AbstractSectionDefTypeBase class

Abstract base class for section definition type data models.

Signature

export declare abstract class AbstractSectionDefTypeBase extends AbstractDataModelBase

Extends: AbstractDataModelBase

Remarks

Represents the foundational structure for section definition elements within Doxygen XML documentation, corresponding to the sectiondefType complex type in the XML schema. This class provides the core properties and utility methods for managing section definitions, including kind classification, optional headers and descriptions, and member collections. All concrete section definition classes should extend this base to ensure consistent structure and behaviour.

Constructors

Constructor	Modifiers	Description
(constructor)(elementName, kind)		Constructs a new abstract section definition type base instance.

Properties

Property	Modifiers	Type	Description
description?		DescriptionDataModel | undefined	(Optional) The optional description content for this section.
header?		string | undefined	(Optional) The optional header text for this section.
kind		string	The kind classification of this section definition.
memberDefs?		MemberDefDataModel[] | undefined	(Optional) Collection of member definition data models.
members?		MemberDataModel[] | undefined	(Optional) Collection of member reference data models.

Methods

Method	Modifiers	Description
computeAdjustedKind(sectionSuffix, memberSuffix)		Computes an adjusted kind string based on section and member suffixes.
hasMembers()		Determines whether this section contains any member information.

---

Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.