mrdocs::doc::DefinitionListBlock

A list of terms paired with definitions.

Synopsis

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

struct DefinitionListBlock final
    : BlockCommonBase<BlockKind::List>

Description

Syntax:

Markdown
: A lightweight markup language
: Created by John Gruber in 2004

HTML
: A standard markup language used to create web pages
: Used for structuring content on the internet

In HTML, it looks like:

<dl>
    <dt>First Term</dt>
    <dd>This is the definition of the first term.</dd>
    <dt>Second Term</dt>
    <dd>This is one definition of the second term. </dd>
    <dd>This is another definition of the second term.</dd>
</dl>

Base Classes

Name Description

BlockCommonBase<BlockKind::List>

Base class for providing variant discriminator functions.

Data Members

Name

Description

items

Sequence of definition list items.

Static Data Members

Name

kind_id

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