doxybook::renderer

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

class renderer;

Render inja templates with the specified configuration.

Public Functions

Member Functions	Description
(constructor)	Constructor. (function)
(destructor)	(function)
render const	Destructor. (function)

Public Functions

function renderer

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

explicit renderer(
    config const & config, 
    doxygen const & doxygen, 
    json_converter const & json_converter, 
    std::optional< std::string > const & templates_path =std::nullopt);

Constructor.

Exception Safety

Basic exception guarantee.

function ~renderer

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

~renderer();

Exception Safety

Basic exception guarantee.

function render

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

(1)

void
render(
    std::string const & name, 
    std::string const & path, 
    nlohmann::json const & data) const;

(2)

std::string
render(std::string const & name, nlohmann::json const & data) const;

1. Destructor.
2. Render template.

Parameters

• data - data as json
• name - template name

Return value

Exception Safety

Basic exception guarantee.

---

_{Updated on 2023-04-03}