mrdocs::doc::getAsPlainText

getAsPlainText overloads

Synopses

Declared in <mrdocs/Metadata/DocComment/Inline/InlineBase.hpp>

Get the plain text representation of an inline element tree.

std::string
getAsPlainText(doc::Inline const& in);

» more...

Flatten an InlineContainer to plain text.

std::string
getAsPlainText(doc::InlineContainer const& in);

» more...

Get the plain text representation of an inline element tree.

void
getAsPlainText(
    doc::Inline const& in,
    std::string& dst);

» more...

Flatten an InlineContainer to plain text.

void
getAsPlainText(
    doc::InlineContainer const& in,
    std::string& dst);

» more...

Return Value

The flattened plain text.

Parameters

Name

Description

in

The input inline element.

dst

The output string to append to.

Created with MrDocs