[#mrdocs-Corpus]
= xref:mrdocs.adoc[mrdocs]::Corpus
:relfileprefix: ../
:mrdocs:

The collection of declarations in extracted form.

== Synopsis

Declared in `<mrdocs/Corpus.hpp>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class Corpus;
----

== Types

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Corpus/TraverseOptions.adoc[`TraverseOptions`] 
| Options to traverse the members of an Symbol.
| xref:mrdocs/Corpus/iterator.adoc[`iterator`] 
| The iterator type for the index of all symbols.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Corpus/2destructor.adoc[`~Corpus`] [.small]#[destructor]# [.small]#[virtual]#
| Destructor.
| xref:mrdocs/Corpus/begin.adoc[`begin`]  [.small]#[virtual]#
| Return the begin iterator for the index of all symbols.
| xref:mrdocs/Corpus/empty.adoc[`empty`] 
| Whether the corpus contains any symbols.
| xref:mrdocs/Corpus/end.adoc[`end`]  [.small]#[virtual]#
| Return the end iterator for the index.
| xref:mrdocs/Corpus/exists.adoc[`exists`] 
| Return true if an Symbol with the specified symbol ID exists.
| xref:mrdocs/Corpus/find.adoc[`find`]  [.small]#[virtual]#
| Return the Symbol with the matching ID, or nullptr.
| xref:mrdocs/Corpus/get.adoc[`get`] 
| Return the Symbol with the specified symbol ID.
| xref:mrdocs/Corpus/globalNamespace.adoc[`globalNamespace`] 
| Return the metadata for the global namespace.
| xref:mrdocs/Corpus/lookup-05.adoc[`lookup`] 
| `lookup` overloads
| xref:mrdocs/Corpus/qualifiedName-0b7.adoc[`qualifiedName`] 
| `qualifiedName` overloads
| xref:mrdocs/Corpus/size.adoc[`size`]  [.small]#[virtual]#
| Return the number of symbols in the corpus.
| xref:mrdocs/Corpus/traverse-02.adoc[`traverse`] 
| Visit the members of specified Symbol.
| xref:mrdocs/Corpus/visitIDs.adoc[`visitIDs`] 
| Visit the specified Symbol IDs
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Corpus/build.adoc[`build`] 
| Build a Corpus from a configuration.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Corpus/config.adoc[`config`] 
| The configuration used to generate this corpus.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Corpus/2constructor.adoc[`Corpus`]         [.small]#[constructor]#
| Create a corpus using the provided configuration.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/getParents-04.adoc[`getParents`]
| Return a list of the parent symbols of the specified Symbol.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#