Skip to main content

DataModel class

Signature

export declare class DataModel

Constructors

Constructor

Modifiers

Description

(constructor)(options)

Constructs a new instance of the DataModel class

Properties

Property

Modifiers

Type

Description

compoundDefs

CompoundDefDataModel[]

doxyfile?

DoxygenFileDataModel

(Optional)

doxygenindex?

DoxygenIndexDataModel

(Optional)

options

CliOptions

The global configuration options.

parsedFilesCounter

number

Keep track of the number of XML files parsed.

projectVersion?

string

(Optional)

xml

DoxygenXmlParser

Methods

Method

Modifiers

Description

parse()

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.