Skip to main content

AbstractIndexCompoundType class

Abstract base class for index compound type data models.

Signature

export declare abstract class AbstractIndexCompoundType extends AbstractDataModelBase

Extends: AbstractDataModelBase

Remarks

Represents compound elements found within Doxygen index XML structures, corresponding to the CompoundType complex type in the XML schema. This class handles the parsing of compound names, member collections, and mandatory attributes (refid and kind). All concrete compound data model classes should extend this abstract base to ensure consistent parsing and data representation.

Constructors

Constructor

Modifiers

Description

(constructor)(xml, element, elementName)

Constructs a new AbstractIndexCompoundType instance from XML data.

Properties

Property

Modifiers

Type

Description

kind

string

The kind classification of this compound.

members

IndexMemberDataModel[] | undefined

Collection of member data models associated with this compound.

name

string

The name of the compound element.

refid

string

The unique reference identifier for this compound.


Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.