[#index]
= Global namespace
:mrdocs:

== Namespaces

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs.adoc[`mrdocs`] 
| Core MrDocs support utilities&period;
|===


== xref:mrdocs.adoc[mrdocs] namespace

Core MrDocs support utilities&period;

=== Namespaces

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/describe.adoc[`describe`] 
| Compile&hyphen;time reflection over structs, enums, and their bases&period;
| xref:mrdocs/doc.adoc[`doc`] 
| Doc&hyphen;comment enums and helpers that describe admonition kinds&period;
| xref:mrdocs/dom.adoc[`dom`] 
| Objects representing JSON&hyphen;like values&period;
| xref:mrdocs/files.adoc[`files`] 
| Filesystem helpers (join, temp, real&hyphen;path resolution) used throughout MrDocs&period;
| xref:mrdocs/helpers.adoc[`helpers`] 
| Handlebars helper registry for templates&period;
| xref:mrdocs/js.adoc[`js`] 
| JavaScript interop helpers for the embedded runtime&period;
| xref:mrdocs/lua.adoc[`lua`] 
| Lua interop helpers for the optional scripting&sol;backend integration&period;
| xref:mrdocs/report.adoc[`report`] 
| Reporting utilities (messages, statistics, sinks)&period;
|===


=== Types

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/AnyFileVisitor.adoc[`AnyFileVisitor`] 
| Polymorphic visitor for files discovered during traversal&period;
| xref:mrdocs/ArrayType.adoc[`ArrayType`] 
| C&plus;&plus; array type (bounded or unbounded)&period;
| xref:mrdocs/ArrayView-06.adoc[`ArrayView`] 
| A non&hyphen;owning, read&hyphen;only view over a contiguous array of T&period;
| xref:mrdocs/AssumeAttribute.adoc[`AssumeAttribute`] 
| The `&lsqb;&lsqb;assume(expression)&rsqb;&rsqb;` attribute (C&plus;&plus;23)&period;
| xref:mrdocs/Attribute.adoc[`Attribute`] 
| A C&plus;&plus; attribute attached to a symbol&period;
| xref:mrdocs/AttributeCommonBase-01.adoc[`AttributeCommonBase`] 
| CRTP base that ties a concrete attribute to a fixed AttributeKind&period;
| xref:mrdocs/AutoType.adoc[`AutoType`] 
| Represents `auto` or `decltype(auto)` placeholder type&period;
| xref:mrdocs/BadExpectedAccess-05.adoc[`BadExpectedAccess`] 
| Base class for accessing an empty Expected&period;
| xref:mrdocs/BaseInfo.adoc[`BaseInfo`] 
| Metadata for a direct base&period;
| xref:mrdocs/CarriesDependencyAttribute.adoc[`CarriesDependencyAttribute`] 
| The `&lsqb;&lsqb;carries&lowbar;dependency&rsqb;&rsqb;` attribute (C&plus;&plus;11)&colon; release&hyphen;consume dependency propagation&period;
| xref:mrdocs/ConceptSymbol.adoc[`ConceptSymbol`] 
| Info for concepts&period;
| xref:mrdocs/Config.adoc[`Config`] 
| Configuration used to generate the Corpus and Docs
| xref:mrdocs/ConstantExprInfo.adoc[`ConstantExprInfo`] 
| Represents an expression with a (possibly known) value
| xref:mrdocs/ConstantTArg.adoc[`ConstantTArg`] 
| Non&hyphen;type template argument&period;
| xref:mrdocs/ConstantTParam.adoc[`ConstantTParam`] 
| A constant template parameter
| xref:mrdocs/Corpus.adoc[`Corpus`] 
| The collection of declarations in extracted form&period;
| xref:mrdocs/DecltypeType.adoc[`DecltypeType`] 
| `decltype(expr)` type wrapper&period;
| xref:mrdocs/DeprecatedAttribute.adoc[`DeprecatedAttribute`] 
| The `&lsqb;&lsqb;deprecated&rsqb;&rsqb;` attribute (C&plus;&plus;14)&period;
| xref:mrdocs/DocComment.adoc[`DocComment`] 
| A processed documentation comment attached to a declaration&period;
| xref:mrdocs/DomCorpus.adoc[`DomCorpus`] 
| Front&hyphen;end factory for producing Dom nodes&period;
| xref:mrdocs/EnumConstantSymbol.adoc[`EnumConstantSymbol`] 
| Info for enum constants&period;
| xref:mrdocs/EnumSymbol.adoc[`EnumSymbol`] 
| Metadata for an enumeration declaration&period;
| xref:mrdocs/Error.adoc[`Error`] 
| Holds the description of an error, or success&period;
| xref:mrdocs/Exception.adoc[`Exception`] 
| Type of all exceptions thrown by the API&period;
| xref:mrdocs/ExecutorGroup.adoc[`ExecutorGroup`] 
| A set of execution agents for performing concurrent work&period;
| xref:mrdocs/ExecutorGroupBase.adoc[`ExecutorGroupBase`] 
| Base class that owns a pool of execution agents and a shared work queue&period;
| xref:mrdocs/Expected-0a.adoc[`Expected`] 
| A container holding an error or a value&period;
| xref:mrdocs/ExplicitInfo.adoc[`ExplicitInfo`] 
| Stores only the operand of the explicit&hyphen;specifier or noexcept&hyphen;specifier as a string&period; The complete expression is not preserved at this time&period; This is a temporary design and may be improved in the future&period;
| xref:mrdocs/ExprInfo.adoc[`ExprInfo`] 
| Represents an expression
| xref:mrdocs/FallthroughAttribute.adoc[`FallthroughAttribute`] 
| The `&lsqb;&lsqb;fallthrough&rsqb;&rsqb;` attribute (C&plus;&plus;17)&colon; an intentional switch fall&hyphen;through&period;
| xref:mrdocs/FormatString.adoc[`FormatString`] 
| A format string with source location&period;
| xref:mrdocs/FriendInfo.adoc[`FriendInfo`] 
| Info for friend declarations&period;
| xref:mrdocs/FunctionSymbol.adoc[`FunctionSymbol`] 
| Metadata for a function or method&period;
| xref:mrdocs/FunctionType.adoc[`FunctionType`] 
| Function type with parameters, qualifiers, and noexcept info&period;
| xref:mrdocs/Generator.adoc[`Generator`] 
| Base class for documentation generators&period;
| xref:mrdocs/GlobPattern.adoc[`GlobPattern`] 
| A glob pattern matcher
| xref:mrdocs/GuideSymbol.adoc[`GuideSymbol`] 
| Info for deduction guides&period;
| xref:mrdocs/Handlebars.adoc[`Handlebars`] 
| A handlebars environment
| xref:mrdocs/HandlebarsError.adoc[`HandlebarsError`] 
| An error thrown or returned by Handlebars
| xref:mrdocs/HandlebarsOptions.adoc[`HandlebarsOptions`] 
| Options for handlebars
| xref:mrdocs/IdentifierName.adoc[`IdentifierName`] 
| Represents an identifier
| xref:mrdocs/IndeterminateAttribute.adoc[`IndeterminateAttribute`] 
| The `&lsqb;&lsqb;indeterminate&rsqb;&rsqb;` attribute (C&plus;&plus;26)&colon; the object has an indeterminate value if uninitialized&period;
| xref:mrdocs/LValueReferenceType.adoc[`LValueReferenceType`] 
| An lvalue reference type&period;
| xref:mrdocs/LikelyAttribute.adoc[`LikelyAttribute`] 
| The `&lsqb;&lsqb;likely&rsqb;&rsqb;` attribute (C&plus;&plus;20)&colon; this path is more likely&period;
| xref:mrdocs/Location.adoc[`Location`] 
| Source location of a symbol or entity&period;
| xref:mrdocs/MaybeUnusedAttribute.adoc[`MaybeUnusedAttribute`] 
| The `&lsqb;&lsqb;maybe&lowbar;unused&rsqb;&rsqb;` attribute (C&plus;&plus;17)&colon; suppresses unused&hyphen;entity warnings&period;
| xref:mrdocs/MemberPointerType.adoc[`MemberPointerType`] 
| Pointer&hyphen;to&hyphen;member type (object or function)&period;
| xref:mrdocs/Name.adoc[`Name`] 
| Represents a name for a named `Type`
| xref:mrdocs/NamedType.adoc[`NamedType`] 
| A type identified by name (possibly fundamental)&period;
| xref:mrdocs/NamespaceAliasSymbol.adoc[`NamespaceAliasSymbol`] 
| Info for namespace aliases&period;
| xref:mrdocs/NamespaceSymbol.adoc[`NamespaceSymbol`] 
| Describes a namespace and its members&period;
| xref:mrdocs/NamespaceTranche.adoc[`NamespaceTranche`] 
| Buckets the members that appear inside a namespace&period;
| xref:mrdocs/NoUniqueAddressAttribute.adoc[`NoUniqueAddressAttribute`] 
| The `&lsqb;&lsqb;no&lowbar;unique&lowbar;address&rsqb;&rsqb;` attribute (C&plus;&plus;20)&colon; the member need not have a unique address&period;
| xref:mrdocs/NodiscardAttribute.adoc[`NodiscardAttribute`] 
| The `&lsqb;&lsqb;nodiscard&rsqb;&rsqb;` attribute (C&plus;&plus;17, reason added in C&plus;&plus;20)&period;
| xref:mrdocs/NoexceptInfo.adoc[`NoexceptInfo`] 
| Captures a `noexcept` specification and its evaluated form&period;
| xref:mrdocs/NoreturnAttribute.adoc[`NoreturnAttribute`] 
| The `&lsqb;&lsqb;noreturn&rsqb;&rsqb;` attribute (C&plus;&plus;11)&colon; the function does not return&period;
| xref:mrdocs/Optional-03.adoc[`Optional`] 
| A compact optional that automatically uses nullable&lowbar;traits&lt;T&gt; when available&period;
| xref:mrdocs/OtherAttribute.adoc[`OtherAttribute`] 
| An attribute mrdocs does not treat specially&period;
| xref:mrdocs/OutputRef.adoc[`OutputRef`] 
| Reference to output stream used by handlebars
| xref:mrdocs/Overload-09.adoc[`Overload`] 
| Combines multiple callable types into a single overloaded function object&period;
| xref:mrdocs/OverloadsSymbol.adoc[`OverloadsSymbol`] 
| Represents a set of function overloads&period;
| xref:mrdocs/Param.adoc[`Param`] 
| Represents a single function parameter
| xref:mrdocs/ParseResult.adoc[`ParseResult`] 
| The result of a parse operation&period;
| xref:mrdocs/PathGlobPattern.adoc[`PathGlobPattern`] 
| A glob pattern matcher for paths
| xref:mrdocs/PointerType.adoc[`PointerType`] 
| Pointer type wrapper&period;
| xref:mrdocs/Polymorphic.adoc[`Polymorphic`] 
| A polymorphic value&hyphen;type&period;
| xref:mrdocs/RValueReferenceType.adoc[`RValueReferenceType`] 
| An rvalue reference type&period;
| xref:mrdocs/RangeFor-0f.adoc[`RangeFor`] 
| Range adapter to expose first&sol;last flags inside range&hyphen;for loops&period;
| xref:mrdocs/RecordInterface.adoc[`RecordInterface`] 
| The aggregated interface for a given struct, class, or union&period;
| xref:mrdocs/RecordSymbol.adoc[`RecordSymbol`] 
| Metadata for struct, class, or union&period;
| xref:mrdocs/RecordTranche.adoc[`RecordTranche`] 
| A group of members that have the same access specifier&period;
| xref:mrdocs/ReferenceDirectories.adoc[`ReferenceDirectories`] 
| Reference directories used to resolve paths
| xref:mrdocs/ScopeExit-0a.adoc[`ScopeExit`] 
| Execute a callable when the enclosing scope exits unless dismissed&period;
| xref:mrdocs/ScopeExitRestore-01.adoc[`ScopeExitRestore`] 
| RAII helper that restores a referenced value on scope exit&period;
| xref:mrdocs/SourceInfo.adoc[`SourceInfo`] 
| Stores source information for a declaration&period;
| xref:mrdocs/SourceLocation.adoc[`SourceLocation`] 
| A source location with filename prettification&period;
| xref:mrdocs/SpecializationName.adoc[`SpecializationName`] 
| Represents a (possibly qualified) symbol name with template arguments&period;
| xref:mrdocs/SplitLinesView.adoc[`SplitLinesView`] 
| A lazy input range of std&colon;&colon;string&lowbar;view lines split on all known line breaks&period;
| xref:mrdocs/StringHash.adoc[`StringHash`] 
| Transparent hash functor for string&hyphen;like keys&period;
| xref:mrdocs/StringList.adoc[`StringList`] 
| A list of strings that accepts several input forms&period;
| xref:mrdocs/Symbol.adoc[`Symbol`] 
| Base class with common properties of all symbols
| xref:mrdocs/SymbolCommonBase-015.adoc[`SymbolCommonBase`] 
| Base class for providing variant discriminator functions&period;
| xref:mrdocs/SymbolGlobPattern.adoc[`SymbolGlobPattern`] 
| A glob pattern matcher for C&plus;&plus; symbols
| xref:mrdocs/SymbolID.adoc[`SymbolID`] 
| A unique identifier for a symbol&period;
| xref:mrdocs/TArg.adoc[`TArg`] 
| Base class for any template argument&period;
| xref:mrdocs/TArgCommonBase-06.adoc[`TArgCommonBase`] 
| CRTP base that fixes the argument kind&period;
| xref:mrdocs/TParam.adoc[`TParam`] 
| Base class for a template parameter declaration&period;
| xref:mrdocs/TParamCommonBase-0c.adoc[`TParamCommonBase`] 
| CRTP base that fixes the parameter kind&period;
| xref:mrdocs/TaskGroup.adoc[`TaskGroup`] 
| A subset of possible work in a thread pool&period;
| xref:mrdocs/TemplateInfo.adoc[`TemplateInfo`] 
| Information about templates and specializations thereof&period;
| xref:mrdocs/TemplateTArg.adoc[`TemplateTArg`] 
| Template template argument&period;
| xref:mrdocs/TemplateTParam.adoc[`TemplateTParam`] 
| Template template parameter&period;
| xref:mrdocs/ThreadPool.adoc[`ThreadPool`] 
| A pool of threads for executing work concurrently&period;
| xref:mrdocs/Type.adoc[`Type`] 
| A possibly qualified type&period;
| xref:mrdocs/TypeCommonBase-0e.adoc[`TypeCommonBase`] 
| CRTP base that ties a concrete type to a fixed TypeKind&period;
| xref:mrdocs/TypeTArg.adoc[`TypeTArg`] 
| Type template argument&period;
| xref:mrdocs/TypeTParam.adoc[`TypeTParam`] 
| Type template parameter&period;
| xref:mrdocs/TypedefSymbol.adoc[`TypedefSymbol`] 
| Info for typedef and using declarations&period;
| xref:mrdocs/Unexpected-0c.adoc[`Unexpected`] 
| Holds an unexpected error value for Expected&period;
| xref:mrdocs/UnlikelyAttribute.adoc[`UnlikelyAttribute`] 
| The `&lsqb;&lsqb;unlikely&rsqb;&rsqb;` attribute (C&plus;&plus;20)&colon; this path is less likely&period;
| xref:mrdocs/UsingSymbol.adoc[`UsingSymbol`] 
| Info for using declarations&period;
| xref:mrdocs/VariableSymbol.adoc[`VariableSymbol`] 
| A variable&period;
| xref:mrdocs/Visitor.adoc[`Visitor`] 
| A visitor for a type
| xref:mrdocs/YCombinator.adoc[`YCombinator`] 
| Enables recursive lambdas by passing a self&hyphen;reference as the first argument&period;
| xref:mrdocs/add_const_from.adoc[`add&lowbar;const&lowbar;from`] 
| Propagate const qualification from `From` to `To`, keeping references&period;
| xref:mrdocs/add_cv_from.adoc[`add&lowbar;cv&lowbar;from`] 
| Propagate both const and volatile qualifiers from `From` to `To`&period;
| xref:mrdocs/add_cvref_from.adoc[`add&lowbar;cvref&lowbar;from`] 
| Propagate cv&hyphen;qualification and reference category from `From` to `To`&period;
| xref:mrdocs/add_lvalue_reference_from.adoc[`add&lowbar;lvalue&lowbar;reference&lowbar;from`] 
| Propagate lvalue&hyphen;reference from `From` to `To` if present&period;
| xref:mrdocs/add_reference_from.adoc[`add&lowbar;reference&lowbar;from`] 
| Propagate reference qualification from `From` to `To`&period;
| xref:mrdocs/add_rvalue_reference_from.adoc[`add&lowbar;rvalue&lowbar;reference&lowbar;from`] 
| Propagate rvalue&hyphen;reference from `From` to `To` if present&period;
| xref:mrdocs/add_volatile_from.adoc[`add&lowbar;volatile&lowbar;from`] 
| Propagate volatile qualification from `From` to `To`, keeping references&period;
| xref:mrdocs/any_callable-01.adoc[`any&lowbar;callable`] 
| A movable, type&hyphen;erased function object&period;
| xref:mrdocs/make_dependent.adoc[`make&lowbar;dependent`] 
| Dependent alias of `T`, useful for delaying instantiation&period;
| xref:mrdocs/nullable_traits-0b.adoc[`nullable&lowbar;traits`] 
| nullable&lowbar;traits&lt;T&gt; defines how to treat a T as “nullable” without an external engaged bit&period;
| xref:mrdocs/sentinel_traits-0a.adoc[`sentinel&lowbar;traits`] 
| Defines a customization point for types that have an intrinsic sentinel value denoting “null”&period;
| xref:mrdocs/unexpect_t.adoc[`unexpect&lowbar;t`] 
| Tag type used to select unexpected construction&period;
| xref:mrdocs/unlock_guard.adoc[`unlock&lowbar;guard`] 
| A scoped guard which unlocks a mutex&period;
|===


=== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/UnorderedStringMap.adoc[`UnorderedStringMap`] 
| unordered&lowbar;map keyed by std&colon;&colon;string with transparent hashing&period;
| xref:mrdocs/UnorderedStringMultiMap.adoc[`UnorderedStringMultiMap`] 
| unordered&lowbar;multimap keyed by std&colon;&colon;string with transparent hashing&period;
| xref:mrdocs/add_const_from_t.adoc[`add&lowbar;const&lowbar;from&lowbar;t`] 
| Alias for `add&lowbar;const&lowbar;from&lt;From, To&gt;&colon;&colon;type`&period;
| xref:mrdocs/add_cv_from_t.adoc[`add&lowbar;cv&lowbar;from&lowbar;t`] 
| Alias for `add&lowbar;cv&lowbar;from&lt;From, To&gt;&colon;&colon;type`&period;
| xref:mrdocs/add_cvref_from_t.adoc[`add&lowbar;cvref&lowbar;from&lowbar;t`] 
| Alias for `add&lowbar;cvref&lowbar;from&lt;From, To&gt;&colon;&colon;type`&period;
| xref:mrdocs/add_lvalue_reference_from_t.adoc[`add&lowbar;lvalue&lowbar;reference&lowbar;from&lowbar;t`] 
| Alias for `add&lowbar;lvalue&lowbar;reference&lowbar;from&lt;From, To&gt;&colon;&colon;type`&period;
| xref:mrdocs/add_reference_from_t.adoc[`add&lowbar;reference&lowbar;from&lowbar;t`] 
| Alias for `add&lowbar;reference&lowbar;from&lt;From, To&gt;&colon;&colon;type`&period;
| xref:mrdocs/add_rvalue_reference_from_t.adoc[`add&lowbar;rvalue&lowbar;reference&lowbar;from&lowbar;t`] 
| Alias for `add&lowbar;rvalue&lowbar;reference&lowbar;from&lt;From, To&gt;&colon;&colon;type`&period;
| xref:mrdocs/add_volatile_from_t.adoc[`add&lowbar;volatile&lowbar;from&lowbar;t`] 
| Alias for `add&lowbar;volatile&lowbar;from&lt;From, To&gt;&colon;&colon;type`&period;
| xref:mrdocs/make_dependent_t.adoc[`make&lowbar;dependent&lowbar;t`] 
| Alias for `make&lowbar;dependent&lt;T, U&gt;&colon;&colon;type`&period;
|===


=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/AccessKind.adoc[`AccessKind`] 
| Access specifier&period;
| xref:mrdocs/AttributeKind.adoc[`AttributeKind`] 
| The kind of a C&plus;&plus; attribute&period;
| xref:mrdocs/AutoKind.adoc[`AutoKind`] 
| The kind of `auto` keyword used in a declaration&period;
| xref:mrdocs/ConstexprKind.adoc[`ConstexprKind`] 
| `constexpr`&sol;`consteval` specifier kinds
| xref:mrdocs/ExplicitKind.adoc[`ExplicitKind`] 
| Explicit specifier kinds
| xref:mrdocs/ExtractionMode.adoc[`ExtractionMode`] 
| Determine why a symbol is extracted
| xref:mrdocs/FileKind.adoc[`FileKind`] 
| Classifies where a file originates from&period;
| xref:mrdocs/FunctionClass.adoc[`FunctionClass`] 
| Function classifications
| xref:mrdocs/FundamentalTypeKind.adoc[`FundamentalTypeKind`] 
| Categorically describes a fundamental type&period;
| xref:mrdocs/ListKind.adoc[`ListKind`] 
| Classification of list ordering&period;
| xref:mrdocs/NameKind.adoc[`NameKind`] 
| Kinds of names that appear in type and symbol metadata&period;
| xref:mrdocs/NoexceptKind.adoc[`NoexceptKind`] 
| Exception specification kinds
| xref:mrdocs/OperatorKind.adoc[`OperatorKind`] 
| Operator kinds
| xref:mrdocs/QualifierKind.adoc[`QualifierKind`] 
| Type qualifiers
| xref:mrdocs/RecordKeyKind.adoc[`RecordKeyKind`] 
| The kind of record&colon; struct, class, or union&period;
| xref:mrdocs/ReferenceKind.adoc[`ReferenceKind`] 
| Reference type kinds
| xref:mrdocs/StorageClassKind.adoc[`StorageClassKind`] 
| Storage class kinds
| xref:mrdocs/SymbolKind.adoc[`SymbolKind`] 
| Info variant discriminator
| xref:mrdocs/TArgKind.adoc[`TArgKind`] 
| The kind of template argument&period;
| xref:mrdocs/TParamKeyKind.adoc[`TParamKeyKind`] 
| The keyword a template parameter was declared with
| xref:mrdocs/TParamKind.adoc[`TParamKind`] 
| Discriminates the different template parameter categories&period;
| xref:mrdocs/TableAlignmentKind.adoc[`TableAlignmentKind`] 
| Horizontal alignment for table columns&period;
| xref:mrdocs/TemplateSpecKind.adoc[`TemplateSpecKind`] 
| The kind of template or specialization&period;
| xref:mrdocs/TypeKind.adoc[`TypeKind`] 
| Variants of C&plus;&plus; types captured in metadata&period;
| xref:mrdocs/UsingClass.adoc[`UsingClass`] 
| The class of using declaration&period;
|===


=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/CompareDerived-0f.adoc[`CompareDerived`] 
| Compares two polymorphic objects that have visit functions
| xref:mrdocs/HTMLEscape-0f.adoc[`HTMLEscape`] 
| `HTMLEscape` overloads
| xref:mrdocs/addMember.adoc[`addMember`] 
| Append a new function overload to the set&period;
| xref:mrdocs/addMetaObject.adoc[`addMetaObject`] 
| Add a $meta object with type information&period;
| xref:mrdocs/allMembers-0a.adoc[`allMembers`] 
| `allMembers` overloads
| xref:mrdocs/assert_failed.adoc[`assert&lowbar;failed`] 
| Handler invoked when `MRDOCS&lowbar;ASSERT` fails&period;
| xref:mrdocs/bottomUpTraverse.adoc[`bottomUpTraverse`] 
| Traverse a DocComment tree bottom&hyphen;up (post&hyphen;order)&period;
| xref:mrdocs/canMerge.adoc[`canMerge`] 
| Check whether two symbols may be merged&period;
| xref:mrdocs/cast-02.adoc[`cast`] 
| `cast` overloads
| xref:mrdocs/cast_or_null-0c.adoc[`cast&lowbar;or&lowbar;null`] 
| `cast&lowbar;or&lowbar;null` overloads
| xref:mrdocs/compareSymbolNames.adoc[`compareSymbolNames`] 
| Return the result of comparing s0 to s1&period;
| xref:mrdocs/contains-064.adoc[`contains`] 
| Determine if a range contains a specific element&period;
| xref:mrdocs/contains_any-00.adoc[`contains&lowbar;any`] 
| Determine if a range contains any of the specified elements&period;
| xref:mrdocs/contains_n.adoc[`contains&lowbar;n`] 
| Determine if a range contains at least N instances of the specified element&period;
| xref:mrdocs/contains_n_any-0e.adoc[`contains&lowbar;n&lowbar;any`] 
| Determine if a range contains at least N instances of any of the specified elements&period;
| xref:mrdocs/countSymbolKind.adoc[`countSymbolKind`] 
| Count the number of SymbolKind enumerators&period;
| xref:mrdocs/createFrame-01.adoc[`createFrame`] 
| Create child data objects&period;
| xref:mrdocs/dyn_cast-02.adoc[`dyn&lowbar;cast`] 
| `dyn&lowbar;cast` overloads
| xref:mrdocs/dyn_cast_or_null-0f.adoc[`dyn&lowbar;cast&lowbar;or&lowbar;null`] 
| `dyn&lowbar;cast&lowbar;or&lowbar;null` overloads
| xref:mrdocs/endsWithOneOf.adoc[`endsWithOneOf`] 
| Determine if a string ends with one of the specified characters
| xref:mrdocs/escapeExpression.adoc[`escapeExpression`] 
| 
| xref:mrdocs/findGenerator.adoc[`findGenerator`] 
| Find a generator by its id&period;
| xref:mrdocs/find_last_of.adoc[`find&lowbar;last&lowbar;of`] 
| Find the last element in a range that matches an element in the specified range&period;
| xref:mrdocs/forEachFile-08.adoc[`forEachFile`] 
| `forEachFile` overloads
| xref:mrdocs/formatError.adoc[`formatError`] 
| Return a formatted error&period;
| xref:mrdocs/fromBase58Str.adoc[`fromBase58Str`] 
| Parse the base58 string form of a SymbolID&period;
| xref:mrdocs/fromString.adoc[`fromString`] 
| Convert a string to a FundamentalTypeKind&period;
| xref:mrdocs/getDefaultAccessString.adoc[`getDefaultAccessString`] 
| Return the default accessibility for a record key kind&period;
| xref:mrdocs/getOperatorKind.adoc[`getOperatorKind`] 
| Return the short name of an operator as a string&period;
| xref:mrdocs/getOperatorKindFromSuffix.adoc[`getOperatorKindFromSuffix`] 
| Return the short name of an operator as a string&period;
| xref:mrdocs/getOperatorName.adoc[`getOperatorName`] 
| Return the name of an operator as a string&period;
| xref:mrdocs/getOperatorReadableName.adoc[`getOperatorReadableName`] 
| Return the human&hyphen;readable name of the operator
| xref:mrdocs/getParents-0d.adoc[`getParents`] 
| `getParents` overloads
| xref:mrdocs/getPrimaryLocation-04.adoc[`getPrimaryLocation`] 
| `getPrimaryLocation` overloads
| xref:mrdocs/getSafeOperatorName.adoc[`getSafeOperatorName`] 
| Return the safe name of an operator as a string&period;
| xref:mrdocs/getShortOperatorName.adoc[`getShortOperatorName`] 
| Return the short name of an operator as a string&period;
| xref:mrdocs/innerType-00.adoc[`innerType`] 
| Return the inner type&period;
| xref:mrdocs/innerTypePtr-06.adoc[`innerTypePtr`] 
| Return the inner type&period;
| xref:mrdocs/innermostType-06.adoc[`innermostType`] 
| `innermostType` overloads
| xref:mrdocs/installGenerator.adoc[`installGenerator`] 
| Install a custom generator&period;
| xref:mrdocs/isAlphaNumeric-05.adoc[`isAlphaNumeric`] 
| `isAlphaNumeric` overloads
| xref:mrdocs/isAlphabetic-05.adoc[`isAlphabetic`] 
| `isAlphabetic` overloads
| xref:mrdocs/isBinaryOperator.adoc[`isBinaryOperator`] 
| Determines whether the operator is potentially binary&period;
| xref:mrdocs/isCopyAssignment.adoc[`isCopyAssignment`] 
| Check whether a function is a copy assignment operator&period;
| xref:mrdocs/isCopyConstructor.adoc[`isCopyConstructor`] 
| Check whether a function is a copy constructor&period;
| xref:mrdocs/isDefaultConstructor.adoc[`isDefaultConstructor`] 
| Check whether a function is a default constructor&period;
| xref:mrdocs/isDigit-03.adoc[`isDigit`] 
| `isDigit` overloads
| xref:mrdocs/isEmpty.adoc[`isEmpty`] 
| Determine if a value is empty
| xref:mrdocs/isLowerCase-04.adoc[`isLowerCase`] 
| `isLowerCase` overloads
| xref:mrdocs/isMoveAssignment.adoc[`isMoveAssignment`] 
| Check whether a function is a move assignment operator&period;
| xref:mrdocs/isMoveConstructor.adoc[`isMoveConstructor`] 
| Check whether a function is a move constructor&period;
| xref:mrdocs/isSpecialMemberFunction.adoc[`isSpecialMemberFunction`] 
| Check whether a function is a special member function&period;
| xref:mrdocs/isUnaryOperator.adoc[`isUnaryOperator`] 
| Determines whether the operator is potentially unary&period;
| xref:mrdocs/isUpperCase-04.adoc[`isUpperCase`] 
| `isUpperCase` overloads
| xref:mrdocs/isWhitespace-09.adoc[`isWhitespace`] 
| `isWhitespace` overloads
| xref:mrdocs/is_null.adoc[`is&lowbar;null`] 
| is&lowbar;null helper that uses nullable&lowbar;traits&lt;T&gt; if available&period;
| xref:mrdocs/is_one_of-0e.adoc[`is&lowbar;one&lowbar;of`] 
| Determine if an element is equal to any of the elements in the specified range&period;
| xref:mrdocs/isa.adoc[`isa`] 
| Return true if the polymorphic object holds a value of type To&period;
| xref:mrdocs/isa_or_null.adoc[`isa&lowbar;or&lowbar;null`] 
| Return true if pointer is non&hyphen;null and referent is of type To&period;
| xref:mrdocs/leastSpecific.adoc[`leastSpecific`] 
| Compare ExtractionModes and returns the least specific
| xref:mrdocs/ltrim-051.adoc[`ltrim`] 
| `ltrim` overloads
| xref:mrdocs/makeChar.adoc[`makeChar`] 
| Apply the &quot;char&quot; specifier to the type
| xref:mrdocs/makeLong.adoc[`makeLong`] 
| Apply the &quot;long&quot; specifier to the type
| xref:mrdocs/makeOverload.adoc[`makeOverload`] 
| Factory function that creates an Overload from the given callables&period;
| xref:mrdocs/makeShort.adoc[`makeShort`] 
| Apply the &quot;short&quot; specifier to the type
| xref:mrdocs/makeSigned.adoc[`makeSigned`] 
| Apply the &quot;signed&quot; specifier to the type
| xref:mrdocs/makeUnsigned.adoc[`makeUnsigned`] 
| Apply the &quot;unsigned&quot; specifier to the type
| xref:mrdocs/makeVisitor.adoc[`makeVisitor`] 
| Make a visitor for a base type
| xref:mrdocs/make_array_view-0a.adoc[`make&lowbar;array&lowbar;view`] 
| `make&lowbar;array&lowbar;view` overloads
| xref:mrdocs/make_null.adoc[`make&lowbar;null`] 
| make&lowbar;null helper that uses nullable&lowbar;traits&lt;T&gt; if available&period;
| xref:mrdocs/mapReflectedType-0f.adoc[`mapReflectedType`] 
| `mapReflectedType` overloads
| xref:mrdocs/match.adoc[`match`] 
| Applies a set of callables to a std&colon;&colon;variant using std&colon;&colon;visit and Overload&period;
| xref:mrdocs/merge-0a.adoc[`merge`] 
| `merge` overloads
| xref:mrdocs/mostSpecific.adoc[`mostSpecific`] 
| Compare ExtractionModes and returns the most specific
| xref:mrdocs/null_of.adoc[`null&lowbar;of`] 
| null&lowbar;of helper that constructs a null T using nullable&lowbar;traits&lt;T&gt;&period;
| xref:mrdocs/operator_bitor.adoc[`operator&verbar;`] 
| Pipe a contiguous character range into the adaptor&period;
| xref:mrdocs/overrides.adoc[`overrides`] 
| Determine if one function would override the other
| xref:mrdocs/parse-07.adoc[`parse`] 
| Parse a string view
| xref:mrdocs/readableTypeName.adoc[`readableTypeName`] 
| Get the unqualified name of a type&period;
| xref:mrdocs/reindentCode.adoc[`reindentCode`] 
| Reindent code by removing the common leading spaces and adding the specified indent&period;
| xref:mrdocs/replace.adoc[`replace`] 
| Return the substring without leading and trailing horizontal whitespace&period;
| xref:mrdocs/rtrim-0c.adoc[`rtrim`] 
| `rtrim` overloads
| xref:mrdocs/safeString-0a.adoc[`safeString`] 
| `safeString` overloads
| xref:mrdocs/splitLines-04.adoc[`splitLines`] 
| `splitLines` overloads
| xref:mrdocs/startsWithOneOf.adoc[`startsWithOneOf`] 
| Determine if a string starts with one of the specified characters
| xref:mrdocs/swap-07d.adoc[`swap`] 
| `swap` overloads
| xref:mrdocs/tag_invoke-005.adoc[`tag&lowbar;invoke`] 
| `tag&lowbar;invoke` overloads
| xref:mrdocs/toBase16Str.adoc[`toBase16Str`] 
| Convert a SymbolID to a string
| xref:mrdocs/toBase58Str.adoc[`toBase58Str`] 
| Convert a SymbolID to its canonical string form&period;
| xref:mrdocs/toCamelCase.adoc[`toCamelCase`] 
| Convert a string to `camelCase` using ASCII letter rules&period;
| xref:mrdocs/toKebabCase.adoc[`toKebabCase`] 
| Convert a string to `kebab&hyphen;case` using ASCII letter rules&period;
| xref:mrdocs/toLowerCase-0a6.adoc[`toLowerCase`] 
| `toLowerCase` overloads
| xref:mrdocs/toPascalCase.adoc[`toPascalCase`] 
| Convert a string to `PascalCase` using ASCII letter rules&period;
| xref:mrdocs/toSnakeCase.adoc[`toSnakeCase`] 
| Convert a string to `snake&lowbar;case` using ASCII letter rules&period;
| xref:mrdocs/toString-02.adoc[`toString`] 
| `toString` overloads
| xref:mrdocs/toUpperCase-0f.adoc[`toUpperCase`] 
| `toUpperCase` overloads
| xref:mrdocs/to_underlying.adoc[`to&lowbar;underlying`] 
| Return the value as its underlying type&period;
| xref:mrdocs/topDownTraverse.adoc[`topDownTraverse`] 
| Traverse a DocComment tree top&hyphen;down (pre&hyphen;order)&period;
| xref:mrdocs/trim-0a.adoc[`trim`] 
| `trim` overloads
| xref:mrdocs/visit-0fa.adoc[`visit`] 
| `visit` overloads
| xref:mrdocs/visitIndexed.adoc[`visitIndexed`] 
| Visits a std&colon;&colon;variant and calls the combined callable with the active index and the value&period;
| xref:mrdocs/yCombinator.adoc[`yCombinator`] 
| Factory that creates a YCombinator from a callable&period;
| xref:mrdocs/operator_lshift-0e1.adoc[`operator&lt;&lt;`] 
| Write to output
| xref:mrdocs/operator_eq-049.adoc[`operator&equals;&equals;`] 
| Equality operators
| xref:mrdocs/operator_not_eq-0a.adoc[`operator!&equals;`] 
| Inequality operators
| xref:mrdocs/operator_lt-0f.adoc[`operator&lt;`] 
| Less&hyphen;than operators
| xref:mrdocs/operator_le-0b.adoc[`operator&lt;&equals;`] 
| Less&hyphen;than&hyphen;or&hyphen;equal operators
| xref:mrdocs/operator_gt-09.adoc[`operator&gt;`] 
| Greater&hyphen;than operators
| xref:mrdocs/operator_ge-00.adoc[`operator&gt;&equals;`] 
| Greater&hyphen;than&hyphen;or&hyphen;equal operators
| xref:mrdocs/operator_3way-003.adoc[`operator&lt;&equals;&gt;`] 
| Three&hyphen;way comparison operators
|===


=== Variables

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/htmlEscapeEntities.adoc[`htmlEscapeEntities`] 
| Character&hyphen;to&hyphen;entity table used by `HTMLEscape`&period;
| xref:mrdocs/is_specialization_of_v-09.adoc[`is&lowbar;specialization&lowbar;of&lowbar;v`] 
| Whether `T` is a specialization of the class template `Template`&period;
| xref:mrdocs/is_specialization_of_v-0e.adoc[`is&lowbar;specialization&lowbar;of&lowbar;v&lt;Template&lt;Args&period;&period;&period;&gt;, Template&gt;`] 
| Whether `T` is a specialization of the class template `Template`&period;
| xref:mrdocs/unexpect.adoc[`unexpect`] 
| Tag object to request unexpected construction&period;
|===


=== Concepts

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/ClearableContainerLike.adoc[`ClearableContainerLike`] 
| Internal concept that matches “empty&hyphen;clear default&hyphen;constructible” types&period;
| xref:mrdocs/DescribedComparable.adoc[`DescribedComparable`] 
| True if T has described members (for comparison)&period;
| xref:mrdocs/DocCommentNode.adoc[`DocCommentNode`] 
| Concept to check if a type represents a DocComment node&period;
| xref:mrdocs/DocCommentNodeTraversable.adoc[`DocCommentNodeTraversable`] 
| Types that can be traversed by DocComment helpers&period;
| xref:mrdocs/HasParse.adoc[`HasParse`] 
| Concept to determine if there&apos;s a parse function for a type&period;
| xref:mrdocs/HasSentinel.adoc[`HasSentinel`] 
| Concept that is satisfied when sentinel&lowbar;traits&lt;T&gt; declares a usable sentinel&period;
| xref:mrdocs/SymbolParent.adoc[`SymbolParent`] 
| A concept for types that have `Symbol` members&period;
| xref:mrdocs/dereferenceable.adoc[`dereferenceable`] 
| Determine if a type is dereferenceable
| xref:mrdocs/has_nullable_traits_v.adoc[`has&lowbar;nullable&lowbar;traits&lowbar;v`] 
| Utility concept that returns true if T has a nullable&lowbar;traits specialization enabled&period;
| xref:mrdocs/pair_like.adoc[`pair&lowbar;like`] 
| Concept to check if a type is pair&hyphen;like
| xref:mrdocs/polymorphic_storage_for.adoc[`polymorphic&lowbar;storage&lowbar;for`] 
| Concept to check if a type is representing a polymorphic storage
| xref:mrdocs/range_of.adoc[`range&lowbar;of`] 
| Concept to check if a type is a range of T
| xref:mrdocs/range_of_tuple_like.adoc[`range&lowbar;of&lowbar;tuple&lowbar;like`] 
| Concept to check if a range is a range of tuple&hyphen;like elements
| xref:mrdocs/tuple_like.adoc[`tuple&lowbar;like`] 
| Concept to check if a type is tuple&hyphen;like
|===


=== Using Declarations

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/reference_constructs_from_temporary_v.adoc[`reference&lowbar;constructs&lowbar;from&lowbar;temporary&lowbar;v`] 
| True when binding `To` from `From` would require a temporary conversion&period;
| xref:mrdocs/reference_converts_from_temporary_v.adoc[`reference&lowbar;converts&lowbar;from&lowbar;temporary&lowbar;v`] 
| Like `reference&lowbar;converts&lowbar;from&lowbar;temporary&lowbar;v`, but for construction&period;
| xref:mrdocs/source_location.adoc[`source&lowbar;location`] 
| Alias to `std&colon;&colon;source&lowbar;location` when available&period;
|===


== xref:mrdocs/describe.adoc[mrdocs::describe] namespace

Compile&hyphen;time reflection over structs, enums, and their bases&period;

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/describe/list.adoc[`list`] 
| A compile&hyphen;time list of descriptor types&period;
|===


=== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/describe/describe_bases.adoc[`describe&lowbar;bases`] 
| The reflected direct base classes of `T`, as a `list` of base descriptors&period;
| xref:mrdocs/describe/describe_enumerators.adoc[`describe&lowbar;enumerators`] 
| The reflected enumerators of `E`, as a `list` of enumerator descriptors&period;
| xref:mrdocs/describe/describe_kinds.adoc[`describe&lowbar;kinds`] 
| The concrete kinds registered for a polymorphic base `T`, as a `list` of kind descriptors (each exposing the derived type as its `type` alias)&period;
| xref:mrdocs/describe/describe_members.adoc[`describe&lowbar;members`] 
| The reflected data members of `T`, as a `list` of member descriptors&period;
| xref:mrdocs/describe/has_describe_bases.adoc[`has&lowbar;describe&lowbar;bases`] 
| A trait that is true when `T` has reflected base classes&period;
| xref:mrdocs/describe/has_describe_enumerators.adoc[`has&lowbar;describe&lowbar;enumerators`] 
| A trait that is true when `E` has reflected enumerators&period;
| xref:mrdocs/describe/has_describe_kinds.adoc[`has&lowbar;describe&lowbar;kinds`] 
| A trait that is true when polymorphic base `T` has its kinds registered (via MRDOCS&lowbar;DESCRIBE&lowbar;KINDS)&period;
| xref:mrdocs/describe/has_describe_members.adoc[`has&lowbar;describe&lowbar;members`] 
| A trait that is true when `T` has reflected members&period;
|===


=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/describe/describedMemberCount.adoc[`describedMemberCount`] 
| The number of reflected members of `T`, counting inherited ones&period;
| xref:mrdocs/describe/describedMembersAllText.adoc[`describedMembersAllText`] 
| Whether every reflected member of `T` (inherited ones included) is an undescribed string, i&period;e&period; a value convertible to `std&colon;&colon;string&lowbar;view`&period;
| xref:mrdocs/describe/enum_from_string.adoc[`enum&lowbar;from&lowbar;string`] 
| Parse a declared enumerator name into an enumerator&period;
| xref:mrdocs/describe/enum_to_string.adoc[`enum&lowbar;to&lowbar;string`] 
| Return the name of enumerator `e` exactly as it was declared&period;
| xref:mrdocs/describe/for_each.adoc[`for&lowbar;each`] 
| Invoke `f` with each descriptor in a descriptor list&period;
| xref:mrdocs/describe/for_each_member.adoc[`for&lowbar;each&lowbar;member`] 
| Invoke `f` with each reflected member descriptor of `T`, inherited ones included&colon; base&hyphen;class members first (recursively), then `T`&apos;s own members&period;
|===


=== Variables

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/describe/undefined_enumerator.adoc[`undefined&lowbar;enumerator`] 
| The enumerator of `E` that stands for the undefined (empty) state&period;
|===


=== Concepts

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/describe/described.adoc[`described`] 
| Satisfied when `T` has reflected members&period;
| xref:mrdocs/describe/has_undefined_enumerator.adoc[`has&lowbar;undefined&lowbar;enumerator`] 
| Whether `E` designates an enumerator as its undefined (empty) state&period;
|===


== xref:mrdocs/doc.adoc[mrdocs::doc] namespace

Doc&hyphen;comment enums and helpers that describe admonition kinds&period;

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/doc/AdmonitionBlock.adoc[`AdmonitionBlock`] 
| A block for side&hyphen;notes like tips, warnings, notes
| xref:mrdocs/doc/Block.adoc[`Block`] 
| A piece of block content
| xref:mrdocs/doc/BlockCommonBase-0ed.adoc[`BlockCommonBase`] 
| Base class for providing variant discriminator functions&period;
| xref:mrdocs/doc/BlockContainer.adoc[`BlockContainer`] 
| A composite block that stores a sequence of child blocks&period;
| xref:mrdocs/doc/BriefBlock.adoc[`BriefBlock`] 
| The brief description
| xref:mrdocs/doc/CodeBlock.adoc[`CodeBlock`] 
| Preformatted source code&period;
| xref:mrdocs/doc/CodeInline.adoc[`CodeInline`] 
| Inline code (monospaced) used for short snippets within text&period;
| xref:mrdocs/doc/CopyDetailsInline.adoc[`CopyDetailsInline`] 
| Documentation copied from another symbol&period;
| xref:mrdocs/doc/DefinitionListBlock.adoc[`DefinitionListBlock`] 
| A list of terms paired with definitions&period;
| xref:mrdocs/doc/DefinitionListItem.adoc[`DefinitionListItem`] 
| An item in a definition list
| xref:mrdocs/doc/EmphInline.adoc[`EmphInline`] 
| Emphasized text (typically rendered in italics)&period;
| xref:mrdocs/doc/FootnoteDefinitionBlock.adoc[`FootnoteDefinitionBlock`] 
| Text defining the content of a footnote reference&period;
| xref:mrdocs/doc/FootnoteReferenceInline.adoc[`FootnoteReferenceInline`] 
| A reference to a symbol&period;
| xref:mrdocs/doc/HeadingBlock.adoc[`HeadingBlock`] 
| A manually specified section heading&period;
| xref:mrdocs/doc/HighlightInline.adoc[`HighlightInline`] 
| Highlighted text span used to call out important words&period;
| xref:mrdocs/doc/ImageInline.adoc[`ImageInline`] 
| An image&period;
| xref:mrdocs/doc/Inline.adoc[`Inline`] 
| A Node containing a string of text&period;
| xref:mrdocs/doc/InlineCommonBase-0dc.adoc[`InlineCommonBase`] 
| Base class for providing variant discriminator functions&period;
| xref:mrdocs/doc/InlineContainer.adoc[`InlineContainer`] 
| An internal node in the inline element tree&period;
| xref:mrdocs/doc/InlineTextLeaf.adoc[`InlineTextLeaf`] 
| A leaf node that stores a string of text&period;
| xref:mrdocs/doc/LineBreakInline.adoc[`LineBreakInline`] 
| A hard line break that renders as &quot;&quot;
| xref:mrdocs/doc/LinkInline.adoc[`LinkInline`] 
| A hyperlink&period;
| xref:mrdocs/doc/ListBlock.adoc[`ListBlock`] 
| A list of list items
| xref:mrdocs/doc/ListItem.adoc[`ListItem`] 
| An item in a xref:mrdocs/doc/ListBlock.adoc[`ListBlock`]
| xref:mrdocs/doc/MathBlock.adoc[`MathBlock`] 
| A block of LaTeX math
| xref:mrdocs/doc/MathInline.adoc[`MathInline`] 
| An inline LaTeX math expression
| xref:mrdocs/doc/ParagraphBlock.adoc[`ParagraphBlock`] 
| A sequence of text nodes&period;
| xref:mrdocs/doc/ParamBlock.adoc[`ParamBlock`] 
| Documentation for a function parameter
| xref:mrdocs/doc/PostconditionBlock.adoc[`PostconditionBlock`] 
| Text describing conditions guaranteed on successful exit&period;
| xref:mrdocs/doc/PreconditionBlock.adoc[`PreconditionBlock`] 
| Text describing required conditions before entry&period;
| xref:mrdocs/doc/QuoteBlock.adoc[`QuoteBlock`] 
| A quoted block of text&period;
| xref:mrdocs/doc/ReferenceInline.adoc[`ReferenceInline`] 
| A reference to a symbol&period;
| xref:mrdocs/doc/ReturnsBlock.adoc[`ReturnsBlock`] 
| Documentation for a function return type
| xref:mrdocs/doc/SeeBlock.adoc[`SeeBlock`] 
| A
| xref:mrdocs/doc/SoftBreakInline.adoc[`SoftBreakInline`] 
| A line break that may render as a space
| xref:mrdocs/doc/StrikethroughInline.adoc[`StrikethroughInline`] 
| Strikethrough span to show removed or deprecated text&period;
| xref:mrdocs/doc/StrongInline.adoc[`StrongInline`] 
| Strong emphasis span (typically rendered in bold)&period;
| xref:mrdocs/doc/SubscriptInline.adoc[`SubscriptInline`] 
| Subscript text fragment (lowered baseline)&period;
| xref:mrdocs/doc/SuperscriptInline.adoc[`SuperscriptInline`] 
| Superscript text fragment (raised baseline)&period;
| xref:mrdocs/doc/TParamBlock.adoc[`TParamBlock`] 
| Documentation for a template parameter
| xref:mrdocs/doc/TableBlock.adoc[`TableBlock`] 
| A table block
| xref:mrdocs/doc/TableCell.adoc[`TableCell`] 
| A cell in a table
| xref:mrdocs/doc/TableRow.adoc[`TableRow`] 
| An item in a list
| xref:mrdocs/doc/TextInline.adoc[`TextInline`] 
| A Node containing a string of text&period;
| xref:mrdocs/doc/ThematicBreakBlock.adoc[`ThematicBreakBlock`] 
| A horizontal thematic break separating sections&period;
| xref:mrdocs/doc/ThrowsBlock.adoc[`ThrowsBlock`] 
| Documentation for a function exception clause
|===


=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/doc/AdmonitionKind.adoc[`AdmonitionKind`] 
| An admonishment style&period;
| xref:mrdocs/doc/BlockKind.adoc[`BlockKind`] 
| Enumerates the different kinds of DocComment blocks&period;
| xref:mrdocs/doc/InlineKind.adoc[`InlineKind`] 
| Enumerates the different kinds of inline nodes&period;
| xref:mrdocs/doc/ParamDirection.adoc[`ParamDirection`] 
| Parameter pass direction&period;
| xref:mrdocs/doc/Parts.adoc[`Parts`] 
| Which parts of the documentation to copy&period;
|===


=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/doc/getAsPlainText-02.adoc[`getAsPlainText`] 
| `getAsPlainText` overloads
| xref:mrdocs/doc/isBlockCommand.adoc[`isBlockCommand`] 
| Return true if the given block kind represents a command block&period;
| xref:mrdocs/doc/isEmpty-04.adoc[`isEmpty`] 
| Determine if the inline is empty
| xref:mrdocs/doc/ltrim-09.adoc[`ltrim`] 
| `ltrim` overloads
| xref:mrdocs/doc/rtrim-03.adoc[`rtrim`] 
| `rtrim` overloads
| xref:mrdocs/doc/tag_invoke-0e.adoc[`tag&lowbar;invoke`] 
| `tag&lowbar;invoke` overloads
| xref:mrdocs/doc/traverse.adoc[`traverse`] 
| Traverse a list of inlines&period;
| xref:mrdocs/doc/trim-00.adoc[`trim`] 
| `trim` overloads
| xref:mrdocs/doc/visit-0e.adoc[`visit`] 
| `visit` overloads
| xref:mrdocs/doc/operator_eq-0a.adoc[`operator&equals;&equals;`] 
| Equality delegates to the three&hyphen;way comparison&period;
| xref:mrdocs/doc/operator_3way-01c.adoc[`operator&lt;&equals;&gt;`] 
| Three&hyphen;way comparison operators
|===


=== Using Declarations

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/doc/operator_3way-08.adoc[`operator&lt;&equals;&gt;`] 
| Three&hyphen;way comparison for any described type&period;
| xref:mrdocs/doc/operator_eq-07.adoc[`operator&equals;&equals;`] 
| Equality for any described type&period;
|===


== xref:mrdocs/dom.adoc[mrdocs::dom] namespace

Objects representing JSON&hyphen;like values&period;

=== Namespaces

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/dom/JSON.adoc[`JSON`] 
| JSON serialization helpers for DOM values&period;
|===


=== Types

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/dom/Array.adoc[`Array`] 
| An array of values
| xref:mrdocs/dom/ArrayImpl.adoc[`ArrayImpl`] 
| Abstract array interface&period;
| xref:mrdocs/dom/DefaultArrayImpl.adoc[`DefaultArrayImpl`] 
| The default array implementation&period;
| xref:mrdocs/dom/DefaultFunctionImpl.adoc[`DefaultFunctionImpl`] 
| Function implementation that wraps a fixed&hyphen;arity callable&period;
| xref:mrdocs/dom/DefaultObjectImpl.adoc[`DefaultObjectImpl`] 
| The default Object implementation&period;
| xref:mrdocs/dom/Function.adoc[`Function`] 
| Value&hyphen;semantic wrapper over a callable exposed to the DOM layer&period;
| xref:mrdocs/dom/FunctionImpl.adoc[`FunctionImpl`] 
| Value&hyphen;semantic wrapper over a callable exposed to the DOM layer&period;
| xref:mrdocs/dom/LazyArrayImpl-07.adoc[`LazyArrayImpl`] 
| Lazy array implementation
| xref:mrdocs/dom/LazyArrayImpl-08.adoc[`LazyArrayImpl`] 
| Lazy array implementation
| xref:mrdocs/dom/LazyObjectImpl-06.adoc[`LazyObjectImpl`] 
| Lazy object implementation&period;
| xref:mrdocs/dom/LazyObjectImpl-0e.adoc[`LazyObjectImpl`] 
| Lazy object implementation&period;
| xref:mrdocs/dom/LazyObjectMapTag.adoc[`LazyObjectMapTag`] 
| Customization point tag&period;
| xref:mrdocs/dom/Object.adoc[`Object`] 
| A container of key and value pairs&period;
| xref:mrdocs/dom/ObjectImpl.adoc[`ObjectImpl`] 
| Abstract object interface&period;
| xref:mrdocs/dom/String.adoc[`String`] 
| UTF&hyphen;8 string value used by the DOM&period;
| xref:mrdocs/dom/Value.adoc[`Value`] 
| A variant container for any kind of Dom value&period;
| xref:mrdocs/dom/ValueFromTag.adoc[`ValueFromTag`] 
| Customization point tag&period;
| xref:mrdocs/dom/VariadicFunctionImpl.adoc[`VariadicFunctionImpl`] 
| Function implementation that forwards the entire Array to a callable&period;
| xref:mrdocs/dom/function_traits-056.adoc[`function&lowbar;traits`] 
| Helper traits to extract return and argument types from callables&period;
|===


=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/dom/Kind.adoc[`Kind`] 
| The type of data in a Value&period;
|===


=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/dom/LazyArray-04.adoc[`LazyArray`] 
| `LazyArray` overloads
| xref:mrdocs/dom/LazyObject-07.adoc[`LazyObject`] 
| `LazyObject` overloads
| xref:mrdocs/dom/TransformArray.adoc[`TransformArray`] 
| Return a new dom&colon;&colon;Array based on a transformed lazy array implementation&period;
| xref:mrdocs/dom/ValueFrom-0a.adoc[`ValueFrom`] 
| `ValueFrom` overloads
| xref:mrdocs/dom/makeInvocable.adoc[`makeInvocable`] 
| Create a Function from a fixed&hyphen;arity invocable&period;
| xref:mrdocs/dom/makeVariadicInvocable.adoc[`makeVariadicInvocable`] 
| Create a Function that receives the argument Array directly&period;
| xref:mrdocs/dom/newArray.adoc[`newArray`] 
| Return a new array using a custom implementation&period;
| xref:mrdocs/dom/newFunction.adoc[`newFunction`] 
| Return a diagnostic string&period;
| xref:mrdocs/dom/newObject.adoc[`newObject`] 
| Return a new object using a custom implementation&period;
| xref:mrdocs/dom/operator_and-0df7.adoc[`operator&amp;&amp;`] 
| Return the first dom&colon;&colon;Value that is not truthy, or the last one&period;
| xref:mrdocs/dom/operator_plus-002.adoc[`operator&plus;`] 
| Addition operators
| xref:mrdocs/dom/operator_or-0e.adoc[`operator&verbar;&verbar;`] 
| Return the first dom&colon;&colon;Value that is truthy, or the last one&period;
| xref:mrdocs/dom/stringOrNull-04.adoc[`stringOrNull`] 
| Return a non&hyphen;empty string, or a null&period;
| xref:mrdocs/dom/swap-0c.adoc[`swap`] 
| `swap` overloads
| xref:mrdocs/dom/toString-07.adoc[`toString`] 
| `toString` overloads
| xref:mrdocs/dom/operator_eq-00.adoc[`operator&equals;&equals;`] 
| Equality operators
| xref:mrdocs/dom/operator_not_eq-04.adoc[`operator!&equals;`] 
| Return the result of comparing two strings&period;
| xref:mrdocs/dom/operator_3way-07b.adoc[`operator&lt;&equals;&gt;`] 
| Three&hyphen;way comparison operators
|===


=== Concepts

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/dom/HasLazyObjectMap.adoc[`HasLazyObjectMap`] 
| Determine if `T` can be converted to xref:mrdocs/dom/Value.adoc[`dom&colon;&colon;Value`]&period;
| xref:mrdocs/dom/HasLazyObjectMapWithContext.adoc[`HasLazyObjectMapWithContext`] 
| Concept to determine if a type can be mapped to a xref:mrdocs/dom/LazyObjectImpl-06.adoc[`dom&colon;&colon;LazyObjectImpl`] with a user&hyphen;provided conversion&period;
| xref:mrdocs/dom/HasLazyObjectMapWithoutContext.adoc[`HasLazyObjectMapWithoutContext`] 
| Concept to determine if a type can be mapped to a xref:mrdocs/dom/LazyObjectImpl-06.adoc[`dom&colon;&colon;LazyObjectImpl`] with a user&hyphen;provided conversion&period;
| xref:mrdocs/dom/HasStandaloneValueFrom.adoc[`HasStandaloneValueFrom`] 
| Determine if ` T` can be converted to xref:mrdocs/dom/Value.adoc[`dom&colon;&colon;Value`] without a context&period;
| xref:mrdocs/dom/HasValueFrom.adoc[`HasValueFrom`] 
| Determine if `T` can be converted to xref:mrdocs/dom/Value.adoc[`dom&colon;&colon;Value`]&period;
| xref:mrdocs/dom/HasValueFromWithContext.adoc[`HasValueFromWithContext`] 
| Concept to determine if a type can be converted to a xref:mrdocs/dom/Value.adoc[`dom&colon;&colon;Value`] with a user&hyphen;provided conversion&period;
| xref:mrdocs/dom/HasValueFromWithoutContext.adoc[`HasValueFromWithoutContext`] 
| Concept to determine if a type can be converted to a xref:mrdocs/dom/Value.adoc[`dom&colon;&colon;Value`] with a user&hyphen;provided conversion&period;
| xref:mrdocs/dom/StringLikeTy.adoc[`StringLikeTy`] 
| Satisfied if StringTy is convertible to String but not a String&period;
| xref:mrdocs/dom/function_traits_convertible_to_value.adoc[`function&lowbar;traits&lowbar;convertible&lowbar;to&lowbar;value`] 
| Concept selecting callables convertible to dom&colon;&colon;Value&period;
| xref:mrdocs/dom/has_function_args_for_default_function_impl.adoc[`has&lowbar;function&lowbar;args&lowbar;for&lowbar;default&lowbar;function&lowbar;impl`] 
| Concept requiring all arguments be convertible to dom&colon;&colon;Value&period;
| xref:mrdocs/dom/has_function_traits.adoc[`has&lowbar;function&lowbar;traits`] 
| Concept true when function&lowbar;traits is defined for F&period;
| xref:mrdocs/dom/has_function_traits_for_default_function_impl.adoc[`has&lowbar;function&lowbar;traits&lowbar;for&lowbar;default&lowbar;function&lowbar;impl`] 
| Concept combining argument and return constraints for default wrapper&period;
| xref:mrdocs/dom/has_invoke_expected_result_convertible_to_dom_value.adoc[`has&lowbar;invoke&lowbar;expected&lowbar;result&lowbar;convertible&lowbar;to&lowbar;dom&lowbar;value`] 
| Concept true when F returns Expected&lt;dom&colon;&colon;Value&gt; or Expected&lt;void&gt;&period;
| xref:mrdocs/dom/has_invoke_result_convertible_to_dom_value.adoc[`has&lowbar;invoke&lowbar;result&lowbar;convertible&lowbar;to&lowbar;dom&lowbar;value`] 
| Concept true when F returns a dom&colon;&colon;Value or void&period;
| xref:mrdocs/dom/has_invoke_result_for_default_function_impl.adoc[`has&lowbar;invoke&lowbar;result&lowbar;for&lowbar;default&lowbar;function&lowbar;impl`] 
| Concept enabling default function wrapper for supported return types&period;
|===


== xref:mrdocs/dom/JSON.adoc[mrdocs::dom::JSON] namespace

JSON serialization helpers for DOM values&period;

=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/dom/JSON/stringify.adoc[`stringify`] 
| Stringify a value as JSON
|===


== xref:mrdocs/files.adoc[mrdocs::files] namespace

Filesystem helpers (join, temp, real&hyphen;path resolution) used throughout MrDocs&period;

=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/files/FileType.adoc[`FileType`] 
| The type of a file&period;
|===


=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/files/appendPath-04.adoc[`appendPath`] 
| `appendPath` overloads
| xref:mrdocs/files/createDirectory.adoc[`createDirectory`] 
| Create a directory&period;
| xref:mrdocs/files/exists.adoc[`exists`] 
| Determine if a path exists
| xref:mrdocs/files/getFileName.adoc[`getFileName`] 
| Return the filename part of the path&period;
| xref:mrdocs/files/getFileText.adoc[`getFileText`] 
| Return the contents of a file as a string&period;
| xref:mrdocs/files/getFileType.adoc[`getFileType`] 
| Return the file type or an error
| xref:mrdocs/files/getParentDir-00.adoc[`getParentDir`] 
| Return the parent directory&period;
| xref:mrdocs/files/getSourceFilename.adoc[`getSourceFilename`] 
| Return the relevant suffix of a source file path&period;
| xref:mrdocs/files/isAbsolute.adoc[`isAbsolute`] 
| Return true if pathName is absolute&period;
| xref:mrdocs/files/isDirectory.adoc[`isDirectory`] 
| Determine if a path is a directory&period;
| xref:mrdocs/files/isDirsy.adoc[`isDirsy`] 
| Return true if pathName ends in a separator&period;
| xref:mrdocs/files/isPosixStyle.adoc[`isPosixStyle`] 
| Check if the path is posix style&period;
| xref:mrdocs/files/isRegularFile.adoc[`isRegularFile`] 
| Determine if a path is a regular file&period;
| xref:mrdocs/files/isResolvedSubpathOf.adoc[`isResolvedSubpathOf`] 
| Checks whether the given path lies within the specified prefix, tolerating symlinks&period;
| xref:mrdocs/files/isSubpathOf.adoc[`isSubpathOf`] 
| Checks whether the given path lies within the specified prefix&period;
| xref:mrdocs/files/looksLikeDirectory.adoc[`looksLikeDirectory`] 
| Determine whether a path looks like a directory&period;
| xref:mrdocs/files/looksLikeFile.adoc[`looksLikeFile`] 
| Determine whether a path looks like a file&period;
| xref:mrdocs/files/makeAbsolute-0d.adoc[`makeAbsolute`] 
| Return an absolute path from a possibly relative path&period;
| xref:mrdocs/files/makeDirsy.adoc[`makeDirsy`] 
| Append a trailing native separator if not already present&period;
| xref:mrdocs/files/makePosixStyle.adoc[`makePosixStyle`] 
| Convert all backward slashes to forward slashes&period;
| xref:mrdocs/files/makeRealPath.adoc[`makeRealPath`] 
| Return the real, symlink&hyphen;resolved form of a path&period;
| xref:mrdocs/files/normalizeDir.adoc[`normalizeDir`] 
| Return a normalized directory&period;
| xref:mrdocs/files/normalizePath.adoc[`normalizePath`] 
| Return a normalized path&period;
| xref:mrdocs/files/requireAbsolute.adoc[`requireAbsolute`] 
| Return an error if pathName is not absolute&period;
| xref:mrdocs/files/requireDirectory.adoc[`requireDirectory`] 
| Return an error if the path is not a directory&period;
| xref:mrdocs/files/withExtension.adoc[`withExtension`] 
| Return the filename with a new or different extension&period;
|===


== xref:mrdocs/helpers.adoc[mrdocs::helpers] namespace

Handlebars helper registry for templates&period;

=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/helpers/and_fn.adoc[`and&lowbar;fn`] 
| &quot;and&quot; helper function
| xref:mrdocs/helpers/detag_fn.adoc[`detag&lowbar;fn`] 
| &quot;detag&quot; helper function
| xref:mrdocs/helpers/eq_fn.adoc[`eq&lowbar;fn`] 
| &quot;eq&quot; helper function
| xref:mrdocs/helpers/increment_fn.adoc[`increment&lowbar;fn`] 
| &quot;increment&quot; helper function
| xref:mrdocs/helpers/ne_fn.adoc[`ne&lowbar;fn`] 
| &quot;ne&quot; helper function
| xref:mrdocs/helpers/not_fn.adoc[`not&lowbar;fn`] 
| &quot;not&quot; helper function
| xref:mrdocs/helpers/or_fn.adoc[`or&lowbar;fn`] 
| &quot;or&quot; helper function
| xref:mrdocs/helpers/registerAntoraHelpers.adoc[`registerAntoraHelpers`] 
| Register all the Antora helpers into a Handlebars instance
| xref:mrdocs/helpers/registerBuiltinHelpers.adoc[`registerBuiltinHelpers`] 
| Register all the built&hyphen;in helpers into a Handlebars instance
| xref:mrdocs/helpers/registerConstructorHelpers.adoc[`registerConstructorHelpers`] 
| Register contructor helpers into a Handlebars instance
| xref:mrdocs/helpers/registerContainerHelpers.adoc[`registerContainerHelpers`] 
| Register helpers to manipulate composite data types
| xref:mrdocs/helpers/registerLogicalHelpers.adoc[`registerLogicalHelpers`] 
| Register logical helpers into a Handlebars instance
| xref:mrdocs/helpers/registerMathHelpers.adoc[`registerMathHelpers`] 
| Register math helpers into a Handlebars instance
| xref:mrdocs/helpers/registerStringHelpers.adoc[`registerStringHelpers`] 
| Register string helpers into a Handlebars instance
| xref:mrdocs/helpers/registerTypeHelpers.adoc[`registerTypeHelpers`] 
| Register type helpers into a Handlebars instance
| xref:mrdocs/helpers/relativize_fn.adoc[`relativize&lowbar;fn`] 
| &quot;relativize&quot; helper function
| xref:mrdocs/helpers/select_fn.adoc[`select&lowbar;fn`] 
| &quot;select&quot; helper function
| xref:mrdocs/helpers/year_fn.adoc[`year&lowbar;fn`] 
| &quot;year&quot; helper function
|===


== xref:mrdocs/js.adoc[mrdocs::js] namespace

JavaScript interop helpers for the embedded runtime&period;

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/js/Array.adoc[`Array`] 
| Lightweight handle to a JavaScript array&period;
| xref:mrdocs/js/Boolean.adoc[`Boolean`] 
| Boolean wrapper for JavaScript values&period;
| xref:mrdocs/js/Context.adoc[`Context`] 
| An isolated JavaScript interpreter instance&period;
| xref:mrdocs/js/Object.adoc[`Object`] 
| Object wrapper for JavaScript values&period;
| xref:mrdocs/js/Scope.adoc[`Scope`] 
| A JavaScript scope for value lifetime management&period;
| xref:mrdocs/js/String.adoc[`String`] 
| String wrapper for JavaScript values&period;
| xref:mrdocs/js/Value.adoc[`Value`] 
| An ECMAScript value&period;
|===


=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/js/Type.adoc[`Type`] 
| Types of values&period;
|===


=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/js/operator_and-0c.adoc[`operator&amp;&amp;`] 
| Return the first Value that is not truthy, or the last one&period;
| xref:mrdocs/js/operator_or-0e1.adoc[`operator&verbar;&verbar;`] 
| Return the first Value that is truthy, or the last one&period;
| xref:mrdocs/js/registerHelper.adoc[`registerHelper`] 
| Register a JavaScript helper function
| xref:mrdocs/js/swap.adoc[`swap`] 
| Swap two values&period;
| xref:mrdocs/js/toString.adoc[`toString`] 
| Return value as a string&period;
| xref:mrdocs/js/operator_eq-0c.adoc[`operator&equals;&equals;`] 
| Compare two values for equality&period;
| xref:mrdocs/js/operator_not_eq-076.adoc[`operator!&equals;`] 
| Inequality operators
| xref:mrdocs/js/operator_3way.adoc[`operator&lt;&equals;&gt;`] 
| Compare two values for inequality&period;
|===


== xref:mrdocs/lua.adoc[mrdocs::lua] namespace

Lua interop helpers for the optional scripting&sol;backend integration&period;

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/lua/Access.adoc[`Access`] 
| Internal tag granting access to lua internals&period;
| xref:mrdocs/lua/Context.adoc[`Context`] 
| A reference to an instance of a Lua interpreter&period;
| xref:mrdocs/lua/Function.adoc[`Function`] 
| A Lua function&period;
| xref:mrdocs/lua/Param.adoc[`Param`] 
| A lazy container to push values to the Lua stack&period;
| xref:mrdocs/lua/Scope.adoc[`Scope`] 
| Stack scope guard for Lua calls&period;
| xref:mrdocs/lua/String.adoc[`String`] 
| A Lua string&period;
| xref:mrdocs/lua/Table.adoc[`Table`] 
| A Lua table&period;
| xref:mrdocs/lua/Value.adoc[`Value`] 
| A Lua value&period;
| xref:mrdocs/lua/zstring.adoc[`zstring`] 
| A null&hyphen;terminated string&period;
|===


=== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/lua/FunctionPtr.adoc[`FunctionPtr`] 
| Pointer to a Lua&hyphen;callable function returning Value&period;
|===


=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/lua/Type.adoc[`Type`] 
| Types of values&period;
|===


=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/lua/makeCallable.adoc[`makeCallable`] 
| Expose a registry&hyphen;anchored Lua function as a dom&colon;&colon;Function&period;
| xref:mrdocs/lua/registerHelper.adoc[`registerHelper`] 
| Register a Lua helper function
|===


== xref:mrdocs/report.adoc[mrdocs::report] namespace

Reporting utilities (messages, statistics, sinks)&period;

=== Types

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/report/Located.adoc[`Located`] 
| Parameter type that adds a source location to a value&period;
| xref:mrdocs/report/Results.adoc[`Results`] 
| Provides statistics on the number of reported messages&period;
|===


=== Enums

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/report/Level.adoc[`Level`] 
| Severity levels attached to reported messags&period;
|===


=== Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/report/debug.adoc[`debug`] 
| Emit a debug&hyphen;level diagnostic for troubleshooting&period;
| xref:mrdocs/report/error.adoc[`error`] 
| Emit an error that indicates failure but allows continuation&period;
| xref:mrdocs/report/fatal.adoc[`fatal`] 
| Emit a fatal error and mark the report as the highest severity&period;
| xref:mrdocs/report/getMinimumLevel.adoc[`getMinimumLevel`] 
| Get the minimum threshold level for reporting&period;
| xref:mrdocs/report/info.adoc[`info`] 
| Emit an informational message for users&period;
| xref:mrdocs/report/log.adoc[`log`] 
| Format a message to the console&period;
| xref:mrdocs/report/print-08.adoc[`print`] 
| Report a message to the console&period;
| xref:mrdocs/report/setMinimumLevel.adoc[`setMinimumLevel`] 
| Set the minimum threshold level for reporting&period;
| xref:mrdocs/report/setSourceLocationWarnings.adoc[`setSourceLocationWarnings`] 
| If true, source location information will be printed with warnings, errors, and fatal messages&period;
| xref:mrdocs/report/trace.adoc[`trace`] 
| Emit a trace&hyphen;level diagnostic (verbose, off by default)&period;
| xref:mrdocs/report/warn.adoc[`warn`] 
| Emit a warning that does not stop execution&period;
|===


=== Variables

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/report/results.adoc[`results`] 
| Holds current statistics on reported messages&period;
|===



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