AbstractLocationType class
Abstract base class for location information data models.
Signature
export declare abstract class AbstractLocationType extends AbstractDataModelBase
Extends: AbstractDataModelBase
Remarks
Represents comprehensive source code location information as parsed from Doxygen XML elements, including file paths, line numbers, and column positions for both declarations and implementations. This class provides the foundation for tracking source location references within the documentation system, enabling precise navigation between documentation and source code.
The implementation handles the XML Schema definition for locationType elements, which contain detailed positioning information for code elements including separate tracking of declaration and implementation locations when they differ (such as header/source file pairs).
Constructors
|
Constructor |
Modifiers |
Description |
|---|---|---|
|
Constructs a new location data model from XML element data. |
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
number | undefined |
(Optional) The ending line number of the implementation body. | ||
|
string | undefined |
(Optional) The file path containing the implementation body. | ||
|
number | undefined |
(Optional) The starting line number of the implementation body. | ||
|
number | undefined |
(Optional) The column number in the primary source file. | ||
|
number | undefined |
(Optional) The column number of the declaration within the declaration file. | ||
|
string | undefined |
(Optional) The file path containing the declaration when separate from implementation. | ||
|
number | undefined |
(Optional) The line number of the declaration within the declaration file. | ||
|
string |
The source file path containing the primary declaration or definition. | ||
|
number | undefined |
(Optional) The line number in the primary source file. |
Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.