Global namespace

Namespaces

Name
mrdocs

mrdocs namespace

Namespaces

Name	Description
doc
dom	Objects representing JSON-like values.
files
helpers
js
lua
report

Types

Name	Description
AnyFileVisitor
ArrayType
ArrayView	A non-owning, read-only view over a contiguous array of T.
AutoType
BadExpectedAccess
BadExpectedAccess<void>
BaseInfo	Metadata for a direct base.
ConceptSymbol	Info for concepts.
Config	Configuration used to generate the Corpus and Docs
ConstantExprInfo	Represents an expression with a (possibly known) value
ConstantTArg
ConstantTParam	A constant template parameter
Corpus	The collection of declarations in extracted form.
DecltypeType
DocComment	A processed documentation comment attached to a declaration.
DomCorpus	Front-end factory for producing Dom nodes.
EnumConstantSymbol	Info for enum constants.
EnumSymbol
Error	Holds the description of an error, or success.
Exception	Type of all exceptions thrown by the API.
ExecutorGroup	A set of execution agents for performing concurrent work.
ExecutorGroupBase
Expected	A container holding an error or a value.
Expected<T, E>
Expected<T&, E>
ExplicitInfo	Stores only the operand of the explicit-specifier or noexcept-specifier as a string. The complete expression is not preserved at this time. This is a temporary design and may be improved in the future.
ExprInfo	Represents an expression
FormatString	A format string with source location.
FriendInfo	Info for friend declarations.
FunctionSymbol
FunctionType
Generator	Base class for documentation generators.
Generators	A dynamic list of Generator elements.
GlobPattern	A glob pattern matcher
GuideSymbol	Info for deduction guides.
Handlebars	A handlebars environment
HandlebarsError	An error thrown or returned by Handlebars
HandlebarsOptions	Options for handlebars
IdentifierName	Represents an identifier
LValueReferenceType
Location
MemberPointerType
Name	Represents a name for a named Type
NamedType
NamespaceAliasSymbol	Info for namespace aliases.
NamespaceSymbol	Describes a namespace.
NamespaceTranche	The members of a Namespace
NoexceptInfo
Optional	A compact optional that automatically uses nullable_traits<T> when available.
Optional<T&>
OutputRef	Reference to output stream used by handlebars
Overload	Combines multiple callable types into a single overloaded function object.
OverloadsSymbol	Represents a set of function overloads.
Param	Represents a single function parameter
ParseResult	The result of a parse operation.
PathGlobPattern	A glob pattern matcher for paths
PointerType
Polymorphic	A polymorphic value-type.
RValueReferenceType
RangeFor	Range to help range-for loops identify first and last.
RecordInterface	The aggregated interface for a given struct, class, or union.
RecordSymbol	Metadata for struct, class, or union.
RecordTranche	A group of members that have the same access specifier.
ReferenceDirectories	Reference directories used to resolve paths
ScopeExit
ScopeExitRestore
SourceInfo	Stores source information for a declaration.
SourceLocation	A source location with filename prettification.
SpecializationName	Represents a (possibly qualified) symbol name with template arguments.
SplitLinesAdaptor
SplitLinesView
StringHash
Symbol	Base class with common properties of all symbols
SymbolCommonBase	Base class for providing variant discriminator functions.
SymbolGlobPattern	A glob pattern matcher for C++ symbols
SymbolID	A unique identifier for a symbol.
TArg
TArgCommonBase
TParam
TParamCommonBase
TaskGroup	A subset of possible work in a thread pool.
TemplateInfo	Information about templates and specializations thereof.
TemplateTArg
TemplateTParam
ThreadPool	A pool of threads for executing work concurrently.
Type	A possibly qualified type.
TypeCommonBase
TypeTArg
TypeTParam
TypedefSymbol
Unexpected
UsingSymbol	Info for using declarations.
VariableSymbol	A variable.
Visitor	A visitor for a type
YCombinator	Enables recursive lambdas by passing a self-reference as the first argument.
add_const_from
add_cv_from
add_cvref_from
add_lvalue_reference_from
add_reference_from
add_rvalue_reference_from
add_volatile_from
any_callable	A movable, type-erased function object.
any_callable<R(Args...)>
make_dependent
nullable_traits	nullable_traits<T> defines how to treat a T as “nullable” without an external engaged bit.
nullable_traits<Location>	nullable_traits specialization for Location.
nullable_traits<T>	nullable_traits for types with a sentinel.
nullable_traits<Polymorphic<T>>	nullable_traits for Polymorphic<T>.
sentinel_traits	Defines a customization point for types that have an intrinsic sentinel value denoting “null”.
sentinel_traits<std::nullptr_t>	sentinel_traits specialization for std::nullptr_t.
sentinel_traits<T>	sentinel_traits specialization for unsigned integral types.
sentinel_traits<T*>	sentinel_traits specialization for raw pointers.
unexpect_t
unlock_guard	A scoped guard which unlocks a mutex.
UnorderedStringMap
UnorderedStringMultiMap
add_const_from_t
add_cv_from_t
add_cvref_from_t
add_lvalue_reference_from_t
add_reference_from_t
add_rvalue_reference_from_t
add_volatile_from_t
make_dependent_t

