AbstractCompoundDefType class

Abstract base class for Doxygen compound definition data models.

Signature

export declare abstract class AbstractCompoundDefType extends AbstractDataModelBase

Extends: AbstractDataModelBase

Remarks

Represents the core structure of compound definitions in Doxygen XML output, including classes, structures, files, namespaces, and other compound types. This class handles the complete XML schema for compound definitions with comprehensive element and attribute processing to capture all aspects of the documented code structures.

Constructors

Constructor	Modifiers	Description
(constructor)(xml, element, elementName)		Constructs a new compound definition data model instance.

Properties

Property	Modifiers	Type	Description
abstract?		boolean | undefined	(Optional) Indicates whether the compound is abstract.
baseCompoundRefs?		BaseCompoundRefDataModel[] | undefined	(Optional) Base compound references for inheritance relationships.
briefDescription?		BriefDescriptionDataModel | undefined	(Optional) Brief description of the compound.
compoundName		string	The name of the compound element.
derivedCompoundRefs?		DerivedCompoundRefDataModel[] | undefined	(Optional) Derived compound references for inheritance relationships.
detailedDescription?		DetailedDescriptionDataModel | undefined	(Optional) Detailed description of the compound.
final?		boolean | undefined	(Optional) Indicates whether the compound is marked as final.
id		string	Unique identifier for the compound.
includedBy?		IncludedByDataModel[] | undefined	(Optional) Reverse include file references for this compound.
includes?		IncludesDataModel[] | undefined	(Optional) Include file references for this compound.
inline?		boolean | undefined	(Optional) Indicates whether the compound is inline.
innerClasses?		InnerClassDataModel[] | undefined	(Optional) Inner class references contained within this compound.
innerDirs?		InnerDirDataModel[] | undefined	(Optional) Inner folder references contained within this compound.
innerFiles?		InnerFileDataModel[] | undefined	(Optional) Inner file references contained within this compound.
innerGroups?		InnerGroupDataModel[] | undefined	(Optional) Inner group references contained within this compound.
innerNamespaces?		InnerNamespaceDataModel[] | undefined	(Optional) Inner namespace references contained within this compound.
innerPages?		InnerPageDataModel[] | undefined	(Optional) Inner page references contained within this compound.
kind		string	The kind or type of compound.
language?		string | undefined	(Optional) Programming language of the compound.
listOfAllMembers?		ListOfAllMembersDataModel | undefined	(Optional) Complete list of all members contained in the compound.
location?		LocationDataModel | undefined	(Optional) Location information for the compound definition.
programListing?		ProgramListingDataModel | undefined	(Optional) Program listing or source code for the compound.
prot?		string | undefined	(Optional) Protection level of the compound.
sealed?		boolean | undefined	(Optional) Indicates whether the compound is sealed.
sectionDefs?		SectionDefDataModel[] | undefined	(Optional) Section definitions within the compound.
tableOfContents?		TableOfContentsDataModel | undefined	(Optional) Table of contents for the compound documentation.
templateParamList?		TemplateParamListDataModel | undefined	(Optional) Template parameter list for templated compounds.
title?		string | undefined	(Optional) Optional title for the compound.

---

Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.