DataModel class

Top-level data model class for orchestrating Doxygen XML parsing and data organisation.

Signature

export declare class DataModel

Remarks

This class serves as the primary entry point for parsing Doxygen-generated XML files and constructing a comprehensive data model. It coordinates the parsing of index files, compound definitions, and configuration files, maintaining references to all parsed content for subsequent processing. The class provides methods for sequential parsing operations and ensures data integrity throughout the parsing workflow.

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new DataModel instance with the specified configuration options.

Properties

Property	Modifiers	Type	Description
compoundDefs		CompoundDefDataModel[]	Collection of compound definition data models parsed from individual XML files.
doxyfile?		DoxygenFileDataModel	(Optional) The parsed Doxyfile configuration data model.
doxygenindex?		DoxygenIndexDataModel	(Optional) The parsed Doxygen index data model from the main index XML file.
options		CliOptions	The global configuration options for the parsing operation.
parsedFilesCounter		number	Counter tracking the number of XML files successfully parsed.
projectVersion?		string	(Optional) The project version string extracted from the documentation metadata.
xml		DoxygenXmlParser	The XML parser instance used for processing Doxygen XML files.

Methods

Method	Modifiers	Description
parse()		Orchestrates the complete parsing of Doxygen XML files and data model construction.
parseDoxyfile()		Parses the Doxyfile XML and initialises the configuration data model.
parseDoxygenIndex()		Parses the main Doxygen index XML file and initialises the index data model.
parseFile({ fileName })		Reads and parses the specified XML file, returning the parsed content.
processCompoundDefs(indexCompound, parsedDoxygenElements)		Processes compound definitions from the parsed Doxygen XML elements.
processMemberdefs()		Processes member definitions and updates member kinds where necessary.

---

Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.