Skip to main content

AbstractIndexDoxygenType class

Abstract base class for Doxygen index type data models.

Signature

export declare abstract class AbstractIndexDoxygenType extends AbstractDataModelBase

Extends: AbstractDataModelBase

Remarks

Represents the top-level structure of Doxygen index XML files, corresponding to the DoxygenType complex type in the XML schema. This class handles the parsing of version and language attributes, along with compound element collections. Note that this definition may clash with similar types in compound.xsd, requiring careful namespace management.

Constructors

Constructor

Modifiers

Description

(constructor)(xml, element, elementName)

Constructs a new AbstractIndexDoxygenType instance from XML data.

Properties

Property

Modifiers

Type

Description

compounds?

IndexCompoundDataModel[] | undefined

(Optional) Collection of compound data models referenced in the index.

lang

string

The language specification for the documentation content.

noNamespaceSchemaLocation?

string | undefined

(Optional) The XML schema location reference for validation.

version

string

The version of the Doxygen tool that generated the XML.


Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.