A block for side-notes like tips, warnings, notes This paragraph represents an admonition, such as a note, tip, important, caution, or warning. isEmpty ltrim ltrim rtrim rtrim trim trim Construct from AdmonitionKind The object to construct from Equality operator true if the objects are equal, false otherwise The right operand Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Optional title for the admonition The kind of admonition This is typically a string in other implementations. A piece of block content The top level is a list of blocks. There are two types of blocks: headings and paragraphs. isEmpty ltrim rtrim trim Destructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Default constructor Construct from BlockKind The object to construct from ltrim rtrim trim Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand The brief description getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Default constructor Copy constructor The object to copy construct from Copy assignment operator Reference to the current object The object to copy assign from Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand Preformatted source code. isEmpty ltrim rtrim trim Default constructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Fence info string, e.g. "cpp" A piece of styled text. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand Documentation copied from another symbol. getAsPlainText getAsPlainText Construct from string The object to construct from Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand isEmpty ltrim rtrim trim Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand An item in a definition list ltrim rtrim trim Equality operator true if the objects are equal, false otherwise The right operand Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A piece of styled text. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand Preformatted source code. isEmpty ltrim ltrim rtrim rtrim trim trim Default constructor Equality operator true if the objects are equal, false otherwise The right operand Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A reference to a symbol. In markdown, this is represented as " [ ]". getAsPlainText getAsPlainText Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A manually specified section heading. getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A piece of highlighted text. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand An image. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A Node containing a string of text. There will be no newlines in the text. Otherwise, this would be represented as multiple text nodes within a Paragraph node. getAsPlainText getAsPlainText Destructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Default constructor Construct from InlineKind The object to construct from An internal node in the inline element tree getAsPlainText getAsPlainText ltrim rtrim trim Default constructor Copy constructor The object to copy construct from Move constructor The object to move construct from Construct an InlineContainer with a single TextInline child. The object to construct from Construct an InlineContainer with a single TextInline child. The object to copy construct from Construct an InlineContainer with a single TextInline child. The object to move construct from Construct an InlineContainer with a single TextInline child. The value to construct from Destructor Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Compare two InlineContainers. The relative order of the objects The right operand A leaf node that stores a string of text. Construct from string_view The object to construct from Construct from string The object to copy construct from Construct from string The object to move construct from Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand A hard line break that renders as " " getAsPlainText getAsPlainText Default constructor Destructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A hyperlink. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Default constructor Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A list of list items isEmpty ltrim rtrim trim Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand An item in a list ltrim rtrim trim Equality operator true if the objects are equal, false otherwise The right operand Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A block of LaTeX math A block of LaTeX math, typically between $\dots$ or fenced with "math". isEmpty ltrim rtrim trim Copy constructor The object to copy construct from Copy assignment operator Reference to the current object The object to copy assign from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Raw TeX math source An inline LaTeX math expression Inline LaTeX math, typically between $\dots$ . getAsPlainText getAsPlainText Default constructor Construct from string The object to construct from Destructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A sequence of text nodes. getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Default constructor Destructor Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand Documentation for a function parameter getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Construct from InlineContainer The object to copy construct from Construct from InlineContainer The object to move construct from Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A list of list items isEmpty ltrim ltrim rtrim rtrim trim trim Equality operator true if the objects are equal, false otherwise The right operand Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A reference to a symbol. getAsPlainText getAsPlainText Construct from string The object to construct from Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Documentation for a function return type getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Copy constructor The object to copy construct from Move constructor The object to move construct from Construct from InlineContainer The object to copy construct from Construct from InlineContainer The object to move construct from Destructor Copy assignment operator Reference to the current object The object to copy assign from Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A paragraph getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A line break that may render as space getAsPlainText getAsPlainText Default constructor Destructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A piece of styled text. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A piece of styled text. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A piece of styled text. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A piece of styled text. getAsPlainText getAsPlainText getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand Documentation for a template parameter getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand A table block isEmpty ltrim rtrim trim Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A cell in a table getAsPlainText getAsPlainText ltrim rtrim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand An item in a list Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand A Node containing a string of text. There will be no newlines in the text. Otherwise, this would be represented as multiple text nodes within a Paragraph node. getAsPlainText getAsPlainText Default constructor Construct from string_view The object to construct from Construct from string The object to copy construct from Construct from string The object to move construct from Construct from char The value to construct from Destructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The brief description isEmpty ltrim rtrim trim Copy constructor The object to copy construct from Copy assignment operator Reference to the current object The object to copy assign from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Documentation for a function parameter getAsPlainText getAsPlainText isEmpty ltrim ltrim rtrim rtrim trim trim Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Assign an InlineContainer with a single TextInline child. Reference to the current object The object to assign from Append a TextInline child. An internal node in the inline element tree Helper function so that derived classes can get a reference to the base class. An internal node in the inline element tree An internal node in the inline element tree Get the last inline child. the last inline child. Get the last inline child. the last inline child. Begin iterator forwarding to children Clear all inline children. Determine if there are no inline children. if there are no inline children. End iterator forwarding to children Erase from children Get the first inline child. the first inline child. Get the first inline child. the first inline child. Erase from children Append a TextInline child. Reference to the current object The right operand Get the number of inline children. the number of inline children. Equality operator true if the objects are equal, false otherwise The right operand Compare two InlineContainers. true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Compare two InlineContainers. The relative order of the objects The right operand An admonishment style. toString No admonishment A general note A tip to the reader Something important A caution admonishment A warning admonishment Parameter pass direction. toString No direction specified Parameter is passed Parameter is passed back to the caller Parameter is passed and passed back to the caller Which parts of the documentation to copy. `all`: copy the brief and the description. `brief`: only copy the brief. `description`: only copy the description. toString Copy the brief and the description Copy the brief Copy the description Get the plain text representation of an inline element tree. This strips all formatting and returns just the text content. The flattened plain text. The input inline element. CodeInline CopyDetailsInline EmphInline FootnoteReferenceInline HighlightInline ImageInline Inline InlineCommonBase LineBreakInline LinkInline MathInline ReferenceInline SoftBreakInline StrikethroughInline StrongInline SubscriptInline SuperscriptInline TextInline Flatten an InlineContainer to plain text. This concatenates all text nodes, ignoring formatting. The flattened plain text. The InlineContainer to flatten. BriefBlock CodeInline EmphInline HeadingBlock HighlightInline ImageInline InlineContainer LinkInline ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock ReturnsBlock SeeBlock StrikethroughInline StrongInline SubscriptInline SuperscriptInline TParamBlock TableCell ThrowsBlock Get the plain text representation of an inline element tree. This strips all formatting and returns just the text content. the plain text representation of an inline element tree. The input inline element. The output string to append to. CodeInline CopyDetailsInline EmphInline FootnoteReferenceInline HighlightInline ImageInline Inline InlineCommonBase LineBreakInline LinkInline MathInline ReferenceInline SoftBreakInline StrikethroughInline StrongInline SubscriptInline SuperscriptInline TextInline Flatten an InlineContainer to plain text. This concatenates all text nodes, ignoring formatting. The InlineContainer to flatten. The output string to append to. BriefBlock CodeInline EmphInline HeadingBlock HighlightInline ImageInline InlineContainer LinkInline ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock ReturnsBlock SeeBlock StrikethroughInline StrongInline SubscriptInline SuperscriptInline TParamBlock TableCell ThrowsBlock Determine if the inline is empty if the inline is empty A piece of block content AdmonitionBlock Block BlockCommonBase BriefBlock CodeBlock DefinitionListBlock FootnoteDefinitionBlock HeadingBlock ListBlock MathBlock ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock QuoteBlock ReturnsBlock SeeBlock TParamBlock TableBlock ThematicBreakBlock ThrowsBlock Determine if the inline is empty if the inline is empty A polymorphic value-type. Polymorphic Determine if the inline is empty This determines if the inline is considered to have no content for the purposes of trimming. if the inline is empty A polymorphic value-type. Polymorphic Removes leading whitespace from the block. void The Block to trim. AdmonitionBlock Block BlockCommonBase BriefBlock CodeBlock DefinitionListBlock FootnoteDefinitionBlock HeadingBlock ListBlock MathBlock ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock QuoteBlock ReturnsBlock SeeBlock TParamBlock TableBlock ThematicBreakBlock ThrowsBlock Removes leading whitespace from the first text elements void The BlockContainer to trim. AdmonitionBlock BlockContainer DefinitionListItem FootnoteDefinitionBlock ListItem QuoteBlock Removes leading whitespace from the first text element in the given InlineContainer. void The InlineContainer to trim. BriefBlock CodeInline EmphInline HeadingBlock HighlightInline ImageInline InlineContainer LinkInline ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock ReturnsBlock SeeBlock StrikethroughInline StrongInline SubscriptInline SuperscriptInline TParamBlock TableCell ThrowsBlock Removes leading whitespace from the block. void The Polymorphic<Block> to trim. Polymorphic Removes leading whitespace from the inline element. void The Polymorphic<Inline> to trim. Polymorphic Removes trailing whitespace from the block. void The Block to trim. AdmonitionBlock Block BlockCommonBase BriefBlock CodeBlock DefinitionListBlock FootnoteDefinitionBlock HeadingBlock ListBlock MathBlock ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock QuoteBlock ReturnsBlock SeeBlock TParamBlock TableBlock ThematicBreakBlock ThrowsBlock Removes trailing whitespace from the last text elements void The BlockContainer to trim. AdmonitionBlock BlockContainer DefinitionListItem FootnoteDefinitionBlock ListItem QuoteBlock Removes trailing whitespace from the last text element in the given InlineContainer. void The InlineContainer to trim. BriefBlock CodeInline EmphInline HeadingBlock HighlightInline ImageInline InlineContainer LinkInline ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock ReturnsBlock SeeBlock StrikethroughInline StrongInline SubscriptInline SuperscriptInline TParamBlock TableCell ThrowsBlock Removes trailing whitespace from the block. void The Polymorphic<Block> to trim. Polymorphic Removes trailing whitespace from the inline element. void The Polymorphic<Inline> to trim. Polymorphic Return the Admonish from a dom::Value string. A variant container for any kind of Dom value. An admonishment style. ValueFromTag Return the ParamDirection from a dom::Value string. A variant container for any kind of Dom value. Parameter pass direction. ValueFromTag Return the Parts from a dom::Value string. A variant container for any kind of Dom value. Which parts of the documentation to copy. ValueFromTag Return the Admonition as a dom::Value object. A variant container for any kind of Dom value. A block for side-notes like tips, warnings, notes Front-end factory for producing Dom nodes. ValueFromTag Return the Block as a dom::Value object. A variant container for any kind of Dom value. A piece of block content Front-end factory for producing Dom nodes. ValueFromTag Return the Brief as a dom::Value object. A variant container for any kind of Dom value. The brief description Front-end factory for producing Dom nodes. ValueFromTag Return the Code as a dom::Value object. A variant container for any kind of Dom value. Preformatted source code. Front-end factory for producing Dom nodes. ValueFromTag Return the Code as a dom::Value object. A variant container for any kind of Dom value. A piece of styled text. Front-end factory for producing Dom nodes. ValueFromTag Return the CopyDetails as a dom::Value object. The output value. The input object. The DOM corpus, or nullptr if not part of a corpus. ValueFromTag Return the DefinitionListItem as a dom::Value object. A variant container for any kind of Dom value. An item in a definition list Front-end factory for producing Dom nodes. ValueFromTag Return the Emph as a dom::Value object. A variant container for any kind of Dom value. A piece of styled text. Front-end factory for producing Dom nodes. ValueFromTag Return the FootnoteDefinition as a dom::Value object. A variant container for any kind of Dom value. Preformatted source code. Front-end factory for producing Dom nodes. ValueFromTag Return the FootnoteReference as a dom::Value object. A variant container for any kind of Dom value. A reference to a symbol. Front-end factory for producing Dom nodes. ValueFromTag Return the Heading as a dom::Value object. A variant container for any kind of Dom value. A manually specified section heading. Front-end factory for producing Dom nodes. ValueFromTag Return the Highlight as a dom::Value object. A variant container for any kind of Dom value. A piece of highlighted text. Front-end factory for producing Dom nodes. ValueFromTag Return the Image as a dom::Value object. A variant container for any kind of Dom value. An image. Front-end factory for producing Dom nodes. ValueFromTag Return the Inline as a dom::Value object. A variant container for any kind of Dom value. A Node containing a string of text. Front-end factory for producing Dom nodes. ValueFromTag Return the LineBreak as a dom::Value object. A variant container for any kind of Dom value. A hard line break that renders as " " Front-end factory for producing Dom nodes. ValueFromTag Return the Link as a dom::Value object. A variant container for any kind of Dom value. A hyperlink. Front-end factory for producing Dom nodes. ValueFromTag Return the UnorderedList as a dom::Value object. A variant container for any kind of Dom value. A list of list items Front-end factory for producing Dom nodes. ValueFromTag Return the ListItem as a dom::Value object. A variant container for any kind of Dom value. An item in a list Front-end factory for producing Dom nodes. ValueFromTag Return the Brief as a dom::Value object. A variant container for any kind of Dom value. A block of LaTeX math Front-end factory for producing Dom nodes. ValueFromTag Return the Math as a dom::Value object. A variant container for any kind of Dom value. An inline LaTeX math expression Front-end factory for producing Dom nodes. ValueFromTag Return the Paragraph as a dom::Value object. A variant container for any kind of Dom value. A sequence of text nodes. Front-end factory for producing Dom nodes. ValueFromTag Return the Param as a dom::Value object. A variant container for any kind of Dom value. Documentation for a function parameter Front-end factory for producing Dom nodes. ValueFromTag Return the Postcondition as a dom::Value object. The value to assign to. The input object. The DOM corpus, or nullptr if not part of a corpus. ValueFromTag Return the Precondition as a dom::Value object. The value to assign to. The input object. The DOM corpus, or nullptr if not part of a corpus. ValueFromTag Return the QuoteBlock as a dom::Value object. A variant container for any kind of Dom value. A list of list items Front-end factory for producing Dom nodes. ValueFromTag Return the Reference as a dom::Value object. A variant container for any kind of Dom value. A reference to a symbol. Front-end factory for producing Dom nodes. ValueFromTag Return the Returns as a dom::Value object. A variant container for any kind of Dom value. Documentation for a function return type Front-end factory for producing Dom nodes. ValueFromTag Return the See as a dom::Value object. A variant container for any kind of Dom value. A Front-end factory for producing Dom nodes. ValueFromTag Return the SoftBreak as a dom::Value object. A variant container for any kind of Dom value. A line break that may render as space Front-end factory for producing Dom nodes. ValueFromTag Return the Strikethrough as a dom::Value object. A variant container for any kind of Dom value. A piece of styled text. Front-end factory for producing Dom nodes. ValueFromTag Return the Strong as a dom::Value object. A variant container for any kind of Dom value. A piece of styled text. Front-end factory for producing Dom nodes. ValueFromTag Return the Subscript as a dom::Value object. A variant container for any kind of Dom value. A piece of styled text. Front-end factory for producing Dom nodes. ValueFromTag Return the Superscript as a dom::Value object. A variant container for any kind of Dom value. A piece of styled text. Front-end factory for producing Dom nodes. ValueFromTag Return the TParam as a dom::Value object. A variant container for any kind of Dom value. Documentation for a template parameter Front-end factory for producing Dom nodes. ValueFromTag Return the UnorderedTable as a dom::Value object. A variant container for any kind of Dom value. A table block Front-end factory for producing Dom nodes. ValueFromTag Return the TableCell as a dom::Value object. A variant container for any kind of Dom value. A cell in a table Front-end factory for producing Dom nodes. ValueFromTag Return the TableRow as a dom::Value object. A variant container for any kind of Dom value. An item in a list Front-end factory for producing Dom nodes. ValueFromTag Return the Text as a dom::Value object. A variant container for any kind of Dom value. A Node containing a string of text. Front-end factory for producing Dom nodes. ValueFromTag Return the Brief as a dom::Value object. A variant container for any kind of Dom value. The brief description Front-end factory for producing Dom nodes. ValueFromTag Return the Throws as a dom::Value object. A variant container for any kind of Dom value. Documentation for a function parameter Front-end factory for producing Dom nodes. ValueFromTag Map the Polymorphic Block as a dom::Value object. The output parameter to receive the dom::Value. The polymorphic Block to convert. The DomCorpus used to resolve references. A variant container for any kind of Dom value. ValueFromTag Return the name of the Admonish as a string. the name of the Admonish as a string. An admonishment style. AdmonitionKind String Return the name of the ParamDirection as a string. the name of the ParamDirection as a string. Parameter pass direction. ParamDirection String Return the name of the Parts as a string. the name of the Parts as a string. Which parts of the documentation to copy. Parts String Removes leading and trailing whitespace from the block. void The Block to trim. AdmonitionBlock Block BlockCommonBase BriefBlock CodeBlock DefinitionListBlock FootnoteDefinitionBlock HeadingBlock ListBlock MathBlock ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock QuoteBlock ReturnsBlock SeeBlock TParamBlock TableBlock ThematicBreakBlock ThrowsBlock Removes leading and trailing whitespace from the text elements void The BlockContainer to trim. AdmonitionBlock BlockContainer DefinitionListItem FootnoteDefinitionBlock ListItem QuoteBlock Removes leading and trailing whitespace from the text elements in the given InlineContainer. void The InlineContainer to trim. BriefBlock CodeInline EmphInline HeadingBlock HighlightInline ImageInline InlineContainer LinkInline ParagraphBlock ParamBlock PostconditionBlock PreconditionBlock ReturnsBlock SeeBlock StrikethroughInline StrongInline SubscriptInline SuperscriptInline TParamBlock TableCell ThrowsBlock Removes leading and trailing whitespace from the block. void The Polymorphic<Block> to trim. Polymorphic Removes leading and trailing whitespace from the inline element. void The Polymorphic<Inline> to trim. Polymorphic Equality operator true if the objects are equal, false otherwise The left operand The right operand Polymorphic Equality operator true if the objects are equal, false otherwise The left operand The right operand Polymorphic Three-way comparison operator The relative order of the objects The left operand The right operand Polymorphic Three-way comparison operator The relative order of the objects The left operand The right operand Polymorphic Objects representing JSON-like values. This class is a variant-like container for holding any kind of value that can be represented in JSON, with extensions for functions and "safe strings". The class supports the following types: - Undefined - Null - Boolean - Integer - String - SafeString - Array - Object - Function The class provides type-safe accessors for each type, as well as methods to check the type of the contained value. Example: {.cpp} dom::Value v1 = 42; // Integer dom::Value v2 = "Hello, World!"; // String dom::Value v3 = dom::Array{v1, v2}; // Array if (v1.isInteger()) { std::cout << "v1 is an integer: " << v1.getInteger() << "\n"; } if (v2.isString()) { std::cout << "v2 is a string: " << v2.getString() << "\n"; } if (v3.isArray()) { std::cout << "v3 is an array with " << v3.getArray().size() << " elements.\n"; } Stringify a value as JSON This function serialized a Value to a string as if JSON.stringify() had been called on it. Recursive objects are identified. A string containing valid JSON. The value to stringify. Value An array of values Arrays are a collection of indexed values. They are an extension of objects with a particular relationship between integer-keyed properties and some abstract length-property. Besides, they include convenient methods to manipulate these ordered sequences of values. LazyArray LazyArray TransformArray ::mrdocs::getParents ::mrdocs::helpers::and_fn ::mrdocs::helpers::eq_fn ::mrdocs::helpers::ne_fn ::mrdocs::helpers::not_fn ::mrdocs::helpers::or_fn A constant iterator referencing an element in an Array. A pointer to an element. A reference to an element. This is a read-only reference to an element. A signed integral type. The implementation type. A pointer to an element. A reference to an element. This is a read-only reference to an element. An unsigned integral type used for indexes and sizes. The type of storage used by the default implementation. The type of an element. A constant iterator referencing an element in an Array. Constructor. Default-constructed arrays refer to a new, empty array which is distinct from every other empty array. Constructor. The newly constructed array will contain copies of the scalars in other, and references to its structured data. The object to copy construct from Constructor. Ownership of the contents is transferred to the new object. The moved-from array will behave as if default-constructed. The object to move construct from Constructor. This constructs an array from an existing implementation, with shared ownership. The pointer cannot not be null. The object to construct from Constructor. Upon construction, the array will retain ownership of a shallow copy of the specified elements. In particular, dynamic objects will be acquired with shared ownership. The elements to acquire. Destructor. Assignment. This acquires shared ownership of the copied array, and ownership of the previous contents is released. Reference to the current object The object to copy assign from Assignment. Ownership of the array is transferred to this, and ownership of the previous contents is released. The moved-from array behaves as if default constructed. Reference to the current object The object to move assign from Return the i-th element. the i-th element. An unsigned integral type used for indexes and sizes. i >= size() Return the last element. the last element. empty() Return an iterator to the beginning of the range of elements. an iterator to the beginning of the range of elements. Return true if the array is empty. true if the array is empty. Return an iterator to the end of the range of elements. an iterator to the end of the range of elements. Return the first element. the first element. empty() Return the i-th element, without bounds checking. the i-th element, without bounds checking. The zero-based index of the element. Return the implementation used by this object. the implementation used by this object. Append an element to the end of the array. If the array is read-only, an exception is thrown. The type of an element. Set the i-th element, without bounds checking. The zero-based index of the element. The value to set. Return the number of elements in the array. the number of elements in the array. Swap two arrays. An array of values Return the type key of the implementation. the type key of the implementation. Abstract array interface. This interface is used by Array types. An unsigned integral type used for indexes and sizes. The type of an element. Destructor. Append an element to the end of the array. The default implementation throws an exception, making the array effectively read-only. The type of an element. Return the i-th element, without bounds checking. the i-th element, without bounds checking. An unsigned integral type used for indexes and sizes. Set the i-th element, without bounds checking. Return the number of elements in the array. the number of elements in the array. Return the type key of the implementation. the type key of the implementation. The default array implementation. This implementation is backed by a simple vector and allows appending. An unsigned integral type used for indexes and sizes. The type of storage used by the default implementation. The type of an element. Default constructor Construct from storage_type The object to construct from Set the i-th element, without bounds checking. The default Object implementation. A reference to an element. This is a read-only reference to an element. The type of storage used by the default implementation. Default constructor Construct from storage_type The object to construct from Return the value for the specified key, or null. The value for the specified key, or null if the key does not exist. The key. Insert or set the given key/value pair. The key. The value to set. Return the type key of the implementation. the type key of the implementation. Invoke the visitor for each key/value pair. The visitor function must return true to continue iteration, or false to stop. The visit function returns true if the visitor returned true for all elements, otherwise false . true if the visitor returned true for all elements, otherwise false . The visitor function. Constructor. A default-constructed function has this equivalent implementation: Value f() { return nullptr; } Constructor. The newly constructed object acquires shared ownership of the function. The object to copy construct from Constructor. Ownership of the function is tranferred. The moved-from object behaves as if default constructed. The object to move construct from Destructor. Assignment. This acquires shared ownership of the function. Ownership of the previous function is removed. Reference to the current object The object to copy assign from Assignment. Ownership of the function is tranferred, and ownership of the previous function is released. The moved-from object behaves as if default constructed. Reference to the current object The object to move assign from Invoke the function. A container holding an error or a value. An array of values Return the implementation used by this object. the implementation used by this object. Swap two objects. The other object. Return the type key. the type key. Destructor. Invoke the function. A container holding an error or a value. An array of values Return the type key of the implementation. the type key of the implementation. Lazy array implementation This array type is used to define a dom::Array whose members are evaluated on demand as they are accessed. Each member can goes through a transform function before being returned as a Value so that all types can be converted to dom::Value. The underlying representation of the array is a range from where the elements are extracted. Elements in this range should be convertible to dom::Value. This class is typically useful for implementing arrays that are expensive and have recursive dependencies, as these recursive dependencies can also be deferred. Unlike a LazyObjectImpl, which contains an overlay object, this implementation is read-only. The set and emplace_back methods are not implemented. An unsigned integral type used for indexes and sizes. The type of an element. Construct from R The object to copy construct from Destructor Append an element to the end of the array. The default implementation throws an exception, making the array effectively read-only. The type of an element. Return the i-th element, without bounds checking. the i-th element, without bounds checking. An unsigned integral type used for indexes and sizes. Set the i-th element, without bounds checking. Return the type key of the implementation. the type key of the implementation. Lazy object implementation. This interface is used to define objects whose members are evaluated on demand as they are accessed. When any of the object properties are accessed, the object dom::Value is constructed. In practice, the object never takes any memory besides the pointer to the underlying object. The keys and values in the underlying object should be mapped using tag_invoke . This class is typically useful for implementing objects that are expensive and have recursive dependencies, as these recursive dependencies can also be deferred. A context can also be stored in the object as a form to customize how the object is mapped. This context should be copyable and is propagated to other objects that support an overload with the same context. The context can be simply a tag identifying how to map the object, or a more complex object carrying data to customize the mapping process. In the latter case, because the context should be a copyable, the user might want to use a type with reference semantics. A reference to an element. This is a read-only reference to an element. The type of storage used by the default implementation. Construct from T The object to copy construct from Destructor Determine if a key exists. true if the key exists, otherwise false . The key to check for existence. Return the value for the specified key, or null. The value for the specified key, or null if the key does not exist. The key. Insert or set the given key/value pair. The key. The value to set. Return the number of properties in the object. the number of properties in the object. Return the type key of the implementation. the type key of the implementation. Invoke the visitor for each key/value pair. The visitor function must return true to continue iteration, or false to stop. The visit function returns true if the visitor returned true for all elements, otherwise false . true if the visitor returned true for all elements, otherwise false . The visitor function. Customization point tag. This tag type is used by the class dom::LazyObjectImpl to select overloads of tag_invoke . This type is empty; it has no members. dom::LazyObjectImpl tag_invoke: A general pattern for supporting customisable functions ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke A container of key and value pairs. Objects are a collection of properties, which are equivalent to key-value pairs. Property values can be any type, including other Objects, allowing for the creation of arbitrarily complex data structures. An Object is a non-primitive (or reference) type, meaning that they are not copied when assigned or passed as a parameter. Instead, the reference is copied, and the original value is shared. These reference types are modeled after JavaScript "Objects". All non-primitive types (Object types) are derived from Object in JavaScript. This means types such as Array and Function represent a relevant selection of built-in types that would derive from Object in JavaScript. Properties Objects are a collection of properties, which are equivalent to key-value pairs. There are two kinds of properties: @li Data properties: Associates a key with a value. @li Accessor properties: Associates a key with one of two accessor functions (`get` and `set`), which are used to retrieve or set the value. The internal representation of objects can determine how properties are stored and the type of properties being represented. Properties can also be enumerable or non-enumerable. An enumerable property is one that is iterated by the `visit` function. Non-enumerable properties can only be accessed by name with the `get` and `set` functions. LazyObject LazyObject newObject ::mrdocs::createFrame A pointer to an element. A reference to an element. This is a read-only reference to an element. A signed integral type. The implementation type. A pointer to an element. A reference to an element. This is a read-only reference to an element. An unsigned integral type used for indexes and sizes. The type of storage used by the default implementation. The type of an element. Elements of this container are key and value pairs where the key is a string. This type is a copyable, movable value type. Constructor. Default-constructed objects refer to a new, empty container which is distinct from every other empty container. Constructor. The newly constructed object will contain copies of the scalars in other, and references to its structured data. The object to copy construct from Constructor. Ownership of the contents is transferred to the new object. The moved-from object will behave as if default-constructed. The object to move construct from Constructor. This constructs an object from an existing implementation, with shared ownership. The pointer cannot not be null. The object to construct from Constructor. Upon construction, the object will retain ownership of a shallow copy of the specified list. In particular, dynamic objects will be acquired with shared ownership. The initial list of values. Destructor. Assignment. Shared ownership and copies of elements in others are acquired by this. Ownership of the previous contents is released. Reference to the current object The object to copy assign from Assignment. Ownership of the object is transferred to this, and ownership of the previous contents is released. The moved-from object behaves as if default constructed. Reference to the current object The object to move assign from Return the element at a given index. The value at the specified index, or null if the index is out of range. The index. Return true if the container is empty. true if the container is empty. Return true if a key exists. true if the key exists, otherwise false . The key to check for existence. Return the element with the specified key The value for the specified key, or null if the key does not exist. The key. Return the implementation used by this object. the implementation used by this object. Set or replace the value for a given key. This function inserts a new key or changes the value for the existing key if it is already present. The key. The value to set. Return the number of elements. the number of elements. Swap two objects. A container of key and value pairs. Return the type key. the type key. Abstract object interface. This interface is used by Object types. A reference to an element. This is a read-only reference to an element. The type of storage used by the default implementation. Destructor. Determine if a key exists. true if the key exists, otherwise false . The key to check for existence. Return the value for the specified key, or null. The value for the specified key, or null if the key does not exist. The key. Insert or set the given key/value pair. The key. The value to set. Return the number of properties in the object. the number of properties in the object. Return the type key of the implementation. the type key of the implementation. Invoke the visitor for each key/value pair. The visitor function must return true to continue iteration, or false to stop. The visit function returns true if the visitor returned true for all elements, otherwise false . true if the visitor returned true for all elements, otherwise false . The visitor function. ::mrdocs::toString ::mrdocs::toString ::mrdocs::toString ::mrdocs::doc::toString ::mrdocs::doc::toString ::mrdocs::doc::toString Constructor. Default constructed strings have a zero size, and include a null terminator. Constructor. The newly constructed string acquries shared ownership of the string referenced by other. The object to copy construct from Constructor. Ownership of the string is transferred to the newly constructed string. The moved-from string behaves as if default constructed. The object to move construct from Constructor. This function constructs a new string from the buffer pointed to by sv . The string to construct with. A copy of this string is made. Constructor. This function constructs a new string from the string pointed to by str of length len . The string to construct with. A copy of this string is made. The length of the string. Destructor. Assignment. This acquires shared ownership of the string referenced by other. Ownership of the previously referenced string is released. Reference to the current object The object to copy assign from Assignment. This transfers ownership of the string referenced by other to this. Ownership of the previously referened string is released. After the assignment, the moved-from string behaves as if default constructed. Reference to the current object The object to move assign from Return the string. The pointed-to character buffer returned by this function is always null-terminated. the string. Return the string. The pointed-to character buffer returned by this function is always null-terminated. the string. Return true if the string is empty. true if the string is empty. Return the string. the string. Return the size. the size. Return the string. the string. Swap two strings. The other string. Return the string. the string. A variant container for any kind of Dom value. ValueFrom ValueFrom stringOrNull stringOrNull stringOrNull JSON::stringify ::mrdocs::isEmpty ::mrdocs::helpers::detag_fn ::mrdocs::helpers::increment_fn ::mrdocs::helpers::or_fn ::mrdocs::helpers::relativize_fn ::mrdocs::helpers::select_fn Default constructor Copy constructor The object to copy construct from Move constructor The object to move construct from Construct from Array The object to construct from Construct from Function The object to construct from Construct from Kind The object to construct from Construct from Object The object to construct from Construct from String The object to construct from Construct from int64_t The object to construct from Construct from nullptr_t The object to construct from Construct from storage_type The object to construct from Construct from char The value to construct from Construct from char The value to construct from Destructor Copy assignment operator Reference to the current object The object to copy assign from Move assignment operator Reference to the current object The object to move assign from Return if an Array or Object is empty. if an Array or Object is empty. Return true if a key exists. true if the key exists, otherwise false . The key to check for existence. Return the element at a given index. The value at the specified index, or a Value of type The index. Return the element for a given key. If the Value is not an object, or the key is not found, a Value of type Kind::Undefined is returned. The value for the specified key, or a Value of type Kind::Undefined if the key does not exist. The key. Return the element at a given index or key. the element at a given index or key. A variant container for any kind of Dom value. Return the array. the array. ! isArray() An array of values Return the underlying boolean value. Behaviour is undefined if !isBoolean() the underlying boolean value. Return the function. the function. ! isFunction() Return the underlying integer value. Behaviour is undefined if !isInteger() the underlying integer value. Return the object. the object. ! isObject() Return the underlying string value. Behaviour is undefined if !isString() the underlying string value. Return true if this is an array. true if this is an array. Return true if this is a boolean. true if this is a boolean. Return true if this is a function. true if this is a function. Return true if this is an integer. true if this is an integer. Return true if this is null. true if this is null. Return true if this is an object. true if this is an object. Return true if this is a safe string. true if this is a safe string. Return true if this is a string. true if this is a string. Determine if a value is truthy A value is truthy if it is a boolean and is true, a number and not zero, or an non-empty string, array or object. true if the value is truthy, false otherwise Return true if this is undefined. true if this is undefined. Return the type of value contained. the type of value contained. Lookup a sequence of keys. This function is equivalent to calling get multiple times, once for each key in the sequence of dot-separated keys. The value at the end of the sequence, or a Value of type Kind::Undefined if any key is not found. The dot-separated sequence of keys. Set or replace the value for a given key. The key. The value to set. Return if an Array or Object is empty. if an Array or Object is empty. Swap two values. A variant container for any kind of Dom value. Return the type key of the value. the type key of the value. Return the string. the string. Determine if a value is truthy A value is truthy if it is a boolean and is true, a number and not zero, or an non-empty string, array or object. true if the value is truthy, false otherwise Customization point tag. This tag type is used by the function dom::ValueFrom to select overloads of tag_invoke . This type is empty; it has no members. dom::ValueFrom tag_invoke: A general pattern for supporting customisable functions ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke ::mrdocs::doc::tag_invoke The type of data in a Value. This is the type of data stored in a Value. These types are loosely modeled after the JavaScript types and data structures. Primitive values are Undefined, Null, Boolean, Integer, and String. Undefined and Null are inhabited by a single value each. The difference between Undefined and Null is that Undefined is the default value for a Value, while Null represents a value that is explicitly set. Undefined is used to represent things such as: An uninitialized Value The Value returned from a function that failed to return a value The result of accessing a nonexistent object property The result of a `find` algorithm when no element is found This distinction is semantically important as algorithms frequently need to distinguish between these two cases. Booleans, Integers, and Strings are also primitive values. This means they are deeply copied when assigned or passed as a parameter. Other value types, such as Array, Object, and Function are reference types, meaning that they are not copied when assigned or passed as a parameter. Instead, the reference is copied, and the original value is shared. These reference types are modeled after JavaScript "Objects". All non-primitive types (Object types) are derived from Object in JavaScript. This means types such as Array and Function represent a relevant selection of built-in types that would derive from Object in JavaScript. Objects are a collection of properties, which are equivalent to key-value pairs. Property values can be any type, including other Objects, allowing for the creation of arbitrarily complex data structures. https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures The value is undefined. The value is null. The value is a boolean. The value is an integer. The value is a string. The value is a safe string. The value is an array. The value is an object. The value is a function. Return the first dom::Value that is not truthy, or the last one. This function is equivalent to the JavaScript && operator. the first dom::Value that is not truthy, or the last one. The left operand The right operand Concatenate two arrays. An array of values The left operand The right operand Concatenate two strings. The concatenated string. The left-hand side string. The right-hand side string. Add or concatenate two values. A variant container for any kind of Dom value. The left operand The right operand Return the first dom::Value that is truthy, or the last one. This function is equivalent to the JavaScript || operator. the first dom::Value that is truthy, or the last one. The left operand The right operand Return a non-empty string, or a null. a non-empty string, or a null. The string to check. Value Return a non-empty string, or a null. a non-empty string, or a null. The string to check. Optional Value Return a non-empty string, or a null. a non-empty string, or a null. The string to check. Value Swap two arrays. An array of values An array of values Swap two objects. The first object. The second object. Swap two objects. A container of key and value pairs. A container of key and value pairs. Swap two strings. The first string. The second string. Swap two values. A variant container for any kind of Dom value. A variant container for any kind of Dom value. Return a diagnostic string. a diagnostic string. Return a diagnostic string. a diagnostic string. Return value as a string. value as a string. A variant container for any kind of Dom value. Return the result of comparing two strings. the result of comparing two strings. The left operand The right operand Compare two values for equality. This operator uses strict equality, meaning that the types must match exactly, and for objects and arrays the children must match exactly. The == operator behaves differently for objects compared to primitive data types like numbers and strings. When comparing objects using == , it checks for reference equality, not structural equality. This means that two objects are considered equal with === only if they reference the exact same object in memory. In JavaScript, this is equivalent to the === operator, which does not perform type conversions. true if the objects are equal, false otherwise The left operand The right operand Compare two objects for equality. true if the objects are equal, false otherwise The left operand The right operand Compare two arrays for equality. true if the objects are equal, false otherwise The left operand The right operand Return the result of comparing two strings. the result of comparing two strings. The left operand The right operand Return the result of comparing two strings. the result of comparing two strings. The left operand The right operand Compare two values for inequality. The relative order of the objects The left operand The right operand Compare two objects for precedence. The relative order of the objects The left operand The right operand Compare two arrays for precedence. The relative order of the objects The left operand The right operand The type of a file. getFileType The file does not exist The path represents a regular file The file is a directory The file is something else Create a directory. Any missing parent directories will also be created. A container holding an error or a value. The absolute or relative path to create. Expected Determine if a path exists true if the path exists, false otherwise. The absolute or relative path Return the filename part of the path. The filename part of the path, or the empty string if there is none. The absolute or relative path to the directory or file. Return the contents of a file as a string. The contents of the file, or an error if any occurred. The absolute or relative path to the file. Expected Return the file type or an error the file type or an error The absolute or relative path to the file. Expected FileType Return the parent directory. If the parent directory is defined, the returned path will always have a trailing separator. The parent directory, or the empty string if there is none. The absolute or relative path to the directory or file. Return the parent directory. If the parent directory is defined, the returned path will always have a trailing separator. The parent directory, or the empty string if there is none. The absolute or relative path to the directory or file. The number of levels to go up. If this is zero, the original path is returned. If this is greater than the number of levels in the path, the empty string is returned. Return the relevant suffix of a source file path. The suffix, including the leading dot, or the empty string if there is no suffix. The absolute or relative path to the file. Return true if pathName is absolute. true if the path is absolute, false otherwise. The absolute or relative path to the directory or file. Determine if a path is a directory. true if the path exists and is a directory, false otherwise. The absolute or relative path Return true if pathName ends in a separator. true if the path ends in a separator, false otherwise. The absolute or relative path to the directory or file. Determine lexically if a path is a directory. This function determines if a path is a directory. If the path does not exist, the function determines lexically if the path represents a directory. In this case, the function returns true if the last path segment contains a period, otherwise false. true if the path exists and is a directory, or if the path does not exist and the last path segment does not contain a period. false otherwise. The absolute or relative path Check if the path is posix style. true if the path uses only forward slashes as path separators, false otherwise. The absolute or relative path to the directory or file. Return an absolute path from a possibly relative path. Relative paths are resolved against the current working directory of the process. The absolute path, or an error if any occurred. The absolute or relative path to the directory or file. Expected Return an absolute path from a possibly relative path. The absolute path, or an error if any occurred. The absolute or relative path to the directory or file. The working directory to resolve relative paths against. Append a trailing native separator if not already present. A copy of the path with a trailing separator if not already present. The absolute or relative path to the directory or file. Convert all backward slashes to forward slashes. A copy of the path with all backslashes replaced with forward slashes. The absolute or relative path to the directory or file. Return a normalized directory. This function returns a new directory path based on applying the changes defined by normalizePath and makeDirsy . The normalized path. The relative or absolute path. Return a normalized path. This function returns a new path based on applying the following changes to the passed path: "." and ".." are resolved Separators made uniform Separators are replaced with the native separator The normalized path. The relative or absolute path. Return an error if pathName is not absolute. An error if the path is not absolute. The absolute or relative path to the directory or file. Expected Return an error if the path is not a directory. An error if the path does not exist or is not a directory. The absolute or relative path Expected Checks if the given path starts with the specified prefix. This function compares the beginning of the pathName with the prefix . It returns true if pathName starts with prefix . The comparison is case-sensitive. Unlike a direct string comparison, this function also accepts differences in the slashes used to separate paths. Therefore, it returns true even when the slashes used in pathName and prefix are not the same. The function accepts both forward slashes ("/") and backslashes (""). A boolean value. Returns true if pathName starts with prefix , false otherwise. A string view representing the path to be checked. A string view representing the prefix to be checked against the path. Return the filename with a new or different extension. the filename with a new or different extension. The absolute or relative path to the directory or file. The extension to use, without a leading dot. If this is empty and the path contains an extension, then the extension is removed. "and" helper function The "and" helper returns true if all of the values are truthy. True if all of the values are truthy, false otherwise. The values to test Array "detag" helper function The "detag" helper applies the regex expression "< [ ]+>" to the input to remove all HTML tags. A variant container for any kind of Dom value. A variant container for any kind of Dom value. Value "eq" helper function The "eq" helper returns true if all of the values are equal. True if all of the values are equal, false otherwise. The values to compare Array "increment" helper function The "increment" helper adds 1 to the value if it's an integer and converts booleans to true . Other values are returned as-is. A variant container for any kind of Dom value. A variant container for any kind of Dom value. Value "ne" helper function The "ne" helper returns true if any of the values are not equal. True if any of the values are not equal, false otherwise. The values to compare Array "not" helper function The "not" helper returns true if not all of the values are truthy. True if not all of the values are truthy, false otherwise. An array of values Array "or" helper function The "or" helper returns true if any of the values are truthy. A variant container for any kind of Dom value. An array of values Array Value Register all the Antora helpers into a Handlebars instance This function registers all the helpers that are part of the default Antora UI. Individual Antora helpers can also be registered with the public *_fn functions in this namespace. Since the Antora helpers are not mandatory and include many functions not applicable to all applications, this allows the user to register only some of the Antora helpers. The Handlebars instance to register the helpers into https://gitlab.com/antora/antora-ui-default/-/tree/master/src/helpers Handlebars Register all the built-in helpers into a Handlebars instance Individual built-in helpers can also be registered with the public *_fn functions in this namespace. This allows the user to override only some of the built-in helpers. In particular, this is important for mandatory helpers, such as blockHelperMissing and helperMissing . The Handlebars instance to register the helpers into https://github.com/handlebars-lang/handlebars.js/tree/master/lib/handlebars/helpers https://handlebarsjs.com/guide/builtin-helpers.html Handlebars Register contructor helpers into a Handlebars instance This function registers a number of common helpers that allows the user to create objects of specific types directly from literals in the template. The Handlebars instance to register the helpers into Handlebars Register helpers to manipulate composite data types This function registers a number of common helpers that operate on Objects and Arrays. Object and Array helpers are particularly useful because most applications will need to manipulate Objects and Arrays to extract information from them, such as object keys or specific Array items known ahead of time. The helper names are inspired by the default functions provided in multiple programming languages for dictionaries, objects, and arrays, such as Python and JavaScript, for their default types. The individual helpers are defined as an implementation detail and cannot be registered individually. The Handlebars instance to register the helpers into Handlebars Register logical helpers into a Handlebars instance This function registers a number of common helpers that perform logical operations. The Handlebars instance to register the helpers into Handlebars Register math helpers into a Handlebars instance This function registers a number of common helpers that perform mathemathical operations. The Handlebars instance to register the helpers into Handlebars Register string helpers into a Handlebars instance This function registers a number of common helpers that operate on strings. String helpers are particularly useful because most applications will need to manipulate strings for presentation purposes. All helpers can be used as either block helpers or inline helpers. When used as a block helper, the block content is used as the first argument to the helper function. When used as an inline helper, the first argument is the value of the helper. The helper names are inspired by the default string functions provided in multiple programming languages, such as Python and JavaScript, for their default string types. The individual helpers are defined as an implementation detail and cannot be registered individually. The Handlebars instance to register the helpers into Handlebars Register type helpers into a Handlebars instance This function registers a number of common helpers that operate on types, such as identity, type checking, and type conversion. The Handlebars instance to register the helpers into Handlebars "relativize" helper function The "relativize" helper makes the first path relative to the second path. A variant container for any kind of Dom value. A variant container for any kind of Dom value. A variant container for any kind of Dom value. A variant container for any kind of Dom value. Value "select" helper function The "select" helper returns the second argument if the first argument is truthy, and the third argument otherwise. A variant container for any kind of Dom value. A variant container for any kind of Dom value. A variant container for any kind of Dom value. A variant container for any kind of Dom value. Value "year" helper function The "year" helper returns the current year as an integer. The current year as an integer. An instance of a JavaScript interpreter. This class represents a JavaScript interpreter context under which we can create Scope objects to define variables and execute scripts. A context represents a JavaScript heap where variables can be allocated and will be later garbage collected. Each context is associated with a single heap allocated with default memory management. Once the context is created, a Scope in this context can be created to define variables and execute scripts. Scope Constructor. Create a javascript execution context associated with its own garbage-collected heap. Constructor. Create a javascript execution context associated with the heap of another context. Both contexts will share the same garbage-collected heap, which is destroyed when the last context is destroyed. While they share the heap, their scripts can include references to the same variables. There are multi-threading restrictions, however: only one native thread can execute any code within a single heap at any time. The object to copy construct from Destructor. Copy assignment. Create a javascript execution context associated with the heap of another context. Both contexts will share the same garbage-collected heap, which is destroyed when the last context is destroyed. While they share the heap, their scripts can include references to the same variables. There are multi-threading restrictions, however: only one native thread can execute any code within a single heap at any time. Reference to the current object The object to copy assign from Construct from string_view The object to construct from Construct from unsigned int The value to construct from A JavaScript scope This class represents a JavaScript scope under which we can define variables and execute scripts. Each scope is a section of the context heap in the JavaScript interpreter. A javascript variable is defined by creating a Value that is associated with this Scope, i.e., subsection of the context heap. When a scope is destroyed, the heap section is popped and all variables defined in that scope are invalidated. For this reason, two scopes of the same context heap cannot be manipulated at the same time. Constructor. Construct a scope for the given context. Variables defined in this scope will be allocated on top of the specified context heap. When the Scope is destroyed, the variables defined in this scope will be popped from the heap. The context to use. Destructor. All variables defined in this scope are popped from the internal context heap. There should be no Value objects associated with this scope when it is destroyed. Compile a script and push results to stack. Compile ECMAScript source code that defines a function and return the compiled function object. Unlike the script() function, the code is not executed. A compiled function with the specified number of arguments that can be executed is returned. If the function code contains more than one function, the return value is the first function compiled. A function object that can be called. The function object has the number of arguments defined in the code. If the code does not define a function, an error is returned. The JavaScript code to compile. Compile a script and push results to stack. Compile ECMAScript source code and return it as a compiled function object that executes it. Unlike the script() function, the code is not executed. A compiled function that can be executed is returned. The returned function has zero arguments and executes as if we called script() . The script returns an implicit return value equivalent to the last non-empty statement value in the code. A function object that can be called. The function object has zero arguments. The JavaScript code to compile. Compile and run a expression. This function compiles and executes the specified JavaScript code. The script can be used to execute commands or define global variables in the parent context. It evaluates the ECMAScript source code and converts any internal errors to Error . A container holding an error or a value. The JavaScript code to execute. Return a global object if it exists. This function returns a Value that represents a global variable in the parent context. If the variable does not exist, an error is returned. a global object if it exists. The name of the global variable. Return the global object. This function returns a Value that represents the global object in the parent context. The global object is the root of the ECMAScript object hierarchy and is the value returned by the global this expression. If the global object does not exist, an error is returned. the global object. Push a new array to the stack An ECMAScript value. Push a boolean to the stack A Value representing the boolean. The boolean value to push. Push a double to the stack A Value representing the double. The double value to push. Push an integer to the stack A Value representing the integer. The integer value to push. Push a new object to the stack An ECMAScript value. Push a string to the stack A Value representing the string. The string value to push. The string is copied to the internal heap. Compile and run a script. This function compiles and executes the specified JavaScript code. The script can be used to execute commands or define global variables in the parent context. It evaluates the ECMAScript source code and converts any internal errors to Error . A container holding an error or a value. The JavaScript code to execute. Set a global object. The name of the global variable. The value to set. An ECMAScript value. This class represents a value in the JavaScript interpreter. A value is a variable that is defined in a Scope . It can be a primitive type or an object. A Value not associated with a Scope is undefined. The user is responsible for ensuring that the lifetime of a Value does not exceed the lifetime of the Scope that created it. A value can be converted to a DOM value using the getDom function. Scope Type Constructor Construct a value that is not associated with a Scope . The value is undefined. Constructor The function pushes a duplicate of value to the stack and associates the new value the top of the stack. The object to copy construct from Constructor The function associates the existing value with this object. The object to move construct from Destructor If the value is associated with a Scope and it is on top of the stack, it is popped. Also, if there are no other Value references to the Scope , all variables defined in that scope are popped via Scope::reset . Copy assignment. The function pushes a duplicate of value to the stack and associates the new value the top of the stack. Reference to the current object The object to copy assign from Move assignment. The function associates the existing value with this object. Reference to the current object The object to move assign from Invoke a function with variadic arguments. The return value of the method. Zero or more arguments to pass to the method. Return if an Array or Object is empty. if an Array or Object is empty. Return true if a key exists. true if the key exists, false otherwise. The key to check for. Return the element at a given index. The element at the given index, or a Value of type Kind::Undefined if the index is out of range. The index of the element to return. Return the element for a given key. If the Value is not an object, or the key is not found, a Value of type Kind::Undefined is returned. The element for the given key, or a Value of type Kind::Undefined if the key is not found. The key to look up. Return the element at a given index or key. the element at a given index or key. A variant container for any kind of Dom value. Return the underlying array. Behaviour is undefined if !isArray() the underlying array. Return the underlying boolean value. Behaviour is undefined if !isBoolean() the underlying boolean value. Return the value as a dom::Value This function returns the value as a dom::Value . If the value is a primitive type, it is converted to a DOM primitive. If the value is an object, a type with reference semantics to access the underlying DOM object is returned. the value as a dom::Value Return the underlying double value. Behaviour is undefined if !isNumber() the underlying double value. Return the underlying array. Behaviour is undefined if !isFunction() the underlying array. Return the underlying integer value. Behaviour is undefined if !isNumber() the underlying integer value. Return the underlying object. Behaviour is undefined if !isObject() the underlying object. Return the underlying string This function returns the value as a string. This function performs no coercions. If the value is not a string, it is not converted to a string. Behaviour is undefined if !isString() the underlying string Check if the value is an array. true if the value is an array, false otherwise Check if the value is a boolean. true if the value is a boolean, false otherwise Check if the value is a floating point number. true if the value is a number but not an integer, false otherwise Check if the value is a function. true if the value is a function, false otherwise Check if the value is an integer number. All numbers are internally represented by IEEE doubles, which are capable of representing all integers up to 53 bits accurately. This function returns true if the value is a number with no precision loss when representing an integer. When isNumber() is true , the function behaves as if evaluating the condition d == static_cast<double>(static_cast<int>(d)) where d is the result of toDouble() . true if the value is a number with no fractional part, false otherwise Check if the value is null. true if the value is null, false otherwise Check if the value is a number. In ECMA, the number type is an IEEE double, including +/- Infinity and NaN values. Zero sign is also preserved. An IEEE double can represent all integers up to 53 bits accurately. The user should not rely on NaNs preserving their exact non-normalized form. true if the value is a number, false otherwise Check if the value is an object. Check if the value is an object but not an array or function. While in ECMA anything with properties is an object, this function returns false for arrays and functions. Properties are key-value pairs with a string key and an arbitrary value, including undefined. true if the value is an object, false otherwise Check if the value is a string. true if the value is a string, false otherwise Determine if a value is truthy A value is truthy if it is a boolean and is true, a number and not zero, or an non-empty string, array or object. true if the value is truthy, false otherwise Check if the value is undefined. true if the value is undefined, false otherwise Lookup a sequence of keys. This function is equivalent to calling get multiple times, once for each key in the sequence of dot-separated keys. The value at the end of the sequence, or a Value of type Kind::Undefined if any key is not found. A sequence of keys separated by dots. Set or replace the value for a given key. The key to set. The value to set. Set or replace the value for a given key. The key to set. The value to set. Set "log" property This function sets the "log" property in the object. The "log" property is populated with a function that takes two javascript arguments (level, message) where level is an unsigned integer and message is a string. The mrdocs library function mrdocs::report::print is then called with these two arguments to report a message to the console. Return if an Array or Object is empty. if an Array or Object is empty. Swap two values. An ECMAScript value. Return the type of the value. This function returns the JavaScript type of the value. The type can represent a primitive type (such as boolean, number, and string) or an object. When the type is an object, the return type also classifies the object as an array or function. An array is an object with the internal ECMAScript class Array or a Proxy wrapping an Array . A function is an object with the internal ECMAScript class Function . the type of the value. Return the string. the string. Determine if a value is truthy A value is truthy if it is a boolean and is true, a number and not zero, or an non-empty string, array or object. true if the value is truthy, false otherwise Constructor Types of values. The value is undefined The value is null The value is a boolean The value is a number The value is a string The value is a function The value is an array The value is an array Return the first Value that is not truthy, or the last one. This function is equivalent to the JavaScript && operator. the first Value that is not truthy, or the last one. The left operand The right operand Return the first Value that is truthy, or the last one. This function is equivalent to the JavaScript || operator. the first Value that is truthy, or the last one. The left operand The right operand Register a JavaScript helper function This function registers a JavaScript function as a helper function that can be called from Handlebars templates. A container holding an error or a value. The Handlebars instance to register the helper into The name of the helper function The JavaScript context to use The JavaScript code that defines the helper function Expected Handlebars Swap two values. An ECMAScript value. An ECMAScript value. Return value as a string. This function coerces any value to a string. value as a string. An ECMAScript value. Compare two values for equality. This operator uses strict equality, meaning that the types must match exactly, and for objects and arrays the children must match exactly. The == operator behaves differently for objects compared to primitive data types like numbers and strings. When comparing objects using == , it checks for reference equality, not structural equality. This means that two objects are considered equal with === only if they reference the exact same object in memory. In JavaScript, this is equivalent to the === operator, which does not perform type conversions. true if the objects are equal, false otherwise The left operand The right operand Inequality operator true if the objects are not equal, false otherwise The left operand The right operand Compare two values for inequality. The relative order of the objects The left operand The right operand A reference to an instance of a Lua interpreter. Constructor. Constructor. The object to copy construct from Destructor. Copy assignment. Reference to the current object The object to copy assign from A Lua function. Construct from Value The object to construct from Return a string representation. This function is used for diagnostics. a string representation. A lazy container to push values to the Lua stack. Copy constructor The object to copy construct from Construct from Array The object to construct from Construct from Object The object to construct from Construct from int64_t The object to construct from Construct from nullptr_t The object to construct from Construct from string_view The object to construct from Construct from Value The object to copy construct from Construct from Value The object to copy construct from Construct from char The value to construct from Destructor Copy assignment operator Reference to the current object The object to copy assign from Construct from Context The object to copy construct from Destructor Return a value from the global table if it exists. The value if it exists, or an error. The key to get. The source location of the call site. Return the global table. the global table. Load a Lua chunk The function if successful, or an error. The Lua chunk to load. The source location of the call site. Load a Lua chunk The function if successful, or an error. The Lua chunk to load. The name of the chunk (used in error messages). The source location of the call site. Run a Lua chunk. The function if successful, or an error. The name of the file to load. The source location of the call site. A Lua string. Construct from Value The object to construct from Construct from string_view The object to construct from Return a string representation. This function is used for diagnostics. a string representation. Conversion to string_view The object converted to string_view A Lua table. Construct from Value The object to construct from Construct from Scope The object to copy construct from Constructor A container of key and value pairs. Return a string representation. This function is used for diagnostics. a string representation. Create or replace the value with a key. The key to set. The value to set. A Lua value. Constructor. Default constructed values have no scope or assigned stack index and are equivalent to the value Nil. Constructor. The new value will be assigned a new stack index which has the same underlying value as other . The value to copy. Constructor. The newly constructed object will acquire the same stack index, while the moved-from object will become as if default-constructed. The object to move construct from Destructor. The Lua value will eventually be removed from the stack. Return a string representation. This function is used for diagnostics. a string representation. Constructor A null-terminated string. Construct from string_view The object to construct from Construct from string The object to copy construct from Construct from char The value to construct from Types of values. The value is nil The value is a boolean The value is a number The value is a string The value is a table The value is a function Provides statistics on the number of reported messages. Severity levels attached to reported messags. log print setMinimumLevel Programming trace messages Debug messages Informational messages Warning messages Error messages Fatal error messages Report a message to the console. The message to print. A trailing newline will be added to the message automatically. Report a message to the console. 0 to 4 The severity of the report. 0 is debug and 4 is fatal. The message to print. A trailing newline will be added to the message automatically. The source location of the report. If this value is null, no location is printed. Holds the description of an error, or success. Level Set the minimum threshold level for reporting. Messages below this level will not be printed. A value of 5 will suppress all messages. Note that messages will still be counted towards result totals even if they are not displayed. Severity levels attached to reported messags. Level If true, source location information will be printed with warnings, errors, and fatal messages. true to enable source location information, false to disable it. The default value is true. Holds current statistics on reported messages. Destructor innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Constraint on the auto type, if any. Metadata for a direct base. Default constructor The access specifier for the base. Whether the base is virtual. The base type. This is typically a NamedType that refers to a RecordSymbol , but it could also be a more complex type such as a decltype . Info for concepts. merge Construct from SymbolID The object to copy construct from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The concepts constraint-expression The concepts template parameters Configuration used to generate the Corpus and Docs This contains all the public settings applied from the command line and the YML file (if any). This class stores the original and public config options as they are passed to MrDocs, in their original data types, such as strings and bools. This class is an abstract interface whose private concrete implementation typically includes these parsed configuration values in a more convenient form for use by MrDocs. Meanwhile, this class is provided publicly to plugins. The configuration is always connected to the directory of the mrdocs.yml file from which absolute paths are calculated from relative paths. Settings values used to generate the Corpus and Docs Option validation traits Enum for "base-member-inheritance" options This enumeration value is valid for the inherit-base-members option Enum for "generator" options This enumeration value is valid for the generator option Enum for "log-level" options This enumeration value is valid for the log-level option Option Type Enum for "sort-symbol-by" options These enumeration values are valid for the following options: - sort-members-by - sort-namespace-members-by Full path to the config file directory The reference directory for most MrDocs options is the directory of the mrdocs.yml file. It is used to calculate full paths from relative paths. This string will always be native style and have a trailing directory separator. The full path to the config file directory. Normalize the configuration values with a visitor This function normalizes and validates the configuration values. Expected<void> with the error if any The reference directories to resolve paths Member access operator Pointer to the current object Full path to the output directory The reference directory for MrDocs output and temporary files is the output directory. This is either the output option (if already a directory) or the parent directory of the output option (if it is a file). When the output option is a path that does not exist, we determine if it's a file or directory by checking if the filename contains a period. This string will always be native style and have a trailing directory separator. The full path to the output directory. Load the configuration from a YAML string This function loads the values from the YAML string without normalizing or validating them. After calling this function, call normalize to normalize and validate the options. Expected<void> with the error if any The PublicSettings object to load the configuration into The YAML string with the configuration Loads the public configuration settings from the specified YAML file. This function takes a YAML file and a set of reference directories as input. It parses the YAML file and loads the configuration settings into a Config::Settings object. The reference directories are used to resolve any relative paths in the configuration settings. An Expected object containing a Config::Settings object if the YAML file was successfully parsed and the configuration settings were loaded, or an error otherwise. A reference to a Config::Settings object where the configuration settings will be loaded. A string view representing the YAML file containing the configuration settings. A constant reference to a PublicSettings::ReferenceDirectories object containing the reference directories. Loads the public configuration settings from the specified file. This function takes a file path and a set of reference directories as input. It reads the file and loads the configuration settings into a Config::Settings object. The reference directories are used to resolve any relative paths in the configuration settings. An Expected object containing void if the file was successfully read and the configuration settings were loaded, or an error otherwise. A reference to a Config::Settings object where the configuration settings will be loaded. A string view representing the file path of the configuration settings. A constant reference to a PublicSettings::ReferenceDirectories object containing the reference directories. Path to the Addons directory Path to the Addons directory. The Addons directory contains the template files used by generators to create the documentation. When a custom Addons directory is not specified, the default templates are used. The default templates are located at the share/mrdocs/addons directory of the MrDocs installation. Users can create custom templates by copying the default templates to a custom directory and specifying the custom directory using this option. command is required. Use the first line of the comment as the brief When set to true , Mr.Docs uses the first line (until the first dot, question mark, or exclamation mark) of the comment as the brief of the symbol. When set to false , a explicit Automatically provide missing documentation for special functions and trivial metadata When set to true , Mr.Docs automatically provides documentation for special functions, such as constructors, destructors, and operators. It also provides documentation for missing documentation metadata, such as known types. Automatically find non-member functions When set to true , Mr.Docs automatically finds non-member functions that are related to the current class. Base URL for links to source code Base URL for links to source code. The base URL is used to create links to the source code in the documentation. The base URL is combined with the path to the source file to create the link. CMake arguments when generating the compilation database from CMakeLists.txt When the compilation-database option is a CMakeLists.txt file, these arguments are passed to the cmake command to generate the compilation_database.json. Configuration or compilation database files The inputs are configuration files or compilation database files that used to generate the documentation. When the input ends with mrdocs.yml , it is interpreted as a configuration file, the file is read and the options are used to generate the documentation as if it was provided to the config option. When the input ends with compilation_database.json or CMakeLists.txt , it is interpreted as a compilation database file, the file is read and the compiler flags are used to generate the documentation as if it was provided to the compilation-database option. Path to the compilation database Path to the compilation database or a build script to generate it. The compilation database is a JSON file that contains the compiler commands used to build the source code. The compilation database is used to extract the compiler flags and the source files used to build the source code and extract symbols. This option also accepts the path to a build script such as CMakeLists.txt to be used to generate the compilation database. In this case, Mr.Docs will look for CMake in PATH or in CMAKE_ROOT and run the script to generate the compilation database file. Number of threads to use The desired level of concurrency: 0 for hardware-suggested. Mr.Docs configuration file The configuration file is a YAML file that contains the options used to generate the documentation. The configuration file is read and the options are used to generate the documentation. The configuration file can be used to specify the source code, the output directory, the compilation database, the generator, and the filters. A string holding the complete configuration YAML. Full path to the current working directory This string will always be native style and have a trailing directory separator. Additional defines passed to the compiler Additional defines passed to the compiler when building the source code. These defines are added to the compilation database regardless of the strategy to generate it. Output an embeddable document Output an embeddable document, which excludes the header, the footer, and everything outside the body of the document. This option is useful for producing documents that can be inserted into an external template. Input directories to exclude Symbols defined in files in these directories are not extracted even if they are in the list of include directories. When relative, the paths are relative to the directory of the mrdocs configuration file. For instance, "include/experimental" will exclude all files in the directory <config-dir>/include/experimental . File patterns to exclude File patterns to exclude. Files that match these patterns are not extracted even if they are in the list of include directories. The patterns are relative to the configuration file. A single * will match all files in the directory. Double ** will match all files in the directory and its subdirectories. Symbol patterns to exclude A symbol that matches one of these patterns is not extracted even if whitelisted by "include-symbols". See the documentation for "include-symbols" for the pattern syntax. Extract all symbols When set to true , MrDocs extracts all symbols from the source code, even if no documentation is provided. MrDocs can only identify whether a symbol is ultimated documented after extracting information from all translation units. For this reason, when this option is set to false , it's still recommendable to provide file and symbol filters so that only the desired symbols are traversed and stored by MrDocs. Extraction policy for anonymous namespaces Determine whether symbols in anonymous namespaces should be extracted. Extraction policy for empty namespaces Determine whether empty namespaces without documentation should be extracted. Extraction policy for friend functions and classes Determine whether friend functions and classes should be extracted. When set to true , MrDocs extracts friend functions and classes. When set to false , friend functions and classes are not extracted. Implicit template specializations used as base classes are extracted as dependencies When set to true , MrDocs extracts implicit template specializations used as base classes as dependencies. This allows MrDocs to extract metadata that can later be used to determine the members of the derived class, as specified by the inherit-base-members option. Extraction policy for records defined locally in source files Determine whether records only defined locally in source files should be extracted. Extraction policy for private class members Determine whether private class members should be extracted Extraction policy for private base classes Determine whether private base classes should be extracted Extraction policy for private virtual methods of a class Determine whether private virtual methods of a class should be extracted Extraction policy for static members of a file Determine whether static members of a file should be extracted. This option does not refer to static members of a class. File patterns to include File patterns to include. Only the files that match these patterns are extracted. The patterns are relative to the input directories. Generator used to create the documentation The generator is responsible for creating the documentation from the extracted symbols. The generator uses the extracted symbols and the templates to create the documentation. The generator can create different types of documentation such as HTML, XML, and AsciiDoc. Use the global namespace page as an index for all symbols When set to true, the page for the global namespace will recursively list all symbols in the documentation, not just those in the global namespace. This makes the global namespace page act as an index for the entire project. Whether AST visitation failures should not stop the program When set to true, MrDocs continues to generate the documentation even if there are AST visitation failures. AST visitation failures occur when the source code contains constructs that are not supported by MrDocs. Continue if files are not mapped correctly When set to true, MrDocs continues to generate the documentation even if some files are not mapped correctly. Files are not mapped correctly when the source file is not found or the compilation database does not contain the compiler flags for the source file. Symbols rendered as "implementation-defined" Symbols that match one of these filters are tagged as "implementation-defined" in the documentation, and so do symbols in scopes tagged as "implementation-defined". This option is used to exclude symbols from the documentation that are considered part of the private API of the project. An "implementation-defined" symbol has no documentation page in the output. If any other symbol refers to it, the reference is rendered as "implementation-defined". See the documentation for "include-symbol" for the pattern syntax. Symbol patterns to include If any patterns are defined here, only symbols that match one of these patterns are extracted. The patterns are applied to the fully qualified name of the symbol without any leading "::". A single "*" will match all symbols in the namespace. Double "**" will match all symbols in the namespace and its subnamespaces. The patterns also support "?" for any chars, " [ <chars> ]" for charsets, " [ ]" for inverted charsets, and "{<glob>,...}" for alternatives. Include paths Include paths. These paths are used to add directories to the include search path. The include search path is used to search for headers. The headers are used to provide declarations and definitions of symbols. The headers are part of the project and are checked for warnings and errors. Determine how derived classes inherit base members Determine how derived classes inherit members of base classes. When set to never , derived classes do not inherit members of base classes and only the relationship is stored. When set to reference , derived classes list members of base classes but references are still linked to the base class. When set to copy-dependencies , a reference is created by default and a copy is created when the base class is a dependency. When set to copy-all , a copy is created for each base symbol as if it was declared in the derived class. If the base class is a dependency, the extraction mode is copied from the new parent. Input directories to extract symbols from Input directories to extract. Only symbols defined in files in these directories are extracted. The paths are relative to the mrdocs configuration file. Use legible names Use legible names for ids in the documentation. When set to true, MrDocs uses legible names for symbols in the documentation. These are symbols that are legible but still safe for URLs. When the option is set to false, MrDocs uses a hash of the symbol ID. Standard Library include paths When use-system-libc is disabled, the C standard library headers are available in these paths. The minimum reporting level The reporting level determines the amount of information displayed during the generation of the documentation. Include path prefixes allowed to be missing Specifies path prefixes for include files that, if missing, will not cause documentation generation to fail. Missing files with these prefixes are served as empty files from an in-memory file system, allowing processing to continue. For example, use "llvm/" to forgive all includes from LLVM. If any such path is specified, MrDocs will attempt to synthesize missing included types. Only simple sets of non-conflicting inferred types can be synthesized. For more complex types or for better control, provide a shim using the "missing-include-shims" option. Shims for forgiven missing include files Specifies a map of include file paths to shim contents. If a missing include file matches a forgiven prefix, MrDocs will use the shim content from this map as the file contents. If no shim is provided for a forgiven file, an empty file is used by default. Full path to the mrdocs root directory This is the directory containing the mrdocs executable and the shared files. This string will always be native style and have a trailing directory separator. Generate a multipage documentation Generates a multipage documentation. The output directory must be a directory. This option acts as a hint to the generator to create a multipage documentation. Whether the hint is followed or not depends on the generator. Directory or file for generating output Multipage generators expect a directory. Single page generators expect a file or a directory where the file will be created. If the directory does not exist, it will be created. Detect and group function overloads When set to true , MrDocs detects function overloads and groups them as a single symbol type. The documentation for this new symbol comes from the union of non-ambiguous metadata from the functions. Recursively include files from "input" paths Recursively include files. When set to true, Mr.Docs includes files in subdirectories of the input directories. When set to false, Mr.Docs includes only the files in the input directories. The minimum reporting level The reporting level determines the amount of information displayed during the generation of the documentation. The value -1 delegates the decision to the log-level option. Exposition only symbols rendered as "see-below". Symbols that match one of these filters are tagged as "see-below" in the documentation, and so do symbols in scopes tagged as "see-below". This option is used to remove details about symbols that are considered part of the private API of the project but the user might need to interact with. In the documentation page for this symbol, the symbol is exposition only: the synopsis of the implementation is rendered as "see-below" and members of scopes (such as a namespace or record) are not listed. The rest of the documentation is rendered as usual to explain the symbol. See the documentation for "include-symbol" for the pattern syntax. Detect and reduce SFINAE expressions When set to true, MrDocs detects SFINAE expressions in the source code and extracts them as part of the documentation. Expressions such as std::enable_if<...> are detected, removed, and documented as a requirement. MrDocs uses an algorithm that extracts SFINAE infomation from types by identifying inspecting the primary template and specializations to detect the result type and the controlling expressions in a specialization. Show enum constant pages in the documentation When set to true, MrDocs creates a page for each enum constant in the documentation. Show namespace pages in the documentation When set to true, MrDocs creates a page for each namespace in the documentation. Sort the members of a record When set to true , sort the members of a record by the criterion determined in the sort-members-by option. When set to false , the members are included in the declaration order they are extracted. Sort assignment operators first When set to true , assignment operators are sorted first in the list of members of a record. Determine how members of a record are sorted If sort-members is set to true , determine how members of a record are sorted. When set to name , members are sorted by name. When set to location , members are sorted by their primary location in the source code, considering the short name of the path and the location in the file. Sort conversion operators last When set to true , conversion operators are sorted last in the list of members of a record or namespace. Sort constructors first When set to true , constructors are sorted first in the list of members of a record. Sort destructors first When set to true , destructors are sorted first in the list of members of a record. Sort relational operators last When set to true , relational operators are sorted last in the list of members of a record or namespace. Determine how members of a namespace are sorted Although members of namespaces are always sorted, determine how members of a namespace are sorted. When set to name , members are sorted by name. When set to location , members are sorted by their primary location in the source code, considering the short name of the path and the location in the file. Path to the root directory of the source code Path to the root directory of the source code. This path is used as a default for input files and a base for relative paths formed from absolute paths. This should typically be the root directory of the git project, as relative paths formed from it can be used to create links to these source files in the repository. Templates use the base-url option to create links to the source code. C++ Standard Library include paths When use-system-stdlib is disabled, the C++ standard library headers are available in these paths. System include paths System include paths. These paths are used to add directories to the system include search path. The system include search path is used to search for system headers. The system headers are headers that are provided by the system and are not part of the project. The system headers are used to provide the standard library headers and other system headers. The system headers are not part of the project and are not checked for warnings and errors. Path for the tagfile Specifies the full path (filename) where the generated tagfile should be saved. If left empty, no tagfile will be generated. Use the system C standard library To achieve reproducible results, MrDocs bundles the LibC headers with its definitions. To use the C standard library available in the system instead, set this option to true. Use the system C++ standard library To achieve reproducible results, MrDocs bundles the LibC++ headers. To use the C++ standard library available in the system instead, set this option to true. Verbose output Verbose output. When set to true, MrDocs outputs additional information during the generation of the documentation. Treat warnings as errors When set to true , MrDocs treats warnings as errors and stops the generation of the documentation. Warn if a documentation reference is broken When set to true , MrDocs outputs a warning message if a reference in the documentation is broken. Warn if documentation has errors When set to true , MrDocs outputs a warning message if the documentation of a symbol has errors such as duplicate parameters and parameters that don't exist. Warn if enum values are not documented When set to true , MrDocs outputs a warning message if an enum value is not documented. Warn if symbols are not documented When set to true , MrDocs outputs a warning message if a symbol that passes all filters is not documented. Warn if parameters are not documented When set to true , MrDocs outputs a warning message if a named function parameter is not documented. Warn if documented functions have unnamed parameters When set to true , MrDocs outputs a warning message if a documented function has a parameter that is not named. Enable warning messages When set to true , MrDocs outputs warning messages during the generation of the documentation. It is usually recommended to enable warnings while writing the documentation. Destructor. Return a DOM object representing the configuration keys. The object is invalidated when the configuration is moved or destroyed. a DOM object representing the configuration keys. Return the settings used to generate the Corpus and Docs. the settings used to generate the Corpus and Docs. Return the settings used to generate the Corpus and Docs. the settings used to generate the Corpus and Docs. Return a pool of threads for executing work. a pool of threads for executing work. Default constructor Three-way comparison operator The relative order of the objects The right operand Template argument expression. A constant template parameter Before C++26, constant template parameters were called non-type template parameter in the standard wording. The terminology was changed by P2841R6 / PR#7587. Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Type of the non-type template parameter The collection of declarations in extracted form. getParents Options to traverse the members of an Symbol. Whether to traverse in a stable order Whether to skip inherited members whose parent is not the Symbol Whether to skip inherited members whose parent is not the Symbol The iterator type for the index of all symbols. The iterator is a forward iterator that iterates over all symbols in the index. It dereferences to a reference to a const Symbol . The logic for incrementing the iterator is provided by the Corpus implementation via a function that retuns the next Symbol in the index, or nullptr if there are no more. Default constructor Copy constructor The object to copy construct from Constructor The object to construct from Base class with common properties of all symbols Base class with common properties of all symbols Copy assignment operator Reference to the current object The object to copy assign from Increment operator Reference to the current object Increment operator Another instance of the object Equality operator true if the objects are equal, false otherwise The right operand Inequality operator true if the objects are not equal, false otherwise The right operand Destructor. Return the begin iterator for the index of all symbols. the begin iterator for the index of all symbols. Whether the corpus contains any symbols. true if the corpus is empty, otherwise false. Return the end iterator for the index. the end iterator for the index. Return true if an Symbol with the specified symbol ID exists. This function uses the find function to locate the Symbol with the specified symbol ID and returns true if it exists, otherwise false. true if an Symbol with the specified symbol ID exists. A unique identifier for a symbol. Return the Symbol with the matching ID, or nullptr. the Symbol with the matching ID, or nullptr. A unique identifier for a symbol. Return the metadata for the global namespace. This function is equivalent to calling get with the symbol ID for the global namespace. the metadata for the global namespace. Return the Symbol for the matching string in the global context. The Symbol for the symbol with the specified name in the global context, or an error if not found. The name of the symbol to look up. Return the Symbol for the matching string in a given context. The Symbol for the symbol with the specified name in the specified context, or an error if not found. If multiple symbols match, one is returned arbitrarily. Use traverse to find all matching symbols. The context to look up the symbol in. The name of the symbol to look up. Return the fully qualified name of the specified Symbol. This function returns the fully qualified name of the specified Symbol I as a string. The Symbol parents are traversed to construct the fully qualified name which is stored in the string temp . A reference to the string temp . The Symbol to get the qualified name for. The string to store the result in. Return a qualified name from the specified context. This function returns the qualified name of the specified Symbol I from the context specified by the SymbolID context . If the context is a parent of I , the qualified name is constructed relative to the context. For instance, if I is A::B::C::D and context is A::B , the result is C::D . If the context is not a parent of I , the qualified name is constructed relative to the global namespace with the prefix :: . a qualified name from the specified context. The Symbol to get the qualified name for. The context to get the qualified name from. The string to store the result in. The configuration used to generate this corpus. Construct from Config The object to copy construct from innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand A processed documentation comment attached to a declaration. A complete documentation comment document consists of a sequence of text blocks. Blocks are the top-level structural units that might contain other blocks or inline elements. These are analogous to markdown blocks. Inline elements (text, emphasis, links, code spans, etc.) live inside certain block types, like paragraphs or headings. Inlines can contain other inlines (e.g., emphasis contains text, link contains text), but they cannot directly contain blocks. Some blocks contain metadata about the symbol being documented, such as parameters and return values. These blocks are parsed as usual, but are stored separately in the DocComment structure. Each block in the document might contain: - No other blocks (leaf blocks) - Other blocks (container blocks: e.g. lists) When they contain no other blocks, they might be: - Inlines only (e.g. paragraphs) - No inlines (e.g. horizontal rule) Inline content elements contain other inlines but cannot contain blocks. Constructor. Constructor The object to construct from Append blocks from another DocComment to this. A processed documentation comment attached to a declaration. Return true if this is empty true if this is empty Equality operator true if the objects are equal, false otherwise The right operand Inequality operator true if the objects are not equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand The list of text blocks. A brief description of the symbol. The list of exceptions. The list of parameters. The list of postconditions. The list of preconditions. The list of "related" references. These references are the inverse of the relates command. They are calculated automatically by MrDocs and are rendered as Non-Member Functions. The list of "relates" references. These references are created with the relates command. The list of return type descriptions. Multiple return descriptions are allowed. The results are concatenated in the order they appear in the source code. The list of "see also" references. The list of template parameters. Front-end factory for producing Dom nodes. This class keeps a reference to the Corpus of extracted metadata, and provides a mechanism for constructing DOM nodes representing the metadata. A Generator can subclass this object then uses it to create the Dom nodes used as input for rendering template engines. getParents Constructor. Ownership of the specified Corpus is not transferred; the caller is responsible for ensuring the lifetime extension of the object. The Corpus whose metadata to use. Destructor. Construct a lazy Dom object representing the specified symbol. This function is called internally when a dom::Object representing a symbol needs to be constructed because it was not found in the cache. A container of key and value pairs. Base class with common properties of all symbols Return a Dom object representing the given symbol. A value containing the symbol contents, or null if id is invalid. The id of the symbol to return. Returns the Corpus associated with the Dom. the Corpus associated with the Dom. Return a Dom value representing the DocComment. The default implementation returns null. A Generator should override this member and return a value that has suitable strings in the generator's output format. a Dom value representing the DocComment. A processed documentation comment attached to a declaration. Returns the Corpus associated with the Dom. the Corpus associated with the Dom. Returns the Corpus associated with the Dom. the Corpus associated with the Dom. Info for enum constants. merge Construct from SymbolID The object to construct from Three-way comparison operator The relative order of the objects The right operand The initializer expression, if any merge Construct from SymbolID The object to construct from Three-way comparison operator The relative order of the objects The right operand The members of this scope. All members are enum constants. Enum constants are independent symbol types that can be documented separately. Indicates whether this enum is scoped (e.g. enum class). If true, the enumerators are accessed with the scope resolution operator (e.g. EnumName::Enumerator). If false, the enumerators are accessed directly (e.g. Enumerator) in the parent context. The underlying type of this enum, if explicitly specified. If not specified, the underlying type is an implementation-defined integral type that can represent all the enumerator values defined in the enumeration. For enum Foo : short { ... }; this will be represent short . Holds the description of an error, or success. formatError Constructor. A default-constructed error is equivalent to success. Constructor. The object to copy construct from Constructor. The object to move construct from Constructor. The constructed object will always indicate a failure, even if the message in the exception is empty. The object to copy construct from Constructor. A string indicating the cause of the failure. This must not be empty. The source location where the error occurred. Constructor. The error code. The source location where the error occurred. Constructor. This constructs a new error from a list of zero or more errors. If the list is empty, or if all the errors in the list indicate success, then newly constructed object will indicate success. The list of errors to combine. The source location where the error occurred. Assignment. Reference to the current object The object to copy assign from Constructor. Reference to the current object The object to move assign from Throw Exception(*this)

            this->failed()
          

