AbstractReferenceType class
Abstract base class for reference type data models.
Signature
export declare abstract class AbstractReferenceType extends AbstractDataModelBase
Extends: AbstractDataModelBase
Remarks
Represents the foundational structure for reference relationship elements within Doxygen XML documentation, corresponding to the referenceType complex type in the XML schema. This class manages bidirectional reference relationships between documented entities, capturing both the descriptive text and precise location information including line number ranges. The reference system enables comprehensive dependency tracking and cross- referencing capabilities, essential for understanding code relationships and generating accurate documentation navigation structures.
Constructors
|
Constructor |
Modifiers |
Description |
|---|---|---|
|
Constructs a new abstract reference type from XML data. |
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
string | undefined |
(Optional) The compound reference identifier for the containing entity. | ||
|
number | undefined |
The ending line number where the reference concludes. | ||
|
string |
The unique reference identifier for the referenced entity. | ||
|
number | undefined |
The starting line number where the reference occurs. | ||
|
string |
The descriptive text content for this reference relationship. |
Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.