mrdocs::doc::HeadingBlock

A manually specified section heading.

Synopsis

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

struct HeadingBlock final
    : BlockCommonBase<BlockKind::Heading>
    , InlineContainer

Base Classes

Name Description

Name	Description
`BlockCommonBase<BlockKind::Heading>`	Base class for providing variant discriminator functions.
`InlineContainer`	An internal node in the inline element tree.

BlockCommonBase<BlockKind::Heading>

Base class for providing variant discriminator functions.

InlineContainer

An internal node in the inline element tree.

Member Functions

Name

Description

operator=

Assignment operators

append

append overloads

asInlineContainer

Return this container as a base‐class reference.

back

Get the last inline child.

begin

Begin iterator forwarding to children.

clear

Clear all inline children.

emplace_back

Append a child of the specified type in‐place.

empty

Determine if there are no inline children.

end

End iterator forwarding to children.

erase

Erase inline children.

front

Get the first inline child.

insert

Insert inline children.

operator+=

Addition assignment operators

size

Get the number of inline children.

operator==

Equality operators

operator<=>

Three‐way comparison operators

Static Member Functions

Name

isFootnoteDefinition

Data Members

Name

Description

children

Child inline elements contained here.

level

Heading depth (1..6).

Static Data Members

Name

kind_id

Using Declarations

Name

Description

HeadingBlock

Inherit inline container constructors.

Non-Member Functions

Name

Description

getAsPlainText

Flatten an InlineContainer to plain text.

getAsPlainText

Flatten an InlineContainer to plain text.

isEmpty

Determine if the inline is empty

ltrim

Removes leading whitespace from the first text element in the given InlineContainer.

ltrim

Removes leading whitespace from the block.

rtrim

Removes trailing whitespace from the last text element in the given InlineContainer.

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 in the given InlineContainer.

Description

Syntax:

@par Heading

or in Markdown:

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Created with MrDocs