Throw Exception(std::move(*this))

            this->failed()
          

Return true if this holds an error. true if this holds an error. Return the source location. the source location. Return the error string. the error string. Return the reason string. the reason string. Return the location string. the location string. Return true if this holds an error. true if this holds an error. Return true if this equals rhs. true if this equals rhs. The right operand Type of all exceptions thrown by the API. Constructor. The object to construct from Return the Error stored in the exception. the Error stored in the exception. Return a null-terminated error string. a null-terminated error string. Move constructor The object to move construct from Destructor Block until all work has completed. Zero or more errors which were thrown from submitted work. Destructor Construct from ThreadPool The object to copy construct from Stores only the operand of the explicit-specifier or noexcept-specifier as a string. The complete expression is not preserved at this time. This is a temporary design and may be improved in the future. toString Three-way comparison operator The relative order of the objects The right operand Whether an explicit-specifier was user-written. The evaluated exception specification. The operand of the explicit-specifier, if any. Represents an expression Three-way comparison operator The relative order of the objects The right operand The expression, as written Info for friend declarations. - Friendship is not transitive - Friendship is not inherited - Access specifiers do not affect the meaning of friend declarations The friends of a record are stored directly in the record's metadata. If the friend declaration is documented, the documentation is stored in the befriended symbol's metadata rather than in the relationship. Befriended type. This member is nullable and only used when befriending a type. Befriended symbol. merge overrides Construct from SymbolID The object to copy construct from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The class of function this is List of parameters. Info about the return type of this function. If the function has a deduced return type, this contains auto to indicate that. By default, we also use auto in the member to indicate an unknown return type. When present, this function is a template or specialization. innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Base class for documentation generators. Destructor. Build reference documentation for the corpus. This function invokes the generator to emit the documentation using the corpus configuration options to determine the output location. The error, if any occurred. The symbols to emit. The generator may modify the contents of the object before returning. Build reference documentation for the corpus. This function invokes the generator to emit the documentation using outputPath as a parameter indicating where the output should go. This can be a directory or a filename depending on the generator and how it is configured. The default implentation assumes the output is single-page and emits the file reference.ext using buildOne to generate the content. The typical implementation will have behavior similar to the default implementation if the output is single-page, or will iterate over the symbols in the corpus to generate multiple files if the output is multi-page. The error, if any occurred. A directory or filename. The symbols to emit. The generator may modify the contents of the object before returning. Build the reference as a single page to a file. Thread Safety Different `corpus` object: may be called concurrently. Same `corpus` object: may not be called concurrently. The error, if any occurred. The file to write. If the file already exists, it will be overwritten. The metadata to emit. Build reference documentation for the corpus. This function invokes the generator to emit the full documentation to an output stream, as a single entity. Thread Safety Different `corpus` object: may be called concurrently. Same `corpus` object: may not be called concurrently. The error, if any occurred. The stream to write to. The metadata to emit. Build the reference as a single page to a string. The error, if any occurred. The string to hold the result. For the duration of the call, this must not be accessed by any other threads. The metadata to emit. Return the display name of the generator. the display name of the generator. Return the extension or tag of the generator. This should be in all lower case. Examples of tags are: "adoc" Asciidoctor "xml" XML "html" HTML The returned string should not include a leading period. the extension or tag of the generator. Return the symbolic name of the generator. This is a short, unique string which identifies the generator in command line options and in configuration files. the symbolic name of the generator. A dynamic list of Generator elements. getGenerators Destructor. Return an iterator to the beginning. an iterator to the beginning. Return an iterator to the end. an iterator to the end. Return a pointer to the matching generator. A pointer to the generator, or nullptr . The name of the generator. The name must be an exact match, including case. Default constructor A glob pattern matcher "*" matches all characters except delimiters. "**" matches all characters "?" matches any single character. "[<chars>]" matches one character in the bracket. "[<char>-<char>]" matches one character in the bracket range. "[^<chars>]" or "[!<chars>]" matches one character not in the bracket. "{<glob>,...}" matches one of the globs in the list. "\" escapes the next character so it is treated as a literal. Nested brace expansions "{<glob>,"{<glob>,...}",...}" are not supported. Construct an empty GlobPattern. An empty GlobPattern will never match any string. Copy constructor The object to copy construct from Move constructor The object to move construct from Destructor Copy assignment Reference to the current object The object to copy assign from Move assignment Reference to the current object The object to move assign from Checks if the glob pattern is a literal string. This function determines if the glob pattern does not contain any special characters. In other words, it matches a single string. true if the glob pattern is a literal string, false otherwise. Matches the given string against the glob pattern. true if the string matches the pattern, false otherwise. The string to match against the pattern. The character that * does not match. Matches the start of a given string against the glob pattern. This function determines if the given string with the specified prefix can potentially match the glob pattern. If the string matches the start of the pattern without failure, even if there are characters left in the string or the pattern, the function returns true. true if the string prefix matches the pattern, false otherwise. The string to match against the pattern. The character that * does not match. Returns the glob pattern. The glob pattern as a string view. Constructs a GlobPattern with the given pattern. The constructed GlobPattern, or an error if the pattern is invalid. The glob pattern to use for matching. The maximum number of subpatterns allowed. If the pattern contains more subpatterns than this value, an error is returned. If not specified, there is no limit. Info for deduction guides. merge Construct from SymbolID The object to construct from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The pattern for the deduced specialization. This is always a SpecializationType. The explicit-specifier, if any. The parameters of the deduction guide. Template head, if any. A handlebars environment This class implements a handlebars template environment. It is analogous to the complete state held by the handlebars.js module, including registered helpers and partials. In the general case, handlebars.js provides a global Handlebars environment where helpers and partials are registered: {.js} let template = Handlebars.compile("{{foo}}"); let result = template({foo: "bar"}); but also provides a way to create a new isolated environment with its own helpers and partials: {.js} let OtherHandlebars = Handlebars.create(); let template = OtherHandlebars.compile("{{foo}}"); let result = template({foo: "bar"}); In this implementation, however, there's no global environment. A new environment needs to be created explicitly be instantiating this class: {.cpp} Handlebars env; dom::Object context; context["foo"] = "bar"; std::string result = env.render("{{ foo }}", context); assert(result == "bar"); A handlebars template can be rendered using the context data provided as a dom::Value , which is usually a dom::Object at the first level when calling render . In the most general case, the result can returned as a string or rendered directly to a buffer or stream. The render function provides an overload that allows the caller to provide an output stream where the template will be rendered directly without allocating a string: {.cpp} Handlebars env; dom::Object context; context["foo"] = "bar"; env.render_to(std::cout, "{{ foo }}", context); // prints "bar" to stdout {.cpp} Handlebars env; dom::Object context; context["foo"] = "bar"; std::string result; env.render_to(result, "{{ foo }}", context); assert(result == "bar"); Design considerations: The following notes include some design considerations for the current implementation of this class. These are intended to describe the current state of the class rather than to provide the final specification of the class behavior. Compiled templates: Unlike handlebars.js, this implementation renders the template directly to the output stream, without requiring an intermediary object to store a representation of the compiled template ( Handlebars.precompile ) or an intermediary callable object required to ultimately render the template ( Handlebars.precompile ). The rationale is that there is not much benefit in pre-compiling templates in C++, since both iterating the input string and a pre-compiled template would have very similar costs even in optimal implementations of the compiled template. The most significant benefit of pre-compiling templates in C++ would be the faster identification of the ends of blocks, which would allow the engine iterate the block only once. For this reason, compiled templates will still be considered in a future version of this sub-library. Also note that compiled templates cannot avoid exceptions, because a compiled template can still invoke a helper that throws exceptions and evaluate dynamic expressions that cannot be identified during the first pass. Incremental rendering and compilation: Although this is not supported by handlebars.js, it's common for C++ template engines to support incremental rendering, where the template is compiled or rendered in chunks as it is parsed. This implementation does not yet support this feature. This is useful for streaming templates, where the template is rendered to a stream as it is parsed, without requiring the entire template to be parsed and compiled before rendering starts. There are two types of incremental rendering and compilation supported by this implementation: - Incremental rendering of a partial template input to a stream - Incremental rendering into an output buffer of fixed size In each of these cases, the template is rendered in chunks until the end of the partial template is reached or the output buffer is full. In a scenario with compiled templates, the complexity of incremental rendering needs to be implemented for both compilation and rendering. The main difficulty to implement incremental rendering for handlebars.js is that helpers can be invoked from anywhere in the template, and most content is actually rendered by helpers. This means that helpers would need to be able to interoperate with whatever mechanism is designed to support suspension in this recursive-coroutine-like interface. Error propagation: The main logic to render a template is implemented in the render function, does not throws by itself. How identifying the next tag in a template string, the algorithms uses a loose implementation where unclosed tags are rendered as-is instead of throwing errors. However, helpers are allowed to throw exceptions to propagate errors, so the render function is not noexcept . For this reason, exceptions thrown by helpers are in fact exceptional conditions that should be handled by the caller. In general, exceptions can be avoided completely by not throwing exceptions from helpers. https://handlebarsjs.com/ helpers::registerAntoraHelpers helpers::registerBuiltinHelpers helpers::registerConstructorHelpers helpers::registerContainerHelpers helpers::registerLogicalHelpers helpers::registerMathHelpers helpers::registerStringHelpers helpers::registerTypeHelpers js::registerHelper Construct a handlebars environment This constructor creates a new handlebars environment with the built-in helpers and default logger. Each environment has its own helpers and partials. Multiple environments are only necessary for use cases that demand distinct helpers or partials. helpers::registerBuiltinHelpers Register a helper accessible by any template in the environment. The helper type is a type erased function of type dom::Function , which receives the resolved template arguments as parameters as a dom::Value for each parameter. The helper function also receives an object populated with variables that are accessible in the current context as its N+1-th parameter. This object contains information about the current context and is useful for helpers that want to change the current context or render internal blocks. As all instances of dom::Function , the helper should also return a dom::Value . If the function semantics does not require a return value, the function should return a dom::Value of type dom::Kind::Undefined . When the helper is used in an subexpression, the dom::Value return value is used as the intermediary result. When the helper is used in a block or a final expression, the dom::Value return value will be formatted to the output. The name of the helper in the handlebars template The helper function https://handlebarsjs.com/guide/expressions.html https://handlebarsjs.com/guide/block-helpers.html https://handlebarsjs.com/guide/builtin-helpers.html Register a logger This function registers a logger with the handlebars environment. A logger is a function that is called from the built-in "log" helper function. The logger can also be called from any helper through the HandlebarsCallback parameter. The logger function is called with a dom::Value indicating the current level and a dom::Array containing values to be logged. The logger function Register a partial This function registers a partial with the handlebars environment. A partial is a template that can be referenced from another template. The partial is rendered in the context of the template that references it. For instance, a partial can be used to render a header or footer that is common to several pages. It can also be used to render a list of items that is used in several places. The following example template uses the partial item to render a list of items: {.handlebars} <ul> {{#each items}} {{> item}} {{/each}} </ul> The name of the partial The content of the partial https://handlebarsjs.com/guide/partials.html Render a handlebars template This function renders the specified handlebars template and returns the result as a string. The context data to render is passed as a dom::Value, which is usually a dom::Object at the first level. When the context is not an object, it is accessed from the handlebars template with the this keyword. The rendered text The handlebars template text The data to render The options to use Render a handlebars template This function renders the specified handlebars template and writes the result to the specified output stream. The output stream can be any type convertible to OutputRef, which is a reference to a stream that can be written to with the << operator. The rendered text The handlebars template text The data to render The options to use Reference to output stream used by handlebars Render a handlebars template This function renders the specified handlebars template and writes the result to the specified output stream. The output stream can be any type convertible to OutputRef, which is a reference to a stream that can be written to with the << operator. The rendered text The handlebars template text The data to render The options to use Render a handlebars template This function renders the specified handlebars template and writes the result to the specified output stream. The output stream can be any type convertible to OutputRef, which is a reference to a stream that can be written to with the << operator. The rendered text The handlebars template text The data to render The options to use Reference to output stream used by handlebars Unregister a helper This function unregisters a helper with the handlebars environment. The name of the helper Unregister a partial This function unregisters a partial with the handlebars environment. The name of the partial An error thrown or returned by Handlebars An error returned or thrown by Handlebars environment when an error occurs during template rendering. The error message will be the same as the error message returned by Handlebars.js. The object will also contain the line, column and position of the error in the template. These can be used to by the caller to provide more detailed error messages. Construct from string_view The object to construct from Options for handlebars This struct is analogous to the Handlebars.compile options. https://handlebarsjs.com/api-reference/compilation.html Removes object existence checks when traversing paths This is a subset of strict mode that generates optimized templates when the data inputs are known to be safe. Enable recursive field lookup When enabled, fields will be looked up recursively in objects and arrays. This mode should be used to enable complete compatibility with Mustache templates. Custom private data object This variable can be used to pass in an object to define custom private variables. Function to escape entities It's initialized with a reference to the HTMLEscape function overload that takes an OutputRef and a string_view. This function can be replaced with a custom function that escapes entities in a different way. Disables implicit context for partials When enabled, partials that are not passed a context value will execute against an empty object. Disables standalone tag removal when set to true By default, Handlebars removes whitespace around block and partial expressions. For instance, the partial: {.handlebars} A and the template: {.handlebars} <div> {{> partial}} </div> will render as: {.html} <div> A</div> because the whitespace up to the newline after the partial is removed. A double newline is required to ensure that the whitespace is not removed. For instance, the template: {.handlebars} <div> {{> partial}} </div> will render as: {.html} <div> A </div> This can be disabled by setting this option to true. When set, blocks and partials that are on their own line will not remove the whitespace on that line. Escape HTML entities or entities defined by the escape function Disable the auto-indent feature By default, an indented partial-call causes the output of the whole partial being indented by the same amount. For instance, the partial: {.handlebars} A B C and the template: {.handlebars} <div> {{> partial}} </div> will render as: {.html} <div> A B C </div> because the partial is indented by the same amount as the partial call. This can be disabled by setting this option to true. In this case, the partial above would be rendered as: {.html} <div> A B C </div> Templates will throw rather than ignore missing fields Run in strict mode. In this mode, templates will throw rather than silently ignore missing fields. Enable tracking of ids When enabled, the ids of the expressions are tracked and passed to the helpers. Helpers often use this information to update the context path to the current expression, which can later be used to look up the value of the expression with ".." segments. Represents an identifier This class is used to represent an identifier that could be in the corpus or not. When the symbol is in the corpus, the id field will be set to the symbol ID of the symbol. When the symbol is not in the corpus, the id field will be set to SymbolID::invalid . Default constructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The unqualified name. The kind of name this is. The parent name info, if any. This recursively includes information about the parent, such as the symbol ID and potentially template arguments, when the parent is a SpecializationName. This is particularly useful because the parent of id could be a primary template. In this case, the Prefix will contain this primary template information and the template arguments. The SymbolID of the named symbol, if it exists. innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Column number within the line Whether this location has documentation. The full file path Line number within the file The file path relative to one of the search directories The file path relative to the source-root directory innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Represents a name for a named Type When the Type is a named type, this class represents the name of the type. It also includes the symbol ID of the named type, so that it can be referenced in the documentation. This allows the Type to store either a Name or a SpecializationName , which contains the arguments for a template specialization without requiring the application to extract an unnecessary symbol. Destructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand The unqualified name. The kind of name this is. The parent name info, if any. This recursively includes information about the parent, such as the symbol ID and potentially template arguments, when the parent is a SpecializationName. This is particularly useful because the parent of id could be a primary template. In this case, the Prefix will contain this primary template information and the template arguments. The SymbolID of the named symbol, if it exists. Default constructor Construct from NameKind The object to construct from innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Info for namespace aliases. merge Construct from SymbolID The object to copy construct from Three-way comparison operator The relative order of the objects The right operand The aliased symbol. This is another namespace that might or might not be in the same project. Describes a namespace. merge Construct from SymbolID The object to copy construct from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The members of this namespace. Namespaces nominated by using-directives. The members of a Namespace Three-way comparison operator The relative order of the objects The right operand toString Three-way comparison operator The relative order of the objects The right operand Whether a noexcept-specifier was user-written. The evaluated exception specification. The operand of the noexcept-specifier, if any. Reference to output stream used by handlebars This class is used to internally pass an output stream to the handlebars environment. It allows many types to be used as output streams, including std::string, std::ostream, llvm::raw_string_ostream, and others. HTMLEscape Represents a set of function overloads. merge Construct from SymbolID The object to copy construct from Three-way comparison operator The relative order of the objects The right operand The class of the functions. The members of the overload set. The overloaded operator, if any. Info about the return type of these function overloads. If all overloads have the same return type, this contains that type. Otherwise, it contains auto to indicate that the return type varies according to the parameters. Represents a single function parameter Default constructor Three-way comparison operator The relative order of the objects The right operand The default argument for this parameter, if any The parameter name. The type of this parameter The result of a parse operation. This class holds the result of a parse operation. The structure is similar to std::from_chars_result , where we have a ptr member that points to the first character not parsed, and a ec member that holds the error code. If parsing was successful, then ec stores a default constructed Error object, which indicates success. The operator bool can also be used to check for success. The typical format of a parsing function is: ParseResult parseType( char const* first, char const* last, Type& value); where more parameters can be defined as needed for parsing options. parse Conversion to bool The object converted to bool A glob pattern matcher for paths A glob pattern matcher where "*" does not match path separators. The pattern "**" can be used to match any number of path separators. Construct an empty PathGlobPattern. An empty PathGlobPattern will never match any string. Construct an empty PathGlobPattern. An empty PathGlobPattern will never match any string. The object to construct from Checks if the glob pattern is a literal string. This function determines if the glob pattern does not contain any special characters. In other words, it matches a single string. true if the glob pattern is a literal string, false otherwise. Matches the given string against the glob pattern. true if the string matches the pattern, false otherwise. The string to match against the pattern. Matches the start of a given string against the glob pattern. This function determines if the given string with the specified prefix can potentially match the glob pattern. If the string matches the start of the pattern without failure, even if there are characters left in the string or the pattern, the function returns true. true if the string prefix matches the pattern, false otherwise. The string to match against the pattern. Returns the glob pattern. The glob pattern as a string view. Constructs a PathGlobPattern with the given pattern. A container holding an error or a value. The glob pattern to use for matching. Constructs a PathGlobPattern with the given pattern. A container holding an error or a value. The glob pattern to use for matching. The maximum number of subpatterns allowed. innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand innerType innerType innerTypePtr innerTypePtr Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The aggregated interface for a given struct, class, or union. This class represents the public, protected, and private interfaces of a record. It is used to generate the "interface" value of the DOM for symbols that represent records or namespaces. The interface is not part of the Corpus. It is a temporary structure generated to aggregate the symbols of a record. This structure is provided to the user via the DOM. While the members of a Namespace are directly represented with a Tranche, the members of a Record are represented with an Interface. The aggregated private interfaces. This tranche contains all private members of a record or namespace. The aggregated protected interfaces. This tranche contains all protected members of a record or namespace. The aggregated public interfaces. This tranche contains all public members of a record or namespace. Metadata for struct, class, or union. merge Construct from SymbolID The object to copy construct from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand List of immediate bases. List of derived classes List of friends. Lists of members. Kind of record this is (class, struct, or union). When present, this record is a template or specialization. A group of members that have the same access specifier. This struct represents a collection of symbols that share the same access specifier within a record. It includes one vector for each info type allowed in a record, and individual vectors for static functions, types, and function overloads. Reference directories used to resolve paths These are the main reference directories used to resolve paths in the application. All other reference directories come directly from the configuration file. Stores source information for a declaration. Default constructor Destructor Three-way comparison operator The relative order of the objects The right operand Location where the entity was defined KRYSTIAN NOTE: this is used for entities which cannot be redeclared -- regardless of whether such a declaration is actually a definition (e.g. alias-declarations and typedef declarations are never definition). Locations where the entity was declared. This does not include the definition. A source location with filename prettification. Construct from source_location The object to copy construct from Represents a (possibly qualified) symbol name with template arguments. Default constructor Equality operator true if the objects are equal, false otherwise The right operand Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The unqualified name. The kind of name this is. The parent name info, if any. This recursively includes information about the parent, such as the symbol ID and potentially template arguments, when the parent is a SpecializationName. This is particularly useful because the parent of id could be a primary template. In this case, the Prefix will contain this primary template information and the template arguments. The template arguments. The SymbolID of the named symbol, if it exists. The SymbolID of the named symbol, if it exists. Default constructor Increment operator Reference to the current object Default constructor Construct from string_view The object to construct from Base class with common properties of all symbols merge Destructor Three-way comparison operator The relative order of the objects The right operand Declaration access. Class members use: `AccessKind::Public`, `AccessKind::Protected`, and `AccessKind::Private`. Namespace members use AccessKind::None . Determine why a symbol is extracted. This flag distinguishes Info from its dependencies and indicates why it was extracted. Non-dependencies can be extracted in normal mode, see-below mode, or implementation-defined mode. A dependency is a symbol that does not meet the configured conditions for extraction, but had to be extracted due to it being used transitively by a primary Info . Kind of declaration. The source location information. The unqualified name. The parent symbol, if any. This is the parent namespace or record where the symbol is defined. The extracted documentation for this declaration. The unique identifier for this symbol. Default constructor Copy constructor The object to copy construct from Move constructor. The object to move construct from Construct an Symbol. The kind of symbol The unique identifier for this symbol A glob pattern matcher for C++ symbols A glob pattern matcher where "*" does not match "::". The pattern "**" can be used to match any number of "::". Construct an empty SymbolGlobPattern. An empty SymbolGlobPattern will never match any string. Construct an empty SymbolGlobPattern. An empty SymbolGlobPattern will never match any string. The object to construct from Checks if the glob pattern is a literal string. This function determines if the glob pattern does not contain any special characters. In other words, it matches a single string. true if the glob pattern is a literal string, false otherwise. Matches the given string against the glob pattern. true if the string matches the pattern, false otherwise. The string to match against the pattern. Matches the start of a given string against the glob pattern. This function determines if the given string with the specified prefix can potentially match the glob pattern. If the string matches the start of the pattern without failure, even if there are characters left in the string or the pattern, the function returns true. true if the string prefix matches the pattern, false otherwise. The string to match against the pattern. Returns the glob pattern. The glob pattern as a string view. Constructs a SymbolGlobPattern with the given pattern. A container holding an error or a value. The glob pattern to use for matching. Constructs a SymbolGlobPattern with the given pattern. A container holding an error or a value. The glob pattern to use for matching. The maximum number of subpatterns allowed. A unique identifier for a symbol. This is calculated as the SHA1 digest of the USR. A USRs is a string that provides an unambiguous reference to a symbol. getParents toBase16Str Default constructor Return an iterator to the first byte of the SymbolID. an iterator to the first byte of the SymbolID. Return the raw data for this SymbolID. the raw data for this SymbolID. Return an iterator to one past the last byte of the SymbolID. an iterator to one past the last byte of the SymbolID. Return the size of the SymbolID. The size of a SymbolID is always 20. the size of the SymbolID. Return a string view of the SymbolID. a string view of the SymbolID. Return true if this is a valid SymbolID. true if this is a valid SymbolID. Compare two SymbolIDs for equality. true if the objects are equal, false otherwise The right operand Compare two SymbolIDs with strong ordering. The relative order of the objects The right operand Construct a SymbolID by hashing a string The SymbolID created by hashing the string. The string to hash. Symbol ID of the global namespace. Destructor Three-way comparison operator The relative order of the objects The right operand Whether this template argument is a parameter expansion. The kind of template argument this is. Default constructor Construct from TArgKind The object to construct from Destructor Three-way comparison operator The relative order of the objects The right operand The default template argument, if any Whether this template parameter is a parameter pack The kind of template parameter this is The template parameters name, if any Default constructor Construct from TParamKind The object to construct from A subset of possible work in a thread pool. Constructor. The object to copy construct from Destructor. Block until all work has completed. Zero or more errors which were thrown from submitted work. Information about templates and specializations thereof. Three-way comparison operator The relative order of the objects The right operand Primary template ID for partial and explicit specializations. The requires-clause for the template parameter list, if any. Three-way comparison operator The relative order of the objects The right operand Name of the referenced template. SymbolID of the referenced template. Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Template parameters for the template-template parameter A pool of threads for executing work concurrently. Constructor. Default constructed thread pools have concurrency equal to one and never spawn new threads. Submitted work blocks the caller until the work is complete. Constructor. The value to construct from Destructor. Return the number of threads in the pool. the number of threads in the pool. Block until all work has completed. A possibly qualified type. This class represents a type that may have qualifiers (e.g. const, volatile). This base class is used to store the kind of type. Derived classes are used to store the type information according to the kind. innerType innerType innerTypePtr innerTypePtr Return the symbol named by this type. the symbol named by this type. Three-way comparison operator The relative order of the objects The right operand The constraints associated with the type This represents the constraints associated with the type, such as SFINAE constraints. For instance, if SFINAE detection is enabled, the expression std::enable_if_t<std::is_integral_v<T>, T> will have type T (NamedType) and constraints {std::is_integral_v<T>} . The const qualifier Whether this is the pattern of a pack expansion. The volatile qualifier The kind of Type this is Construct from TypeKind The object to construct from Destructor Three-way comparison operator The relative order of the objects The right operand Template argument type. Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The type-constraint for the parameter, if any. Keyword (class/typename) the parameter uses merge Construct from SymbolID The object to construct from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand Indicates if this is a new C++ "using"-style typedef using MyVector = std::vector<int> False means it's a C-style typedef: typedef std::vector<int> MyVector; Info for using declarations. For instance, the following code: using A::f; // where f is a function in namespace A would be represented by a UsingSymbol object. Using-declarations can be used to introduce namespace members into other namespaces and block scopes, or to introduce base class members into derived class definitions, or to introduce enumerators into namespaces, block, and class scopes. merge Construct from SymbolID The object to construct from Three-way comparison operator The relative order of the objects The right operand The using declaration. The symbol being introduced. This is the symbol that is being "used" or introduced into the current scope. Note that this can be a qualified name, such as A::f in the example above. The shadow declarations. A using declaration can refer to and introduce multiple symbols into the current context. These multiple symbols are considered a special case of declarations: "shadow declarations". This typically happens when there are conflicting symbol names in the scope being introduced, such as: Overloaded functions: the base namespace contains overloaded functions. Name conflicts: the base scope contains a function and a type. Enums: a using enum declaration can refer to multiple enumerators. Also note that more shadow declarations can be introduced later in the same scope, after the using declaration. The shadow declarations here are only those that are shadowed at the point where the using declaration is located. A variable. This includes variables at namespace or record scope. merge Construct from SymbolID The object to copy construct from Three-way comparison operator The relative order of the objects The right operand Three-way comparison operator The relative order of the objects The right operand The width of the bitfield The default member initializer, if any. Whether the field is a bitfield Whether the field is declared mutable Whether the field is a variant member The template information, if any. The type of the variable Default constructor A scoped guard which unlocks a mutex. Constructor. The object to copy construct from Destructor. Access specifier. None is set to zero since it is the most frequently occurring access, and it is elided by the bitstream encoder because it has an all-zero bit pattern. This improves compression in the bitstream. None is used for namespace members and friend; such declarations have no access. Unspecified access Public access Protected access Private access The kind of auto keyword used in a declaration. This is either auto or decltype(auto) . The auto keyword The decltype(auto) keyword constexpr / consteval specifier kinds [ dcl.spec.general ]p2: At most one of the constexpr , consteval , and constinit keywords shall appear in a decl-specifier-seq No constexpr or consteval specifier The constexpr specifier The consteval specifier only valid for functions Explicit specifier kinds No explicit-specifier or explicit-specifier evaluated to false explicit-specifier evaluates to true Dependent explicit-specifier Determine why a symbol is extracted The enum constants are ordered by specificity, with the least specific at the beginning and the most specific at the end. leastSpecific mostSpecific toString We're extracting the current symbol because it passes all filters. We're extracting the current symbol because it passes all filters, but we should also tag it as see-below because it passes one of the see-below filters. This symbol has its own page but it has no details and no child members. We're extracting the current symbol because it passes all filters, but we should also tag it as implementation-defined because one of its parents matches the implementation-defined filter. This symbol has no page and other symbols that depend on it will just render / implementation-defined /. We're extracting the current symbol even though it doesn't pass all filters because it's a direct dependency of a symbol that does pass all filters and needs information about it (e.g.: base classes outside the filters). This symbol has no page and it might even deleted from the corpus if no other symbol depends on it after we extracted the information we wanted from it in post-processing steps. File in the source directory File in a system include directory File outside the source directory Function classifications The function is a normal function. The function is a constructor. The function is a conversion operator. The function is a destructor. Categorically describes a fundamental type. https://en.cppreference.com/w/cpp/language/types makeChar makeLong makeShort makeSigned makeUnsigned toString void std::nullptr_t bool char signed char unsigned char char8_t char16_t char32_t wchar_t short / short int / signed short / signed short int unsigned short / unsigned short int int / signed / signed int unsigned / unsigned int long / long int / signed long / signed long int unsigned long / unsigned long int long long / long long int / signed long long / signed long long int unsigned long long / unsigned long long int float double long double Exception specification kinds Potentially-throwing exception specification Non-throwing exception specification Dependent exception specification Operator kinds getOperatorKind getOperatorKindFromSuffix getOperatorName getOperatorReadableName getSafeOperatorName getShortOperatorName isBinaryOperator isUnaryOperator No operator The new Operator The delete Operator The new[] Operator The delete[] Operator The + Operator The - Operator The * Operator The / Operator The % Operator The ^ Operator The & Operator The | Operator The ~ Operator The ! Operator The += Operator The -= Operator The *= Operator The /= Operator The %= Operator The ^= Operator The &= Operator The |= Operator The << Operator The >> Operator The <<= Operator The >>= Operator The ! Operator The == Operator The != Operator The < Operator The <= Operator The > Operator The >= Operator The <=> Operator The && Operator The || Operator The ++ Operator The -- Operator The , Operator The ->* Operator The -> Operator The () Operator The [ ]Operator The ? : Operator The coawait Operator Type qualifiers No qualifiers The const qualifier The volatile qualifier The kind of record: struct, class, or union. A struct. A C++ class. A C-style Union Reference type kinds Not a reference An L-Value reference An R-Value reference Storage class kinds [ dcl.stc ]p1: At most one storage-class-specifier shall appear in a given decl-specifier-seq, except that thread_local may appear with static or extern . No storage class specifier thread_local storage-class-specifier mutable storage-class-specifier auto storage-class-specifier (removed in C++11) only valid for variables register storage-class-specifier (removed in C++17) only valid for variables Info variant discriminator toString Kind is not specified. The kind of template argument. The keyword a template parameter was declared with Class keyword Typename keyword The kind of template or specialization. Primary template Full template specialization Partial template specialization The class of using declaration. This indicates whether the using declaration is a normal using , a using typename , or a using enum . Using declaration class. Using typename declaration class. Using enum declaration class. HTML escapes the specified string. This function HTML escapes the specified string, making it safe for rendering as text within HTML content. Replaces & , < , > , " , ' , , =` with the HTML entity equivalent value for string values. The output of all expressions except for triple-braced expressions are passed through this method. Helpers should also use this method when returning HTML content via a SafeString instance, to prevent possible code injection. Helper values created by the SafeString function are left untouched by the template and are not passed through this function. The escaped string. The string to escape. HTML escapes the specified string This function HTML escapes the specified string, making it safe for rendering as text within HTML content. Replaces & , < , > , " , ' , , =` with the HTML entity equivalent value for string values. The output of all expressions except for triple-braced expressions are passed through this method. Helpers should also use this method when returning HTML content via a SafeString instance, to prevent possible code injection. Helper values created by the SafeString function are left untouched by the template and are not passed through this function. This function has the same behavior as the corresponding utility function in the Handlebars.js library. The output stream reference where the escaped string will be written. The string to escape. https://github.com/handlebars-lang/handlebars.js/blob/master/lib/handlebars/utils.js OutputRef Return the result of comparing s0 to s1. This function returns true if the string s0 is less than the string s1. The comparison is first made without regard to case, unless the strings compare equal and then they are compared with lowercase letters coming before uppercase letters. The result of the comparison. The first symbol name to compare. The second symbol name to compare. Create child data objects. This function can be used by block helpers to create child data objects. The child data object is an overlay frame object implementation that will first look for a value in the child object and if not found will look in the parent object. Helpers that modify the data state should create a new frame object when doing so, to isolate themselves and avoid corrupting the state of any parents. Generally, only one frame needs to be created per helper execution. For example, the each iterator creates a single frame which is reused for all child execution. The overlay object The underlying frame object https://mustache.github.io/mustache.5.html#Sections Object Determine if a string ends with one of the specified characters if a string ends with one of the specified characters The string to check. The characters to check for. Call a function for each file in a directory. This will iterate all the regular files in a directory and invoke the visitor with the path. An error if any occurred. The path to the directory. If true, files in subdirectories are also visited, recursively. The visitor to invoke for each file. Expected Convert a string to a FundamentalTypeKind. This function converts a string to a FundamentalTypeKind. All variations of the type specifiers are supported. However, the "long long" specifier cannot be split into two separate specifiers. true if the string was successfully converted The string to convert The resulting FundamentalTypeKind Return a reference to the global Generators instance. a reference to the global Generators instance. Generators Return the short name of an operator as a string. The OperatorKind, or OperatorKind::None if not recognized. The operator name, e.g. operator+ , operator++ , operator[] , etc. OperatorKind Return the short name of an operator as a string. The OperatorKind, or OperatorKind::None if not recognized. The operator suffix, e.g. + , ++ , [] , etc. OperatorKind Return the name of an operator as a string. the name of an operator as a string. The kind of operator. Whether the name should be prefixed with the operator keyword. OperatorKind Return the human-readable name of the operator The readable name, or nullopt if the operator is not recognized. The kind of operator. The number of parameters the operator takes. OperatorKind Optional Return a list of the parent symbols of the specified Symbol. a list of the parent symbols of the specified Symbol. The collection of declarations in extracted form. Base class with common properties of all symbols Corpus SymbolID Return a list of the parent symbols of the specified Info. a list of the parent symbols of the specified Info. Front-end factory for producing Dom nodes. Base class with common properties of all symbols Array DomCorpus Return the safe name of an operator as a string. the safe name of an operator as a string. The kind of operator. Whether the name should be prefixed with operator_ . OperatorKind Return the short name of an operator as a string. the short name of an operator as a string. Operator kinds OperatorKind Return the full path for single page output. This function determines the full path for a single-page output file based on the provided outputPath and file extension . If the outputPath already exists: - If it is a directory, appends the default file name with the provided extension. - If it is a file, uses the provided outputPath directly. If the outputPath does not exist: - If it ends with a '/', assumes it is a directory and appends the default file name. - Otherwise, it returns an error because the path is ambiguous. The full path or an error if the outputPath is ambiguous. The specified output path, which can be a directory or file. The file extension to use for single-page output. Expected Return the inner type. The inner type is the type that is modified by a specifier (e.g. "int" in "pointer to int"). the inner type. A possibly qualified type. ArrayType AutoType DecltypeType FunctionType LValueReferenceType MemberPointerType NamedType Optional PointerType Polymorphic RValueReferenceType Type TypeCommonBase Return the inner type. The inner type is the type that is modified by a specifier (e.g. "int" in "pointer to int"). the inner type. A possibly qualified type. ArrayType AutoType DecltypeType FunctionType LValueReferenceType MemberPointerType NamedType Optional PointerType Polymorphic RValueReferenceType Type TypeCommonBase Return the inner type. The inner type is the type that is modified by a specifier (e.g. "int" in "pointer to int"). the inner type. A possibly qualified type. ArrayType AutoType DecltypeType FunctionType LValueReferenceType MemberPointerType NamedType PointerType RValueReferenceType Type TypeCommonBase Return the inner type. The inner type is the type that is modified by a specifier (e.g. "int" in "pointer to int"). the inner type. A possibly qualified type. ArrayType AutoType DecltypeType FunctionType LValueReferenceType MemberPointerType NamedType PointerType RValueReferenceType Type TypeCommonBase Return the innermost type. The innermost type is the type which is not modified by any specifiers (e.g. "int" in "pointer to const int"). If the type has an inner type, we recursively call this function until we reach the innermost type. If the type has no inner type, we return the current type. the innermost type. A polymorphic value-type. Polymorphic Return the innermost type. The innermost type is the type which is not modified by any specifiers (e.g. "int" in "pointer to const int"). If the type has an inner type, we recursively call this function until we reach the innermost type. If the type has no inner type, we return the current type. the innermost type. A polymorphic value-type. Polymorphic Determines whether the operator is potentially binary. whether the operator is potentially binary. Operator kinds OperatorKind Determine if a value is empty This is used by the built-in if and with helpers to control their execution flow. The Handlebars definition of empty is any of: - Array with length 0 - falsy values other than 0 This is intended to match the Mustache Behaviour. True if the value is empty, false otherwise The value to test https://mustache.github.io/mustache.5.html#Sections Value Determines whether the operator is potentially unary. whether the operator is potentially unary. Operator kinds OperatorKind Determine if a string is only whitespace. true if the string is empty or contains only whitespace characters (space, tab, newline, vertical tab, form feed, carriage return). false otherwise. The string to check. Compare ExtractionModes and returns the least specific This function returns the least specific of the two ExtractionModes in terms of the number of filters passed. If the symbol passes the filter that categorizes it as a , then it also passes the filter that categorizes it as b (or vice-versa), then this function will return the final category for the symbol. Determine why a symbol is extracted Determine why a symbol is extracted Determine why a symbol is extracted ExtractionMode Return the substring without leading horizontal whitespace. The modified string. The string to trim. Return the substring without leading specified characters. The modified string. The string to trim. The characters to remove. Apply the "char" specifier to the type If applying the "char" specifier to a type that might have been declared only with "signed/unsigned" or "short/long" specifiers, the function changes the type and returns true. For instance, applying "char" to FundamentalTypeKind::Int ("int", which could be declared as "signed") results in FundamentalTypeKind::SignedChar ("signed char"). Whether the operation was successful The type to modify FundamentalTypeKind Apply the "long" specifier to the type If applying "long" the specifier is a valid operation the function changes the type and returns true. For instance, applying "long" to FundamentalTypeKind::Int ("int") results in FundamentalTypeKind::Long ("long int"). Whether the operation was successful The type to modify FundamentalTypeKind Apply the "short" specifier to the type If applying "short" the specifier is a valid operation the function changes the type and returns true. For instance, applying "short" to FundamentalTypeKind::Int ("int") results in FundamentalTypeKind::Short ("short int"). Whether the operation was successful The type to modify FundamentalTypeKind Apply the "signed" specifier to the type If applying the "signed" specifier is a valid operation the function changes the type and returns true. For instance, applying "signed" to FundamentalTypeKind::Char ("char") results in FundamentalTypeKind::SignedChar ("signed char"). It also returns true if applying the "signed" specifier is a valid operation but doesn't affect the type. For instance, applying "signed" to FundamentalTypeKind::Int ("int") doesn't change the type but returns true , even though FundamentalTypeKind::Int could be declared as "int" or "signed" and multiple "signed" specifiers are not allowed. Whether the operation was successful The type to modify FundamentalTypeKind Apply the "unsigned" specifier to the type If applying the "unsigned" specifier is a valid operation the function changes the type and returns true. For instance, applying "unsigned" to FundamentalTypeKind::Char ("char") results in FundamentalTypeKind::UnsignedChar ("unsigned char") and applying "unsigned" to FundamentalTypeKind::Int ("int") results in FundamentalTypeKind::UnsignedInt ("unsigned int"). Whether the operation was successful The type to modify FundamentalTypeKind Merges two Symbol objects. This function is used to merge two Symbol objects with the same SymbolID. The function assumes that the two Symbol objects are of the same type. If they are not, the function will fail. The Symbol object to merge into. The Symbol object to merge from. ConceptSymbol EnumConstantSymbol EnumSymbol FunctionSymbol GuideSymbol NamespaceAliasSymbol NamespaceSymbol OverloadsSymbol RecordSymbol Symbol SymbolCommonBase TypedefSymbol UsingSymbol VariableSymbol Compare ExtractionModes and returns the most specific This function returns the most specific of the two ExtractionModes in terms of number of filters passed. Determine why a symbol is extracted Determine why a symbol is extracted Determine why a symbol is extracted ExtractionMode Determine if one function would override the other if one function would override the other The base function The derived function FunctionSymbol Reindent code by removing the common leading spaces and adding the specified indent. The modified code block. The code block to unindent. Return the substring without leading and trailing horizontal whitespace. The modified string. The string to trim. The substring to remove. The substring to replace with. If this is empty, the substring is removed. Return the substring without trailing horizontal whitespace. The modified string. The string to trim. Return the substring without trailing specified characters. The modified string. The string to trim. The characters to remove. Create a wrapper for a safe string. This string wrapper prevents the string from being escaped when the template is rendered. When a helper returns a safe string, it will be marked as safe and will not be escaped when rendered. The string will be rendered as if converted to a dom::Value and rendered as-is. When constructing the string that will be marked as safe, any external content should be properly escaped using the escapeExpression function to avoid potential security concerns. The safe string wrapper The string to mark as safe https://handlebarsjs.com/api-reference/utilities.html#handlebars-safestring-string Determine if a string starts with one of the specified characters if a string starts with one of the specified characters The string to check. The characters to check for. Return the SymbolKind from a dom::Value string. A variant container for any kind of Dom value. Determine why a symbol is extracted ValueFromTag Return the ReferenceKind as a dom::Value string. A variant container for any kind of Dom value. Reference type kinds ValueFromTag Return the UsingClass as a dom::Value string. The output value. The UsingClass to convert. ValueFromTag Return the AccessKind as a dom::Value string. A variant container for any kind of Dom value. Access specifier. ValueFromTag Return the ConstexprKind as a dom::Value string. A variant container for any kind of Dom value. constexpr / consteval specifier kinds ValueFromTag Return the FunctionClass from a dom::Value string. A variant container for any kind of Dom value. Function classifications ValueFromTag Return the StorageClassKind as a dom::Value string. A variant container for any kind of Dom value. Storage class kinds ValueFromTag Return the SymbolKind from a dom::Value string. A variant container for any kind of Dom value. Info variant discriminator ValueFromTag Return the ExplicitInfo as a dom::Value string. The output parameter to receive the dom::Value. The ExplicitInfo to convert. ValueFromTag Convert SymbolID to dom::Value string in the DOM using toBase16 A variant container for any kind of Dom value. A unique identifier for a symbol. ValueFromTag Map the ConceptSymbol to a dom::Value object. A variant container for any kind of Dom value. Info for concepts. Front-end factory for producing Dom nodes. ValueFromTag Return the DocComment as a dom::Value object. A variant container for any kind of Dom value. A processed documentation comment attached to a declaration. Front-end factory for producing Dom nodes. ValueFromTag Map the EnumConstantSymbol to a dom::Value object. A variant container for any kind of Dom value. Info for enum constants. Front-end factory for producing Dom nodes. ValueFromTag Map the EnumSymbol to a dom::Value object. The output parameter to receive the dom::Value. The EnumSymbol to convert. The DomCorpus used to resolve references. ValueFromTag Map the FriendInfo to a dom::Value object. A variant container for any kind of Dom value. Info for friend declarations. Front-end factory for producing Dom nodes. ValueFromTag Map the FunctionSymbol to a dom::Value object. The output parameter to receive the dom::Value. The FunctionSymbol to convert. The DomCorpus used to resolve references. ValueFromTag Map the GuideSymbol to a dom::Value object. A variant container for any kind of Dom value. Info for deduction guides. Front-end factory for producing Dom nodes. ValueFromTag Map the NamespaceAliasSymbol to a dom::Value object. A variant container for any kind of Dom value. Info for namespace aliases. Front-end factory for producing Dom nodes. ValueFromTag Map the NamespaceSymbol to a dom::Value object. A variant container for any kind of Dom value. Describes a namespace. Front-end factory for producing Dom nodes. ValueFromTag Map the NamespaceTranche to a dom::Value object. A variant container for any kind of Dom value. The members of a Namespace Front-end factory for producing Dom nodes. ValueFromTag Map the OverloadsSymbol to a dom::Value object. A variant container for any kind of Dom value. Represents a set of function overloads. Front-end factory for producing Dom nodes. ValueFromTag Return the Param as a dom::Value object. A variant container for any kind of Dom value. Represents a single function parameter Front-end factory for producing Dom nodes. ValueFromTag Map the RecordInterface to a dom::Value object. A variant container for any kind of Dom value. The aggregated interface for a given struct, class, or union. Front-end factory for producing Dom nodes. ValueFromTag Map the RecordSymbol to a dom::Value object. A variant container for any kind of Dom value. Metadata for struct, class, or union. Front-end factory for producing Dom nodes. ValueFromTag Map the RecordTranche to a dom::Value object. A variant container for any kind of Dom value. A group of members that have the same access specifier. Front-end factory for producing Dom nodes. ValueFromTag Return the Symbol as a dom::Value object. A variant container for any kind of Dom value. Base class with common properties of all symbols Front-end factory for producing Dom nodes. ValueFromTag Convert SymbolID to dom::Value object in the DOM using Corpus A variant container for any kind of Dom value. A unique identifier for a symbol. Front-end factory for producing Dom nodes. ValueFromTag Map the TypedefSymbol to a dom::Value object. The output parameter to receive the dom::Value. The TypedefSymbol to convert. The DomCorpus used to resolve references. ValueFromTag Map the UsingSymbol to a dom::Value object. A variant container for any kind of Dom value. Info for using declarations. Front-end factory for producing Dom nodes. ValueFromTag Map the VariableSymbol to a dom::Value object. A variant container for any kind of Dom value. A variable. Front-end factory for producing Dom nodes. ValueFromTag Convert SymbolID pointers to dom::Value or null. The output parameter to receive the dom::Value. The SymbolID pointer to convert. If null, the dom::Value is set to null. The DomCorpus to use, or nullptr. If null, the SymbolID is converted to a base16 string. ValueFromTag Convert a SymbolID to a string The base16 string representation of the SymbolID. The SymbolID to convert. SymbolID Return the name of the SymbolKind as a string. the name of the SymbolKind as a string. Determine why a symbol is extracted ExtractionMode Convert a FundamentalTypeKind to a string. This function converts a FundamentalTypeKind to the shortest canonical string representing the type. The string representation of the kind Categorically describes a fundamental type. FundamentalTypeKind Return the name of the SymbolKind as a string. the name of the SymbolKind as a string. Info variant discriminator String SymbolKind Convert ExplicitInfo to a string. The string representation of the explicit-specifier. The explicit-specifier information. If true, the operand is not shown when the explicit-specifier is non-dependent. If true, implicit explicit-specifiers are shown. ExplicitInfo String Convert NoexceptInfo to a string. The string representation of the noexcept-specifier. The noexcept-specifier information. If true, the operand is not shown when the exception specification is non-dependent. If true, implicit exception specifications are shown. NoexceptInfo String Return the substring without leading and trailing horizontal whitespace. The modified string. The string to trim. Return the substring without leading and trailing specified characters. The modified string. The string to trim. The characters to remove. Write to output A reference to this object The output stream reference The string to write Write to output A reference to this object The output stream reference The character to write Write to output A reference to this object The output stream reference The string to write Equality operator true if the objects are equal, false otherwise The left operand The right operand Equality operator true if the objects are equal, false otherwise The left operand The right operand Equality operator true if the objects are equal, false otherwise The left operand The right operand Optional Equality operator true if the objects are equal, false otherwise The left operand The right operand Polymorphic Equality operator true if the objects are equal, false otherwise The left operand The right operand Polymorphic Equality operator true if the objects are equal, false otherwise The left operand The right operand Optional Equality operator true if the objects are equal, false otherwise The left operand The right operand Polymorphic Equality operator true if the objects are equal, false otherwise The left operand The right operand Three-way comparison operator The relative order of the objects The left operand The right operand Three-way comparison operator The relative order of the objects The left operand The right operand Polymorphic Three-way comparison operator The relative order of the objects The left operand The right operand Optional Three-way comparison operator The relative order of the objects The left operand The right operand Polymorphic Three-way comparison operator The relative order of the objects The left operand The right operand Polymorphic Three-way comparison operator The relative order of the objects The left operand The right operand Polymorphic Three-way comparison operator The relative order of the objects The left operand The right operand Optional Split a string view into lines, recognizing all common line breaks This is a convenience function for creating a SplitLinesView.