mrdocs::Corpus

The collection of declarations in extracted form.

Synopsis

Declared in <mrdocs/Corpus.hpp>

class Corpus;

Types

Name

Description

TraverseOptions

Options to traverse the members of an Symbol.

iterator

The iterator type for the index of all symbols.

Member Functions

Name

Description

~Corpus [destructor] [virtual]

Destructor.

begin [virtual]

Return the begin iterator for the index of all symbols.

empty

Whether the corpus contains any symbols.

end [virtual]

Return the end iterator for the index.

exists

Return true if an Symbol with the specified symbol ID exists.

find [virtual]

Return the Symbol with the matching ID, or nullptr.

get

Return the Symbol with the specified symbol ID.

globalNamespace

Return the metadata for the global namespace.

lookup

lookup overloads

qualifiedName

qualifiedName overloads

traverse

Visit the members of specified Symbol.

visitIDs

Visit the specified Symbol IDs

Data Members

Name

Description

config

The configuration used to generate this corpus.

Protected Member Functions

Name

Description

Corpus [constructor]

Construct from Config

Non-Member Functions

Name

Description

getParents

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

Created with MrDocs