doxybook::json_converter

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

class json_converter;

Convert elements to json so they can be rendered with inja.

Public Functions

Member Functions	Description
(constructor)	Constructor. (function)
convert const	Convert a vector of strings to a json array. (function)
get_as_json const	Convert a doxygen node to json. (function)

Public Functions

function json_converter

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

explicit json_converter(
    config const & config, 
    doxygen const & doxygen, 
    text_printer const & plainPrinter, 
    text_printer const & markdownPrinter);

Constructor.

Exception Safety

Basic exception guarantee.

function convert

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

(1)

nlohmann::json
convert(std::vector< std::string > const & vec) const;

(2)

nlohmann::json
convert(node::class_reference const & class_) const;

(3)

nlohmann::json
convert(std::vector< node::class_reference > const & classes) const;

(4)

nlohmann::json
convert(node::source_location const & location) const;

(5)

nlohmann::json
convert(node::param const & param) const;

(6)

nlohmann::json
convert(node::parameter_list_item const & item) const;

(7)

nlohmann::json
convert(std::vector< node::parameter_list_item > const & item) const;

(8)

nlohmann::json
convert(node const & node) const;

(9)

nlohmann::json
convert(node const & node, node::data const & data) const;

1. Convert a vector of strings to a json array.
2. Convert a class_reference to json.
3. Convert a vector of class references to json.
4. Convert a source location to json.
5. Convert a doxygen param to json.
6. Convert a parameter list item to json.
7. Convert a parameter list to json.
8. Convert a doxygen node to json.
9. Convert a doxygen node data to json.

Exception Safety

Basic exception guarantee.

function get_as_json

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

nlohmann::json
get_as_json(node const & node) const;

Convert a doxygen node to json.

Exception Safety

Basic exception guarantee.

---

_{Updated on 2023-04-03}