AbstractIncType class

Abstract base class for include-type elements within documentation.

Signature

export declare abstract class AbstractIncType extends AbstractDataModelBase

Extends: AbstractDataModelBase

Remarks

Implements processing for include-type elements that represent file inclusion relationships within source code documentation. This class handles the XML Schema definition for incType elements, which contain textual content representing file paths or names along with attributes that specify inclusion behaviour and reference relationships.

The implementation processes both local and system includes, distinguishing between quoted includes ("filename") and angle-bracket includes () through the local attribute. Optional reference identifiers enable cross-referencing to the included file's documentation.

Constructors

Constructor	Modifiers	Description
(constructor)(xml, element, elementName)		Constructs an AbstractIncType instance from XML element data.

Properties

Property	Modifiers	Type	Description
local		boolean	Indicates whether the include uses local or system include syntax.
refId?		string | undefined	(Optional) Optional reference identifier for cross-linking to the included file.
text		string	The textual content representing the file path or name being included.

---

Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.