Skip to content

Doxybook2::Config

#include <Config.hpp>

Public Attributes

Name
std::stringoutputDir
booldebugTemplateJson
booluseFolders
boolsort
boolcopyImages
std::stringimagesFolder
boollinkLowercase
boollinkAndInlineCodeAsHTML
boolindexInFolders
boolmainPageInRoot
std::stringmainPageName
std::stringbaseUrl
std::stringfileExt
std::stringlinkSuffix
std::stringfolderGroupsName
std::stringfolderClassesName
std::stringfolderFilesName
std::stringfolderRelatedPagesName
std::stringfolderNamespacesName
std::stringfolderExamplesName
std::stringindexGroupsName
std::stringindexClassesName
std::stringindexFilesName
std::stringindexRelatedPagesName
std::stringindexNamespacesName
std::stringindexExamplesName
std::stringtemplateKindClass
std::stringtemplateKindStruct
std::stringtemplateKindUnion
std::stringtemplateKindInterface
std::stringtemplateKindJavaEnum
std::stringtemplateKindNamespace
std::stringtemplateKindGroup
std::stringtemplateKindFile
std::stringtemplateKindDir
std::stringtemplateKindPage
std::stringtemplateKindExample
std::stringtemplateIndexClasses
std::stringtemplateIndexNamespaces
std::stringtemplateIndexGroups
std::stringtemplateIndexFiles
std::stringtemplateIndexRelatedPages
std::stringtemplateIndexExamples
std::stringindexClassesTitle
std::stringindexNamespacesTitle
std::stringindexGroupsTitle
std::stringindexFilesTitle
std::stringindexRelatedPagesTitle
std::stringindexExamplesTitle
std::vector<std::string>filesFilter
std::vector<FolderCategory>foldersToGenerate
std::stringformulaInlineStart
std::stringformulaInlineEnd
std::stringformulaBlockStart
std::stringformulaBlockEnd
boolreplaceUnderscoresInAnchors

Public Attributes Documentation

variable outputDir

cpp
std::string outputDir;

variable debugTemplateJson

cpp
bool debugTemplateJson {false};

variable useFolders

cpp
bool useFolders {true};

variable sort

cpp
bool sort {false};

variable copyImages

cpp
bool copyImages {true};

variable imagesFolder

cpp
std::string imagesFolder {"images"};

variable linkLowercase

cpp
bool linkLowercase {false};

variable linkAndInlineCodeAsHTML

cpp
bool linkAndInlineCodeAsHTML {false};

variable indexInFolders

cpp
bool indexInFolders {false};

variable mainPageInRoot

cpp
bool mainPageInRoot {false};

variable mainPageName

cpp
std::string mainPageName {"indexpage"};

variable baseUrl

cpp
std::string baseUrl {""};

variable fileExt

cpp
std::string fileExt {"md"};

variable linkSuffix

cpp
std::string linkSuffix {".md"};

variable folderGroupsName

cpp
std::string folderGroupsName {"Modules"};

variable folderClassesName

cpp
std::string folderClassesName {"Classes"};

variable folderFilesName

cpp
std::string folderFilesName {"Files"};

variable folderRelatedPagesName

cpp
std::string folderRelatedPagesName {"Pages"};

variable folderNamespacesName

cpp
std::string folderNamespacesName {"Namespaces"};

variable folderExamplesName

cpp
std::string folderExamplesName {"Examples"};

variable indexGroupsName

cpp
std::string indexGroupsName {"index_groups"};

variable indexClassesName

cpp
std::string indexClassesName {"index_classes"};

variable indexFilesName

cpp
std::string indexFilesName {"index_files"};

variable indexRelatedPagesName

cpp
std::string indexRelatedPagesName {"index_pages"};

variable indexNamespacesName

cpp
std::string indexNamespacesName {"index_namespaces"};

variable indexExamplesName

cpp
std::string indexExamplesName {"index_examples"};

variable templateKindClass

cpp
std::string templateKindClass {"kind_class"};

variable templateKindStruct

cpp
std::string templateKindStruct {"kind_class"};

variable templateKindUnion

cpp
std::string templateKindUnion {"kind_class"};

variable templateKindInterface

cpp
std::string templateKindInterface {"kind_class"};

variable templateKindJavaEnum

cpp
std::string templateKindJavaEnum {"kind_class"};

variable templateKindNamespace

cpp
std::string templateKindNamespace {"kind_nonclass"};

variable templateKindGroup

cpp
std::string templateKindGroup {"kind_nonclass"};

variable templateKindFile

cpp
std::string templateKindFile {"kind_file"};

variable templateKindDir

cpp
std::string templateKindDir {"kind_file"};

variable templateKindPage

cpp
std::string templateKindPage {"kind_page"};

variable templateKindExample

cpp
std::string templateKindExample {"kind_page"};

variable templateIndexClasses

cpp
std::string templateIndexClasses {"index_classes"};

variable templateIndexNamespaces

cpp
std::string templateIndexNamespaces {"index_namespaces"};

variable templateIndexGroups

cpp
std::string templateIndexGroups {"index_groups"};

variable templateIndexFiles

cpp
std::string templateIndexFiles {"index_files"};

variable templateIndexRelatedPages

cpp
std::string templateIndexRelatedPages {"index_pages"};

variable templateIndexExamples

cpp
std::string templateIndexExamples {"index_examples"};

variable indexClassesTitle

cpp
std::string indexClassesTitle {"Classes"};

variable indexNamespacesTitle

cpp
std::string indexNamespacesTitle {"Namespaces"};

variable indexGroupsTitle

cpp
std::string indexGroupsTitle {"Modules"};

variable indexFilesTitle

cpp
std::string indexFilesTitle {"Files"};

variable indexRelatedPagesTitle

cpp
std::string indexRelatedPagesTitle {"Pages"};

variable indexExamplesTitle

cpp
std::string indexExamplesTitle {"Examples"};

variable filesFilter

cpp
std::vector<std::string> filesFilter {};

variable foldersToGenerate

cpp
std::vector<FolderCategory> foldersToGenerate {
            FolderCategory::MODULES,
            FolderCategory::CLASSES,
            FolderCategory::FILES,
            FolderCategory::PAGES,
            FolderCategory::NAMESPACES,
            FolderCategory::EXAMPLES,
        };

variable formulaInlineStart

cpp
std::string formulaInlineStart {"\\("};

variable formulaInlineEnd

cpp
std::string formulaInlineEnd {"\\)"};

variable formulaBlockStart

cpp
std::string formulaBlockStart {"\\["};

variable formulaBlockEnd

cpp
std::string formulaBlockEnd {"\\]"};

variable replaceUnderscoresInAnchors

cpp
bool replaceUnderscoresInAnchors {true};

Updated on 2026-05-17 at 13:22:38 +0000

Built with VitePress