Namespaces

Name

Description

doc

Javadoc related types and functions.

dom

Objects representing JSON‐like values.

files

helpers

js

lua

report

Types

Name

Description

AnyFileVisitor

ArrayTypeInfo

AutoTypeInfo

BadExpectedAccess

BadExpectedAccess<void>

BaseInfo

Metadata for a direct base.

ConceptInfo

Info for concepts.

Config

Configuration used to generate the Corpus and Docs

ConstantExprInfo

Represents an expression with a (possibly known) value

Corpus

The collection of declarations in extracted form.

DecltypeTypeInfo

DefaultEmptyPredicate

The default empty predicate.

DomCorpus

Front‐end factory for producing Dom nodes.

EnumConstantInfo

Info for enum constants.

EnumInfo

Error

Holds the description of an error, or success.

Exception

Type of all exceptions thrown by the API.

ExecutorGroup

A set of execution agents for performing concurrent work.

ExecutorGroupBase

Expected

A container holding an error or a value.

Expected<T, E>

ExplicitInfo

ExprInfo

Represents an expression

FormatString

A format string with source location.

FriendInfo

Info for friend declarations.

FunctionInfo

FunctionTypeInfo

Generator

Base class for documentation generators.

Generators

A dynamic list of Generator

GlobPattern

A glob pattern matcher

GuideInfo

Info for deduction guides.

Handlebars

A handlebars environment

HandlebarsError

An error thrown or returned by Handlebars

HandlebarsOptions

Options for handlebars

Info

Base class with common properties of all symbols

InfoCommonBase

Base class for providing variant discriminator functions.

IsTArg

Javadoc

A processed Doxygen‐style comment attached to a declaration.

LValueReferenceTypeInfo

Location

LocationEmptyPredicate

MemberPointerTypeInfo

NameInfo

Represents a name for a named TypeInfo

NamedTypeInfo

NamespaceAliasInfo

Info for namespace aliases.

NamespaceInfo

Describes a namespace.

NamespaceTranche

The members of a Namespace

NoexceptInfo

NonTypeTArg

NonTypeTParam

Optional

A compact optional.

OutputRef

Reference to output stream used by handlebars

OverloadsInfo

Represents a set of function overloads.

Param

Represents a single function parameter

ParseResult

The result of a parse operation.

PathGlobPattern

A glob pattern matcher for paths

PointerTypeInfo

Polymorphic

A polymorphic value‐type.

RValueReferenceTypeInfo

RangeFor

Range to help range‐for loops identify first and last.

RecordInfo

Metadata for struct, class, or union.

RecordInterface

The aggregated interface for a given struct, class, or union.

RecordTranche

A group of members that have the same access specifier.

ReferenceDirectories

Reference directories used to resolve paths

ScopeExit

ScopeExitRestore

SourceInfo

Stores source information for a declaration.

SourceLocation

A source location with filename prettification.

SpecializationNameInfo

Represents a (possibly qualified) symbol name with template arguments.

StringHash

SymbolGlobPattern

A glob pattern matcher for C++ symbols

SymbolID

A unique identifier for a symbol.

TArg

TParam

TParamCommonBase

TaskGroup

A subset of possible work in a thread pool.

TemplateInfo

Information pertaining to templates and specializations thereof.

TemplateTArg

TemplateTParam

ThreadPool

A pool of threads for executing work concurrently.

TypeInfo

A possibly qualified type.

TypeInfoCommonBase

TypeTArg

TypeTParam

TypedefInfo

Unexpected

UsingInfo

Info for using declarations.

VariableInfo

A variable.

Visitor

A visitor for a type

add_const_from

add_cv_from

add_cvref_from

add_lvalue_reference_from

add_reference_from

add_rvalue_reference_from

add_volatile_from

any_callable

A movable, type‐erased function object.

any_callable<R(Args...)>

make_dependent

unexpect_t

unlock_guard

A scoped guard which unlocks a mutex.

OptionalLocation

Like std::optional<Location>

UnorderedStringMap

UnorderedStringMultiMap

add_const_from_t

add_cv_from_t

add_cvref_from_t

add_lvalue_reference_from_t

add_reference_from_t

add_rvalue_reference_from_t

add_volatile_from_t

make_dependent_t

Enums

Name

Description

AccessKind

Access specifier.

AutoKind

The kind of auto keyword used in a declaration.

ConstexprKind

constexpr/`consteval` specifier kinds

