Doxybook2

Namespaces

Name
Doxybook2::Path
Doxybook2::Utils

Classes

	Name
struct	Doxybook2::Config
struct	Doxybook2::DefaultTemplate
class	Doxybook2::Doxygen
class	Doxybook2::Exception
class	Doxybook2::Generator
class	Doxybook2::JsonConverter
class	Doxybook2::Node
class	Doxybook2::Renderer
class	Doxybook2::TextMarkdownPrinter
class	Doxybook2::TextPlainPrinter
class	Doxybook2::TextPrinter
class	Doxybook2::Xml
class	Doxybook2::XmlTextParser

Types

	Name
enum class	Kind
enum class	Visibility
enum class	Virtual
enum class	Type
enum class	FolderCategory
typedef std::shared_ptr<Node>	NodePtr
typedef std::unordered_map<std::string, NodePtr>	NodeCacheMap

Functions

	Name
void	loadConfig(Config & config, const std::string & path)
void	loadConfigData(Config & config, const std::string & src)
void	saveConfig(Config & config, const std::string & path)
void	saveDefaultTemplates(const std::string & path)
Kind	toEnumKind(const std::string & str)
Type	toEnumType(const std::string & str)
Visibility	toEnumVisibility(const std::string & str)
Virtual	toEnumVirtual(const std::string & str)
FolderCategory	toEnumFolderCategory(const std::string & str)
std::string	toStr(Kind value)
std::string	toStr(Type value)
std::string	toStr(Visibility value)
std::string	toStr(Virtual value)
std::string	toStr(FolderCategory value)
Type	kindToType(Kind kind)
bool	isKindLanguage(Kind kind)
bool	isKindStructured(Kind kind)
bool	isKindFile(Kind kind)
std::string	typeFolderCategoryToFolderName(const Config & config, FolderCategory type)
std::string	typeToFolderName(const Config & config, Type type)
std::string	typeToIndexName(const Config & config, FolderCategory type)
std::string	typeToIndexTemplate(const Config & config, FolderCategory type)
std::string	typeToIndexTitle(const Config & config, FolderCategory type)
void	to_json(nlohmann::json & j, const Visibility & p)
void	from_json(const nlohmann::json & j, Visibility & p)
void	to_json(nlohmann::json & j, const FolderCategory & p)
void	from_json(const nlohmann::json & j, FolderCategory & p)

Attributes

	Name
std::unordered_map<std::string, DefaultTemplate>	defaultTemplates

Types Documentation

enum Kind

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

enum Visibility

Enumerator	Value	Description
PUBLIC
PROTECTED
PRIVATE
PACKAGE

enum Virtual

Enumerator	Value	Description
NON_VIRTUAL
VIRTUAL
PURE_VIRTUAL

enum Type

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

enum FolderCategory

Enumerator	Value	Description
CLASSES
NAMESPACES
MODULES
PAGES
FILES
EXAMPLES

typedef NodePtr

cpp

typedef std::shared_ptr<Node> Doxybook2::NodePtr;

typedef NodeCacheMap

cpp

typedef std::unordered_map<std::string, NodePtr> Doxybook2::NodeCacheMap;

Functions Documentation

function loadConfig

cpp

void loadConfig(
    Config & config,
    const std::string & path
)

function loadConfigData

cpp

void loadConfigData(
    Config & config,
    const std::string & src
)

function saveConfig

cpp

void saveConfig(
    Config & config,
    const std::string & path
)

function saveDefaultTemplates

cpp

void saveDefaultTemplates(
    const std::string & path
)

function toEnumKind

cpp

Kind toEnumKind(
    const std::string & str
)

function toEnumType

cpp

Type toEnumType(
    const std::string & str
)

function toEnumVisibility

cpp

Visibility toEnumVisibility(
    const std::string & str
)

function toEnumVirtual

cpp

Virtual toEnumVirtual(
    const std::string & str
)

function toEnumFolderCategory

cpp

FolderCategory toEnumFolderCategory(
    const std::string & str
)

function toStr

cpp

std::string toStr(
    Kind value
)

function toStr

cpp

std::string toStr(
    Type value
)

function toStr

cpp

std::string toStr(
    Visibility value
)

function toStr

cpp

std::string toStr(
    Virtual value
)

function toStr

cpp

std::string toStr(
    FolderCategory value
)

function kindToType

cpp

Type kindToType(
    Kind kind
)

function isKindLanguage

cpp

bool isKindLanguage(
    Kind kind
)

function isKindStructured

cpp

bool isKindStructured(
    Kind kind
)

function isKindFile

cpp

bool isKindFile(
    Kind kind
)

function typeFolderCategoryToFolderName

cpp

std::string typeFolderCategoryToFolderName(
    const Config & config,
    FolderCategory type
)

function typeToFolderName

cpp

std::string typeToFolderName(
    const Config & config,
    Type type
)

function typeToIndexName

cpp

std::string typeToIndexName(
    const Config & config,
    FolderCategory type
)

function typeToIndexTemplate

cpp

std::string typeToIndexTemplate(
    const Config & config,
    FolderCategory type
)

function typeToIndexTitle

cpp

std::string typeToIndexTitle(
    const Config & config,
    FolderCategory type
)

function to_json

cpp

inline void to_json(
    nlohmann::json & j,
    const Visibility & p
)

function from_json

cpp

inline void from_json(
    const nlohmann::json & j,
    Visibility & p
)

function to_json

cpp

inline void to_json(
    nlohmann::json & j,
    const FolderCategory & p
)

function from_json

cpp

inline void from_json(
    const nlohmann::json & j,
    FolderCategory & p
)

Attributes Documentation

variable defaultTemplates

cpp

std::unordered_map<std::string, DefaultTemplate> defaultTemplates;

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

Doxybook2 ​

Namespaces ​

Classes ​

Types ​

Functions ​

Attributes ​

Types Documentation ​

enum Kind ​

enum Visibility ​

enum Virtual ​

enum Type ​

enum FolderCategory ​

typedef NodePtr ​

typedef NodeCacheMap ​

Functions Documentation ​

function loadConfig ​

function loadConfigData ​

function saveConfig ​

function saveDefaultTemplates ​

function toEnumKind ​

function toEnumType ​

function toEnumVisibility ​

function toEnumVirtual ​

function toEnumFolderCategory ​

function toStr ​

function toStr ​

function toStr ​

function toStr ​

function toStr ​

function kindToType ​

function isKindLanguage ​

function isKindStructured ​

function isKindFile ​

function typeFolderCategoryToFolderName ​

function typeToFolderName ​

function typeToIndexName ​

function typeToIndexTemplate ​

function typeToIndexTitle ​

function to_json ​

function from_json ​

function to_json ​

function from_json ​

Attributes Documentation ​

variable defaultTemplates ​

Doxybook2

Namespaces

Classes

Types

Functions

Attributes

Types Documentation

enum Kind

enum Visibility

enum Virtual

enum Type

enum FolderCategory

typedef NodePtr

typedef NodeCacheMap

Functions Documentation

function loadConfig

function loadConfigData

function saveConfig

function saveDefaultTemplates

function toEnumKind

function toEnumType

function toEnumVisibility

function toEnumVirtual

function toEnumFolderCategory

function toStr

function toStr

function toStr

function toStr

function toStr

function kindToType

function isKindLanguage

function isKindStructured

function isKindFile

function typeFolderCategoryToFolderName

function typeToFolderName

function typeToIndexName

function typeToIndexTemplate

function typeToIndexTitle

function to_json

function from_json

function to_json

function from_json

Attributes Documentation

variable defaultTemplates