include/Doxybook/Config.hpp

Namespaces

Name
Doxybook2

Classes

	Name
struct	Doxybook2::Config

Source code

#pragma once
#include "Enums.hpp"
#include <string>

namespace Doxybook2 {
    struct Config {
        // Where to store the output files?
        std::string outputDir;

        // Generate extra JSON for each rendered template
        bool debugTemplateJson{false};

        // Put all stuff into categorized folders or everything into destination folder?
        bool useFolders{true};

        // Sort alphabetically
        bool sort{false};

        // Copy images from the Doxygen xml dir?
        bool copyImages{true};

        // Where to copy images
        std::string imagesFolder{"images"};

        // Convert all refids (including folder names) into lowercase?
        bool linkLowercase{false};

        // Output links as HTML <a> tags and inline code as <code> tags instead of Markdown.
        bool linkAndInlineCodeAsHTML{false};

        // Should we put the class, namespace, modules, and files indexes
        // into their respective folders? (Hugo/Learn) needs that!
        bool indexInFolders{false};

        // If mainpage (indexpage) is present, should it be located
        // in the outputDir folder or in outpurDir/folderRelatedPagesName folder?
        bool mainPageInRoot{false};

        // Name of the mainpage (indexpage)
        std::string mainPageName{"indexpage"};

        // What is the base URL to prepend all links with?
        std::string baseUrl{""};

        // What should the file end with?
        std::string fileExt{"md"};

        // What should the link end with?
        std::string linkSuffix{".md"};

        // What are the folder names?
        std::string folderGroupsName{"Modules"};
        std::string folderClassesName{"Classes"};
        std::string folderFilesName{"Files"};
        std::string folderRelatedPagesName{"Pages"};
        std::string folderNamespacesName{"Namespaces"};
        std::string folderExamplesName{"Examples"};

        // What are the names of the index files?
        std::string indexGroupsName{"index_groups"};
        std::string indexClassesName{"index_classes"};
        std::string indexFilesName{"index_files"};
        std::string indexRelatedPagesName{"index_pages"};
        std::string indexNamespacesName{"index_namespaces"};
        std::string indexExamplesName{"index_examples"};

        // What templates to use for each kind?
        std::string templateKindClass{"kind_class"};
        std::string templateKindStruct{"kind_class"};
        std::string templateKindUnion{"kind_class"};
        std::string templateKindInterface{"kind_class"};
        std::string templateKindJavaEnum{"kind_class"};
        std::string templateKindNamespace{"kind_nonclass"};
        std::string templateKindGroup{"kind_nonclass"};
        std::string templateKindFile{"kind_file"};
        std::string templateKindDir{"kind_file"};
        std::string templateKindPage{"kind_page"};
        std::string templateKindExample{"kind_page"};

        // What templates to use for indexes?
        std::string templateIndexClasses{"index_classes"};
        std::string templateIndexNamespaces{"index_namespaces"};
        std::string templateIndexGroups{"index_groups"};
        std::string templateIndexFiles{"index_files"};
        std::string templateIndexRelatedPages{"index_pages"};
        std::string templateIndexExamples{"index_examples"};

        // What should the title be in the index pages?
        std::string indexClassesTitle{"Classes"};
        std::string indexNamespacesTitle{"Namespaces"};
        std::string indexGroupsTitle{"Modules"};
        std::string indexFilesTitle{"Files"};
        std::string indexRelatedPagesTitle{"Pages"};
        std::string indexExamplesTitle{"Examples"};

        // Which source files are allowed to be included in the output? (empty => all)
        std::vector<std::string> filesFilter{};

        // Folder to generate.
        std::vector<FolderCategory> foldersToGenerate{
            FolderCategory::MODULES,
            FolderCategory::CLASSES,
            FolderCategory::FILES,
            FolderCategory::PAGES,
            FolderCategory::NAMESPACES,
            FolderCategory::EXAMPLES,
        };

        // Formulas (Latex)
        std::string formulaInlineStart{"\\("};
        std::string formulaInlineEnd{"\\)"};
        std::string formulaBlockStart{"\\["};
        std::string formulaBlockEnd{"\\]"};

        // Replace underscores with hyphens in anchors?
        bool replaceUnderscoresInAnchors{true};
    };

    void loadConfig(Config& config, const std::string& path);
    void loadConfigData(Config& config, const std::string& src);
    void saveConfig(Config& config, const std::string& path);
} // namespace Doxybook2

---

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