ExplicitKind

Explicit specifier kinds

ExtractionMode

Determine why a symbol is extracted

FileKind

FunctionClass

Function classifications

FundamentalTypeKind

Categorically describes a fundamental type.

InfoKind

Info variant discriminator

NameKind

NoexceptKind

Exception specification kinds

OperatorKind

Operator kinds

QualifierKind

Type qualifiers

RecordKeyKind

The kind of record: struct, class, or union.

ReferenceKind

Reference type kinds

StorageClassKind

Storage class kinds

TArgKind

The kind of template argument.

TParamKeyKind

The keyword a template parameter was declared with

TParamKind

TemplateSpecKind

The kind of template or specialization.

TypeKind

UsingClass

The class of using declaration.

Functions

Name

Description

CompareDerived

Compares two polymorphic objects that have visit functions

HTMLEscape

HTMLEscape overloads

addMember

allMembers

assert_failed

canMerge

compareSymbolNames

Return the result of comparing s0 to s1.

contains

Determine if a range contains a specific element.

contains_any

Determine if a range contains any of the specified elements.

contains_n

Determine if a range contains at least N instances of the specified element.

contains_n_any

Determine if a range contains at least N instances of any of the specified elements.

countInfoKind

createFrame

Create child data objects.

endsWithOneOf

Determine if a string ends with one of the specified characters

escapeExpression

find_last_of

Find the last element in a range that matches an element in the specified range.

forEachFile

forEachFile overloads

formatError

Return a formatted error.

fromString

Convert a string to a FundamentalTypeKind.

getDefaultAccessString

getGenerators

Return a reference to the global Generators instance.

getOperatorKind

Return the short name of an operator as a string.

getOperatorKindFromSuffix

Return the short name of an operator as a string.

getOperatorName

Return the name of an operator as a string.

getOperatorReadableName

Return the human‐readable name of the operator

getParents

Return a list of the parent symbols of the specified Info.

getPrimaryLocation

getSafeOperatorName

Return the safe name of an operator as a string.

getShortOperatorName

Return the short name of an operator as a string.

getSinglePageFullPath

Return the full path for single page output.

innerType

Return the inner type.

innerTypePtr

Return the inner type.

innermostType

Return the innermost type.

isAlphaNumeric

isAlphabetic

isBinaryOperator

Determines whether the operator is potentially binary.

isDigit

isEmpty

Determine if a value is empty

isLowerCase

isUnaryOperator

Determines whether the operator is potentially unary.

isUpperCase

isWhitespace

Determine if a string is only whitespace.

is_one_of

Determine if an element is equal to any of the elements in the specified range.

leastSpecific

Compare ExtractionModes and returns the least specific

ltrim

ltrim overloads

makeChar

Apply the "char" specifier to the type

makeLong

Apply the "long" specifier to the type

makeShort

Apply the "short" specifier to the type

makeSigned

Apply the "signed" specifier to the type

makeUnsigned

Apply the "unsigned" specifier to the type

makeVisitor

Make a visitor for a base type

merge

merge overloads

mostSpecific

Compare ExtractionModes and returns the most specific

overrides

Determine if one function would override the other

parse

Parse a string view

replace

Return the substring without leading and trailing horizontal whitespace.

rtrim

rtrim overloads

safeString

Create a wrapper for a safe string.

startsWithOneOf

Determine if a string starts with one of the specified characters

swap

tag_invoke

tag_invoke overloads

toBase16Str

Convert a SymbolID to a string

toCamelCase

toKebabCase

toLowerCase

toPascalCase

toSnakeCase

toString

toString overloads

toUpperCase

to_underlying

Return the value as its underlying type.

trim

trim overloads

visit

Invoke a function object with a type derived from Info

operator<<

Write to output

operator==

Equality operators

operator<=>

Three‐way comparison operators

Variables

Name

unexpect

Concepts

Name

Description

HasParse

Concept to determine if there's a parse function for a type.

InfoParent

A concept for types that have Info members.

dereferenceable

Determine if a type is dereferenceable

pair_like

Concept to check if a type is pair‐like

polymorphic_storage_for

Concept to check if a type is representing a polymorphic storage

range_of

Concept to check if a type is a range of T

range_of_tuple_like

Concept to check if a range is a range of tuple‐like elements

tuple_like

Concept to check if a type is tuple‐like

Deduction Guides

Using Declarations

Name

source_location

Created with MrDocs