doxybook::config

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

struct config;

Configuration for the doxygen and generator classes.

Public Attributes

Member Public Attributes	Description
output_dir	Where to store the output files? ^{(public variable)}
debug_template_json	Generate extra JSON for each rendered template. ^{(public variable)}
use_folders	Put all files into categorized folders. ^{(public variable)}
undocumented_macros	Whether we should allow undocumented macros. ^{(public variable)}
index_in_folders	Put index files into the respective subdirectories. ^{(public variable)}
main_page_in_root	Main page should be located in the root directory. ^{(public variable)}
main_page_name	Name of the mainpage / indexpage. ^{(public variable)}
base_url	The base URL to prepend all links with. ^{(public variable)}
file_extension	The extension for markdown files. ^{(public variable)}
link_suffix	The suffix to end links with. ^{(public variable)}
replaceUnderscoresInAnchors	Replace underscores with hyphens in anchors. ^{(public variable)}
sort	Sort symbols alphabetically. ^{(public variable)}
copy_images	Copy images from the Doxygen xml dir. ^{(public variable)}
images_folder	Where to copy images. ^{(public variable)}
link_lowercase	Convert all refids and folder names to lowercase. ^{(public variable)}
link_and_inline_code_as_html	Output links/code as /`tags instead of Markdown. ^{(public variable)}`
folder_groups_name	The modules folder name. ^{(public variable)}
folder_classes_name	The classes folder name. ^{(public variable)}
folder_files_name	The files folder name. ^{(public variable)}
folder_related_pages_name	The pages folder name. ^{(public variable)}
folder_namespaces_name	The namespaces folder name. ^{(public variable)}
folder_examples_name	The examples folder name. ^{(public variable)}
index_groups_name	The groups index file name. ^{(public variable)}
index_classes_name	The classes index file name. ^{(public variable)}
index_files_name	The files index file name. ^{(public variable)}
index_related_pages_name	The relatedPages index file name. ^{(public variable)}
index_namespaces_name	The namespaces index file name. ^{(public variable)}
index_examples_name	The examples index file name. ^{(public variable)}
template_kind_class	The template file we should use for classes. ^{(public variable)}
template_kind_struct	The template file we should use for structs. ^{(public variable)}
template_kind_union	The template file we should use for unions. ^{(public variable)}
template_kind_interface	The template file we should use for interfaces. ^{(public variable)}
template_kind_java_enum	The template file we should use for java enums. ^{(public variable)}
template_kind_namespace	The template file we should use for namespaces. ^{(public variable)}
template_kind_group	The template file we should use for groups. ^{(public variable)}
template_kind_file	The template file we should use for files. ^{(public variable)}
template_kind_dir	The template file we should use for dirs. ^{(public variable)}
template_kind_page	The template file we should use for pages. ^{(public variable)}
template_kind_example	The template file we should use for examples. ^{(public variable)}
template_index_classes	The template file we should we for the class index. ^{(public variable)}
template_index_namespaces	The template file we should we for the namespace index. ^{(public variable)}
template_index_groups	The template file we should we for the group index. ^{(public variable)}
template_index_files	The template file we should we for the file index. ^{(public variable)}
template_index_related_pages	The template file we should we for the related page index. ^{(public variable)}
template_index_examples	The template file we should we for the example index. ^{(public variable)}
index_classes_title	The title for classes in index pages. ^{(public variable)}
index_namespaces_title	The title for namespaces in index pages. ^{(public variable)}
index_groups_title	The title for groups in index pages. ^{(public variable)}
index_files_title	The title for files in index pages. ^{(public variable)}
index_related_pages_title	The title for relatedPages in index pages. ^{(public variable)}
index_examples_title	The title for examples in index pages. ^{(public variable)}
files_filter	The source files allowed in the output? ^{(public variable)}
folders_to_generate	Folders we should generate. ^{(public variable)}
formulaInlineStart	Token for latex formulas inline start. ^{(public variable)}
formulaInlineEnd	Token for latex formulas inline end. ^{(public variable)}
formulaBlockStart	Token for latex formulas block start. ^{(public variable)}
formulaBlockEnd	Token for latex formulas block end. ^{(public variable)}

