mrdocs::doc::DefinitionListItem

An item in a definition list

Synopsis

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

struct DefinitionListItem final
    : BlockContainer

Base Classes

Name Description

BlockContainer

A composite block that stores a sequence of child blocks.

Member Functions

Name

Description

asBlockContainer

asBlockContainer overloads

Data Members

Name

Description

blocks

Child blocks contained within this composite block.

term

The term being defined.

Non-Member Functions

Name

Description

ltrim

Removes leading whitespace from the first text elements

rtrim

Removes trailing whitespace from the last text elements

trim

Removes leading and trailing whitespace from the text elements

Created with MrDocs