Enums

Name	Description
AccessKind	Access specifier.
AutoKind	The kind of auto keyword used in a declaration.
ConstexprKind	constexpr/consteval specifier kinds
ExplicitKind	Explicit specifier kinds
ExtractionMode	Determine why a symbol is extracted
FileKind
FunctionClass	Function classifications
FundamentalTypeKind	Categorically describes a fundamental type.
ListKind
NameKind
NoexceptKind	Exception specification kinds
OperatorKind	Operator kinds
QualifierKind	Type qualifiers
RecordKeyKind	The kind of record: struct, class, or union.
ReferenceKind	Reference type kinds
StorageClassKind	Storage class kinds
SymbolKind	Info variant discriminator
TArgKind	The kind of template argument.
TParamKeyKind	The keyword a template parameter was declared with
TParamKind
TableAlignmentKind
TemplateSpecKind	The kind of template or specialization.
TypeKind
UsingClass	The class of using declaration.

Functions

Name	Description
CompareDerived	Compares two polymorphic objects that have visit functions
HTMLEscape	HTMLEscape overloads
addMember
allMembers
assert_failed
bottomUpTraverse
canMerge
cast
cast_or_null
compareSymbolNames	Return the result of comparing s0 to s1.
contains	Determine if a range contains a specific element.
contains_any	Determine if a range contains any of the specified elements.
contains_n	Determine if a range contains at least N instances of the specified element.
contains_n_any	Determine if a range contains at least N instances of any of the specified elements.
countSymbolKind
createFrame	Create child data objects.
dyn_cast
dyn_cast_or_null
endsWithOneOf	Determine if a string ends with one of the specified characters
escapeExpression
find_last_of	Find the last element in a range that matches an element in the specified range.
forEachFile	forEachFile overloads
formatError	Return a formatted error.
fromString	Convert a string to a FundamentalTypeKind.
getDefaultAccessString
getGenerators	Return a reference to the global Generators instance.
getOperatorKind	Return the short name of an operator as a string.
getOperatorKindFromSuffix	Return the short name of an operator as a string.
getOperatorName	Return the name of an operator as a string.
getOperatorReadableName	Return the human-readable name of the operator
getParents	getParents overloads
getPrimaryLocation
getSafeOperatorName	Return the safe name of an operator as a string.
getShortOperatorName	Return the short name of an operator as a string.
getSinglePageFullPath	Return the full path for single page output.
innerType	Return the inner type.
innerTypePtr	Return the inner type.
innermostType	Return the innermost type.
isAlphaNumeric
isAlphabetic
isBinaryOperator	Determines whether the operator is potentially binary.
isDigit
isEmpty	Determine if a value is empty
isLowerCase
isUnaryOperator	Determines whether the operator is potentially unary.
isUpperCase
isWhitespace	Determine if a string is only whitespace.
is_null	is_null helper that uses nullable_traits<T> if available.
is_one_of	Determine if an element is equal to any of the elements in the specified range.
isa
isa_or_null
leastSpecific	Compare ExtractionModes and returns the least specific
ltrim	ltrim overloads
makeChar	Apply the "char" specifier to the type
makeLong	Apply the "long" specifier to the type
makeOverload	Factory function that creates an Overload from the given callables.
makeShort	Apply the "short" specifier to the type
makeSigned	Apply the "signed" specifier to the type
makeUnsigned	Apply the "unsigned" specifier to the type
makeVisitor	Make a visitor for a base type
make_array_view
make_null	make_null helper that uses nullable_traits<T> if available.
match	Applies a set of callables to a std::variant using std::visit and Overload.
merge	merge overloads
mostSpecific	Compare ExtractionModes and returns the most specific
null_of	null_of helper that constructs a null T using nullable_traits<T>.
operator|
overrides	Determine if one function would override the other
parse	Parse a string view
reindentCode	Reindent code by removing the common leading spaces and adding the specified indent.
replace	Return the substring without leading and trailing horizontal whitespace.
rtrim	rtrim overloads
safeString	Create a wrapper for a safe string.
startsWithOneOf	Determine if a string starts with one of the specified characters
swap
tag_invoke	tag_invoke overloads
toBase16Str	Convert a SymbolID to a string
toCamelCase
toKebabCase
toLowerCase
toPascalCase
toSnakeCase
toString	toString overloads
toUpperCase
to_underlying	Return the value as its underlying type.
topDownTraverse
trim	trim overloads
visit	Invoke a function object with a type derived from Symbol
visitIndexed	Visits a std::variant and calls the combined callable with the active index and the value.
yCombinator	Factory that creates a YCombinator from a callable.
operator<<	Write to output
operator==	Equality operators
operator!=	Inequality operators
operator<	Less-than operators
operator<=	Less-than-or-equal operators
operator>	Greater-than operators
operator>=	Greater-than-or-equal operators
operator<=>	Three-way comparison operators

