[#clang-mrdocs] = xref:clang.adoc[clang]::mrdocs :relfileprefix: ../ :mrdocs: == 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`] |=== [.small]#Created with https://www.mrdocs.com[MrDocs]#