[#index]
= Global namespace
:relfileprefix: 
:mrdocs:

== Namespaces

[cols=1]
|===
| Name
| xref:clang.adoc[`clang`] 
|===

== xref:clang.adoc[clang] namespace

=== Namespaces

[cols=1]
|===
| Name
| xref:clang/mrdocs.adoc[`mrdocs`] 
|===

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

=== Namespaces

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/doc.adoc[`doc`] 
| Javadoc related types and functions.
| xref:clang/mrdocs/dom.adoc[`dom`] 
| Objects representing JSON‐like values.
| xref:clang/mrdocs/files.adoc[`files`] 
| 
| xref:clang/mrdocs/helpers.adoc[`helpers`] 
| 
| xref:clang/mrdocs/js.adoc[`js`] 
| 
| xref:clang/mrdocs/lua.adoc[`lua`] 
| 
| xref:clang/mrdocs/report.adoc[`report`] 
| 
|===

=== Types

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/AnyFileVisitor.adoc[`AnyFileVisitor`] 
| 
| xref:clang/mrdocs/ArrayTypeInfo.adoc[`ArrayTypeInfo`] 
| 
| xref:clang/mrdocs/AutoTypeInfo.adoc[`AutoTypeInfo`] 
| 
| xref:clang/mrdocs/BadExpectedAccess-0d.adoc[`BadExpectedAccess`] 
| 
| xref:clang/mrdocs/BadExpectedAccess-01.adoc[`BadExpectedAccess<void>`] 
| 
| xref:clang/mrdocs/BaseInfo.adoc[`BaseInfo`] 
| Metadata for a direct base.
| xref:clang/mrdocs/ConceptInfo.adoc[`ConceptInfo`] 
| Info for concepts.
| xref:clang/mrdocs/Config.adoc[`Config`] 
| Configuration used to generate the Corpus and Docs
| xref:clang/mrdocs/ConstantExprInfo.adoc[`ConstantExprInfo`] 
| Represents an expression with a (possibly known) value
| xref:clang/mrdocs/Corpus.adoc[`Corpus`] 
| The collection of declarations in extracted form.
| xref:clang/mrdocs/DecltypeTypeInfo.adoc[`DecltypeTypeInfo`] 
| 
| xref:clang/mrdocs/DefaultEmptyPredicate.adoc[`DefaultEmptyPredicate`] 
| The default empty predicate.
| xref:clang/mrdocs/DomCorpus.adoc[`DomCorpus`] 
| Front‐end factory for producing Dom nodes.
| xref:clang/mrdocs/EnumConstantInfo.adoc[`EnumConstantInfo`] 
| Info for enum constants.
| xref:clang/mrdocs/EnumInfo.adoc[`EnumInfo`] 
| 
| xref:clang/mrdocs/Error.adoc[`Error`] 
| Holds the description of an error, or success.
| xref:clang/mrdocs/Exception.adoc[`Exception`] 
| Type of all exceptions thrown by the API.
| xref:clang/mrdocs/ExecutorGroup.adoc[`ExecutorGroup`] 
| A set of execution agents for performing concurrent work.
| xref:clang/mrdocs/ExecutorGroupBase.adoc[`ExecutorGroupBase`] 
| 
| xref:clang/mrdocs/Expected-03.adoc[`Expected`] 
| A container holding an error or a value.
| xref:clang/mrdocs/Expected-0c.adoc[`Expected<T, E>`] 
| 
| xref:clang/mrdocs/ExplicitInfo.adoc[`ExplicitInfo`] 
| 
| xref:clang/mrdocs/ExprInfo.adoc[`ExprInfo`] 
| Represents an expression
| xref:clang/mrdocs/FormatString.adoc[`FormatString`] 
| A format string with source location.
| xref:clang/mrdocs/FriendInfo.adoc[`FriendInfo`] 
| Info for friend declarations.
| xref:clang/mrdocs/FunctionInfo.adoc[`FunctionInfo`] 
| 
| xref:clang/mrdocs/FunctionTypeInfo.adoc[`FunctionTypeInfo`] 
| 
| xref:clang/mrdocs/Generator.adoc[`Generator`] 
| Base class for documentation generators.
| xref:clang/mrdocs/Generators.adoc[`Generators`] 
| A dynamic list of Generator
| xref:clang/mrdocs/GlobPattern.adoc[`GlobPattern`] 
| A glob pattern matcher
| xref:clang/mrdocs/GuideInfo.adoc[`GuideInfo`] 
| Info for deduction guides.
| xref:clang/mrdocs/Handlebars.adoc[`Handlebars`] 
| A handlebars environment
| xref:clang/mrdocs/HandlebarsError.adoc[`HandlebarsError`] 
| An error thrown or returned by Handlebars
| xref:clang/mrdocs/HandlebarsOptions.adoc[`HandlebarsOptions`] 
| Options for handlebars
| xref:clang/mrdocs/Info.adoc[`Info`] 
| Base class with common properties of all symbols
| xref:clang/mrdocs/InfoCommonBase-08.adoc[`InfoCommonBase`] 
| Base class for providing variant discriminator functions.
| xref:clang/mrdocs/IsTArg-01.adoc[`IsTArg`] 
| 
| xref:clang/mrdocs/Javadoc.adoc[`Javadoc`] 
| A processed Doxygen‐style comment attached to a declaration.
| xref:clang/mrdocs/LValueReferenceTypeInfo.adoc[`LValueReferenceTypeInfo`] 
| 
| xref:clang/mrdocs/Location.adoc[`Location`] 
| 
| xref:clang/mrdocs/LocationEmptyPredicate.adoc[`LocationEmptyPredicate`] 
| 
| xref:clang/mrdocs/MemberPointerTypeInfo.adoc[`MemberPointerTypeInfo`] 
| 
| xref:clang/mrdocs/NameInfo.adoc[`NameInfo`] 
| Represents a name for a named `TypeInfo`
| xref:clang/mrdocs/NamedTypeInfo.adoc[`NamedTypeInfo`] 
| 
| xref:clang/mrdocs/NamespaceAliasInfo.adoc[`NamespaceAliasInfo`] 
| Info for namespace aliases.
| xref:clang/mrdocs/NamespaceInfo.adoc[`NamespaceInfo`] 
| Describes a namespace.
| xref:clang/mrdocs/NamespaceTranche.adoc[`NamespaceTranche`] 
| The members of a Namespace
| xref:clang/mrdocs/NoexceptInfo.adoc[`NoexceptInfo`] 
| 
| xref:clang/mrdocs/NonTypeTArg.adoc[`NonTypeTArg`] 
| 
| xref:clang/mrdocs/NonTypeTParam.adoc[`NonTypeTParam`] 
| 
| xref:clang/mrdocs/Optional.adoc[`Optional`] 
| A compact optional.
| xref:clang/mrdocs/OutputRef.adoc[`OutputRef`] 
| Reference to output stream used by handlebars
| xref:clang/mrdocs/OverloadsInfo.adoc[`OverloadsInfo`] 
| Represents a set of function overloads.
| xref:clang/mrdocs/Param.adoc[`Param`] 
| Represents a single function parameter
| xref:clang/mrdocs/ParseResult.adoc[`ParseResult`] 
| The result of a parse operation.
| xref:clang/mrdocs/PathGlobPattern.adoc[`PathGlobPattern`] 
| A glob pattern matcher for paths
| xref:clang/mrdocs/PointerTypeInfo.adoc[`PointerTypeInfo`] 
| 
| xref:clang/mrdocs/Polymorphic.adoc[`Polymorphic`] 
| A polymorphic value‐type.
| xref:clang/mrdocs/RValueReferenceTypeInfo.adoc[`RValueReferenceTypeInfo`] 
| 
| xref:clang/mrdocs/RangeFor-07.adoc[`RangeFor`] 
| Range to help range‐for loops identify first and last.
| xref:clang/mrdocs/RecordInfo.adoc[`RecordInfo`] 
| Metadata for struct, class, or union.
| xref:clang/mrdocs/RecordInterface.adoc[`RecordInterface`] 
| The aggregated interface for a given struct, class, or union.
| xref:clang/mrdocs/RecordTranche.adoc[`RecordTranche`] 
| A group of members that have the same access specifier.
| xref:clang/mrdocs/ReferenceDirectories.adoc[`ReferenceDirectories`] 
| Reference directories used to resolve paths
| xref:clang/mrdocs/ScopeExit-04.adoc[`ScopeExit`] 
| 
| xref:clang/mrdocs/ScopeExitRestore-05.adoc[`ScopeExitRestore`] 
| 
| xref:clang/mrdocs/SourceInfo.adoc[`SourceInfo`] 
| Stores source information for a declaration.
| xref:clang/mrdocs/SourceLocation.adoc[`SourceLocation`] 
| A source location with filename prettification.
| xref:clang/mrdocs/SpecializationNameInfo.adoc[`SpecializationNameInfo`] 
| Represents a (possibly qualified) symbol name with template arguments.
| xref:clang/mrdocs/StringHash.adoc[`StringHash`] 
| 
| xref:clang/mrdocs/SymbolGlobPattern.adoc[`SymbolGlobPattern`] 
| A glob pattern matcher for C++ symbols
| xref:clang/mrdocs/SymbolID.adoc[`SymbolID`] 
| A unique identifier for a symbol.
| xref:clang/mrdocs/TArg.adoc[`TArg`] 
| 
| xref:clang/mrdocs/TParam.adoc[`TParam`] 
| 
| xref:clang/mrdocs/TParamCommonBase-00.adoc[`TParamCommonBase`] 
| 
| xref:clang/mrdocs/TaskGroup.adoc[`TaskGroup`] 
| A subset of possible work in a thread pool.
| xref:clang/mrdocs/TemplateInfo.adoc[`TemplateInfo`] 
| Information pertaining to templates and specializations thereof.
| xref:clang/mrdocs/TemplateTArg.adoc[`TemplateTArg`] 
| 
| xref:clang/mrdocs/TemplateTParam.adoc[`TemplateTParam`] 
| 
| xref:clang/mrdocs/ThreadPool.adoc[`ThreadPool`] 
| A pool of threads for executing work concurrently.
| xref:clang/mrdocs/TypeInfo.adoc[`TypeInfo`] 
| A possibly qualified type.
| xref:clang/mrdocs/TypeInfoCommonBase-0a.adoc[`TypeInfoCommonBase`] 
| 
| xref:clang/mrdocs/TypeTArg.adoc[`TypeTArg`] 
| 
| xref:clang/mrdocs/TypeTParam.adoc[`TypeTParam`] 
| 
| xref:clang/mrdocs/TypedefInfo.adoc[`TypedefInfo`] 
| 
| xref:clang/mrdocs/Unexpected-02.adoc[`Unexpected`] 
| 
| xref:clang/mrdocs/UsingInfo.adoc[`UsingInfo`] 
| Info for using declarations.
| xref:clang/mrdocs/VariableInfo.adoc[`VariableInfo`] 
| A variable.
| xref:clang/mrdocs/Visitor.adoc[`Visitor`] 
| A visitor for a type
| xref:clang/mrdocs/add_const_from.adoc[`add_const_from`] 
| 
| xref:clang/mrdocs/add_cv_from.adoc[`add_cv_from`] 
| 
| xref:clang/mrdocs/add_cvref_from.adoc[`add_cvref_from`] 
| 
| xref:clang/mrdocs/add_lvalue_reference_from.adoc[`add_lvalue_reference_from`] 
| 
| xref:clang/mrdocs/add_reference_from.adoc[`add_reference_from`] 
| 
| xref:clang/mrdocs/add_rvalue_reference_from.adoc[`add_rvalue_reference_from`] 
| 
| xref:clang/mrdocs/add_volatile_from.adoc[`add_volatile_from`] 
| 
| xref:clang/mrdocs/any_callable-06.adoc[`any_callable`] 
| A movable, type‐erased function object.
| xref:clang/mrdocs/any_callable-07.adoc[`any_callable<R(Args...)>`] 
| 
| xref:clang/mrdocs/make_dependent.adoc[`make_dependent`] 
| 
| xref:clang/mrdocs/unexpect_t.adoc[`unexpect_t`] 
| 
| xref:clang/mrdocs/unlock_guard.adoc[`unlock_guard`] 
| A scoped guard which unlocks a mutex.
| xref:clang/mrdocs/OptionalLocation.adoc[`OptionalLocation`] 
| Like std::optional<Location>
| xref:clang/mrdocs/UnorderedStringMap.adoc[`UnorderedStringMap`] 
| 
| xref:clang/mrdocs/UnorderedStringMultiMap.adoc[`UnorderedStringMultiMap`] 
| 
| xref:clang/mrdocs/add_const_from_t.adoc[`add_const_from_t`] 
| 
| xref:clang/mrdocs/add_cv_from_t.adoc[`add_cv_from_t`] 
| 
| xref:clang/mrdocs/add_cvref_from_t.adoc[`add_cvref_from_t`] 
| 
| xref:clang/mrdocs/add_lvalue_reference_from_t.adoc[`add_lvalue_reference_from_t`] 
| 
| xref:clang/mrdocs/add_reference_from_t.adoc[`add_reference_from_t`] 
| 
| xref:clang/mrdocs/add_rvalue_reference_from_t.adoc[`add_rvalue_reference_from_t`] 
| 
| xref:clang/mrdocs/add_volatile_from_t.adoc[`add_volatile_from_t`] 
| 
| xref:clang/mrdocs/make_dependent_t.adoc[`make_dependent_t`] 
| 
|===

=== Enums

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

=== Functions

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/CompareDerived-06.adoc[`CompareDerived`] 
| Compares two polymorphic objects that have visit functions
| xref:clang/mrdocs/HTMLEscape-08.adoc[`HTMLEscape`] 
| `HTMLEscape` overloads
| xref:clang/mrdocs/addMember.adoc[`addMember`] 
| 
| xref:clang/mrdocs/allMembers-02.adoc[`allMembers`] 
| 
| xref:clang/mrdocs/assert_failed.adoc[`assert_failed`] 
| 
| xref:clang/mrdocs/canMerge.adoc[`canMerge`] 
| 
| xref:clang/mrdocs/compareSymbolNames.adoc[`compareSymbolNames`] 
| Return the result of comparing s0 to s1.
| xref:clang/mrdocs/contains-01.adoc[`contains`] 
| Determine if a range contains a specific element.
| xref:clang/mrdocs/contains_any-00d.adoc[`contains_any`] 
| Determine if a range contains any of the specified elements.
| xref:clang/mrdocs/contains_n.adoc[`contains_n`] 
| Determine if a range contains at least N instances of the specified element.
| xref:clang/mrdocs/contains_n_any-08.adoc[`contains_n_any`] 
| Determine if a range contains at least N instances of any of the specified elements.
| xref:clang/mrdocs/countInfoKind.adoc[`countInfoKind`] 
| 
| xref:clang/mrdocs/createFrame-0e.adoc[`createFrame`] 
| Create child data objects.
| xref:clang/mrdocs/endsWithOneOf.adoc[`endsWithOneOf`] 
| Determine if a string ends with one of the specified characters
| xref:clang/mrdocs/escapeExpression.adoc[`escapeExpression`] 
| 
| xref:clang/mrdocs/find_last_of.adoc[`find_last_of`] 
| Find the last element in a range that matches an element in the specified range.
| xref:clang/mrdocs/forEachFile-0df.adoc[`forEachFile`] 
| `forEachFile` overloads
| xref:clang/mrdocs/formatError.adoc[`formatError`] 
| Return a formatted error.
| xref:clang/mrdocs/fromString.adoc[`fromString`] 
| Convert a string to a FundamentalTypeKind.
| xref:clang/mrdocs/getDefaultAccessString.adoc[`getDefaultAccessString`] 
| 
| xref:clang/mrdocs/getGenerators.adoc[`getGenerators`] 
| Return a reference to the global Generators instance.
| xref:clang/mrdocs/getOperatorKind.adoc[`getOperatorKind`] 
| Return the short name of an operator as a string.
| xref:clang/mrdocs/getOperatorKindFromSuffix.adoc[`getOperatorKindFromSuffix`] 
| Return the short name of an operator as a string.
| xref:clang/mrdocs/getOperatorName.adoc[`getOperatorName`] 
| Return the name of an operator as a string.
| xref:clang/mrdocs/getOperatorReadableName.adoc[`getOperatorReadableName`] 
| Return the human‐readable name of the operator
| xref:clang/mrdocs/getParents-0b.adoc[`getParents`] 
| Return a list of the parent symbols of the specified Info.
| xref:clang/mrdocs/getPrimaryLocation-00.adoc[`getPrimaryLocation`] 
| 
| xref:clang/mrdocs/getSafeOperatorName.adoc[`getSafeOperatorName`] 
| Return the safe name of an operator as a string.
| xref:clang/mrdocs/getShortOperatorName.adoc[`getShortOperatorName`] 
| Return the short name of an operator as a string.
| xref:clang/mrdocs/getSinglePageFullPath.adoc[`getSinglePageFullPath`] 
| Return the full path for single page output.
| xref:clang/mrdocs/innerType-02.adoc[`innerType`] 
| Return the inner type.
| xref:clang/mrdocs/innerTypePtr-07.adoc[`innerTypePtr`] 
| Return the inner type.
| xref:clang/mrdocs/innermostType-06.adoc[`innermostType`] 
| Return the innermost type.
| xref:clang/mrdocs/isAlphaNumeric-0c.adoc[`isAlphaNumeric`] 
| 
| xref:clang/mrdocs/isAlphabetic-0a.adoc[`isAlphabetic`] 
| 
| xref:clang/mrdocs/isBinaryOperator.adoc[`isBinaryOperator`] 
| Determines whether the operator is potentially binary.
| xref:clang/mrdocs/isDigit-03.adoc[`isDigit`] 
| 
| xref:clang/mrdocs/isEmpty.adoc[`isEmpty`] 
| Determine if a value is empty
| xref:clang/mrdocs/isLowerCase-06.adoc[`isLowerCase`] 
| 
| xref:clang/mrdocs/isUnaryOperator.adoc[`isUnaryOperator`] 
| Determines whether the operator is potentially unary.
| xref:clang/mrdocs/isUpperCase-04.adoc[`isUpperCase`] 
| 
| xref:clang/mrdocs/isWhitespace.adoc[`isWhitespace`] 
| Determine if a string is only whitespace.
| xref:clang/mrdocs/is_one_of-0f.adoc[`is_one_of`] 
| Determine if an element is equal to any of the elements in the specified range.
| xref:clang/mrdocs/leastSpecific.adoc[`leastSpecific`] 
| Compare ExtractionModes and returns the least specific
| xref:clang/mrdocs/ltrim-0d.adoc[`ltrim`] 
| `ltrim` overloads
| xref:clang/mrdocs/makeChar.adoc[`makeChar`] 
| Apply the "char" specifier to the type
| xref:clang/mrdocs/makeLong.adoc[`makeLong`] 
| Apply the "long" specifier to the type
| xref:clang/mrdocs/makeShort.adoc[`makeShort`] 
| Apply the "short" specifier to the type
| xref:clang/mrdocs/makeSigned.adoc[`makeSigned`] 
| Apply the "signed" specifier to the type
| xref:clang/mrdocs/makeUnsigned.adoc[`makeUnsigned`] 
| Apply the "unsigned" specifier to the type
| xref:clang/mrdocs/makeVisitor.adoc[`makeVisitor`] 
| Make a visitor for a base type
| xref:clang/mrdocs/merge-034.adoc[`merge`] 
| `merge` overloads
| xref:clang/mrdocs/mostSpecific.adoc[`mostSpecific`] 
| Compare ExtractionModes and returns the most specific
| xref:clang/mrdocs/overrides.adoc[`overrides`] 
| Determine if one function would override the other
| xref:clang/mrdocs/parse-0c.adoc[`parse`] 
| Parse a string view
| xref:clang/mrdocs/replace.adoc[`replace`] 
| Return the substring without leading and trailing horizontal whitespace.
| xref:clang/mrdocs/rtrim-04.adoc[`rtrim`] 
| `rtrim` overloads
| xref:clang/mrdocs/safeString-08.adoc[`safeString`] 
| Create a wrapper for a safe string.
| xref:clang/mrdocs/startsWithOneOf.adoc[`startsWithOneOf`] 
| Determine if a string starts with one of the specified characters
| xref:clang/mrdocs/swap-0e.adoc[`swap`] 
| 
| xref:clang/mrdocs/tag_invoke-09f5.adoc[`tag_invoke`] 
| `tag_invoke` overloads
| xref:clang/mrdocs/toBase16Str.adoc[`toBase16Str`] 
| Convert a SymbolID to a string
| xref:clang/mrdocs/toCamelCase.adoc[`toCamelCase`] 
| 
| xref:clang/mrdocs/toKebabCase.adoc[`toKebabCase`] 
| 
| xref:clang/mrdocs/toLowerCase-0e.adoc[`toLowerCase`] 
| 
| xref:clang/mrdocs/toPascalCase.adoc[`toPascalCase`] 
| 
| xref:clang/mrdocs/toSnakeCase.adoc[`toSnakeCase`] 
| 
| xref:clang/mrdocs/toString-004.adoc[`toString`] 
| `toString` overloads
| xref:clang/mrdocs/toUpperCase-0e.adoc[`toUpperCase`] 
| 
| xref:clang/mrdocs/to_underlying.adoc[`to_underlying`] 
| Return the value as its underlying type.
| xref:clang/mrdocs/trim-05.adoc[`trim`] 
| `trim` overloads
| xref:clang/mrdocs/visit-04.adoc[`visit`] 
| Invoke a function object with a type derived from Info
| xref:clang/mrdocs/operator_lshift-0e.adoc[`operator<<`] 
| Write to output
| xref:clang/mrdocs/operator_eq-05.adoc[`operator==`] 
| Equality operators
| xref:clang/mrdocs/operator_3way-0f1.adoc[`operator<=>`] 
| Three‐way comparison operators
|===

=== Variables

[cols=1]
|===
| Name
| xref:clang/mrdocs/unexpect.adoc[`unexpect`] 
|===

=== Concepts

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/HasParse.adoc[`HasParse`] 
| Concept to determine if there's a parse function for a type.
| xref:clang/mrdocs/InfoParent.adoc[`InfoParent`] 
| A concept for types that have `Info` members.
| xref:clang/mrdocs/dereferenceable.adoc[`dereferenceable`] 
| Determine if a type is dereferenceable
| xref:clang/mrdocs/pair_like.adoc[`pair_like`] 
| Concept to check if a type is pair‐like
| xref:clang/mrdocs/polymorphic_storage_for.adoc[`polymorphic_storage_for`] 
| Concept to check if a type is representing a polymorphic storage
| xref:clang/mrdocs/range_of.adoc[`range_of`] 
| Concept to check if a type is a range of T
| xref:clang/mrdocs/range_of_tuple_like.adoc[`range_of_tuple_like`] 
| Concept to check if a range is a range of tuple‐like elements
| xref:clang/mrdocs/tuple_like.adoc[`tuple_like`] 
| Concept to check if a type is tuple‐like
|===

=== Deduction Guides

[cols=1]
|===
| Name
| xref:clang/mrdocs/RangeFor-04.adoc[`RangeFor<Container>`] 
| xref:clang/mrdocs/ScopeExit-0e.adoc[`ScopeExit<F>`] 
| xref:clang/mrdocs/ScopeExitRestore-0a.adoc[`ScopeExitRestore<T>`] 
| xref:clang/mrdocs/ScopeExitRestore-08.adoc[`ScopeExitRestore<T>`] 
| xref:clang/mrdocs/Unexpected-03.adoc[`Unexpected<E>`] 
|===

=== Using Declarations

[cols=1]
|===
| Name
| xref:clang/mrdocs/source_location.adoc[`source_location`] 
|===

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

Javadoc related types and functions.

=== Types

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/doc/Admonition.adoc[`Admonition`] 
| An admonition.
| xref:clang/mrdocs/doc/Block.adoc[`Block`] 
| A piece of block content
| xref:clang/mrdocs/doc/Brief.adoc[`Brief`] 
| The brief description
| xref:clang/mrdocs/doc/Code.adoc[`Code`] 
| Preformatted source code.
| xref:clang/mrdocs/doc/CopyDetails.adoc[`CopyDetails`] 
| Documentation copied from another symbol.
| xref:clang/mrdocs/doc/Heading.adoc[`Heading`] 
| A manually specified section heading.
| xref:clang/mrdocs/doc/Link.adoc[`Link`] 
| A hyperlink.
| xref:clang/mrdocs/doc/ListItem.adoc[`ListItem`] 
| An item in a list
| xref:clang/mrdocs/doc/Node.adoc[`Node`] 
| This is a variant‐like list element.
| xref:clang/mrdocs/doc/Paragraph.adoc[`Paragraph`] 
| A sequence of text nodes.
| xref:clang/mrdocs/doc/Param.adoc[`Param`] 
| Documentation for a function parameter
| xref:clang/mrdocs/doc/Postcondition.adoc[`Postcondition`] 
| 
| xref:clang/mrdocs/doc/Precondition.adoc[`Precondition`] 
| 
| xref:clang/mrdocs/doc/Reference.adoc[`Reference`] 
| A reference to a symbol.
| xref:clang/mrdocs/doc/Returns.adoc[`Returns`] 
| Documentation for a function return type
| xref:clang/mrdocs/doc/See.adoc[`See`] 
| A
| xref:clang/mrdocs/doc/Styled.adoc[`Styled`] 
| A piece of styled text.
| xref:clang/mrdocs/doc/TParam.adoc[`TParam`] 
| Documentation for a template parameter
| xref:clang/mrdocs/doc/Text.adoc[`Text`] 
| A Node containing a string of text.
| xref:clang/mrdocs/doc/Throws.adoc[`Throws`] 
| Documentation for a function parameter
| xref:clang/mrdocs/doc/UnorderedList.adoc[`UnorderedList`] 
| A list of list items
|===

=== Enums

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/doc/Admonish.adoc[`Admonish`] 
| An admonishment style.
| xref:clang/mrdocs/doc/NodeKind.adoc[`NodeKind`] 
| The kind of node.
| xref:clang/mrdocs/doc/ParamDirection.adoc[`ParamDirection`] 
| Parameter pass direction.
| xref:clang/mrdocs/doc/Parts.adoc[`Parts`] 
| Which parts of the documentation to copy.
| xref:clang/mrdocs/doc/Style.adoc[`Style`] 
| The text style.
|===

=== Functions

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/doc/tag_invoke-0503.adoc[`tag_invoke`] 
| `tag_invoke` overloads
| xref:clang/mrdocs/doc/toString-05.adoc[`toString`] 
| `toString` overloads
| xref:clang/mrdocs/doc/traverse.adoc[`traverse`] 
| Traverse a list of nodes.
| xref:clang/mrdocs/doc/visit.adoc[`visit`] 
| Visit a node.
| xref:clang/mrdocs/doc/operator_eq.adoc[`operator==`] 
| Equality operator
| xref:clang/mrdocs/doc/operator_3way.adoc[`operator<=>`] 
| Three‐way comparison operator
|===

== See Also

https://en.wikipedia.org/wiki/Javadoc

https://www.doxygen.nl

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

Objects representing JSON‐like values.

=== Namespaces

[cols=1]
|===
| Name
| xref:clang/mrdocs/dom/JSON.adoc[`JSON`] 
|===

=== Types

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/dom/Array.adoc[`Array`] 
| An array of values
| xref:clang/mrdocs/dom/ArrayImpl.adoc[`ArrayImpl`] 
| Abstract array interface.
| xref:clang/mrdocs/dom/DefaultArrayImpl.adoc[`DefaultArrayImpl`] 
| The default array implementation.
| xref:clang/mrdocs/dom/DefaultFunctionImpl.adoc[`DefaultFunctionImpl`] 
| 
| xref:clang/mrdocs/dom/DefaultObjectImpl.adoc[`DefaultObjectImpl`] 
| The default Object implementation.
| xref:clang/mrdocs/dom/Function.adoc[`Function`] 
| 
| xref:clang/mrdocs/dom/FunctionImpl.adoc[`FunctionImpl`] 
| 
| xref:clang/mrdocs/dom/LazyArrayImpl.adoc[`LazyArrayImpl`] 
| Lazy array implementation
| xref:clang/mrdocs/dom/LazyObjectImpl.adoc[`LazyObjectImpl`] 
| Lazy object implementation.
| xref:clang/mrdocs/dom/LazyObjectMapTag.adoc[`LazyObjectMapTag`] 
| Customization point tag.
| xref:clang/mrdocs/dom/Object.adoc[`Object`] 
| A container of key and value pairs.
| xref:clang/mrdocs/dom/ObjectImpl.adoc[`ObjectImpl`] 
| Abstract object interface.
| xref:clang/mrdocs/dom/String.adoc[`String`] 
| 
| xref:clang/mrdocs/dom/Value.adoc[`Value`] 
| A variant container for any kind of Dom value.
| xref:clang/mrdocs/dom/ValueFromTag.adoc[`ValueFromTag`] 
| Customization point tag.
| xref:clang/mrdocs/dom/VariadicFunctionImpl.adoc[`VariadicFunctionImpl`] 
| 
| xref:clang/mrdocs/dom/function_traits-00.adoc[`function_traits`] 
| 
| xref:clang/mrdocs/dom/function_traits-0a8.adoc[`function_traits<F>`] 
| 
| xref:clang/mrdocs/dom/function_traits-03.adoc[`function_traits<R(*)(Args...)>`] 
| 
| xref:clang/mrdocs/dom/function_traits-0e.adoc[`function_traits<R(Args...)>`] 
| 
| xref:clang/mrdocs/dom/function_traits-0ae.adoc[`function_traits<R const volatile(C::*)(Args...)>`] 
| 
|===

=== Enums

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/dom/Kind.adoc[`Kind`] 
| The type of data in a Value.
|===

=== Functions

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/dom/LazyArray-0c.adoc[`LazyArray`] 
| `LazyArray` overloads
| xref:clang/mrdocs/dom/LazyObject-05.adoc[`LazyObject`] 
| `LazyObject` overloads
| xref:clang/mrdocs/dom/TransformArray.adoc[`TransformArray`] 
| Return a new dom::Array based on a transformed lazy array implementation.
| xref:clang/mrdocs/dom/ValueFrom-0cc.adoc[`ValueFrom`] 
| `ValueFrom` overloads
| xref:clang/mrdocs/dom/makeInvocable.adoc[`makeInvocable`] 
| 
| xref:clang/mrdocs/dom/makeVariadicInvocable.adoc[`makeVariadicInvocable`] 
| 
| xref:clang/mrdocs/dom/newArray.adoc[`newArray`] 
| Return a new array using a custom implementation.
| xref:clang/mrdocs/dom/newFunction.adoc[`newFunction`] 
| Return a diagnostic string.
| xref:clang/mrdocs/dom/newObject.adoc[`newObject`] 
| Return a new object using a custom implementation.
| xref:clang/mrdocs/dom/operator_and-03.adoc[`operator&&`] 
| Return the first dom::Value that is not truthy, or the last one.
| xref:clang/mrdocs/dom/operator_plus-0b0.adoc[`operator+`] 
| Addition operators
| xref:clang/mrdocs/dom/operator_or-08.adoc[`operator||`] 
| Return the first dom::Value that is truthy, or the last one.
| xref:clang/mrdocs/dom/stringOrNull.adoc[`stringOrNull`] 
| Return a non‐empty string, or a null.
| xref:clang/mrdocs/dom/swap-06.adoc[`swap`] 
| `swap` overloads
| xref:clang/mrdocs/dom/toString-05.adoc[`toString`] 
| `toString` overloads
| xref:clang/mrdocs/dom/operator_eq-0f.adoc[`operator==`] 
| Equality operators
| xref:clang/mrdocs/dom/operator_not_eq-0a.adoc[`operator!=`] 
| Return the result of comparing two strings.
| xref:clang/mrdocs/dom/operator_3way-0fa.adoc[`operator<=>`] 
| Three‐way comparison operators
|===

=== Concepts

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/dom/HasLazyObjectMap.adoc[`HasLazyObjectMap`] 
| Determine if `T` can be converted to xref:clang/mrdocs/dom/Value.adoc[`dom::Value`].
| xref:clang/mrdocs/dom/HasLazyObjectMapWithContext.adoc[`HasLazyObjectMapWithContext`] 
| Concept to determine if a type can be mapped to a xref:clang/mrdocs/dom/LazyObjectImpl.adoc[`dom::LazyObjectImpl`] with a user‐provided conversion.
| xref:clang/mrdocs/dom/HasLazyObjectMapWithoutContext.adoc[`HasLazyObjectMapWithoutContext`] 
| Concept to determine if a type can be mapped to a xref:clang/mrdocs/dom/LazyObjectImpl.adoc[`dom::LazyObjectImpl`] with a user‐provided conversion.
| xref:clang/mrdocs/dom/HasStandaloneValueFrom.adoc[`HasStandaloneValueFrom`] 
| Determine if `T` can be converted to xref:clang/mrdocs/dom/Value.adoc[`dom::Value`] without a context.
| xref:clang/mrdocs/dom/HasValueFrom.adoc[`HasValueFrom`] 
| Determine if `T` can be converted to xref:clang/mrdocs/dom/Value.adoc[`dom::Value`].
| xref:clang/mrdocs/dom/HasValueFromWithContext.adoc[`HasValueFromWithContext`] 
| Concept to determine if a type can be converted to a xref:clang/mrdocs/dom/Value.adoc[`dom::Value`] with a user‐provided conversion.
| xref:clang/mrdocs/dom/HasValueFromWithoutContext.adoc[`HasValueFromWithoutContext`] 
| Concept to determine if a type can be converted to a xref:clang/mrdocs/dom/Value.adoc[`dom::Value`] with a user‐provided conversion.
| xref:clang/mrdocs/dom/StringLikeTy.adoc[`StringLikeTy`] 
| Satisfied if StringTy is convertible to String but not a String.
| xref:clang/mrdocs/dom/function_traits_convertible_to_value.adoc[`function_traits_convertible_to_value`] 
| 
| xref:clang/mrdocs/dom/has_function_args_for_default_function_impl.adoc[`has_function_args_for_default_function_impl`] 
| 
| xref:clang/mrdocs/dom/has_function_traits.adoc[`has_function_traits`] 
| 
| xref:clang/mrdocs/dom/has_function_traits_for_default_function_impl.adoc[`has_function_traits_for_default_function_impl`] 
| 
| xref:clang/mrdocs/dom/has_invoke_expected_result_convertible_to_dom_value.adoc[`has_invoke_expected_result_convertible_to_dom_value`] 
| 
| xref:clang/mrdocs/dom/has_invoke_result_convertible_to_dom_value.adoc[`has_invoke_result_convertible_to_dom_value`] 
| 
| xref:clang/mrdocs/dom/has_invoke_result_for_default_function_impl.adoc[`has_invoke_result_for_default_function_impl`] 
| 
|===

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

=== Functions

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/dom/JSON/stringify.adoc[`stringify`] 
| Stringify a value as JSON
|===

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

=== Enums

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/files/FileType.adoc[`FileType`] 
| The type of a file.
|===

=== Functions

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

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

=== Functions

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

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

=== Types

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/js/Access.adoc[`Access`] 
| 
| xref:clang/mrdocs/js/Array.adoc[`Array`] 
| 
| xref:clang/mrdocs/js/Boolean.adoc[`Boolean`] 
| 
| xref:clang/mrdocs/js/Context.adoc[`Context`] 
| An instance of a JavaScript interpreter.
| xref:clang/mrdocs/js/Object.adoc[`Object`] 
| 
| xref:clang/mrdocs/js/Prop.adoc[`Prop`] 
| 
| xref:clang/mrdocs/js/Scope.adoc[`Scope`] 
| A JavaScript scope
| xref:clang/mrdocs/js/String.adoc[`String`] 
| 
| xref:clang/mrdocs/js/Value.adoc[`Value`] 
| An ECMAScript value.
|===

=== Enums

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/js/Type.adoc[`Type`] 
| Types of values.
|===

=== Functions

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/js/operator_and-06.adoc[`operator&&`] 
| Return the first Value that is not truthy, or the last one.
| xref:clang/mrdocs/js/operator_or-0b.adoc[`operator||`] 
| Return the first Value that is truthy, or the last one.
| xref:clang/mrdocs/js/registerHelper.adoc[`registerHelper`] 
| Register a JavaScript helper function
| xref:clang/mrdocs/js/swap.adoc[`swap`] 
| Swap two values.
| xref:clang/mrdocs/js/toString.adoc[`toString`] 
| Return value as a string.
| xref:clang/mrdocs/js/operator_eq-07.adoc[`operator==`] 
| Compare two values for equality.
| xref:clang/mrdocs/js/operator_not_eq-01.adoc[`operator!=`] 
| Inequality operators
| xref:clang/mrdocs/js/operator_3way.adoc[`operator<=>`] 
| Compare two values for inequality.
|===

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

=== Types

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/lua/Access.adoc[`Access`] 
| 
| xref:clang/mrdocs/lua/Context.adoc[`Context`] 
| A reference to an instance of a Lua interpreter.
| xref:clang/mrdocs/lua/Function.adoc[`Function`] 
| A Lua function.
| xref:clang/mrdocs/lua/Param.adoc[`Param`] 
| A lazy container to push values to the Lua stack.
| xref:clang/mrdocs/lua/Scope.adoc[`Scope`] 
| 
| xref:clang/mrdocs/lua/String.adoc[`String`] 
| A Lua string.
| xref:clang/mrdocs/lua/Table.adoc[`Table`] 
| A Lua table.
| xref:clang/mrdocs/lua/Value.adoc[`Value`] 
| A Lua value.
| xref:clang/mrdocs/lua/zstring.adoc[`zstring`] 
| A null‐terminated string.
| xref:clang/mrdocs/lua/FunctionPtr.adoc[`FunctionPtr`] 
| 
|===

=== Enums

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/lua/Type.adoc[`Type`] 
| Types of values.
|===

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

=== Types

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/report/Located.adoc[`Located`] 
| Parameter type that adds a source location to a value.
| xref:clang/mrdocs/report/Results.adoc[`Results`] 
| Provides statistics on the number of reported messages.
|===

=== Enums

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/report/Level.adoc[`Level`] 
| Severity levels attached to reported messags.
|===

=== Functions

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/report/debug.adoc[`debug`] 
| Report a message to the console.
| xref:clang/mrdocs/report/error.adoc[`error`] 
| Report a message to the console.
| xref:clang/mrdocs/report/fatal.adoc[`fatal`] 
| Report a message to the console.
| xref:clang/mrdocs/report/getMinimumLevel.adoc[`getMinimumLevel`] 
| 
| xref:clang/mrdocs/report/info.adoc[`info`] 
| Report a message to the console.
| xref:clang/mrdocs/report/log.adoc[`log`] 
| Format a message to the console.
| xref:clang/mrdocs/report/print-06.adoc[`print`] 
| Report a message to the console.
| xref:clang/mrdocs/report/setMinimumLevel.adoc[`setMinimumLevel`] 
| Set the minimum threshold level for reporting.
| xref:clang/mrdocs/report/setSourceLocationWarnings.adoc[`setSourceLocationWarnings`] 
| If true, source location information will be printed with warnings, errors, and fatal messages.
| xref:clang/mrdocs/report/trace.adoc[`trace`] 
| Report a message to the console.
| xref:clang/mrdocs/report/warn.adoc[`warn`] 
| Report a message to the console.
|===

=== Variables

[cols=2]
|===
| Name
| Description
| xref:clang/mrdocs/report/results.adoc[`results`] 
| Holds current statistics on reported messages.
|===


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