doxybook::generator

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

class generator;

A class that stores a doxygen object and generates the markdown documentation.

Description

This is main class in this whole library. The cli executable basically controls this generator.

Public Classes

	Name
struct	summary_section A section we should generate.

Public Types

Member Types	Definition
filter_set	A set of kinds we should use in an operation. (using)

Public Functions

Member Functions	Description
(constructor)	Constructor. (function)
print	Generate the documentation for the specified doxygen kinds. (function)
json	Generate json for the specified doxygen kinds. (function)
manifest	Generate a manifest file. (function)
print_index	Generate the indexes for the specified doxygen kinds. (function)
summary	Generate the summary for the specified doxygen sections. (function)

Public Types

using filter_set

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

using filter_set = std::unordered_set< kind >;

A set of kinds we should use in an operation.

Public Functions

function generator

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

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

Constructor.

Parameters

• config - Configuration options
• doxygen - Doxygen files
• json_converter - Converter from json to markdown
• templates_path - An optional path with templates

Description

The constructor requires the configuration and doxygen object which should be previously constructed.

Exception Safety

Basic exception guarantee.

function print

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

void
print(filter_set const & filter, filter_set const & skip);

Generate the documentation for the specified doxygen kinds.

Exception Safety

Basic exception guarantee.

function json

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

void
json(filter_set const & filter, filter_set const & skip);

Generate json for the specified doxygen kinds.

Exception Safety

Basic exception guarantee.

function manifest

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

void
manifest();

Generate a manifest file.

Exception Safety

Basic exception guarantee.

function print_index

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

void
print_index(
    folder_category type, 
    filter_set const & filter, 
    filter_set const & skip);

Generate the indexes for the specified doxygen kinds.

Exception Safety

Basic exception guarantee.

function summary

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

void
summary(
    std::string const & input_file, 
    std::string const & output_file, 
    std::vector< summary_section > const & sections);

Generate the summary for the specified doxygen sections.

Exception Safety

Basic exception guarantee.

---

_{Updated on 2023-04-03}