A manually specified section heading.
Declared in <mrdocs/Metadata/DocComment/Block/HeadingBlock.hpp>
struct HeadingBlock final
: BlockCommonBase<BlockKind::Heading>
, InlineContainer
Syntax:
@par Heading
or in Markdown:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
| Name | Description |
|---|---|
BlockCommonBase<BlockKind::Heading> | Base class for providing variant discriminator functions. |
InlineContainer | An internal node in the inline element tree. |
| 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. |
| Name | Description |
|---|---|
children | Child inline elements contained here. |
level | Heading depth (1..6). |
| Name | Description |
|---|---|
HeadingBlock | Inherit inline container constructors. |