Variables

Name	Description
splitLines	Split a string view into lines, recognizing all common line breaks
unexpect

Concepts

Name	Description
ClearableContainerLike	Internal concept that matches “empty-clear default-constructible” types.
DocCommentNode	Concept to check if a type represents a DocComment node.
DocCommentNodeTraversable
HasParse	Concept to determine if there's a parse function for a type.
HasSentinel	Concept that is satisfied when sentinel_traits<T> declares a usable sentinel.
SymbolParent	A concept for types that have Symbol members.
dereferenceable	Determine if a type is dereferenceable
has_nullable_traits_v	Utility function that returns true if T has a nullable_traits specialization enabled.
pair_like	Concept to check if a type is pair-like
polymorphic_storage_for	Concept to check if a type is representing a polymorphic storage
range_of	Concept to check if a type is a range of T
range_of_tuple_like	Concept to check if a range is a range of tuple-like elements
reference_constructs_from_temporary_v
reference_converts_from_temporary_v
tuple_like	Concept to check if a type is tuple-like

Deduction Guides

Name	Description
ArrayView<T>
ArrayView<T>
Overload<Ts...>	Class template argument deduction guide for Overload.
RangeFor<Container>
ScopeExit<F>
ScopeExitRestore<T>
ScopeExitRestore<T>
Unexpected<E>

Using Declarations

Name
source_location

mrdocs::doc namespace

Types

