-
Notifications
You must be signed in to change notification settings - Fork 0
/
Doxyfile_common
200 lines (166 loc) · 8.82 KB
/
Doxyfile_common
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# Doxyfile 1.8.20
PROJECT_NAME = Colibri
PROJECT_NUMBER =
PROJECT_BRIEF = "A fast and lightweight garbage-collected datatype library"
PROJECT_LOGO =
GENERATE_HTML = YES
GENERATE_XML = YES
GENERATE_LATEX = NO
INPUT = README.md \
./include \
./src \
./src/platform \
./src/platform/unix \
./src/platform/win32
FILE_PATTERNS = *.c \
*.h
USE_MDFILE_AS_MAINPAGE = README.md
INPUT_ENCODING = UTF-8
TAB_SIZE = 8
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = YES
STRIP_CODE_COMMENTS = NO
SUBGROUPING = NO
INLINE_GROUPED_CLASSES = YES
EXTRACT_STATIC = YES
SORT_MEMBER_DOCS = NO
ALWAYS_DETAILED_SEC = YES
INLINE_SIMPLE_STRUCTS = YES
TYPEDEF_HIDES_STRUCT = YES
OPTIMIZE_OUTPUT_FOR_C = YES
PREDEFINED += DOXYGEN
PREDEFINED += BYTE_ORDER BIG_ENDIAN COL_BIGENDIAN
PREDEFINED += SIZE_BIT=32
PREDEFINED += PROMOTE_COMPACT
PREDEFINED += COL_USE_THREADS
SKIP_FUNCTION_MACROS = NO
IGNORE_PREFIX = Col_ \
COL_
ALIASES += sideeffect="@par Side Effect"
ALIASES += fatal{1}="@exception #\1 @link COL_FATAL [F]@endlink @copybrief \1 "
ALIASES += fatal{2}="@exception #\1 @link COL_FATAL [F]@endlink @copybrief \1 (<em>\2</em>) "
ALIASES += error{1}="@exception #\1 @link COL_ERROR [E]@endlink @copybrief \1 "
ALIASES += error{2}="@exception #\1 @link COL_ERROR [E]@endlink @copybrief \1 (<em>\2</em>) "
ALIASES += typecheck{1}="@exception #\1 @link COL_TYPECHECK [T]@endlink @copybrief \1 "
ALIASES += typecheck{2}="@exception #\1 @link COL_TYPECHECK [T]@endlink <b>\2</b>: @copybrief \1 "
ALIASES += valuecheck{1}="@exception #\1 @link COL_VALUECHECK [V]@endlink @copybrief \1 "
ALIASES += valuecheck{2}="@exception #\1 @link COL_VALUECHECK [V]@endlink <b>\2</b>: @copybrief \1 "
ALIASES += beginprivate="@privatesection"
ALIASES += endprivate="@publicsection"
ALIASES += begindiagram="@if IGNORE"
ALIASES += enddiagram="@endif"
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
"This file" \
"This header file" \
is \
provides \
specifies \
contains \
represents \
defines \
a \
an \
the
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
# included in the documentation.
# The default value is: NO.
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO doxygen will only warn about wrong or incomplete parameter
# documentation, but not about the absence of documentation.
# The default value is: NO.
WARN_NO_PARAMDOC = YES
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file($line): $text"
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = NO
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot.
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif and svg.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = svg
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 1
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = YES
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = YES