Public Attributes

variable output_dir

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

std::string output_dir;

Where to store the output files?

variable debug_template_json

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

bool debug_template_json { false };

Generate extra JSON for each rendered template.

variable use_folders

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

bool use_folders { true };

Put all files into categorized folders.

variable undocumented_macros

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

bool undocumented_macros { false };

Whether we should allow undocumented macros.

variable index_in_folders

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

bool index_in_folders { false };

Put index files into the respective subdirectories.

Description

(Hugo/Learn) needs that

variable main_page_in_root

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

bool main_page_in_root { false };

Main page should be located in the root directory.

variable main_page_name

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

std::string main_page_name { "indexpage" };

Name of the mainpage / indexpage.

variable base_url

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

std::string base_url { "" };

The base URL to prepend all links with.

variable file_extension

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

std::string file_extension { "md" };

The extension for markdown files.

variable link_suffix

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

std::string link_suffix { ".md" };

The suffix to end links with.

variable replaceUnderscoresInAnchors

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

bool replaceUnderscoresInAnchors { true };

Replace underscores with hyphens in anchors.

variable sort

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

bool sort { false };

Sort symbols alphabetically.

variable copy_images

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

bool copy_images { true };

Copy images from the Doxygen xml dir.

variable images_folder

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

std::string images_folder { "images" };

Where to copy images.

variable link_lowercase

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

bool link_lowercase { false };

Convert all refids and folder names to lowercase.

variable link_and_inline_code_as_html

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

bool link_and_inline_code_as_html { false };

Output links/code as / tags instead of Markdown.


variable folder_groups_name

^{Defined in header}<doxybook/config.hpp>
std::string folder_groups_name { "libraries" };

The modules folder name. 
variable folder_classes_name
^{Defined in header <doxybook/config.hpp>}
std::string folder_classes_name { "classes" };

The classes folder name. 
variable folder_files_name
^{Defined in header <doxybook/config.hpp>}
std::string folder_files_name { "files" };

The files folder name. 
variable folder_related_pages_name
^{Defined in header <doxybook/config.hpp>}
std::string folder_related_pages_name { "pages" };

The pages folder name. 
variable folder_namespaces_name
^{Defined in header <doxybook/config.hpp>}
std::string folder_namespaces_name { "namespaces" };

The namespaces folder name. 
variable folder_examples_name
^{Defined in header <doxybook/config.hpp>}
std::string folder_examples_name { "examples" };

The examples folder name. 
variable index_groups_name
^{Defined in header <doxybook/config.hpp>}
std::string index_groups_name { "index_groups" };

The groups index file name. 
variable index_classes_name
^{Defined in header <doxybook/config.hpp>}
std::string index_classes_name { "index_classes" };

The classes index file name. 
variable index_files_name
^{Defined in header <doxybook/config.hpp>}
std::string index_files_name { "index_files" };

The files index file name. 
variable index_related_pages_name
^{Defined in header <doxybook/config.hpp>}
std::string index_related_pages_name { "index_pages" };

The relatedPages index file name. 
variable index_namespaces_name
^{Defined in header <doxybook/config.hpp>}
std::string index_namespaces_name { "index_namespaces" };

The namespaces index file name. 
variable index_examples_name
^{Defined in header <doxybook/config.hpp>}
std::string index_examples_name { "index_examples" };

The examples index file name. 
variable template_kind_class
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_class { "kind_class" };

The template file we should use for classes. 
variable template_kind_struct
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_struct { "kind_class" };

The template file we should use for structs. 
variable template_kind_union
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_union { "kind_class" };

The template file we should use for unions. 
variable template_kind_interface
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_interface { "kind_class" };

