Doxyfile

# Doxyfile for common_system

PROJECT_NAME           = "Common System"
PROJECT_NUMBER         = "0.2.0"
PROJECT_BRIEF          = "Common interfaces and patterns for system integration"
OUTPUT_DIRECTORY       = documents
CREATE_SUBDIRS         = NO
OUTPUT_LANGUAGE        = English
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the
ALWAYS_DETAILED_SEC    = NO
INLINE_INHERITED_MEMB  = NO
FULL_PATH_NAMES        = YES
SHORT_NAMES            = NO
JAVADOC_AUTOBRIEF      = NO
QT_AUTOBRIEF           = NO
MULTILINE_CPP_IS_BRIEF = YES
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 4
MARKDOWN_SUPPORT       = YES
TOC_INCLUDE_HEADINGS   = 6
AUTOLINK_SUPPORT       = YES
BUILTIN_STL_SUPPORT    = YES
SUBGROUPING            = YES
NUM_PROC_THREADS       = 1
TIMESTAMP              = NO

# Extraction settings
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
CASE_SENSE_NAMES       = SYSTEM
SHOW_INCLUDE_FILES     = YES
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = YES
SHOW_FILES             = YES
SHOW_NAMESPACES        = YES

# Warning settings
QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = YES
WARN_AS_ERROR          = NO
WARN_IF_INCOMPLETE_DOC = YES
WARN_FORMAT            = "$file:$line: $text"

# Input settings
INPUT                  = ./include/kcenon/common \
                         ./src \
                         ./README.md \
                         ./docs/mainpage.dox \
                         ./docs/ecosystem_guide.dox \
                         ./docs/tutorial_result.dox \
                         ./docs/tutorial_di.dox \
                         ./docs/tutorial_eventbus.dox \
                         ./docs/faq.dox \
                         ./docs/troubleshooting.dox \
                         ./examples
INPUT_ENCODING         = UTF-8
FILE_PATTERNS          = *.c \
                         *.cc \
                         *.cxx \
                         *.cpp \
                         *.cppm \
                         *.h \
                         *.hh \
                         *.hpp \
                         *.tpp \
                         *.md \
                         *.dox
RECURSIVE              = YES
EXCLUDE                = ./build \
                         ./build_test \
                         ./vcpkg \
                         ./vcpkg_installed \
                         ./documents
EXCLUDE_SYMLINKS       = NO
EXCLUDE_PATTERNS       = */CMakeFiles/* \
                         */.git/* \
                         */node_modules/* \
                         */build/* \
                         */build_*/* \
                         */vcpkg*/* \
                         */_deps/* \
                         */test/*
EXAMPLE_PATH           = ./examples
EXAMPLE_PATTERNS       = *.cpp \
                         *.h
EXAMPLE_RECURSIVE      = YES
USE_MDFILE_AS_MAINPAGE =

# Source browsing
SOURCE_BROWSER         = YES
INLINE_SOURCES         = YES
STRIP_CODE_COMMENTS    = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS        = YES
VERBATIM_HEADERS       = YES

# Index
ALPHABETICAL_INDEX     = YES

# HTML output
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
HTML_HEADER            = docs/header.html
HTML_EXTRA_STYLESHEET  = docs/doxygen-awesome-css/doxygen-awesome.css \
                         docs/doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
                         docs/custom.css
HTML_EXTRA_FILES       = docs/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
                         docs/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
                         docs/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
                         docs/doxygen-awesome-css/doxygen-awesome-interactive-toc.js
HTML_COPY_CLIPBOARD    = NO
HTML_COLORSTYLE        = LIGHT
HTML_COLORSTYLE_HUE    = 220
HTML_COLORSTYLE_SAT    = 100
HTML_COLORSTYLE_GAMMA  = 80
HTML_DYNAMIC_MENUS     = YES
HTML_CODE_FOLDING      = YES
HTML_INDEX_NUM_ENTRIES = 100
DISABLE_INDEX          = NO
GENERATE_TREEVIEW      = YES
FULL_SIDEBAR           = NO
ENUM_VALUES_PER_LINE   = 4
TREEVIEW_WIDTH         = 250
SEARCHENGINE           = YES

# Other output formats (disabled)
GENERATE_LATEX         = NO
GENERATE_RTF           = NO
GENERATE_MAN           = NO
GENERATE_XML           = NO
GENERATE_DOCBOOK       = NO

# Preprocessing
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES
INCLUDE_PATH           = ./include/kcenon/common
INCLUDE_FILE_PATTERNS  = *.h \
                         *.hpp
PREDEFINED             = BUILD_WITH_COMMON_SYSTEM \
                         COMMON_SYSTEM_EXPORT= \
                         COMMON_SYSTEM_API=
SKIP_FUNCTION_MACROS   = YES

ALIASES                = "thread_safety=@par Thread Safety:^^" \
                         "performance=@par Performance:^^"

# External references
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
EXTERNAL_PAGES         = YES

# Graph generation (requires dot from Graphviz)
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = YES
DOT_NUM_THREADS        = 0
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
GROUP_GRAPHS           = YES
UML_LOOK               = YES
UML_LIMIT_NUM_FIELDS   = 10
DOT_WRAP_THRESHOLD     = 17
TEMPLATE_RELATIONS     = YES
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES
GRAPHICAL_HIERARCHY    = YES
DIRECTORY_GRAPH        = YES
DOT_IMAGE_FORMAT       = png
INTERACTIVE_SVG        = NO
DOT_GRAPH_MAX_NODES    = 50
MAX_DOT_GRAPH_DEPTH    = 0
GENERATE_LEGEND        = YES
DOT_CLEANUP            = YES
DOT_PATH               =