libmx2/Doxyfile at main · lostjared/libmx2 · 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# Doxyfile for libmx2
# Generated for Doxygen 1.16.x
# Run: doxygen Doxyfile  (from the libmx2/ directory)
# Output will be written to docs/html/index.html

#---------------------------------------------------------------------------
# Project metadata
#---------------------------------------------------------------------------

PROJECT_NAME           = "libmx2"
PROJECT_NUMBER         = "2.2.1"
PROJECT_BRIEF          = "C++20 multimedia and game-engine library (SDL2 / OpenGL / Vulkan)"
PROJECT_LOGO           =

OUTPUT_DIRECTORY       = docs

#---------------------------------------------------------------------------
# Input files
#---------------------------------------------------------------------------

INPUT                  = mainpage.dox libmx/libmx
FILE_PATTERNS          = *.hpp *.cpp
RECURSIVE              = YES

EXCLUDE                =
EXCLUDE_SYMLINKS       = NO
EXCLUDE_PATTERNS       =

# Include protected/private members in the output
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES

#---------------------------------------------------------------------------
# Build options
#---------------------------------------------------------------------------

FULL_PATH_NAMES        = NO
# Treat "/** ... */" blocks before the first sentence as the brief description
JAVADOC_AUTOBRIEF      = YES

# Show template parameter documentation
BUILTIN_STL_SUPPORT    = YES
CPP_CLI_SUPPORT        = NO
EXTENSION_MAPPING      =

# Enable concept documentation (C++20) and all WITH_* feature guards so that
# Doxygen sees the classes inside #ifdef WITH_GL, WITH_MIXER, etc.
PREDEFINED             = __cplusplus=202002L \
                         WITH_GL=1 \
                         WITH_MIXER=1 \
                         WITH_JPEG=1 \
                         WITH_MOLTEN=1

# Warns about missing @param / @return
WARN_IF_UNDOCUMENTED   = NO
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO

QUIET                  = NO
WARNINGS               = YES

#---------------------------------------------------------------------------
# HTML output
#---------------------------------------------------------------------------

GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
HTML_COLORSTYLE        = DARK
GENERATE_TREEVIEW      = YES
TREEVIEW_WIDTH         = 250
ENUM_VALUES_PER_LINE   = 4

#---------------------------------------------------------------------------
# Other output formats (disabled by default)
#---------------------------------------------------------------------------

GENERATE_LATEX         = NO
GENERATE_MAN           = NO
GENERATE_RTF           = NO
GENERATE_XML           = NO

#---------------------------------------------------------------------------
# Source browsing
#---------------------------------------------------------------------------

SOURCE_BROWSER         = YES
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = NO
REFERENCES_RELATION    = YES
REFERENCED_BY_RELATION = YES

#---------------------------------------------------------------------------
# Graphviz / dot (installed at /usr/sbin/dot)
#---------------------------------------------------------------------------

HAVE_DOT               = YES
DOT_PATH               = /usr/sbin
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
GRAPHICAL_HIERARCHY    = YES
DOT_IMAGE_FORMAT       = svg
INTERACTIVE_SVG        = YES
MAX_DOT_GRAPH_DEPTH    = 3

#---------------------------------------------------------------------------
# Alphabetical index
#---------------------------------------------------------------------------

ALPHABETICAL_INDEX     = YES

#---------------------------------------------------------------------------
# Preprocessing
#---------------------------------------------------------------------------

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES