A horizontal thematic break separating sections.

Synopsis

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

struct ThematicBreakBlock final
    : BlockCommonBase<BlockKind::ThematicBreak>

Description

Syntax:

---

or

**

or

___

or

- - -
  • You can use an asterisk (), dash (‐), or underscore ().

  • There must be at least three characters in a row.

  • Spaces can be used between the characters, but no other characters.

  • The thematic break should be on its own line, separated by blank lines above and below.

  • Thematic breaks can also be used inside lists, but the character used for the break must be different from the list marker.

Base Classes

Name

Description

BlockCommonBase<BlockKind::ThematicBreak>

Base class for providing variant discriminator functions.

Member Functions

Name

Description

ThematicBreakBlock [constructor]

Copy constructor.

operator=

Copy assignment.

Static Member Functions

Non-Member Functions

Name

Description

isEmpty

Determine if the inline is empty

ltrim

Removes leading whitespace from the block.

rtrim

Removes trailing whitespace from the block.

trim

Removes leading and trailing whitespace from the block.

Created with MrDocs