AbstractRefType class
Abstract base class for reference type data models.
Signature
export declare abstract class AbstractRefType extends AbstractDataModelBase
Extends: AbstractDataModelBase
Remarks
Represents the foundational structure for reference elements within Doxygen XML documentation, corresponding to the refType complex type in the XML schema. This class manages references to various documented entities such as classes, namespaces, files, folders, modules, pages, and groups. Each reference includes the entity name, a unique identifier for linking, and optional protection and inline attributes. All concrete reference implementations should extend this base to ensure consistent structure and parsing behaviour across different reference types.
Constructors
|
Constructor |
Modifiers |
Description |
|---|---|---|
|
Constructs a new abstract reference type from XML data. |
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
boolean | undefined |
(Optional) Indicates whether the referenced entity is inline. | ||
|
string | undefined |
(Optional) The protection level of the referenced entity. | ||
|
string |
The unique reference identifier for the referenced entity. | ||
|
string |
The name of the referenced entity. |
Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.