doxybook::text_printer

^{Defined in header <doxybook/text_printer.hpp>}

class text_printer;

An abstract text printer.

Inherited by: text_printer is a base class for text_markdown_printer and text_plain_printer

Public Functions

Member Functions	Description
(constructor)	Constructor. (function)
(destructor) = default	Destructor. (virtual function)
print const = 0	Convert an element to text. (virtual function)

Protected Attributes

Member Protected Attributes	Description
config_	config const & (protected variable)
doxygen_	doxygen const & (protected variable)

Public Functions

function text_printer

^{Defined in header <doxybook/text_printer.hpp>}

explicit text_printer(config const & config, doxygen const & doxygen);

Constructor.

Exception Safety

Basic exception guarantee.

function ~text_printer

^{Defined in header <doxybook/text_printer.hpp>}

virtual ~text_printer() = default;

Destructor.

Exception Safety

Basic exception guarantee.

function print

^{Defined in header <doxybook/text_printer.hpp>}

virtual std::string
print(
    xml_text_parser::node const & node, 
    std::string const & language ="cpp") const = 0;

Convert an element to text.

Exception Safety

Basic exception guarantee.

Protected Attributes

variable config_

^{Defined in header <doxybook/text_printer.hpp>}

config const  & config_;

variable doxygen_

^{Defined in header <doxybook/text_printer.hpp>}

doxygen const  & doxygen_;

---

_{Updated on 2023-04-03}