mrdocs::Corpus

The collection of declarations in extracted form.

Synopsis

Declared in <mrdocs/Corpus.hpp>

class Corpus;

Description

A corpus is a plain value holding the extracted symbols, so it can be moved freely and stays valid wherever it is built. It does not own the configuration: the Config that drives a build is passed to build, and again to whatever consumes the corpus (for example a Generator). Use build to produce one from a Config.

Types

Name

Description

TraverseOptions

Options to traverse the members of a Symbol.

iterator

The iterator type for the index of all symbols.

Member Functions

Name

Description

begin

Return the begin iterator for the index of all symbols.

empty

Whether the corpus contains any symbols.

end

Return the end iterator for the index.

exists

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

finalize

Finalize the corpus.

find

find overloads

get

Return the Symbol with the specified symbol ID.

globalNamespace

Return the metadata for the global namespace.

lookup

lookup overloads

qualifiedName

qualifiedName overloads

size

Return the number of symbols in the corpus.

traverse

Visit the members of the specified Symbol.

visitIDs

Visit the specified Symbol IDs.

Static Member Functions

Name

Description

build

build overloads

Friends

Name

Description

mrdocs::SpecializationFinalizer

mrdocs::FunctionObjectFinalizer

mrdocs::DerivedFinalizer

mrdocs::NamespacesFinalizer

mrdocs::DocCommentFinalizer

mrdocs::SortMembersFinalizer

mrdocs::OverloadsFinalizer

mrdocs::HiddenFriendsFinalizer

mrdocs::BaseMembersFinalizer

Non-Member Functions

Name

Description

buildCorpusDom

Build a DOM object representing an entire corpus.

buildCorpusDom

Build a DOM object representing an entire corpus.

getParents

Return the parents of the specified symbol

Created with MrDocs