Namespaces
Name |
Description |
Core MrDocs support utilities. |
mrdocs namespace
Core MrDocs support utilities.
Namespaces
Name |
Description |
Doc‐comment enums and helpers that describe admonition kinds. |
|
Objects representing JSON‐like values. |
|
Filesystem helpers (join, temp, canonicalize) used throughout MrDocs. |
|
Handlebars helper registry for templates. |
|
JavaScript interop helpers for the embedded runtime. |
|
Lua interop helpers for the optional scripting/backend integration. |
|
Reporting utilities (messages, statistics, sinks). |
Types
Name |
Description |
Polymorphic visitor for files discovered during traversal. |
|
C++ array type (bounded or unbounded). |
|
A non‐owning, read‐only view over a contiguous array of T. |
|
Represents |
|
Base class for accessing an empty Expected. |
|
Exception thrown when reading the value of an empty Expected. |
|
Metadata for a direct base. |
|
Info for concepts. |
|
Configuration used to generate the Corpus and Docs |
|
Represents an expression with a (possibly known) value |
|
Non‐type template argument. |
|
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. |
|
Metadata for an enumeration declaration. |
|
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. |
|
Base class that owns a pool of execution agents and a shared work queue. |
|
A container holding an error or a value. |
|
Expected specialization for |
|
Expected specialization for lvalue references. Holds either a bound reference to |
|
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. |
|
Metadata for a function or method. |
|
Function type with parameters, qualifiers, and noexcept info. |
|
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 |
|
An lvalue reference type. |
|
Source location of a symbol or entity. |
|
Pointer‐to‐member type (object or function). |
|
Represents a name for a named |
|
A type identified by name (possibly fundamental). |
|
Info for namespace aliases. |
|
Describes a namespace and its members. |
|
Buckets the members that appear inside a namespace. |
|
Captures a |
|
A compact optional that automatically uses nullable_traits<T> when available. |
|
Optional reference wrapper that never owns storage. |
|
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 |
|
Pointer type wrapper. |
|
A polymorphic value‐type. |
|
An rvalue reference type. |
|
Range adapter to expose first/last flags inside range‐for loops. |
|
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 |
|
Execute a callable when the enclosing scope exits unless dismissed. |
|
RAII helper that restores a referenced value on scope exit. |
|
Stores source information for a declaration. |
|
A source location with filename prettification. |
|
Represents a (possibly qualified) symbol name with template arguments. |
|
Range adaptor that constructs a SplitLinesView. |
|
A lazy input range of std::string_view lines split on all known line breaks. |
|
Transparent hash functor for string‐like keys. |
|
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. |
|
Base class for any template argument. |
|
CRTP base that fixes the argument kind. |
|
Base class for a template parameter declaration. |
|
CRTP base that fixes the parameter kind. |
|
A subset of possible work in a thread pool. |
|
Information about templates and specializations thereof. |
|
Template template argument. |
|
Template template parameter. |
|
A pool of threads for executing work concurrently. |
|
A possibly qualified type. |
|
CRTP base that ties a concrete type to a fixed TypeKind. |
|
Type template argument. |
|
Type template parameter. |
|
Info for typedef and using declarations. |
|
Holds an unexpected error value for Expected. |
|
Info for using declarations. |
|
A variable. |
|
A visitor for a type |
|
Enables recursive lambdas by passing a self‐reference as the first argument. |
|
Propagate const qualification from |
|
Propagate both const and volatile qualifiers from |
|
Propagate cv‐qualification and reference category from |
|
Propagate lvalue‐reference from |
|
Propagate reference qualification from |
|
Propagate rvalue‐reference from |
|
Propagate volatile qualification from |
|
A movable, type‐erased function object. |
|
Type‐erased callable wrapper for signature |
|
Dependent alias of |
|
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. |
|
Tag type used to select unexpected construction. |
|
A scoped guard which unlocks a mutex. |
|
unordered_map keyed by std::string with transparent hashing. |
|
unordered_multimap keyed by std::string with transparent hashing. |
|
Alias for |
|
Alias for |
|
Alias for |
|
Alias for |
|
Alias for |
|
Alias for |
|
Alias for |
|
Alias for |
Enums
Name |
Description |
Access specifier. |
|
The kind of |
|
|
|
Explicit specifier kinds |
|
Determine why a symbol is extracted |
|
Classifies where a file originates from. |
|
Function classifications |
|
Categorically describes a fundamental type. |
|
Classification of list ordering. |
|
Kinds of names that appear in type and symbol metadata. |
|
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 |
|
Discriminates the different template parameter categories. |
|
Horizontal alignment for table columns. |
|
The kind of template or specialization. |
|
Variants of C++ types captured in metadata. |
|
The class of using declaration. |
Functions
Name |
Description |
Compares two polymorphic objects that have visit functions |
|
|
|
Append a new function overload to the set. |
|
|
|
Handler invoked when |
|
Traverse a DocComment tree bottom‐up (post‐order). |
|
Check whether two symbols may be merged. |
|
|
|
|
|
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. |
|
Count the number of SymbolKind enumerators. |
|
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 the default accessibility for a record key kind. |
|
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. |
|
|
|
|
|
|
|
Determines whether the operator is potentially binary. |
|
|
|
Determine if a value is empty |
|
|
|
Determines whether the operator is potentially unary. |
|
|
|
|
|
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. |
|
Return true if the polymorphic object holds a value of type To. |
|
Return true if pointer is non‐null and referent is of type To. |
|
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>. |
|
Pipe a contiguous character range into the adaptor. |
|
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. |
|
|
|
|
|
Determine if a string starts with one of the specified characters |
|
|
|
|
|
Convert a SymbolID to a string |
|
Convert a string to |
|
Convert a string to |
|
|
|
Convert a string to |
|
Convert a string to |
|
|
|
|
|
Return the value as its underlying type. |
|
Traverse a DocComment tree top‐down (pre‐order). |
|
|
|
|
|
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 |
|
Tag object to request unexpected construction. |
Concepts
Name |
Description |
Internal concept that matches “empty‐clear default‐constructible” types. |
|
Concept to check if a type represents a DocComment node. |
|
Types that can be traversed by DocComment helpers. |
|
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 concept 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 |
|
Like |
|
True when binding |
|
Concept to check if a type is tuple‐like |
Deduction Guides
Name |
Description |
Deduce ArrayView element type from C‐style array. |
|
Deduce ArrayView element type from pointer and count. |
|
Class template argument deduction guide for Overload. |
|
Deduction guide for RangeFor. |
|
Deduction guide for ScopeExit. |
|
Deduction guide for ScopeExitRestore taking a reference. |
|
Deduction guide for ScopeExitRestore taking a reference and new value. |
|
Deduction guide for Unexpected, forwarding the error type. |
Using Declarations
Name |
Description |
Alias to |
mrdocs::doc namespace
Doc‐comment enums and helpers that describe admonition kinds.
Types
Name |
Description |
A block for side‐notes like tips, warnings, notes |
|
A piece of block content |
|
Base class for providing variant discriminator functions. |
|
A composite block that stores a sequence of child blocks. |
|
The brief description |
|
Preformatted source code. |
|
Inline code (monospaced) used for short snippets within text. |
|
Documentation copied from another symbol. |
|
A list of terms paired with definitions. |
|
An item in a definition list |
|
Emphasized text (typically rendered in italics). |
|
Text defining the content of a footnote reference. |
|
A reference to a symbol. |
|
A manually specified section heading. |
|
Highlighted text span used to call out important words. |
|
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 |
|
A block of LaTeX math |
|
An inline LaTeX math expression |
|
A sequence of text nodes. |
|
Documentation for a function parameter |
|
Text describing conditions guaranteed on successful exit. |
|
Text describing required conditions before entry. |
|
A quoted block of text. |
|
A reference to a symbol. |
|
Documentation for a function return type |
|
A |
|
A line break that may render as a space |
|
Strikethrough span to show removed or deprecated text. |
|
Strong emphasis span (typically rendered in bold). |
|
Subscript text fragment (lowered baseline). |
|
Superscript text fragment (raised baseline). |
|
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. |
|
A horizontal thematic break separating sections. |
|
Documentation for a function exception clause |
Enums
Name |
Description |
An admonishment style. |
|
Enumerates the different kinds of DocComment blocks. |
|
Enumerates the different kinds of inline nodes. |
|
Parameter pass direction. |
|
Which parts of the documentation to copy. |
Functions
Name |
Description |
|
|
Return true if the given block kind represents a command block. |
|
Determine if the inline is empty |
|
|
|
|
|
|
|
|
|
Traverse a list of inlines. |
|
|
|
|
|
Equality delegates to the three‐way comparison. |
|
Three‐way comparison operators |
mrdocs::dom namespace
Objects representing JSON‐like values.
Namespaces
Name |
Description |
JSON serialization helpers for DOM values. |
Types
Name |
Description |
An array of values |
|
Abstract array interface. |
|
The default array implementation. |
|
Function implementation that wraps a fixed‐arity callable. |
|
The default Object implementation. |
|
Value‐semantic wrapper over a callable exposed to the DOM layer. |
|
Value‐semantic wrapper over a callable exposed to the DOM layer. |
|
Lazy array implementation |
|
Lazy array implementation |
|
Lazy object implementation. |
|
Lazy object implementation. |
|
Customization point tag. |
|
A container of key and value pairs. |
|
Abstract object interface. |
|
UTF‐8 string value used by the DOM. |
|
A variant container for any kind of Dom value. |
|
Customization point tag. |
|
Function implementation that forwards the entire Array to a callable. |
|
Helper traits to extract return and argument types from callables. |
|
Traits specialization for functors/lambdas. |
|
Traits specialization for function pointers. |
|
Traits specialization for free functions. |
|
Traits specialization for member functions. |
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. |
|
|
|
Create a Function from a fixed‐arity invocable. |
|
Create a Function that receives the argument Array directly. |
|
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. |
|
Concept selecting callables convertible to dom::Value. |
|
Concept requiring all arguments be convertible to dom::Value. |
|
Concept true when function_traits is defined for F. |
|
Concept combining argument and return constraints for default wrapper. |
|
Concept true when F returns Expected<dom::Value> or Expected<void>. |
|
Concept true when F returns a dom::Value or void. |
|
Concept enabling default function wrapper for supported return types. |
mrdocs::dom::JSON namespace
JSON serialization helpers for DOM values.
Functions
Name |
Description |
Stringify a value as JSON |
mrdocs::files namespace
Filesystem helpers (join, temp, canonicalize) used throughout MrDocs.
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
Handlebars helper registry for templates.
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
JavaScript interop helpers for the embedded runtime.
Types
Name |
Description |
Opaque tag that allows bridge classes to reach JS internals. |
|
Lightweight handle to a JavaScript array. |
|
Boolean wrapper for JavaScript values. |
|
An instance of a JavaScript interpreter. |
|
Object wrapper for JavaScript values. |
|
Represents either a property name or array index when addressing JS objects. |
|
A JavaScript scope |
|
String wrapper for JavaScript values. |
|
Generic JavaScript value wrapper. |
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
Lua interop helpers for the optional scripting/backend integration.
Types
Name |
Description |
Internal tag granting access to lua internals. |
|
A reference to an instance of a Lua interpreter. |
|
A Lua function. |
|
A lazy container to push values to the Lua stack. |
|
Stack scope guard for Lua calls. |
|
A Lua string. |
|
A Lua table. |
|
A Lua value. |
|
A null‐terminated string. |
|
Pointer to a Lua‐callable function returning Value. |
Enums
Name |
Description |
Types of values. |
mrdocs::report namespace
Reporting utilities (messages, statistics, sinks).
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 |
Emit a debug‐level diagnostic for troubleshooting. |
|
Emit an error that indicates failure but allows continuation. |
|
Emit a fatal error and mark the report as the highest severity. |
|
Get the minimum threshold level for reporting. |
|
Emit an informational message for users. |
|
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. |
|
Emit a trace‐level diagnostic (verbose, off by default). |
|
Emit a warning that does not stop execution. |