Name	Description
AdmonitionBlock	A block for side-notes like tips, warnings, notes
Block	A piece of block content
BlockCommonBase	Base class for providing variant discriminator functions.
BlockContainer
BriefBlock	The brief description
CodeBlock	Preformatted source code.
CodeInline	A piece of styled text.
CopyDetailsInline	Documentation copied from another symbol.
DefinitionListBlock
DefinitionListItem	An item in a definition list
EmphInline	A piece of styled text.
FootnoteDefinitionBlock	Preformatted source code.
FootnoteReferenceInline	A reference to a symbol.
HeadingBlock	A manually specified section heading.
HighlightInline	A piece of highlighted text.
ImageInline	An image.
Inline	A Node containing a string of text.
InlineCommonBase	Base class for providing variant discriminator functions.
InlineContainer	An internal node in the inline element tree
InlineTextLeaf	A leaf node that stores a string of text.
LineBreakInline	A hard line break that renders as ""
LinkInline	A hyperlink.
ListBlock	A list of list items
ListItem	An item in a list
MathBlock	A block of LaTeX math
MathInline	An inline LaTeX math expression
ParagraphBlock	A sequence of text nodes.
ParamBlock	Documentation for a function parameter
PostconditionBlock
PreconditionBlock
QuoteBlock	A list of list items
ReferenceInline	A reference to a symbol.
ReturnsBlock	Documentation for a function return type
SeeBlock	A
SoftBreakInline	A line break that may render as space
StrikethroughInline	A piece of styled text.
StrongInline	A piece of styled text.
SubscriptInline	A piece of styled text.
SuperscriptInline	A piece of styled text.
TParamBlock	Documentation for a template parameter
TableBlock	A table block
TableCell	A cell in a table
TableRow	An item in a list
TextInline	A Node containing a string of text.
ThematicBreakBlock	The brief description
ThrowsBlock	Documentation for a function parameter

Enums

Name	Description
AdmonitionKind	An admonishment style.
BlockKind
InlineKind
ParamDirection	Parameter pass direction.
Parts	Which parts of the documentation to copy.

Functions

Name	Description
getAsPlainText	getAsPlainText overloads
isBlockCommand
isEmpty	Determine if the inline is empty
ltrim	ltrim overloads
rtrim	rtrim overloads
tag_invoke	tag_invoke overloads
toString	toString overloads
traverse	Traverse a list of inlines.
trim	trim overloads
visit	visit overloads
operator==	Equality operators
operator<=>	Three-way comparison operators

mrdocs::dom namespace

Namespaces

Name
JSON

Types

Name	Description
Array	An array of values
ArrayImpl	Abstract array interface.
DefaultArrayImpl	The default array implementation.
DefaultFunctionImpl
DefaultObjectImpl	The default Object implementation.
Function
FunctionImpl
LazyArrayImpl	Lazy array implementation
LazyObjectImpl	Lazy object implementation.
LazyObjectMapTag	Customization point tag.
Object	A container of key and value pairs.
ObjectImpl	Abstract object interface.
String
Value	A variant container for any kind of Dom value.
ValueFromTag	Customization point tag.
VariadicFunctionImpl
function_traits
function_traits<F>
function_traits<R(*)(Args...)>
function_traits<R(Args...)>
function_traits<R const volatile(C::*)(Args...)>

Enums

Name	Description
Kind	The type of data in a Value.

Functions

Name	Description
LazyArray	LazyArray overloads
LazyObject	LazyObject overloads
TransformArray	Return a new dom::Array based on a transformed lazy array implementation.
ValueFrom	ValueFrom overloads
makeInvocable
makeVariadicInvocable
newArray	Return a new array using a custom implementation.
newFunction	Return a diagnostic string.
newObject	Return a new object using a custom implementation.
operator&&	Return the first dom::Value that is not truthy, or the last one.
operator+	Addition operators
operator||	Return the first dom::Value that is truthy, or the last one.
stringOrNull	Return a non-empty string, or a null.
swap	swap overloads
toString	toString overloads
operator==	Equality operators
operator!=	Return the result of comparing two strings.
operator<=>	Three-way comparison operators

Concepts

Name	Description
HasLazyObjectMap	Determine if T can be converted to dom::Value.
HasLazyObjectMapWithContext	Concept to determine if a type can be mapped to a dom::LazyObjectImpl with a user-provided conversion.
HasLazyObjectMapWithoutContext	Concept to determine if a type can be mapped to a dom::LazyObjectImpl with a user-provided conversion.
HasStandaloneValueFrom	Determine if T can be converted to dom::Value without a context.
HasValueFrom	Determine if T can be converted to dom::Value.
HasValueFromWithContext	Concept to determine if a type can be converted to a dom::Value with a user-provided conversion.
HasValueFromWithoutContext	Concept to determine if a type can be converted to a dom::Value with a user-provided conversion.
StringLikeTy	Satisfied if StringTy is convertible to String but not a String.
function_traits_convertible_to_value
has_function_args_for_default_function_impl
has_function_traits
has_function_traits_for_default_function_impl
has_invoke_expected_result_convertible_to_dom_value
has_invoke_result_convertible_to_dom_value
has_invoke_result_for_default_function_impl

