Mr.Docs The C++ Alliance GitHub Repo
  • Mr.Docs
  • Reference
  • mrdocs
  • doc
  • getAsPlainText-09
master develop 2026.9.4 v0.8.0
Mr.Docs The C++ Alliance GitHub Repo

Mr.Docs

    • Home
    • Demos
    • Installation
    • Getting Started
    • The Configuration File
    • Documenting the Code
    • Generators
    • Design Notes
    • Library Reference
    • Contributor’s Guide
    • License

mrdocs::doc::getAsPlainText

Flatten an InlineContainer to plain text.

Synopsis

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

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

Description

This concatenates all text nodes, ignoring formatting.

Return Value

The flattened plain text.

Parameters

Name

Description

in

The InlineContainer to flatten.

Created with MrDocs