FZGPUModules/Doxyfile at main · szcompressor/FZGPUModules · 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
# Doxyfile for FZGPUModules
# Doxygen 1.9.8+
# Run: doxygen Doxyfile   (or: cmake --build build --target docs)

#---------------------------------------------------------------------------
# Project identity
#---------------------------------------------------------------------------
PROJECT_NAME           = "FZGPUModules"
PROJECT_NUMBER         = "2.0"
PROJECT_BRIEF          = "GPU-accelerated modular compression pipelines"
OUTPUT_DIRECTORY       = docs/doxygen

#---------------------------------------------------------------------------
# Input
#---------------------------------------------------------------------------
INPUT                  = include/ \
                         modules/ \
                         docs/mainpage.md \
                         docs/building.md \
                         docs/stages/ \
                         docs/config_file.md \
                         docs/cli.md \
                         docs/api_reference.md \
                         docs/architecture.md \
                         docs/how_to_add_a_stage.md \
                         docs/fzm_format.md \
                         docs/docker.md \
                         docs/libpressio_python.md
RECURSIVE              = YES
FILE_PATTERNS          = *.h *.md
USE_MDFILE_AS_MAINPAGE = docs/mainpage.md

STRIP_FROM_PATH        = .

#---------------------------------------------------------------------------
# What to extract
#---------------------------------------------------------------------------
# Only show symbols that have a /** */ doc block
EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO
EXTRACT_ANON_NSPACES   = NO
HIDE_UNDOC_MEMBERS     = YES
HIDE_UNDOC_CLASSES     = YES
INTERNAL_DOCS          = YES

#---------------------------------------------------------------------------
# Output formats
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
GENERATE_LATEX         = NO
GENERATE_MAN           = NO
GENERATE_XML           = NO

HTML_OUTPUT            = html
HTML_DYNAMIC_SECTIONS  = YES
GENERATE_TREEVIEW      = YES
DISABLE_INDEX          = NO
FULL_SIDEBAR           = NO

#---------------------------------------------------------------------------
# Source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER         = NO
INLINE_SOURCES         = NO
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION    = NO

#---------------------------------------------------------------------------
# Diagrams (requires Graphviz / dot)
#---------------------------------------------------------------------------
HAVE_DOT               = YES
DOT_NUM_THREADS        = 4
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = NO
INCLUDE_GRAPH          = NO
INCLUDED_BY_GRAPH      = NO
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
DOT_IMAGE_FORMAT       = svg
INTERACTIVE_SVG        = YES
MAX_DOT_GRAPH_DEPTH    = 3

#---------------------------------------------------------------------------
# Preprocessing
#---------------------------------------------------------------------------
# Doxygen doesn't understand CUDA
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = __host__= \
                         __device__= \
                         __global__= \
                         __forceinline__=inline \
                         CUDA_CALLABLE= \
                         "static_assert(x,y)="

#---------------------------------------------------------------------------
# Warnings
#---------------------------------------------------------------------------
QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = NO
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO

#---------------------------------------------------------------------------
# Miscellaneous
#---------------------------------------------------------------------------
SORT_MEMBER_DOCS       = NO
SORT_BRIEF_DOCS        = NO
ALPHABETICAL_INDEX     = NO
SHOW_USED_FILES        = NO
SHOW_FILES             = YES
SHOW_NAMESPACES        = NO
TYPEDEF_HIDES_STRUCT   = NO