mrdocs::dom::JSON namespace

Functions

Name	Description
stringify	Stringify a value as JSON

mrdocs::files namespace

Enums

Name	Description
FileType	The type of a file.

Functions

Name	Description
appendPath
createDirectory	Create a directory.
exists	Determine if a path exists
getFileName	Return the filename part of the path.
getFileText	Return the contents of a file as a string.
getFileType	Return the file type or an error
getParentDir	Return the parent directory.
getSourceFilename	Return the relevant suffix of a source file path.
isAbsolute	Return true if pathName is absolute.
isDirectory	Determine if a path is a directory.
isDirsy	Return true if pathName ends in a separator.
isLexicalDirectory	Determine lexically if a path is a directory.
isPosixStyle	Check if the path is posix style.
makeAbsolute	Return an absolute path from a possibly relative path.
makeDirsy	Append a trailing native separator if not already present.
makePosixStyle	Convert all backward slashes to forward slashes.
normalizeDir	Return a normalized directory.
normalizePath	Return a normalized path.
requireAbsolute	Return an error if pathName is not absolute.
requireDirectory	Return an error if the path is not a directory.
startsWith	Checks if the given path starts with the specified prefix.
withExtension	Return the filename with a new or different extension.

mrdocs::helpers namespace

Functions

Name	Description
and_fn	"and" helper function
detag_fn	"detag" helper function
eq_fn	"eq" helper function
increment_fn	"increment" helper function
ne_fn	"ne" helper function
not_fn	"not" helper function
or_fn	"or" helper function
registerAntoraHelpers	Register all the Antora helpers into a Handlebars instance
registerBuiltinHelpers	Register all the built-in helpers into a Handlebars instance
registerConstructorHelpers	Register contructor helpers into a Handlebars instance
registerContainerHelpers	Register helpers to manipulate composite data types
registerLogicalHelpers	Register logical helpers into a Handlebars instance
registerMathHelpers	Register math helpers into a Handlebars instance
registerStringHelpers	Register string helpers into a Handlebars instance
registerTypeHelpers	Register type helpers into a Handlebars instance
relativize_fn	"relativize" helper function
select_fn	"select" helper function
year_fn	"year" helper function

mrdocs::js namespace

Types

Name	Description
Access
Array
Boolean
Context	An instance of a JavaScript interpreter.
Object
Prop
Scope	A JavaScript scope
String
Value	An ECMAScript value.

Enums

Name	Description
Type	Types of values.

Functions

Name	Description
operator&&	Return the first Value that is not truthy, or the last one.
operator||	Return the first Value that is truthy, or the last one.
registerHelper	Register a JavaScript helper function
swap	Swap two values.
toString	Return value as a string.
operator==	Compare two values for equality.
operator!=	Inequality operators
operator<=>	Compare two values for inequality.

mrdocs::lua namespace

Types

Name	Description
Access
Context	A reference to an instance of a Lua interpreter.
Function	A Lua function.
Param	A lazy container to push values to the Lua stack.
Scope
String	A Lua string.
Table	A Lua table.
Value	A Lua value.
zstring	A null-terminated string.
FunctionPtr

Enums

Name	Description
Type	Types of values.

mrdocs::report namespace

Types

Name	Description
Located	Parameter type that adds a source location to a value.
Results	Provides statistics on the number of reported messages.

Enums

Name	Description
Level	Severity levels attached to reported messags.

Functions

Name	Description
debug	Report a message to the console.
error	Report a message to the console.
fatal	Report a message to the console.
getMinimumLevel
info	Report a message to the console.
log	Format a message to the console.
print	Report a message to the console.
setMinimumLevel	Set the minimum threshold level for reporting.
setSourceLocationWarnings	If true, source location information will be printed with warnings, errors, and fatal messages.
trace	Report a message to the console.
warn	Report a message to the console.

Variables

Name	Description
results	Holds current statistics on reported messages.

Created with MrDocs