mrdocs::doc::FootnoteDefinitionBlock

Text defining the content of a footnote reference.

Synopsis

Declared in <mrdocs/Metadata/DocComment/Block/FootnoteDefinitionBlock.hpp>

struct FootnoteDefinitionBlock final
    : BlockCommonBase<BlockKind::FootnoteDefinition>
    , BlockContainer

Base Classes

Name Description

Name	Description
`BlockCommonBase<BlockKind::FootnoteDefinition>`	Base class for providing variant discriminator functions.
`BlockContainer`	A composite block that stores a sequence of child blocks.

BlockCommonBase<BlockKind::FootnoteDefinition>

Base class for providing variant discriminator functions.

BlockContainer

A composite block that stores a sequence of child blocks.

Member Functions

Name

Description

FootnoteDefinitionBlock [constructor]

Construct an empty footnote definition.

asBlockContainer

asBlockContainer overloads

operator==

Equality operators

operator<=>

Three‐way comparison operators

Static Member Functions

Name

isFootnoteDefinition

Data Members

Name

Description

blocks

Child blocks contained within this composite block.

label

Footnote label identifier.

Static Data Members

Name

kind_id

Non-Member Functions

Name

Description

isEmpty

Determine if the inline is empty

ltrim

Removes leading whitespace from the first text elements

ltrim

Removes leading whitespace from the block.

rtrim

Removes trailing whitespace from the last text elements

rtrim

Removes trailing whitespace from the block.

trim

Removes leading and trailing whitespace from the block.

trim

Removes leading and trailing whitespace from the text elements

Description

Syntax:

This is a sentence with a footnote[^1].

[^1]: This is the content of the footnote. It can also have multiple paragraphs.
      Here is the second paragraph, which needs to be indented.

Created with MrDocs