rusty-kv-cli/Doxyfile at master · rusty-org/rusty-kv-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Simplified Doxyfile for RustyKv CLI

# Project information
DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = "RustyKv CLI"  # Set your project name
PROJECT_NUMBER         = "1.0"          # Set version number
PROJECT_BRIEF          = "A C++ client application for interacting with RustyKv server"  # Brief description
PROJECT_LOGO           =                # Optional: path to project logo image

# Output configuration
OUTPUT_DIRECTORY       = "docs"         # Output directory for documentation
CREATE_SUBDIRS         = NO
OUTPUT_LANGUAGE        = English

# Input configuration
INPUT                  = src include client utils  # Directories containing source files
INPUT_ENCODING         = UTF-8
FILE_PATTERNS          = *.cpp *.hpp *.h
RECURSIVE              = YES

# Source browsing options
SOURCE_BROWSER         = YES            # Enable source code browsing
INLINE_SOURCES         = YES            # Include source code in documentation

# HTML output options
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
GENERATE_TREEVIEW      = YES            # Generate navigation tree
FULL_SIDEBAR           = YES

GENERATE_LATEX       = NO             # Disable LaTeX output

# Diagram options
HAVE_DOT               = YES            # Set to NO if you don't have Graphviz installed
UML_LOOK               = YES            # Use UML notation in diagrams
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
CALL_GRAPH             = NO             # Set to YES for detailed call graphs
CALLER_GRAPH           = NO             # Set to YES for detailed caller graphs

# Extract everything for better documentation
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES

# Build related options
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES

# Preprocessing
ENABLE_PREPROCESSING   = YES
SEARCH_INCLUDES        = YES

# Don't use these unless needed
QUIET                  = NO
TIMESTAMP              = NO