1
0
Fork 0
forked from fun/fun

Added basic Doxygen.in file to create code documentation in the future. No code changes. (0.41.5)

This commit is contained in:
Johannes Findeisen 2026-04-28 06:11:21 +02:00
commit d452c9c6bc
3 changed files with 99 additions and 1 deletions

53
Doxygen.in Normal file
View file

@ -0,0 +1,53 @@
## Doxygen configuration for the "fun" project (processed by CMake)
# This file is configured by CMake's configure_file(@ONLY).
# --- Project ---
PROJECT_NAME = "Fun"
PROJECT_NUMBER = "@FUN_DOCS_VERSION@"
# Optional project logo (relative or absolute path). Leave empty if not found.
PROJECT_LOGO = "@FUN_DOCS_LOGO@"
# --- Output ---
OUTPUT_DIRECTORY = "@CMAKE_CURRENT_BINARY_DIR@/docs"
CREATE_SUBDIRS = NO
GENERATE_HTML = YES
HTML_OUTPUT = html
GENERATE_LATEX = NO
# --- Input ---
INPUT = "@CMAKE_SOURCE_DIR@/src"
RECURSIVE = YES
FILE_PATTERNS = *.h *.hpp *.c *.cc *.cpp
# --- Extraction policy ---
# Default to public/protected only to reduce noise; flip to YES if you want internals.
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_METHODS = YES
OPTIMIZE_OUTPUT_FOR_C = YES
# --- Paths shown in docs ---
FULL_PATH_NAMES = NO
STRIP_FROM_PATH = "@CMAKE_SOURCE_DIR@"
# --- Source browsing ---
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
GENERATE_TREEVIEW = YES
# --- Diagrams (Graphviz) ---
HAVE_DOT = @HAVE_DOT@
CLASS_DIAGRAMS = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
DOT_IMAGE_FORMAT = svg
# --- Warnings / noise ---
QUIET = YES
WARN_IF_UNDOCUMENTED = NO
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO