doxybook

Namespaces

Name	Description
doxybook::path
doxybook::utils

Classes

Classes	Description
config	Configuration for the doxygen and generator classes. ^(struct)
default_template	Describe the default template for a page. ^(struct)
doxygen	All the nodes representing the content of doxygen xml files. ^(class)
exception	Doxybook exceptions. ^(class)
generator	A class that stores a doxygen object and generates the markdown documentation. ^(class)
json_converter	Convert elements to json so they can be rendered with inja. ^(class)
node	A doxygen node. ^(class)
renderer	Render inja templates with the specified configuration. ^(class)
text_markdown_printer	Print xml nodes as markdown. ^(class)
text_plain_printer	Print elements as plain text. ^(class)
text_printer	An abstract text printer. ^(class)
xml	Represents and wraps an xml node. ^(class)
xml_text_parser	Parser for a doxygen xml file as an xml document. ^(class)

Types

Member Types	Definition
kind	The kind of a symbol in a doxygen xml file. ^(enum)
visibility	Types of symbol visibility. ^(enum)
virtual_category	Types of virtual functions. ^(enum)
type	Doxygen types. ^(enum)
folder_category	Types of folder category. ^(enum)
node_cache_map	A map of nodes associated to a string. ^(using)

Functions

Member Functions	Description
load_config	Load configuration from a path. ^(function)
load_config_data	Load configuration from a json string. ^(function)
save_config	Save configuration to a path. ^(function)
save_default_templates	Save default templates. ^(function)
to_enum_kind	Convert a string to a doxygen kind. ^(function)
to_enum_type	Convert a string to a doxygen type. ^(function)
to_enum_visibility	Convert a string to a doxygen visibility type. ^(function)
to_enum_virtual	Convert a string to a doxygen virtual category. ^(function)
to_enum_folder_category	Convert a string to a doxygen folder category. ^(function)
to_str	Convert a kind to a string. ^(function)
kind_to_type	Convert a kind to a type. ^(function)
is_kind_language	Determine if kind is a language feature. ^(function)
is_kind_structured	Determine if kind is a structured type. ^(function)
is_kind_file	Determine if kind is a file or directory. ^(function)
type_folder_category_to_folder_name	Determine the appropriate folder name for a folder category. ^(function)
type_to_folder_name	Determine the appropriate folder name for a type. ^(function)
type_to_index_name	Determine the appropriate index file name for a folder category. ^(function)
type_to_index_template	Determine the appropriate index template file name for a folder category. ^(function)
type_to_index_title	Determine the appropriate index title name for a folder category. ^(function)
to_json	Convert a visibility type to a json string. ^(function)
from_json	Convert a json string to a visibility type. ^(function)

Attributes

Member Attributes	Description
default_templates	A map with all the default templates. ^{(public variable)}

Types

enum kind

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

enum class kind;

Enumerator	Value	Description
INDEX
DEFINE
CLASS
NAMESPACE
STRUCT
INTERFACE
FUNCTION
VARIABLE
CONCEPT
TYPEDEF
USING
FRIEND
ENUM
ENUMVALUE
UNION
DIR
FILE
MODULE
PAGE
EXAMPLE
SIGNAL
SLOT
PROPERTY
EVENT
JAVAENUM
JAVAENUMCONSTANT

The kind of a symbol in a doxygen xml file.

enum visibility

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

enum class visibility;

Enumerator	Value	Description
PUBLIC
PROTECTED
PRIVATE
PACKAGE

Types of symbol visibility.

enum virtual_category

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

enum class virtual_category;

Enumerator	Value	Description
NON_VIRTUAL
VIRTUAL
PURE_VIRTUAL

Types of virtual functions.

enum type

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

enum class type;

Enumerator	Value	Description
NONE
DEFINES
FUNCTIONS
NAMESPACES
CLASSES
ATTRIBUTES
TYPES
DIRS
FILES
MODULES
FRIENDS
PAGES
EXAMPLES
SIGNALS
SLOTS
EVENTS
PROPERTIES
JAVAENUMCONSTANTS

Doxygen types.

enum folder_category

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

enum class folder_category;

Enumerator	Value	Description
CLASSES
NAMESPACES
MODULES
PAGES
FILES
EXAMPLES

Types of folder category.

using node_cache_map

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

using node_cache_map = 
    std::unordered_map< std::string, std::shared_ptr< node > >;

A map of nodes associated to a string.

Functions

function load_config

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

void
load_config(config & config, std::string const & path);

Load configuration from a path.

Exception Safety

Basic exception guarantee.

function load_config_data

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

void
load_config_data(config & config, std::string_view src);

Load configuration from a json string.

Exception Safety

Basic exception guarantee.

function save_config

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

void
save_config(config & config, std::string const & path);

Save configuration to a path.

Exception Safety

Basic exception guarantee.

function save_default_templates

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

void
save_default_templates(std::string const & path);

Save default templates.

Description

This function stores all the default templates to files. The user can edit these templates to come up with new templates.

Exception Safety

Basic exception guarantee.

function to_enum_kind

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

kind
to_enum_kind(std::string const & str);

Convert a string to a doxygen kind.

Exception Safety

Basic exception guarantee.

function to_enum_type

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

type
to_enum_type(std::string const & str);

Convert a string to a doxygen type.

Exception Safety

Basic exception guarantee.

function to_enum_visibility

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

visibility
to_enum_visibility(std::string const & str);

Convert a string to a doxygen visibility type.

Exception Safety

Basic exception guarantee.

function to_enum_virtual

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

virtual_category
to_enum_virtual(std::string const & str);

Convert a string to a doxygen virtual category.

Exception Safety

Basic exception guarantee.

function to_enum_folder_category

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

folder_category
to_enum_folder_category(std::string const & str);

Convert a string to a doxygen folder category.

Exception Safety

Basic exception guarantee.

function to_str

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

(1)

std::string
to_str(kind value);

(2)

std::string
to_str(type value);

(3)

std::string
to_str(visibility value);

(4)

std::string
to_str(virtual_category value);

(5)

std::string
to_str(folder_category value);

Convert a kind to a string.
Convert a type to a string.
Convert a visibility to a string.
Convert a virtual_category to a string.
Convert a folder_category to a string.

Exception Safety

Basic exception guarantee.

function kind_to_type

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

type
kind_to_type(kind kind);

Convert a kind to a type.

Exception Safety

Basic exception guarantee.

function is_kind_language

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

bool
is_kind_language(kind kind);

Determine if kind is a language feature.

Exception Safety

Basic exception guarantee.

function is_kind_structured

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

bool
is_kind_structured(kind kind);

Determine if kind is a structured type.

Exception Safety

Basic exception guarantee.

function is_kind_file

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

bool
is_kind_file(kind kind);

Determine if kind is a file or directory.

Exception Safety

Basic exception guarantee.

function type_folder_category_to_folder_name

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

std::string
type_folder_category_to_folder_name(config const & config, folder_category type);

Determine the appropriate folder name for a folder category.

Return value

The folder name

Description

Get the appropriate folder name in the configuration file for the specified folder category.

Not all types have corresponding folder categories.

Exception Safety

Basic exception guarantee.

function type_to_folder_name

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

std::string
type_to_folder_name(config const & config, type type);

Determine the appropriate folder name for a type.

Return value

The folder name

Description

Get the appropriate folder name in the configuration file for the specified type.

Not all types have corresponding folder categories.

Exception Safety

Basic exception guarantee.

function type_to_index_name

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

std::string
type_to_index_name(config const & config, folder_category type);

Determine the appropriate index file name for a folder category.

Return value

The folder name

Description

Get the appropriate index file name in the configuration file for the specified folder category.

Not all types have corresponding folder categories.

Exception Safety

Basic exception guarantee.

function type_to_index_template

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

std::string
type_to_index_template(config const & config, folder_category type);

Determine the appropriate index template file name for a folder category.

Return value

The folder name

Description

Get the appropriate template file name in the configuration file for the specified folder category.

Not all types have corresponding folder categories.

Exception Safety

Basic exception guarantee.

function type_to_index_title

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

std::string
type_to_index_title(config const & config, folder_category type);

Determine the appropriate index title name for a folder category.

Return value

The folder name

Description

Get the appropriate index title name in the configuration file for the specified folder category.

Not all types have corresponding folder categories.

Exception Safety

Basic exception guarantee.

function to_json

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

(1)

void
to_json(nlohmann::json & j, visibility const & p);

(2)

void
to_json(nlohmann::json & j, folder_category const & p);

Convert a visibility type to a json string.
Convert a folder category to a json string.

Exception Safety

Basic exception guarantee.

function from_json

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

(1)

void
from_json(nlohmann::json const & j, visibility & p);

(2)

void
from_json(nlohmann::json const & j, folder_category & p);

Convert a json string to a visibility type.
Convert a json string to a folder category.

Exception Safety

Basic exception guarantee.

Attributes

variable default_templates

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

std::unordered_map< std::string, default_template > default_templates;

A map with all the default templates.

Description

Unless template files are provided, these templates are used.

_{Updated on 2023-04-03}