doxybook::doxygen

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

class doxygen;

All the nodes representing the content of doxygen xml files.

Public Functions

Member Functions	Description
(constructor)	Constructor. (function)
(destructor) = default	Destructor. (virtual function)
load	Load an xml directory generated with doxygen. (function)
finalize	Finalize by printing the index with the printers. (function)
get_index const	Get root node representing the index. (function)
find const	Find a node with the given ID. (function)
find_if const	Find a node with the given condition. (function)
get_cache const	Get cache of nodes. (function)

Public Functions

function doxygen

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

explicit doxygen(config const & c);

Constructor.

Exception Safety

Basic exception guarantee.

function ~doxygen

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

virtual ~doxygen() = default;

Destructor.

Exception Safety

Basic exception guarantee.

function load

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

void
load(std::string const & input_dir);

Load an xml directory generated with doxygen.

Exception Safety

Basic exception guarantee.

function finalize

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

void
finalize(
    text_printer const & plain_printer, 
    text_printer const & markdown_printer);

Finalize by printing the index with the printers.

Exception Safety

Basic exception guarantee.

function get_index

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

node const  &
get_index() const;

Get root node representing the index.

Exception Safety

Basic exception guarantee.

function find

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

std::shared_ptr< node >
find(std::string const & refid) const;

Find a node with the given ID.

Exception Safety

Basic exception guarantee.

function find_if

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

std::shared_ptr< node >
find_if(std::function< bool(node const &)> f) const;

Find a node with the given condition.

Exception Safety

Basic exception guarantee.

function get_cache

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

node_cache_map const  &
get_cache() const;

Get cache of nodes.

Exception Safety

Basic exception guarantee.

---

_{Updated on 2023-04-03}