mrdocs::DomCorpus

Front‐end factory for producing Dom nodes.

Synopsis

Declared in <mrdocs/Metadata/DomCorpus.hpp>

class DomCorpus;

Description

This class keeps a reference to the Corpus of extracted metadata, and provides a mechanism for constructing DOM nodes representing the metadata.

A Generator can subclass this object then uses it to create the Dom nodes used as input for rendering template engines.

Member Functions

Name

Description

DomCorpus [constructor]

Constructor.

~DomCorpus [destructor] [virtual]

Destructor.

construct [virtual]

Construct a lazy Dom object representing the specified symbol.

get

Return a Dom object representing the given symbol.

getCorpus

Returns the Corpus associated with the Dom.

getDocComment [virtual]

Return a Dom value representing the DocComment.

operator*

Returns the Corpus associated with the Dom.

operator‐>

Returns the Corpus associated with the Dom.

Non-Member Functions

Name

Description

getParents

Return a list of the parent symbols of the specified Info.

Created with MrDocs