The template file we should use for interfaces. 
variable template_kind_java_enum
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_java_enum { "kind_class" };

The template file we should use for java enums. 
variable template_kind_namespace
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_namespace { "kind_nonclass" };

The template file we should use for namespaces. 
variable template_kind_group
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_group { "kind_nonclass" };

The template file we should use for groups. 
variable template_kind_file
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_file { "kind_file" };

The template file we should use for files. 
variable template_kind_dir
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_dir { "kind_file" };

The template file we should use for dirs. 
variable template_kind_page
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_page { "kind_page" };

The template file we should use for pages. 
variable template_kind_example
^{Defined in header <doxybook/config.hpp>}
std::string template_kind_example { "kind_page" };

The template file we should use for examples. 
variable template_index_classes
^{Defined in header <doxybook/config.hpp>}
std::string template_index_classes { "index_classes" };

The template file we should we for the class index. 
variable template_index_namespaces
^{Defined in header <doxybook/config.hpp>}
std::string template_index_namespaces { "index_namespaces" };

The template file we should we for the namespace index. 
variable template_index_groups
^{Defined in header <doxybook/config.hpp>}
std::string template_index_groups { "index_groups" };

The template file we should we for the group index. 
variable template_index_files
^{Defined in header <doxybook/config.hpp>}
std::string template_index_files { "index_files" };

The template file we should we for the file index. 
variable template_index_related_pages
^{Defined in header <doxybook/config.hpp>}
std::string template_index_related_pages { "index_pages" };

The template file we should we for the related page index. 
variable template_index_examples
^{Defined in header <doxybook/config.hpp>}
std::string template_index_examples { "index_examples" };

The template file we should we for the example index. 
variable index_classes_title
^{Defined in header <doxybook/config.hpp>}
std::string index_classes_title { "Classes" };

The title for classes in index pages. 
variable index_namespaces_title
^{Defined in header <doxybook/config.hpp>}
std::string index_namespaces_title { "Namespaces" };

The title for namespaces in index pages. 
variable index_groups_title
^{Defined in header <doxybook/config.hpp>}
std::string index_groups_title { "Libraries" };

The title for groups in index pages. 
variable index_files_title
^{Defined in header <doxybook/config.hpp>}
std::string index_files_title { "Files" };

The title for files in index pages. 
variable index_related_pages_title
^{Defined in header <doxybook/config.hpp>}
std::string index_related_pages_title { "Pages" };

The title for relatedPages in index pages. 
variable index_examples_title
^{Defined in header <doxybook/config.hpp>}
std::string index_examples_title { "Examples" };

The title for examples in index pages. 
variable files_filter
^{Defined in header <doxybook/config.hpp>}
std::vector< std::string > files_filter {};

The source files allowed in the output? 
Description
An empty list means all files are allowed 
variable folders_to_generate
^{Defined in header <doxybook/config.hpp>}
std::vector< folder_category > folders_to_generate {
            folder_category::MODULES,    folder_category::CLASSES,
            folder_category::FILES,      folder_category::PAGES,
            folder_category::NAMESPACES, folder_category::EXAMPLES,
        };

Folders we should generate. 
variable formulaInlineStart
^{Defined in header <doxybook/config.hpp>}
std::string formulaInlineStart { "\\(" };

Token for latex formulas inline start. 
variable formulaInlineEnd
^{Defined in header <doxybook/config.hpp>}
std::string formulaInlineEnd { "\\)" };

Token for latex formulas inline end. 
variable formulaBlockStart
^{Defined in header <doxybook/config.hpp>}
std::string formulaBlockStart { "\\[" };

Token for latex formulas block start. 
variable formulaBlockEnd
^{Defined in header <doxybook/config.hpp>}
std::string formulaBlockEnd { "\\]" };

Token for latex formulas block end. 

_{Updated on 2023-04-03}


  




                


    
        ⭐️ Star Doxybook