Namespaces
Name |
mrdocs namespace
Namespaces
Name |
Description |
Objects representing JSON‐like values. |
|
Types
Name |
Description |
A non‐owning, read‐only view over a contiguous array of T. |
|
Metadata for a direct base. |
|
Info for concepts. |
|
Configuration used to generate the Corpus and Docs |
|
Represents an expression with a (possibly known) value |
|
A constant template parameter |
|
The collection of declarations in extracted form. |
|
A processed documentation comment attached to a declaration. |
|
Front‐end factory for producing Dom nodes. |
|
Info for enum constants. |
|
Holds the description of an error, or success. |
|
Type of all exceptions thrown by the API. |
|
A set of execution agents for performing concurrent work. |
|
A container holding an error or a value. |
|
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. |
|
Represents an expression |
|
A format string with source location. |
|
Info for friend declarations. |
|
Base class for documentation generators. |
|
A dynamic list of |
|
A glob pattern matcher |
|
Info for deduction guides. |
|
A handlebars environment |
|
An error thrown or returned by Handlebars |
|
Options for handlebars |
|
Represents an identifier |
|
Represents a name for a named |
|
Info for namespace aliases. |
|
Describes a namespace. |
|
The members of a Namespace |
|
A compact optional that automatically uses nullable_traits<T> when available. |
|
Reference to output stream used by handlebars |
|
Combines multiple callable types into a single overloaded function object. |
|
Represents a set of function overloads. |
|
Represents a single function parameter |
|
The result of a parse operation. |
|
A glob pattern matcher for paths |
|
A polymorphic value‐type. |
|
Range to help range‐for loops identify first and last. |
|
The aggregated interface for a given struct, class, or union. |
|
Metadata for struct, class, or union. |
|
A group of members that have the same access specifier. |
|
Reference directories used to resolve paths |
|
Stores source information for a declaration. |
|
A source location with filename prettification. |
|
Represents a (possibly qualified) symbol name with template arguments. |
|
Base class with common properties of all symbols |
|
Base class for providing variant discriminator functions. |
|
A glob pattern matcher for C++ symbols |
|
A unique identifier for a symbol. |
|
A subset of possible work in a thread pool. |
|
Information about templates and specializations thereof. |
|
A pool of threads for executing work concurrently. |
|
A possibly qualified type. |
|
Info for using declarations. |
|
A variable. |
|
A visitor for a type |
|
Enables recursive lambdas by passing a self‐reference as the first argument. |
|
A movable, type‐erased function object. |
|
nullable_traits<T> defines how to treat a T as “nullable” without an external engaged bit. |
|
nullable_traits specialization for Location. |
|
nullable_traits for types with a sentinel. |
|
nullable_traits for Polymorphic<T>. |
|
Defines a customization point for types that have an intrinsic sentinel value denoting “null”. |
|
sentinel_traits specialization for std::nullptr_t. |
|
sentinel_traits specialization for unsigned integral types. |
|
sentinel_traits specialization for raw pointers. |
|
A scoped guard which unlocks a mutex. |
|
Enums
Name |
Description |
Access specifier. |
|
The kind of |
|
|
|
Explicit specifier kinds |
|
Determine why a symbol is extracted |
|
Function classifications |
|
Categorically describes a fundamental type. |
|
Exception specification kinds |
|
Operator kinds |
|
Type qualifiers |
|
The kind of record: struct, class, or union. |
|
Reference type kinds |
|
Storage class kinds |
|
Info variant discriminator |
|
The kind of template argument. |
|
The keyword a template parameter was declared with |
|
The kind of template or specialization. |
|
The class of using declaration. |
Functions
Name |
Description |
Compares two polymorphic objects that have visit functions |
|
|
|
Return the result of comparing s0 to s1. |
|
Determine if a range contains a specific element. |
|
Determine if a range contains any of the specified elements. |
|
Determine if a range contains at least N instances of the specified element. |
|
Determine if a range contains at least N instances of any of the specified elements. |
|
Create child data objects. |
|
Determine if a string ends with one of the specified characters |
|
Find the last element in a range that matches an element in the specified range. |
|
|
|
Return a formatted error. |
|
Convert a string to a FundamentalTypeKind. |
|
Return a reference to the global Generators instance. |
|
Return the short name of an operator as a string. |
|
Return the short name of an operator as a string. |
|
Return the name of an operator as a string. |
|
Return the human‐readable name of the operator |
|
|
|
Return the safe name of an operator as a string. |
|
Return the short name of an operator as a string. |
|
Return the full path for single page output. |
|
Return the inner type. |
|
Return the inner type. |
|
Return the innermost type. |
|
Determines whether the operator is potentially binary. |
|
Determine if a value is empty |
|
Determines whether the operator is potentially unary. |
|
Determine if a string is only whitespace. |
|
is_null helper that uses nullable_traits<T> if available. |
|
Determine if an element is equal to any of the elements in the specified range. |
|
Compare ExtractionModes and returns the least specific |
|
|
|
Apply the "char" specifier to the type |
|
Apply the "long" specifier to the type |
|
Factory function that creates an Overload from the given callables. |
|
Apply the "short" specifier to the type |
|
Apply the "signed" specifier to the type |
|
Apply the "unsigned" specifier to the type |
|
Make a visitor for a base type |
|
make_null helper that uses nullable_traits<T> if available. |
|
Applies a set of callables to a std::variant using std::visit and Overload. |
|
|
|
Compare ExtractionModes and returns the most specific |
|
null_of helper that constructs a null T using nullable_traits<T>. |
|
Determine if one function would override the other |
|
Parse a string view |
|
Reindent code by removing the common leading spaces and adding the specified indent. |
|
Return the substring without leading and trailing horizontal whitespace. |
|
|
|
Create a wrapper for a safe string. |
|
Determine if a string starts with one of the specified characters |
|
|
|
Convert a SymbolID to a string |
|
|
|
Return the value as its underlying type. |
|
|
|
Invoke a function object with a type derived from Symbol |
|
Visits a std::variant and calls the combined callable with the active index and the value. |
|
Factory that creates a YCombinator from a callable. |
|
Write to output |
|
Equality operators |
|
Inequality operators |
|
Less‐than operators |
|
Less‐than‐or‐equal operators |
|
Greater‐than operators |
|
Greater‐than‐or‐equal operators |
|
Three‐way comparison operators |
Variables
Name |
Description |
Split a string view into lines, recognizing all common line breaks |
|
Concepts
Name |
Description |
Internal concept that matches “empty‐clear default‐constructible” types. |
|
Concept to check if a type represents a DocComment node. |
|
Concept to determine if there's a parse function for a type. |
|
Concept that is satisfied when sentinel_traits<T> declares a usable sentinel. |
|
A concept for types that have |
|
Determine if a type is dereferenceable |
|
Utility function that returns true if T has a nullable_traits specialization enabled. |
|
Concept to check if a type is pair‐like |
|
Concept to check if a type is representing a polymorphic storage |
|
Concept to check if a type is a range of T |
|
Concept to check if a range is a range of tuple‐like elements |
|
Concept to check if a type is tuple‐like |
Deduction Guides
Name |
Description |
Class template argument deduction guide for Overload. |
|
Using Declarations
Name |
mrdocs::doc namespace
Types
Name |
Description |
A block for side‐notes like tips, warnings, notes |
|
A piece of block content |
|
Base class for providing variant discriminator functions. |
|
The brief description |
|
Preformatted source code. |
|
A piece of styled text. |
|
Documentation copied from another symbol. |
|
An item in a definition list |
|
A piece of styled text. |
|
Preformatted source code. |
|
A reference to a symbol. |
|
A manually specified section heading. |
|
A piece of highlighted text. |
|
An image. |
|
A Node containing a string of text. |
|
Base class for providing variant discriminator functions. |
|
An internal node in the inline element tree |
|
A leaf node that stores a string of text. |
|
A hard line break that renders as "" |
|
A hyperlink. |
|
A list of list items |
|
An item in a list |
|
A block of LaTeX math |
|
An inline LaTeX math expression |
|
A sequence of text nodes. |
|
Documentation for a function parameter |
|
A list of list items |
|
A reference to a symbol. |
|
Documentation for a function return type |
|
A |
|
A line break that may render as space |
|
A piece of styled text. |
|
A piece of styled text. |
|
A piece of styled text. |
|
A piece of styled text. |
|
Documentation for a template parameter |
|
A table block |
|
A cell in a table |
|
An item in a list |
|
A Node containing a string of text. |
|
The brief description |
|
Documentation for a function parameter |
Enums
Name |
Description |
An admonishment style. |
|
Parameter pass direction. |
|
Which parts of the documentation to copy. |
Functions
Name |
Description |
|
|
Determine if the inline is empty |
|
|
|
|
|
|
|
|
|
Traverse a list of inlines. |
|
|
|
|
|
Equality operators |
|
Three‐way comparison operators |
mrdocs::dom namespace
Objects representing JSON‐like values.
Namespaces
Name |
Types
Name |
Description |
An array of values |
|
Abstract array interface. |
|
The default array implementation. |
|
The default Object implementation. |
|
Lazy array implementation |
|
Lazy object implementation. |
|
Customization point tag. |
|
A container of key and value pairs. |
|
Abstract object interface. |
|
A variant container for any kind of Dom value. |
|
Customization point tag. |
|
Enums
Name |
Description |
The type of data in a Value. |
Functions
Name |
Description |
|
|
|
|
Return a new dom::Array based on a transformed lazy array implementation. |
|
|
|
Return a new array using a custom implementation. |
|
Return a diagnostic string. |
|
Return a new object using a custom implementation. |
|
Return the first dom::Value that is not truthy, or the last one. |
|
Addition operators |
|
Return the first dom::Value that is truthy, or the last one. |
|
Return a non‐empty string, or a null. |
|
|
|
|
|
Equality operators |
|
Return the result of comparing two strings. |
|
Three‐way comparison operators |
Concepts
Name |
Description |
Determine if |
|
Concept to determine if a type can be mapped to a |
|
Concept to determine if a type can be mapped to a |
|
Determine if ` T` can be converted to |
|
Determine if |
|
Concept to determine if a type can be converted to a |
|
Concept to determine if a type can be converted to a |
|
Satisfied if StringTy is convertible to String but not a String. |
|
mrdocs::dom::JSON namespace
Functions
Name |
Description |
Stringify a value as JSON |
mrdocs::files namespace
Enums
Name |
Description |
The type of a file. |
Functions
Name |
Description |
Create a directory. |
|
Determine if a path exists |
|
Return the filename part of the path. |
|
Return the contents of a file as a string. |
|
Return the file type or an error |
|
Return the parent directory. |
|
Return the relevant suffix of a source file path. |
|
Return true if pathName is absolute. |
|
Determine if a path is a directory. |
|
Return true if pathName ends in a separator. |
|
Determine lexically if a path is a directory. |
|
Check if the path is posix style. |
|
Return an absolute path from a possibly relative path. |
|
Append a trailing native separator if not already present. |
|
Convert all backward slashes to forward slashes. |
|
Return a normalized directory. |
|
Return a normalized path. |
|
Return an error if pathName is not absolute. |
|
Return an error if the path is not a directory. |
|
Checks if the given path starts with the specified prefix. |
|
Return the filename with a new or different extension. |
mrdocs::helpers namespace
Functions
Name |
Description |
"and" helper function |
|
"detag" helper function |
|
"eq" helper function |
|
"increment" helper function |
|
"ne" helper function |
|
"not" helper function |
|
"or" helper function |
|
Register all the Antora helpers into a Handlebars instance |
|
Register all the built‐in helpers into a Handlebars instance |
|
Register contructor helpers into a Handlebars instance |
|
Register helpers to manipulate composite data types |
|
Register logical helpers into a Handlebars instance |
|
Register math helpers into a Handlebars instance |
|
Register string helpers into a Handlebars instance |
|
Register type helpers into a Handlebars instance |
|
"relativize" helper function |
|
"select" helper function |
|
"year" helper function |
mrdocs::js namespace
Types
Name |
Description |
An instance of a JavaScript interpreter. |
|
A JavaScript scope |
|
An ECMAScript value. |
Enums
Name |
Description |
Types of values. |
Functions
Name |
Description |
Return the first Value that is not truthy, or the last one. |
|
Return the first Value that is truthy, or the last one. |
|
Register a JavaScript helper function |
|
Swap two values. |
|
Return value as a string. |
|
Compare two values for equality. |
|
Inequality operators |
|
Compare two values for inequality. |
mrdocs::lua namespace
Types
Name |
Description |
A reference to an instance of a Lua interpreter. |
|
A Lua function. |
|
A lazy container to push values to the Lua stack. |
|
A Lua string. |
|
A Lua table. |
|
A Lua value. |
|
A null‐terminated string. |
|
Enums
Name |
Description |
Types of values. |
mrdocs::report namespace
Types
Name |
Description |
Parameter type that adds a source location to a value. |
|
Provides statistics on the number of reported messages. |
Enums
Name |
Description |
Severity levels attached to reported messags. |
Functions
Name |
Description |
Report a message to the console. |
|
Report a message to the console. |
|
Report a message to the console. |
|
Report a message to the console. |
|
Format a message to the console. |
|
Report a message to the console. |
|
Set the minimum threshold level for reporting. |
|
If true, source location information will be printed with warnings, errors, and fatal messages. |
|
Report a message to the console. |
|
Report a message to the console. |