| User | Revision | Line number | New contents of line |
|---|
| leothedragon |
0:25fa8795676b
|
1
|
# Doxyfile 1.8.2
|
| leothedragon |
0:25fa8795676b
|
2
|
|
| leothedragon |
0:25fa8795676b
|
3
|
# This file describes the settings to be used by the documentation system
|
| leothedragon |
0:25fa8795676b
|
4
|
# doxygen (www.doxygen.org) for a project
|
| leothedragon |
0:25fa8795676b
|
5
|
#
|
| leothedragon |
0:25fa8795676b
|
6
|
# All text after a hash (#) is considered a comment and will be ignored
|
| leothedragon |
0:25fa8795676b
|
7
|
# The format is:
|
| leothedragon |
0:25fa8795676b
|
8
|
# TAG = value [value, ...]
|
| leothedragon |
0:25fa8795676b
|
9
|
# For lists items can also be appended using:
|
| leothedragon |
0:25fa8795676b
|
10
|
# TAG += value [value, ...]
|
| leothedragon |
0:25fa8795676b
|
11
|
# Values that contain spaces should be placed between quotes (" ")
|
| leothedragon |
0:25fa8795676b
|
12
|
|
| leothedragon |
0:25fa8795676b
|
13
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
14
|
# Project related configuration options
|
| leothedragon |
0:25fa8795676b
|
15
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
16
|
|
| leothedragon |
0:25fa8795676b
|
17
|
# This tag specifies the encoding used for all characters in the config file
|
| leothedragon |
0:25fa8795676b
|
18
|
# that follow. The default is UTF-8 which is also the encoding used for all
|
| leothedragon |
0:25fa8795676b
|
19
|
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
|
| leothedragon |
0:25fa8795676b
|
20
|
# iconv built into libc) for the transcoding. See
|
| leothedragon |
0:25fa8795676b
|
21
|
# http://www.gnu.org/software/libiconv for the list of possible encodings.
|
| leothedragon |
0:25fa8795676b
|
22
|
|
| leothedragon |
0:25fa8795676b
|
23
|
DOXYFILE_ENCODING = UTF-8
|
| leothedragon |
0:25fa8795676b
|
24
|
|
| leothedragon |
0:25fa8795676b
|
25
|
# The PROJECT_NAME tag is a single word (or sequence of words) that should
|
| leothedragon |
0:25fa8795676b
|
26
|
# identify the project. Note that if you do not use Doxywizard you need
|
| leothedragon |
0:25fa8795676b
|
27
|
# to put quotes around the project name if it contains spaces.
|
| leothedragon |
0:25fa8795676b
|
28
|
|
| leothedragon |
0:25fa8795676b
|
29
|
PROJECT_NAME = mbed-cloud-client
|
| leothedragon |
0:25fa8795676b
|
30
|
|
| leothedragon |
0:25fa8795676b
|
31
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
| leothedragon |
0:25fa8795676b
|
32
|
# This could be handy for archiving the generated documentation or
|
| leothedragon |
0:25fa8795676b
|
33
|
# if some version control system is used.
|
| leothedragon |
0:25fa8795676b
|
34
|
|
| leothedragon |
0:25fa8795676b
|
35
|
PROJECT_NUMBER =
|
| leothedragon |
0:25fa8795676b
|
36
|
|
| leothedragon |
0:25fa8795676b
|
37
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
| leothedragon |
0:25fa8795676b
|
38
|
# for a project that appears at the top of each page and should give viewer
|
| leothedragon |
0:25fa8795676b
|
39
|
# a quick idea about the purpose of the project. Keep the description short.
|
| leothedragon |
0:25fa8795676b
|
40
|
|
| leothedragon |
0:25fa8795676b
|
41
|
PROJECT_BRIEF = "mbed Cloud Client C++ library"
|
| leothedragon |
0:25fa8795676b
|
42
|
|
| leothedragon |
0:25fa8795676b
|
43
|
# With the PROJECT_LOGO tag one can specify an logo or icon that is
|
| leothedragon |
0:25fa8795676b
|
44
|
# included in the documentation. The maximum height of the logo should not
|
| leothedragon |
0:25fa8795676b
|
45
|
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
|
| leothedragon |
0:25fa8795676b
|
46
|
# Doxygen will copy the logo to the output directory.
|
| leothedragon |
0:25fa8795676b
|
47
|
|
| leothedragon |
0:25fa8795676b
|
48
|
PROJECT_LOGO =
|
| leothedragon |
0:25fa8795676b
|
49
|
|
| leothedragon |
0:25fa8795676b
|
50
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
| leothedragon |
0:25fa8795676b
|
51
|
# base path where the generated documentation will be put.
|
| leothedragon |
0:25fa8795676b
|
52
|
# If a relative path is entered, it will be relative to the location
|
| leothedragon |
0:25fa8795676b
|
53
|
# where doxygen was started. If left blank the current directory will be used.
|
| leothedragon |
0:25fa8795676b
|
54
|
|
| leothedragon |
0:25fa8795676b
|
55
|
OUTPUT_DIRECTORY = ../api_docs
|
| leothedragon |
0:25fa8795676b
|
56
|
|
| leothedragon |
0:25fa8795676b
|
57
|
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
| leothedragon |
0:25fa8795676b
|
58
|
# 4096 sub-directories (in 2 levels) under the output directory of each output
|
| leothedragon |
0:25fa8795676b
|
59
|
# format and will distribute the generated files over these directories.
|
| leothedragon |
0:25fa8795676b
|
60
|
# Enabling this option can be useful when feeding doxygen a huge amount of
|
| leothedragon |
0:25fa8795676b
|
61
|
# source files, where putting all generated files in the same directory would
|
| leothedragon |
0:25fa8795676b
|
62
|
# otherwise cause performance problems for the file system.
|
| leothedragon |
0:25fa8795676b
|
63
|
|
| leothedragon |
0:25fa8795676b
|
64
|
CREATE_SUBDIRS = NO
|
| leothedragon |
0:25fa8795676b
|
65
|
|
| leothedragon |
0:25fa8795676b
|
66
|
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
| leothedragon |
0:25fa8795676b
|
67
|
# documentation generated by doxygen is written. Doxygen will use this
|
| leothedragon |
0:25fa8795676b
|
68
|
# information to generate all constant output in the proper language.
|
| leothedragon |
0:25fa8795676b
|
69
|
# The default language is English, other supported languages are:
|
| leothedragon |
0:25fa8795676b
|
70
|
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
|
| leothedragon |
0:25fa8795676b
|
71
|
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
|
| leothedragon |
0:25fa8795676b
|
72
|
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
|
| leothedragon |
0:25fa8795676b
|
73
|
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
|
| leothedragon |
0:25fa8795676b
|
74
|
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
|
| leothedragon |
0:25fa8795676b
|
75
|
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
|
| leothedragon |
0:25fa8795676b
|
76
|
|
| leothedragon |
0:25fa8795676b
|
77
|
OUTPUT_LANGUAGE = English
|
| leothedragon |
0:25fa8795676b
|
78
|
|
| leothedragon |
0:25fa8795676b
|
79
|
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
| leothedragon |
0:25fa8795676b
|
80
|
# include brief member descriptions after the members that are listed in
|
| leothedragon |
0:25fa8795676b
|
81
|
# the file and class documentation (similar to JavaDoc).
|
| leothedragon |
0:25fa8795676b
|
82
|
# Set to NO to disable this.
|
| leothedragon |
0:25fa8795676b
|
83
|
|
| leothedragon |
0:25fa8795676b
|
84
|
BRIEF_MEMBER_DESC = YES
|
| leothedragon |
0:25fa8795676b
|
85
|
|
| leothedragon |
0:25fa8795676b
|
86
|
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
| leothedragon |
0:25fa8795676b
|
87
|
# the brief description of a member or function before the detailed description.
|
| leothedragon |
0:25fa8795676b
|
88
|
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
| leothedragon |
0:25fa8795676b
|
89
|
# brief descriptions will be completely suppressed.
|
| leothedragon |
0:25fa8795676b
|
90
|
|
| leothedragon |
0:25fa8795676b
|
91
|
REPEAT_BRIEF = YES
|
| leothedragon |
0:25fa8795676b
|
92
|
|
| leothedragon |
0:25fa8795676b
|
93
|
# This tag implements a quasi-intelligent brief description abbreviator
|
| leothedragon |
0:25fa8795676b
|
94
|
# that is used to form the text in various listings. Each string
|
| leothedragon |
0:25fa8795676b
|
95
|
# in this list, if found as the leading text of the brief description, will be
|
| leothedragon |
0:25fa8795676b
|
96
|
# stripped from the text and the result after processing the whole list, is
|
| leothedragon |
0:25fa8795676b
|
97
|
# used as the annotated text. Otherwise, the brief description is used as-is.
|
| leothedragon |
0:25fa8795676b
|
98
|
# If left blank, the following values are used ("$name" is automatically
|
| leothedragon |
0:25fa8795676b
|
99
|
# replaced with the name of the entity): "The $name class" "The $name widget"
|
| leothedragon |
0:25fa8795676b
|
100
|
# "The $name file" "is" "provides" "specifies" "contains"
|
| leothedragon |
0:25fa8795676b
|
101
|
# "represents" "a" "an" "the"
|
| leothedragon |
0:25fa8795676b
|
102
|
|
| leothedragon |
0:25fa8795676b
|
103
|
ABBREVIATE_BRIEF = "The $name class" \
|
| leothedragon |
0:25fa8795676b
|
104
|
"The $name widget" \
|
| leothedragon |
0:25fa8795676b
|
105
|
"The $name file" \
|
| leothedragon |
0:25fa8795676b
|
106
|
is \
|
| leothedragon |
0:25fa8795676b
|
107
|
provides \
|
| leothedragon |
0:25fa8795676b
|
108
|
specifies \
|
| leothedragon |
0:25fa8795676b
|
109
|
contains \
|
| leothedragon |
0:25fa8795676b
|
110
|
represents \
|
| leothedragon |
0:25fa8795676b
|
111
|
a \
|
| leothedragon |
0:25fa8795676b
|
112
|
an \
|
| leothedragon |
0:25fa8795676b
|
113
|
the
|
| leothedragon |
0:25fa8795676b
|
114
|
|
| leothedragon |
0:25fa8795676b
|
115
|
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
| leothedragon |
0:25fa8795676b
|
116
|
# Doxygen will generate a detailed section even if there is only a brief
|
| leothedragon |
0:25fa8795676b
|
117
|
# description.
|
| leothedragon |
0:25fa8795676b
|
118
|
|
| leothedragon |
0:25fa8795676b
|
119
|
ALWAYS_DETAILED_SEC = NO
|
| leothedragon |
0:25fa8795676b
|
120
|
|
| leothedragon |
0:25fa8795676b
|
121
|
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
| leothedragon |
0:25fa8795676b
|
122
|
# inherited members of a class in the documentation of that class as if those
|
| leothedragon |
0:25fa8795676b
|
123
|
# members were ordinary class members. Constructors, destructors and assignment
|
| leothedragon |
0:25fa8795676b
|
124
|
# operators of the base classes will not be shown.
|
| leothedragon |
0:25fa8795676b
|
125
|
|
| leothedragon |
0:25fa8795676b
|
126
|
INLINE_INHERITED_MEMB = NO
|
| leothedragon |
0:25fa8795676b
|
127
|
|
| leothedragon |
0:25fa8795676b
|
128
|
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
| leothedragon |
0:25fa8795676b
|
129
|
# path before files name in the file list and in the header files. If set
|
| leothedragon |
0:25fa8795676b
|
130
|
# to NO the shortest path that makes the file name unique will be used.
|
| leothedragon |
0:25fa8795676b
|
131
|
|
| leothedragon |
0:25fa8795676b
|
132
|
FULL_PATH_NAMES = NO
|
| leothedragon |
0:25fa8795676b
|
133
|
|
| leothedragon |
0:25fa8795676b
|
134
|
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
|
| leothedragon |
0:25fa8795676b
|
135
|
# can be used to strip a user-defined part of the path. Stripping is
|
| leothedragon |
0:25fa8795676b
|
136
|
# only done if one of the specified strings matches the left-hand part of
|
| leothedragon |
0:25fa8795676b
|
137
|
# the path. The tag can be used to show relative paths in the file list.
|
| leothedragon |
0:25fa8795676b
|
138
|
# If left blank the directory from which doxygen is run is used as the
|
| leothedragon |
0:25fa8795676b
|
139
|
# path to strip. Note that you specify absolute paths here, but also
|
| leothedragon |
0:25fa8795676b
|
140
|
# relative paths, which will be relative from the directory where doxygen is
|
| leothedragon |
0:25fa8795676b
|
141
|
# started.
|
| leothedragon |
0:25fa8795676b
|
142
|
|
| leothedragon |
0:25fa8795676b
|
143
|
STRIP_FROM_PATH =
|
| leothedragon |
0:25fa8795676b
|
144
|
|
| leothedragon |
0:25fa8795676b
|
145
|
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
|
| leothedragon |
0:25fa8795676b
|
146
|
# the path mentioned in the documentation of a class, which tells
|
| leothedragon |
0:25fa8795676b
|
147
|
# the reader which header file to include in order to use a class.
|
| leothedragon |
0:25fa8795676b
|
148
|
# If left blank only the name of the header file containing the class
|
| leothedragon |
0:25fa8795676b
|
149
|
# definition is used. Otherwise one should specify the include paths that
|
| leothedragon |
0:25fa8795676b
|
150
|
# are normally passed to the compiler using the -I flag.
|
| leothedragon |
0:25fa8795676b
|
151
|
|
| leothedragon |
0:25fa8795676b
|
152
|
STRIP_FROM_INC_PATH =
|
| leothedragon |
0:25fa8795676b
|
153
|
|
| leothedragon |
0:25fa8795676b
|
154
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
| leothedragon |
0:25fa8795676b
|
155
|
# (but less readable) file names. This can be useful if your file system
|
| leothedragon |
0:25fa8795676b
|
156
|
# doesn't support long names like on DOS, Mac, or CD-ROM.
|
| leothedragon |
0:25fa8795676b
|
157
|
|
| leothedragon |
0:25fa8795676b
|
158
|
SHORT_NAMES = NO
|
| leothedragon |
0:25fa8795676b
|
159
|
|
| leothedragon |
0:25fa8795676b
|
160
|
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
| leothedragon |
0:25fa8795676b
|
161
|
# will interpret the first line (until the first dot) of a JavaDoc-style
|
| leothedragon |
0:25fa8795676b
|
162
|
# comment as the brief description. If set to NO, the JavaDoc
|
| leothedragon |
0:25fa8795676b
|
163
|
# comments will behave just like regular Qt-style comments
|
| leothedragon |
0:25fa8795676b
|
164
|
# (thus requiring an explicit @brief command for a brief description.)
|
| leothedragon |
0:25fa8795676b
|
165
|
|
| leothedragon |
0:25fa8795676b
|
166
|
JAVADOC_AUTOBRIEF = NO
|
| leothedragon |
0:25fa8795676b
|
167
|
|
| leothedragon |
0:25fa8795676b
|
168
|
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
|
| leothedragon |
0:25fa8795676b
|
169
|
# interpret the first line (until the first dot) of a Qt-style
|
| leothedragon |
0:25fa8795676b
|
170
|
# comment as the brief description. If set to NO, the comments
|
| leothedragon |
0:25fa8795676b
|
171
|
# will behave just like regular Qt-style comments (thus requiring
|
| leothedragon |
0:25fa8795676b
|
172
|
# an explicit \brief command for a brief description.)
|
| leothedragon |
0:25fa8795676b
|
173
|
|
| leothedragon |
0:25fa8795676b
|
174
|
QT_AUTOBRIEF = NO
|
| leothedragon |
0:25fa8795676b
|
175
|
|
| leothedragon |
0:25fa8795676b
|
176
|
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
|
| leothedragon |
0:25fa8795676b
|
177
|
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
|
| leothedragon |
0:25fa8795676b
|
178
|
# comments) as a brief description. This used to be the default behaviour.
|
| leothedragon |
0:25fa8795676b
|
179
|
# The new default is to treat a multi-line C++ comment block as a detailed
|
| leothedragon |
0:25fa8795676b
|
180
|
# description. Set this tag to YES if you prefer the old behaviour instead.
|
| leothedragon |
0:25fa8795676b
|
181
|
|
| leothedragon |
0:25fa8795676b
|
182
|
MULTILINE_CPP_IS_BRIEF = NO
|
| leothedragon |
0:25fa8795676b
|
183
|
|
| leothedragon |
0:25fa8795676b
|
184
|
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
| leothedragon |
0:25fa8795676b
|
185
|
# member inherits the documentation from any documented member that it
|
| leothedragon |
0:25fa8795676b
|
186
|
# re-implements.
|
| leothedragon |
0:25fa8795676b
|
187
|
|
| leothedragon |
0:25fa8795676b
|
188
|
INHERIT_DOCS = YES
|
| leothedragon |
0:25fa8795676b
|
189
|
|
| leothedragon |
0:25fa8795676b
|
190
|
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
|
| leothedragon |
0:25fa8795676b
|
191
|
# a new page for each member. If set to NO, the documentation of a member will
|
| leothedragon |
0:25fa8795676b
|
192
|
# be part of the file/class/namespace that contains it.
|
| leothedragon |
0:25fa8795676b
|
193
|
|
| leothedragon |
0:25fa8795676b
|
194
|
SEPARATE_MEMBER_PAGES = NO
|
| leothedragon |
0:25fa8795676b
|
195
|
|
| leothedragon |
0:25fa8795676b
|
196
|
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
| leothedragon |
0:25fa8795676b
|
197
|
# Doxygen uses this value to replace tabs by spaces in code fragments.
|
| leothedragon |
0:25fa8795676b
|
198
|
|
| leothedragon |
0:25fa8795676b
|
199
|
TAB_SIZE = 16
|
| leothedragon |
0:25fa8795676b
|
200
|
|
| leothedragon |
0:25fa8795676b
|
201
|
# This tag can be used to specify a number of aliases that acts
|
| leothedragon |
0:25fa8795676b
|
202
|
# as commands in the documentation. An alias has the form "name=value".
|
| leothedragon |
0:25fa8795676b
|
203
|
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
| leothedragon |
0:25fa8795676b
|
204
|
# put the command \sideeffect (or @sideeffect) in the documentation, which
|
| leothedragon |
0:25fa8795676b
|
205
|
# will result in a user-defined paragraph with heading "Side Effects:".
|
| leothedragon |
0:25fa8795676b
|
206
|
# You can put \n's in the value part of an alias to insert newlines.
|
| leothedragon |
0:25fa8795676b
|
207
|
|
| leothedragon |
0:25fa8795676b
|
208
|
ALIASES =
|
| leothedragon |
0:25fa8795676b
|
209
|
|
| leothedragon |
0:25fa8795676b
|
210
|
# This tag can be used to specify a number of word-keyword mappings (TCL only).
|
| leothedragon |
0:25fa8795676b
|
211
|
# A mapping has the form "name=value". For example adding
|
| leothedragon |
0:25fa8795676b
|
212
|
# "class=itcl::class" will allow you to use the command class in the
|
| leothedragon |
0:25fa8795676b
|
213
|
# itcl::class meaning.
|
| leothedragon |
0:25fa8795676b
|
214
|
|
| leothedragon |
0:25fa8795676b
|
215
|
TCL_SUBST =
|
| leothedragon |
0:25fa8795676b
|
216
|
|
| leothedragon |
0:25fa8795676b
|
217
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
|
| leothedragon |
0:25fa8795676b
|
218
|
# sources only. Doxygen will then generate output that is more tailored for C.
|
| leothedragon |
0:25fa8795676b
|
219
|
# For instance, some of the names that are used will be different. The list
|
| leothedragon |
0:25fa8795676b
|
220
|
# of all members will be omitted, etc.
|
| leothedragon |
0:25fa8795676b
|
221
|
|
| leothedragon |
0:25fa8795676b
|
222
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
| leothedragon |
0:25fa8795676b
|
223
|
|
| leothedragon |
0:25fa8795676b
|
224
|
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
|
| leothedragon |
0:25fa8795676b
|
225
|
# sources only. Doxygen will then generate output that is more tailored for
|
| leothedragon |
0:25fa8795676b
|
226
|
# Java. For instance, namespaces will be presented as packages, qualified
|
| leothedragon |
0:25fa8795676b
|
227
|
# scopes will look different, etc.
|
| leothedragon |
0:25fa8795676b
|
228
|
|
| leothedragon |
0:25fa8795676b
|
229
|
OPTIMIZE_OUTPUT_JAVA = NO
|
| leothedragon |
0:25fa8795676b
|
230
|
|
| leothedragon |
0:25fa8795676b
|
231
|
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
|
| leothedragon |
0:25fa8795676b
|
232
|
# sources only. Doxygen will then generate output that is more tailored for
|
| leothedragon |
0:25fa8795676b
|
233
|
# Fortran.
|
| leothedragon |
0:25fa8795676b
|
234
|
|
| leothedragon |
0:25fa8795676b
|
235
|
OPTIMIZE_FOR_FORTRAN = NO
|
| leothedragon |
0:25fa8795676b
|
236
|
|
| leothedragon |
0:25fa8795676b
|
237
|
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
|
| leothedragon |
0:25fa8795676b
|
238
|
# sources. Doxygen will then generate output that is tailored for
|
| leothedragon |
0:25fa8795676b
|
239
|
# VHDL.
|
| leothedragon |
0:25fa8795676b
|
240
|
|
| leothedragon |
0:25fa8795676b
|
241
|
OPTIMIZE_OUTPUT_VHDL = NO
|
| leothedragon |
0:25fa8795676b
|
242
|
|
| leothedragon |
0:25fa8795676b
|
243
|
# Doxygen selects the parser to use depending on the extension of the files it
|
| leothedragon |
0:25fa8795676b
|
244
|
# parses. With this tag you can assign which parser to use for a given
|
| leothedragon |
0:25fa8795676b
|
245
|
# extension. Doxygen has a built-in mapping, but you can override or extend it
|
| leothedragon |
0:25fa8795676b
|
246
|
# using this tag. The format is ext=language, where ext is a file extension,
|
| leothedragon |
0:25fa8795676b
|
247
|
# and language is one of the parsers supported by doxygen: IDL, Java,
|
| leothedragon |
0:25fa8795676b
|
248
|
# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
|
| leothedragon |
0:25fa8795676b
|
249
|
# C++. For instance to make doxygen treat .inc files as Fortran files (default
|
| leothedragon |
0:25fa8795676b
|
250
|
# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
|
| leothedragon |
0:25fa8795676b
|
251
|
# that for custom extensions you also need to set FILE_PATTERNS otherwise the
|
| leothedragon |
0:25fa8795676b
|
252
|
# files are not read by doxygen.
|
| leothedragon |
0:25fa8795676b
|
253
|
|
| leothedragon |
0:25fa8795676b
|
254
|
EXTENSION_MAPPING =
|
| leothedragon |
0:25fa8795676b
|
255
|
|
| leothedragon |
0:25fa8795676b
|
256
|
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
|
| leothedragon |
0:25fa8795676b
|
257
|
# comments according to the Markdown format, which allows for more readable
|
| leothedragon |
0:25fa8795676b
|
258
|
# documentation. See http://daringfireball.net/projects/markdown/ for details.
|
| leothedragon |
0:25fa8795676b
|
259
|
# The output of markdown processing is further processed by doxygen, so you
|
| leothedragon |
0:25fa8795676b
|
260
|
# can mix doxygen, HTML, and XML commands with Markdown formatting.
|
| leothedragon |
0:25fa8795676b
|
261
|
# Disable only in case of backward compatibilities issues.
|
| leothedragon |
0:25fa8795676b
|
262
|
|
| leothedragon |
0:25fa8795676b
|
263
|
MARKDOWN_SUPPORT = YES
|
| leothedragon |
0:25fa8795676b
|
264
|
|
| leothedragon |
0:25fa8795676b
|
265
|
# When enabled doxygen tries to link words that correspond to documented classes,
|
| leothedragon |
0:25fa8795676b
|
266
|
# or namespaces to their corresponding documentation. Such a link can be
|
| leothedragon |
0:25fa8795676b
|
267
|
# prevented in individual cases by by putting a % sign in front of the word or
|
| leothedragon |
0:25fa8795676b
|
268
|
# globally by setting AUTOLINK_SUPPORT to NO.
|
| leothedragon |
0:25fa8795676b
|
269
|
|
| leothedragon |
0:25fa8795676b
|
270
|
AUTOLINK_SUPPORT = YES
|
| leothedragon |
0:25fa8795676b
|
271
|
|
| leothedragon |
0:25fa8795676b
|
272
|
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
|
| leothedragon |
0:25fa8795676b
|
273
|
# to include (a tag file for) the STL sources as input, then you should
|
| leothedragon |
0:25fa8795676b
|
274
|
# set this tag to YES in order to let doxygen match functions declarations and
|
| leothedragon |
0:25fa8795676b
|
275
|
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
|
| leothedragon |
0:25fa8795676b
|
276
|
# func(std::string) {}). This also makes the inheritance and collaboration
|
| leothedragon |
0:25fa8795676b
|
277
|
# diagrams that involve STL classes more complete and accurate.
|
| leothedragon |
0:25fa8795676b
|
278
|
|
| leothedragon |
0:25fa8795676b
|
279
|
BUILTIN_STL_SUPPORT = NO
|
| leothedragon |
0:25fa8795676b
|
280
|
|
| leothedragon |
0:25fa8795676b
|
281
|
# If you use Microsoft's C++/CLI language, you should set this option to YES to
|
| leothedragon |
0:25fa8795676b
|
282
|
# enable parsing support.
|
| leothedragon |
0:25fa8795676b
|
283
|
|
| leothedragon |
0:25fa8795676b
|
284
|
CPP_CLI_SUPPORT = NO
|
| leothedragon |
0:25fa8795676b
|
285
|
|
| leothedragon |
0:25fa8795676b
|
286
|
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
|
| leothedragon |
0:25fa8795676b
|
287
|
# Doxygen will parse them like normal C++ but will assume all classes use public
|
| leothedragon |
0:25fa8795676b
|
288
|
# instead of private inheritance when no explicit protection keyword is present.
|
| leothedragon |
0:25fa8795676b
|
289
|
|
| leothedragon |
0:25fa8795676b
|
290
|
SIP_SUPPORT = NO
|
| leothedragon |
0:25fa8795676b
|
291
|
|
| leothedragon |
0:25fa8795676b
|
292
|
# For Microsoft's IDL there are propget and propput attributes to indicate
|
| leothedragon |
0:25fa8795676b
|
293
|
# getter and setter methods for a property. Setting this option to YES (the
|
| leothedragon |
0:25fa8795676b
|
294
|
# default) will make doxygen replace the get and set methods by a property in
|
| leothedragon |
0:25fa8795676b
|
295
|
# the documentation. This will only work if the methods are indeed getting or
|
| leothedragon |
0:25fa8795676b
|
296
|
# setting a simple type. If this is not the case, or you want to show the
|
| leothedragon |
0:25fa8795676b
|
297
|
# methods anyway, you should set this option to NO.
|
| leothedragon |
0:25fa8795676b
|
298
|
|
| leothedragon |
0:25fa8795676b
|
299
|
IDL_PROPERTY_SUPPORT = YES
|
| leothedragon |
0:25fa8795676b
|
300
|
|
| leothedragon |
0:25fa8795676b
|
301
|
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
| leothedragon |
0:25fa8795676b
|
302
|
# tag is set to YES, then doxygen will reuse the documentation of the first
|
| leothedragon |
0:25fa8795676b
|
303
|
# member in the group (if any) for the other members of the group. By default
|
| leothedragon |
0:25fa8795676b
|
304
|
# all members of a group must be documented explicitly.
|
| leothedragon |
0:25fa8795676b
|
305
|
|
| leothedragon |
0:25fa8795676b
|
306
|
DISTRIBUTE_GROUP_DOC = NO
|
| leothedragon |
0:25fa8795676b
|
307
|
|
| leothedragon |
0:25fa8795676b
|
308
|
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
|
| leothedragon |
0:25fa8795676b
|
309
|
# the same type (for instance a group of public functions) to be put as a
|
| leothedragon |
0:25fa8795676b
|
310
|
# subgroup of that type (e.g. under the Public Functions section). Set it to
|
| leothedragon |
0:25fa8795676b
|
311
|
# NO to prevent subgrouping. Alternatively, this can be done per class using
|
| leothedragon |
0:25fa8795676b
|
312
|
# the \nosubgrouping command.
|
| leothedragon |
0:25fa8795676b
|
313
|
|
| leothedragon |
0:25fa8795676b
|
314
|
SUBGROUPING = YES
|
| leothedragon |
0:25fa8795676b
|
315
|
|
| leothedragon |
0:25fa8795676b
|
316
|
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
|
| leothedragon |
0:25fa8795676b
|
317
|
# unions are shown inside the group in which they are included (e.g. using
|
| leothedragon |
0:25fa8795676b
|
318
|
# @ingroup) instead of on a separate page (for HTML and Man pages) or
|
| leothedragon |
0:25fa8795676b
|
319
|
# section (for LaTeX and RTF).
|
| leothedragon |
0:25fa8795676b
|
320
|
|
| leothedragon |
0:25fa8795676b
|
321
|
INLINE_GROUPED_CLASSES = NO
|
| leothedragon |
0:25fa8795676b
|
322
|
|
| leothedragon |
0:25fa8795676b
|
323
|
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
|
| leothedragon |
0:25fa8795676b
|
324
|
# unions with only public data fields will be shown inline in the documentation
|
| leothedragon |
0:25fa8795676b
|
325
|
# of the scope in which they are defined (i.e. file, namespace, or group
|
| leothedragon |
0:25fa8795676b
|
326
|
# documentation), provided this scope is documented. If set to NO (the default),
|
| leothedragon |
0:25fa8795676b
|
327
|
# structs, classes, and unions are shown on a separate page (for HTML and Man
|
| leothedragon |
0:25fa8795676b
|
328
|
# pages) or section (for LaTeX and RTF).
|
| leothedragon |
0:25fa8795676b
|
329
|
|
| leothedragon |
0:25fa8795676b
|
330
|
INLINE_SIMPLE_STRUCTS = NO
|
| leothedragon |
0:25fa8795676b
|
331
|
|
| leothedragon |
0:25fa8795676b
|
332
|
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
|
| leothedragon |
0:25fa8795676b
|
333
|
# is documented as struct, union, or enum with the name of the typedef. So
|
| leothedragon |
0:25fa8795676b
|
334
|
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
| leothedragon |
0:25fa8795676b
|
335
|
# with name TypeT. When disabled the typedef will appear as a member of a file,
|
| leothedragon |
0:25fa8795676b
|
336
|
# namespace, or class. And the struct will be named TypeS. This can typically
|
| leothedragon |
0:25fa8795676b
|
337
|
# be useful for C code in case the coding convention dictates that all compound
|
| leothedragon |
0:25fa8795676b
|
338
|
# types are typedef'ed and only the typedef is referenced, never the tag name.
|
| leothedragon |
0:25fa8795676b
|
339
|
|
| leothedragon |
0:25fa8795676b
|
340
|
TYPEDEF_HIDES_STRUCT = NO
|
| leothedragon |
0:25fa8795676b
|
341
|
|
| leothedragon |
0:25fa8795676b
|
342
|
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
|
| leothedragon |
0:25fa8795676b
|
343
|
# determine which symbols to keep in memory and which to flush to disk.
|
| leothedragon |
0:25fa8795676b
|
344
|
# When the cache is full, less often used symbols will be written to disk.
|
| leothedragon |
0:25fa8795676b
|
345
|
# For small to medium size projects (<1000 input files) the default value is
|
| leothedragon |
0:25fa8795676b
|
346
|
# probably good enough. For larger projects a too small cache size can cause
|
| leothedragon |
0:25fa8795676b
|
347
|
# doxygen to be busy swapping symbols to and from disk most of the time
|
| leothedragon |
0:25fa8795676b
|
348
|
# causing a significant performance penalty.
|
| leothedragon |
0:25fa8795676b
|
349
|
# If the system has enough physical memory increasing the cache will improve the
|
| leothedragon |
0:25fa8795676b
|
350
|
# performance by keeping more symbols in memory. Note that the value works on
|
| leothedragon |
0:25fa8795676b
|
351
|
# a logarithmic scale so increasing the size by one will roughly double the
|
| leothedragon |
0:25fa8795676b
|
352
|
# memory usage. The cache size is given by this formula:
|
| leothedragon |
0:25fa8795676b
|
353
|
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
| leothedragon |
0:25fa8795676b
|
354
|
# corresponding to a cache size of 2^16 = 65536 symbols.
|
| leothedragon |
0:25fa8795676b
|
355
|
|
| leothedragon |
0:25fa8795676b
|
356
|
SYMBOL_CACHE_SIZE = 0
|
| leothedragon |
0:25fa8795676b
|
357
|
|
| leothedragon |
0:25fa8795676b
|
358
|
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
|
| leothedragon |
0:25fa8795676b
|
359
|
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
|
| leothedragon |
0:25fa8795676b
|
360
|
# their name and scope. Since this can be an expensive process and often the
|
| leothedragon |
0:25fa8795676b
|
361
|
# same symbol appear multiple times in the code, doxygen keeps a cache of
|
| leothedragon |
0:25fa8795676b
|
362
|
# pre-resolved symbols. If the cache is too small doxygen will become slower.
|
| leothedragon |
0:25fa8795676b
|
363
|
# If the cache is too large, memory is wasted. The cache size is given by this
|
| leothedragon |
0:25fa8795676b
|
364
|
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
| leothedragon |
0:25fa8795676b
|
365
|
# corresponding to a cache size of 2^16 = 65536 symbols.
|
| leothedragon |
0:25fa8795676b
|
366
|
|
| leothedragon |
0:25fa8795676b
|
367
|
LOOKUP_CACHE_SIZE = 0
|
| leothedragon |
0:25fa8795676b
|
368
|
|
| leothedragon |
0:25fa8795676b
|
369
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
370
|
# Build related configuration options
|
| leothedragon |
0:25fa8795676b
|
371
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
372
|
|
| leothedragon |
0:25fa8795676b
|
373
|
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
| leothedragon |
0:25fa8795676b
|
374
|
# documentation are documented, even if no documentation was available.
|
| leothedragon |
0:25fa8795676b
|
375
|
# Private class members and static file members will be hidden unless
|
| leothedragon |
0:25fa8795676b
|
376
|
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
| leothedragon |
0:25fa8795676b
|
377
|
|
| leothedragon |
0:25fa8795676b
|
378
|
EXTRACT_ALL = NO
|
| leothedragon |
0:25fa8795676b
|
379
|
|
| leothedragon |
0:25fa8795676b
|
380
|
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
| leothedragon |
0:25fa8795676b
|
381
|
# will be included in the documentation.
|
| leothedragon |
0:25fa8795676b
|
382
|
|
| leothedragon |
0:25fa8795676b
|
383
|
EXTRACT_PRIVATE = NO
|
| leothedragon |
0:25fa8795676b
|
384
|
|
| leothedragon |
0:25fa8795676b
|
385
|
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
|
| leothedragon |
0:25fa8795676b
|
386
|
# scope will be included in the documentation.
|
| leothedragon |
0:25fa8795676b
|
387
|
|
| leothedragon |
0:25fa8795676b
|
388
|
EXTRACT_PACKAGE = NO
|
| leothedragon |
0:25fa8795676b
|
389
|
|
| leothedragon |
0:25fa8795676b
|
390
|
# If the EXTRACT_STATIC tag is set to YES all static members of a file
|
| leothedragon |
0:25fa8795676b
|
391
|
# will be included in the documentation.
|
| leothedragon |
0:25fa8795676b
|
392
|
|
| leothedragon |
0:25fa8795676b
|
393
|
EXTRACT_STATIC = NO
|
| leothedragon |
0:25fa8795676b
|
394
|
|
| leothedragon |
0:25fa8795676b
|
395
|
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
|
| leothedragon |
0:25fa8795676b
|
396
|
# defined locally in source files will be included in the documentation.
|
| leothedragon |
0:25fa8795676b
|
397
|
# If set to NO only classes defined in header files are included.
|
| leothedragon |
0:25fa8795676b
|
398
|
|
| leothedragon |
0:25fa8795676b
|
399
|
EXTRACT_LOCAL_CLASSES = NO
|
| leothedragon |
0:25fa8795676b
|
400
|
|
| leothedragon |
0:25fa8795676b
|
401
|
# This flag is only useful for Objective-C code. When set to YES local
|
| leothedragon |
0:25fa8795676b
|
402
|
# methods, which are defined in the implementation section but not in
|
| leothedragon |
0:25fa8795676b
|
403
|
# the interface are included in the documentation.
|
| leothedragon |
0:25fa8795676b
|
404
|
# If set to NO (the default) only methods in the interface are included.
|
| leothedragon |
0:25fa8795676b
|
405
|
|
| leothedragon |
0:25fa8795676b
|
406
|
EXTRACT_LOCAL_METHODS = NO
|
| leothedragon |
0:25fa8795676b
|
407
|
|
| leothedragon |
0:25fa8795676b
|
408
|
# If this flag is set to YES, the members of anonymous namespaces will be
|
| leothedragon |
0:25fa8795676b
|
409
|
# extracted and appear in the documentation as a namespace called
|
| leothedragon |
0:25fa8795676b
|
410
|
# 'anonymous_namespace{file}', where file will be replaced with the base
|
| leothedragon |
0:25fa8795676b
|
411
|
# name of the file that contains the anonymous namespace. By default
|
| leothedragon |
0:25fa8795676b
|
412
|
# anonymous namespaces are hidden.
|
| leothedragon |
0:25fa8795676b
|
413
|
|
| leothedragon |
0:25fa8795676b
|
414
|
EXTRACT_ANON_NSPACES = NO
|
| leothedragon |
0:25fa8795676b
|
415
|
|
| leothedragon |
0:25fa8795676b
|
416
|
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
| leothedragon |
0:25fa8795676b
|
417
|
# undocumented members of documented classes, files or namespaces.
|
| leothedragon |
0:25fa8795676b
|
418
|
# If set to NO (the default) these members will be included in the
|
| leothedragon |
0:25fa8795676b
|
419
|
# various overviews, but no documentation section is generated.
|
| leothedragon |
0:25fa8795676b
|
420
|
# This option has no effect if EXTRACT_ALL is enabled.
|
| leothedragon |
0:25fa8795676b
|
421
|
|
| leothedragon |
0:25fa8795676b
|
422
|
HIDE_UNDOC_MEMBERS = YES
|
| leothedragon |
0:25fa8795676b
|
423
|
|
| leothedragon |
0:25fa8795676b
|
424
|
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
| leothedragon |
0:25fa8795676b
|
425
|
# undocumented classes that are normally visible in the class hierarchy.
|
| leothedragon |
0:25fa8795676b
|
426
|
# If set to NO (the default) these classes will be included in the various
|
| leothedragon |
0:25fa8795676b
|
427
|
# overviews. This option has no effect if EXTRACT_ALL is enabled.
|
| leothedragon |
0:25fa8795676b
|
428
|
|
| leothedragon |
0:25fa8795676b
|
429
|
HIDE_UNDOC_CLASSES = YES
|
| leothedragon |
0:25fa8795676b
|
430
|
|
| leothedragon |
0:25fa8795676b
|
431
|
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
|
| leothedragon |
0:25fa8795676b
|
432
|
# friend (class|struct|union) declarations.
|
| leothedragon |
0:25fa8795676b
|
433
|
# If set to NO (the default) these declarations will be included in the
|
| leothedragon |
0:25fa8795676b
|
434
|
# documentation.
|
| leothedragon |
0:25fa8795676b
|
435
|
|
| leothedragon |
0:25fa8795676b
|
436
|
HIDE_FRIEND_COMPOUNDS = YES
|
| leothedragon |
0:25fa8795676b
|
437
|
|
| leothedragon |
0:25fa8795676b
|
438
|
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
|
| leothedragon |
0:25fa8795676b
|
439
|
# documentation blocks found inside the body of a function.
|
| leothedragon |
0:25fa8795676b
|
440
|
# If set to NO (the default) these blocks will be appended to the
|
| leothedragon |
0:25fa8795676b
|
441
|
# function's detailed documentation block.
|
| leothedragon |
0:25fa8795676b
|
442
|
|
| leothedragon |
0:25fa8795676b
|
443
|
HIDE_IN_BODY_DOCS = YES
|
| leothedragon |
0:25fa8795676b
|
444
|
|
| leothedragon |
0:25fa8795676b
|
445
|
# The INTERNAL_DOCS tag determines if documentation
|
| leothedragon |
0:25fa8795676b
|
446
|
# that is typed after a \internal command is included. If the tag is set
|
| leothedragon |
0:25fa8795676b
|
447
|
# to NO (the default) then the documentation will be excluded.
|
| leothedragon |
0:25fa8795676b
|
448
|
# Set it to YES to include the internal documentation.
|
| leothedragon |
0:25fa8795676b
|
449
|
|
| leothedragon |
0:25fa8795676b
|
450
|
INTERNAL_DOCS = NO
|
| leothedragon |
0:25fa8795676b
|
451
|
|
| leothedragon |
0:25fa8795676b
|
452
|
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
| leothedragon |
0:25fa8795676b
|
453
|
# file names in lower-case letters. If set to YES upper-case letters are also
|
| leothedragon |
0:25fa8795676b
|
454
|
# allowed. This is useful if you have classes or files whose names only differ
|
| leothedragon |
0:25fa8795676b
|
455
|
# in case and if your file system supports case sensitive file names. Windows
|
| leothedragon |
0:25fa8795676b
|
456
|
# and Mac users are advised to set this option to NO.
|
| leothedragon |
0:25fa8795676b
|
457
|
|
| leothedragon |
0:25fa8795676b
|
458
|
CASE_SENSE_NAMES = NO
|
| leothedragon |
0:25fa8795676b
|
459
|
|
| leothedragon |
0:25fa8795676b
|
460
|
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
| leothedragon |
0:25fa8795676b
|
461
|
# will show members with their full class and namespace scopes in the
|
| leothedragon |
0:25fa8795676b
|
462
|
# documentation. If set to YES the scope will be hidden.
|
| leothedragon |
0:25fa8795676b
|
463
|
|
| leothedragon |
0:25fa8795676b
|
464
|
HIDE_SCOPE_NAMES = YES
|
| leothedragon |
0:25fa8795676b
|
465
|
|
| leothedragon |
0:25fa8795676b
|
466
|
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
|
| leothedragon |
0:25fa8795676b
|
467
|
# will put a list of the files that are included by a file in the documentation
|
| leothedragon |
0:25fa8795676b
|
468
|
# of that file.
|
| leothedragon |
0:25fa8795676b
|
469
|
|
| leothedragon |
0:25fa8795676b
|
470
|
SHOW_INCLUDE_FILES = NO
|
| leothedragon |
0:25fa8795676b
|
471
|
|
| leothedragon |
0:25fa8795676b
|
472
|
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
|
| leothedragon |
0:25fa8795676b
|
473
|
# will list include files with double quotes in the documentation
|
| leothedragon |
0:25fa8795676b
|
474
|
# rather than with sharp brackets.
|
| leothedragon |
0:25fa8795676b
|
475
|
|
| leothedragon |
0:25fa8795676b
|
476
|
FORCE_LOCAL_INCLUDES = NO
|
| leothedragon |
0:25fa8795676b
|
477
|
|
| leothedragon |
0:25fa8795676b
|
478
|
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
| leothedragon |
0:25fa8795676b
|
479
|
# is inserted in the documentation for inline members.
|
| leothedragon |
0:25fa8795676b
|
480
|
|
| leothedragon |
0:25fa8795676b
|
481
|
INLINE_INFO = YES
|
| leothedragon |
0:25fa8795676b
|
482
|
|
| leothedragon |
0:25fa8795676b
|
483
|
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
| leothedragon |
0:25fa8795676b
|
484
|
# will sort the (detailed) documentation of file and class members
|
| leothedragon |
0:25fa8795676b
|
485
|
# alphabetically by member name. If set to NO the members will appear in
|
| leothedragon |
0:25fa8795676b
|
486
|
# declaration order.
|
| leothedragon |
0:25fa8795676b
|
487
|
|
| leothedragon |
0:25fa8795676b
|
488
|
SORT_MEMBER_DOCS = YES
|
| leothedragon |
0:25fa8795676b
|
489
|
|
| leothedragon |
0:25fa8795676b
|
490
|
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
|
| leothedragon |
0:25fa8795676b
|
491
|
# brief documentation of file, namespace and class members alphabetically
|
| leothedragon |
0:25fa8795676b
|
492
|
# by member name. If set to NO (the default) the members will appear in
|
| leothedragon |
0:25fa8795676b
|
493
|
# declaration order.
|
| leothedragon |
0:25fa8795676b
|
494
|
|
| leothedragon |
0:25fa8795676b
|
495
|
SORT_BRIEF_DOCS = NO
|
| leothedragon |
0:25fa8795676b
|
496
|
|
| leothedragon |
0:25fa8795676b
|
497
|
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
|
| leothedragon |
0:25fa8795676b
|
498
|
# will sort the (brief and detailed) documentation of class members so that
|
| leothedragon |
0:25fa8795676b
|
499
|
# constructors and destructors are listed first. If set to NO (the default)
|
| leothedragon |
0:25fa8795676b
|
500
|
# the constructors will appear in the respective orders defined by
|
| leothedragon |
0:25fa8795676b
|
501
|
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
|
| leothedragon |
0:25fa8795676b
|
502
|
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
|
| leothedragon |
0:25fa8795676b
|
503
|
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
|
| leothedragon |
0:25fa8795676b
|
504
|
|
| leothedragon |
0:25fa8795676b
|
505
|
SORT_MEMBERS_CTORS_1ST = NO
|
| leothedragon |
0:25fa8795676b
|
506
|
|
| leothedragon |
0:25fa8795676b
|
507
|
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
|
| leothedragon |
0:25fa8795676b
|
508
|
# hierarchy of group names into alphabetical order. If set to NO (the default)
|
| leothedragon |
0:25fa8795676b
|
509
|
# the group names will appear in their defined order.
|
| leothedragon |
0:25fa8795676b
|
510
|
|
| leothedragon |
0:25fa8795676b
|
511
|
SORT_GROUP_NAMES = NO
|
| leothedragon |
0:25fa8795676b
|
512
|
|
| leothedragon |
0:25fa8795676b
|
513
|
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
|
| leothedragon |
0:25fa8795676b
|
514
|
# sorted by fully-qualified names, including namespaces. If set to
|
| leothedragon |
0:25fa8795676b
|
515
|
# NO (the default), the class list will be sorted only by class name,
|
| leothedragon |
0:25fa8795676b
|
516
|
# not including the namespace part.
|
| leothedragon |
0:25fa8795676b
|
517
|
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
| leothedragon |
0:25fa8795676b
|
518
|
# Note: This option applies only to the class list, not to the
|
| leothedragon |
0:25fa8795676b
|
519
|
# alphabetical list.
|
| leothedragon |
0:25fa8795676b
|
520
|
|
| leothedragon |
0:25fa8795676b
|
521
|
SORT_BY_SCOPE_NAME = NO
|
| leothedragon |
0:25fa8795676b
|
522
|
|
| leothedragon |
0:25fa8795676b
|
523
|
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
|
| leothedragon |
0:25fa8795676b
|
524
|
# do proper type resolution of all parameters of a function it will reject a
|
| leothedragon |
0:25fa8795676b
|
525
|
# match between the prototype and the implementation of a member function even
|
| leothedragon |
0:25fa8795676b
|
526
|
# if there is only one candidate or it is obvious which candidate to choose
|
| leothedragon |
0:25fa8795676b
|
527
|
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
|
| leothedragon |
0:25fa8795676b
|
528
|
# will still accept a match between prototype and implementation in such cases.
|
| leothedragon |
0:25fa8795676b
|
529
|
|
| leothedragon |
0:25fa8795676b
|
530
|
STRICT_PROTO_MATCHING = NO
|
| leothedragon |
0:25fa8795676b
|
531
|
|
| leothedragon |
0:25fa8795676b
|
532
|
# The GENERATE_TODOLIST tag can be used to enable (YES) or
|
| leothedragon |
0:25fa8795676b
|
533
|
# disable (NO) the todo list. This list is created by putting \todo
|
| leothedragon |
0:25fa8795676b
|
534
|
# commands in the documentation.
|
| leothedragon |
0:25fa8795676b
|
535
|
|
| leothedragon |
0:25fa8795676b
|
536
|
GENERATE_TODOLIST = YES
|
| leothedragon |
0:25fa8795676b
|
537
|
|
| leothedragon |
0:25fa8795676b
|
538
|
# The GENERATE_TESTLIST tag can be used to enable (YES) or
|
| leothedragon |
0:25fa8795676b
|
539
|
# disable (NO) the test list. This list is created by putting \test
|
| leothedragon |
0:25fa8795676b
|
540
|
# commands in the documentation.
|
| leothedragon |
0:25fa8795676b
|
541
|
|
| leothedragon |
0:25fa8795676b
|
542
|
GENERATE_TESTLIST = YES
|
| leothedragon |
0:25fa8795676b
|
543
|
|
| leothedragon |
0:25fa8795676b
|
544
|
# The GENERATE_BUGLIST tag can be used to enable (YES) or
|
| leothedragon |
0:25fa8795676b
|
545
|
# disable (NO) the bug list. This list is created by putting \bug
|
| leothedragon |
0:25fa8795676b
|
546
|
# commands in the documentation.
|
| leothedragon |
0:25fa8795676b
|
547
|
|
| leothedragon |
0:25fa8795676b
|
548
|
GENERATE_BUGLIST = YES
|
| leothedragon |
0:25fa8795676b
|
549
|
|
| leothedragon |
0:25fa8795676b
|
550
|
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
|
| leothedragon |
0:25fa8795676b
|
551
|
# disable (NO) the deprecated list. This list is created by putting
|
| leothedragon |
0:25fa8795676b
|
552
|
# \deprecated commands in the documentation.
|
| leothedragon |
0:25fa8795676b
|
553
|
|
| leothedragon |
0:25fa8795676b
|
554
|
GENERATE_DEPRECATEDLIST= YES
|
| leothedragon |
0:25fa8795676b
|
555
|
|
| leothedragon |
0:25fa8795676b
|
556
|
# The ENABLED_SECTIONS tag can be used to enable conditional
|
| leothedragon |
0:25fa8795676b
|
557
|
# documentation sections, marked by \if sectionname ... \endif.
|
| leothedragon |
0:25fa8795676b
|
558
|
|
| leothedragon |
0:25fa8795676b
|
559
|
ENABLED_SECTIONS =
|
| leothedragon |
0:25fa8795676b
|
560
|
|
| leothedragon |
0:25fa8795676b
|
561
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
| leothedragon |
0:25fa8795676b
|
562
|
# the initial value of a variable or macro consists of for it to appear in
|
| leothedragon |
0:25fa8795676b
|
563
|
# the documentation. If the initializer consists of more lines than specified
|
| leothedragon |
0:25fa8795676b
|
564
|
# here it will be hidden. Use a value of 0 to hide initializers completely.
|
| leothedragon |
0:25fa8795676b
|
565
|
# The appearance of the initializer of individual variables and macros in the
|
| leothedragon |
0:25fa8795676b
|
566
|
# documentation can be controlled using \showinitializer or \hideinitializer
|
| leothedragon |
0:25fa8795676b
|
567
|
# command in the documentation regardless of this setting.
|
| leothedragon |
0:25fa8795676b
|
568
|
|
| leothedragon |
0:25fa8795676b
|
569
|
MAX_INITIALIZER_LINES = 18
|
| leothedragon |
0:25fa8795676b
|
570
|
|
| leothedragon |
0:25fa8795676b
|
571
|
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
| leothedragon |
0:25fa8795676b
|
572
|
# at the bottom of the documentation of classes and structs. If set to YES the
|
| leothedragon |
0:25fa8795676b
|
573
|
# list will mention the files that were used to generate the documentation.
|
| leothedragon |
0:25fa8795676b
|
574
|
|
| leothedragon |
0:25fa8795676b
|
575
|
SHOW_USED_FILES = YES
|
| leothedragon |
0:25fa8795676b
|
576
|
|
| leothedragon |
0:25fa8795676b
|
577
|
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
|
| leothedragon |
0:25fa8795676b
|
578
|
# This will remove the Files entry from the Quick Index and from the
|
| leothedragon |
0:25fa8795676b
|
579
|
# Folder Tree View (if specified). The default is YES.
|
| leothedragon |
0:25fa8795676b
|
580
|
|
| leothedragon |
0:25fa8795676b
|
581
|
SHOW_FILES = YES
|
| leothedragon |
0:25fa8795676b
|
582
|
|
| leothedragon |
0:25fa8795676b
|
583
|
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
|
| leothedragon |
0:25fa8795676b
|
584
|
# Namespaces page. This will remove the Namespaces entry from the Quick Index
|
| leothedragon |
0:25fa8795676b
|
585
|
# and from the Folder Tree View (if specified). The default is YES.
|
| leothedragon |
0:25fa8795676b
|
586
|
|
| leothedragon |
0:25fa8795676b
|
587
|
SHOW_NAMESPACES = YES
|
| leothedragon |
0:25fa8795676b
|
588
|
|
| leothedragon |
0:25fa8795676b
|
589
|
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
| leothedragon |
0:25fa8795676b
|
590
|
# doxygen should invoke to get the current version for each file (typically from
|
| leothedragon |
0:25fa8795676b
|
591
|
# the version control system). Doxygen will invoke the program by executing (via
|
| leothedragon |
0:25fa8795676b
|
592
|
# popen()) the command <command> <input-file>, where <command> is the value of
|
| leothedragon |
0:25fa8795676b
|
593
|
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
|
| leothedragon |
0:25fa8795676b
|
594
|
# provided by doxygen. Whatever the program writes to standard output
|
| leothedragon |
0:25fa8795676b
|
595
|
# is used as the file version. See the manual for examples.
|
| leothedragon |
0:25fa8795676b
|
596
|
|
| leothedragon |
0:25fa8795676b
|
597
|
FILE_VERSION_FILTER =
|
| leothedragon |
0:25fa8795676b
|
598
|
|
| leothedragon |
0:25fa8795676b
|
599
|
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
| leothedragon |
0:25fa8795676b
|
600
|
# by doxygen. The layout file controls the global structure of the generated
|
| leothedragon |
0:25fa8795676b
|
601
|
# output files in an output format independent way. To create the layout file
|
| leothedragon |
0:25fa8795676b
|
602
|
# that represents doxygen's defaults, run doxygen with the -l option.
|
| leothedragon |
0:25fa8795676b
|
603
|
# You can optionally specify a file name after the option, if omitted
|
| leothedragon |
0:25fa8795676b
|
604
|
# DoxygenLayout.xml will be used as the name of the layout file.
|
| leothedragon |
0:25fa8795676b
|
605
|
|
| leothedragon |
0:25fa8795676b
|
606
|
LAYOUT_FILE =
|
| leothedragon |
0:25fa8795676b
|
607
|
|
| leothedragon |
0:25fa8795676b
|
608
|
# The CITE_BIB_FILES tag can be used to specify one or more bib files
|
| leothedragon |
0:25fa8795676b
|
609
|
# containing the references data. This must be a list of .bib files. The
|
| leothedragon |
0:25fa8795676b
|
610
|
# .bib extension is automatically appended if omitted. Using this command
|
| leothedragon |
0:25fa8795676b
|
611
|
# requires the bibtex tool to be installed. See also
|
| leothedragon |
0:25fa8795676b
|
612
|
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
|
| leothedragon |
0:25fa8795676b
|
613
|
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
|
| leothedragon |
0:25fa8795676b
|
614
|
# feature you need bibtex and perl available in the search path.
|
| leothedragon |
0:25fa8795676b
|
615
|
|
| leothedragon |
0:25fa8795676b
|
616
|
CITE_BIB_FILES =
|
| leothedragon |
0:25fa8795676b
|
617
|
|
| leothedragon |
0:25fa8795676b
|
618
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
619
|
# configuration options related to warning and progress messages
|
| leothedragon |
0:25fa8795676b
|
620
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
621
|
|
| leothedragon |
0:25fa8795676b
|
622
|
# The QUIET tag can be used to turn on/off the messages that are generated
|
| leothedragon |
0:25fa8795676b
|
623
|
# by doxygen. Possible values are YES and NO. If left blank NO is used.
|
| leothedragon |
0:25fa8795676b
|
624
|
|
| leothedragon |
0:25fa8795676b
|
625
|
QUIET = NO
|
| leothedragon |
0:25fa8795676b
|
626
|
|
| leothedragon |
0:25fa8795676b
|
627
|
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
| leothedragon |
0:25fa8795676b
|
628
|
# generated by doxygen. Possible values are YES and NO. If left blank
|
| leothedragon |
0:25fa8795676b
|
629
|
# NO is used.
|
| leothedragon |
0:25fa8795676b
|
630
|
|
| leothedragon |
0:25fa8795676b
|
631
|
WARNINGS = YES
|
| leothedragon |
0:25fa8795676b
|
632
|
|
| leothedragon |
0:25fa8795676b
|
633
|
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
| leothedragon |
0:25fa8795676b
|
634
|
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
| leothedragon |
0:25fa8795676b
|
635
|
# automatically be disabled.
|
| leothedragon |
0:25fa8795676b
|
636
|
|
| leothedragon |
0:25fa8795676b
|
637
|
WARN_IF_UNDOCUMENTED = YES
|
| leothedragon |
0:25fa8795676b
|
638
|
|
| leothedragon |
0:25fa8795676b
|
639
|
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
|
| leothedragon |
0:25fa8795676b
|
640
|
# potential errors in the documentation, such as not documenting some
|
| leothedragon |
0:25fa8795676b
|
641
|
# parameters in a documented function, or documenting parameters that
|
| leothedragon |
0:25fa8795676b
|
642
|
# don't exist or using markup commands wrongly.
|
| leothedragon |
0:25fa8795676b
|
643
|
|
| leothedragon |
0:25fa8795676b
|
644
|
WARN_IF_DOC_ERROR = YES
|
| leothedragon |
0:25fa8795676b
|
645
|
|
| leothedragon |
0:25fa8795676b
|
646
|
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
|
| leothedragon |
0:25fa8795676b
|
647
|
# functions that are documented, but have no documentation for their parameters
|
| leothedragon |
0:25fa8795676b
|
648
|
# or return value. If set to NO (the default) doxygen will only warn about
|
| leothedragon |
0:25fa8795676b
|
649
|
# wrong or incomplete parameter documentation, but not about the absence of
|
| leothedragon |
0:25fa8795676b
|
650
|
# documentation.
|
| leothedragon |
0:25fa8795676b
|
651
|
|
| leothedragon |
0:25fa8795676b
|
652
|
WARN_NO_PARAMDOC = NO
|
| leothedragon |
0:25fa8795676b
|
653
|
|
| leothedragon |
0:25fa8795676b
|
654
|
# The WARN_FORMAT tag determines the format of the warning messages that
|
| leothedragon |
0:25fa8795676b
|
655
|
# doxygen can produce. The string should contain the $file, $line, and $text
|
| leothedragon |
0:25fa8795676b
|
656
|
# tags, which will be replaced by the file and line number from which the
|
| leothedragon |
0:25fa8795676b
|
657
|
# warning originated and the warning text. Optionally the format may contain
|
| leothedragon |
0:25fa8795676b
|
658
|
# $version, which will be replaced by the version of the file (if it could
|
| leothedragon |
0:25fa8795676b
|
659
|
# be obtained via FILE_VERSION_FILTER)
|
| leothedragon |
0:25fa8795676b
|
660
|
|
| leothedragon |
0:25fa8795676b
|
661
|
WARN_FORMAT = "$file:$line: $text"
|
| leothedragon |
0:25fa8795676b
|
662
|
|
| leothedragon |
0:25fa8795676b
|
663
|
# The WARN_LOGFILE tag can be used to specify a file to which warning
|
| leothedragon |
0:25fa8795676b
|
664
|
# and error messages should be written. If left blank the output is written
|
| leothedragon |
0:25fa8795676b
|
665
|
# to stderr.
|
| leothedragon |
0:25fa8795676b
|
666
|
|
| leothedragon |
0:25fa8795676b
|
667
|
WARN_LOGFILE =
|
| leothedragon |
0:25fa8795676b
|
668
|
|
| leothedragon |
0:25fa8795676b
|
669
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
670
|
# configuration options related to the input files
|
| leothedragon |
0:25fa8795676b
|
671
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
672
|
|
| leothedragon |
0:25fa8795676b
|
673
|
# The INPUT tag can be used to specify the files and/or directories that contain
|
| leothedragon |
0:25fa8795676b
|
674
|
# documented source files. You may enter file names like "myfile.cpp" or
|
| leothedragon |
0:25fa8795676b
|
675
|
# directories like "/usr/src/myproject". Separate the files or directories
|
| leothedragon |
0:25fa8795676b
|
676
|
# with spaces.
|
| leothedragon |
0:25fa8795676b
|
677
|
|
| leothedragon |
0:25fa8795676b
|
678
|
INPUT = ../mbed-cloud-client
|
| leothedragon |
0:25fa8795676b
|
679
|
|
| leothedragon |
0:25fa8795676b
|
680
|
# This tag can be used to specify the character encoding of the source files
|
| leothedragon |
0:25fa8795676b
|
681
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
| leothedragon |
0:25fa8795676b
|
682
|
# also the default input encoding. Doxygen uses libiconv (or the iconv built
|
| leothedragon |
0:25fa8795676b
|
683
|
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
|
| leothedragon |
0:25fa8795676b
|
684
|
# the list of possible encodings.
|
| leothedragon |
0:25fa8795676b
|
685
|
|
| leothedragon |
0:25fa8795676b
|
686
|
INPUT_ENCODING = UTF-8
|
| leothedragon |
0:25fa8795676b
|
687
|
|
| leothedragon |
0:25fa8795676b
|
688
|
# If the value of the INPUT tag contains directories, you can use the
|
| leothedragon |
0:25fa8795676b
|
689
|
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
| leothedragon |
0:25fa8795676b
|
690
|
# and *.h) to filter out the source-files in the directories. If left
|
| leothedragon |
0:25fa8795676b
|
691
|
# blank the following patterns are tested:
|
| leothedragon |
0:25fa8795676b
|
692
|
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
|
| leothedragon |
0:25fa8795676b
|
693
|
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
|
| leothedragon |
0:25fa8795676b
|
694
|
# *.f90 *.f *.for *.vhd *.vhdl
|
| leothedragon |
0:25fa8795676b
|
695
|
|
| leothedragon |
0:25fa8795676b
|
696
|
FILE_PATTERNS = *.c \
|
| leothedragon |
0:25fa8795676b
|
697
|
*.cc \
|
| leothedragon |
0:25fa8795676b
|
698
|
*.cxx \
|
| leothedragon |
0:25fa8795676b
|
699
|
*.cpp \
|
| leothedragon |
0:25fa8795676b
|
700
|
*.c++ \
|
| leothedragon |
0:25fa8795676b
|
701
|
*.d \
|
| leothedragon |
0:25fa8795676b
|
702
|
*.java \
|
| leothedragon |
0:25fa8795676b
|
703
|
*.ii \
|
| leothedragon |
0:25fa8795676b
|
704
|
*.ixx \
|
| leothedragon |
0:25fa8795676b
|
705
|
*.ipp \
|
| leothedragon |
0:25fa8795676b
|
706
|
*.i++ \
|
| leothedragon |
0:25fa8795676b
|
707
|
*.inl \
|
| leothedragon |
0:25fa8795676b
|
708
|
*.h \
|
| leothedragon |
0:25fa8795676b
|
709
|
*.hh \
|
| leothedragon |
0:25fa8795676b
|
710
|
*.hxx \
|
| leothedragon |
0:25fa8795676b
|
711
|
*.hpp \
|
| leothedragon |
0:25fa8795676b
|
712
|
*.h++ \
|
| leothedragon |
0:25fa8795676b
|
713
|
*.idl \
|
| leothedragon |
0:25fa8795676b
|
714
|
*.odl \
|
| leothedragon |
0:25fa8795676b
|
715
|
*.cs \
|
| leothedragon |
0:25fa8795676b
|
716
|
*.php \
|
| leothedragon |
0:25fa8795676b
|
717
|
*.php3 \
|
| leothedragon |
0:25fa8795676b
|
718
|
*.inc \
|
| leothedragon |
0:25fa8795676b
|
719
|
*.m \
|
| leothedragon |
0:25fa8795676b
|
720
|
*.markdown \
|
| leothedragon |
0:25fa8795676b
|
721
|
*.md \
|
| leothedragon |
0:25fa8795676b
|
722
|
*.mm \
|
| leothedragon |
0:25fa8795676b
|
723
|
*.dox \
|
| leothedragon |
0:25fa8795676b
|
724
|
*.py \
|
| leothedragon |
0:25fa8795676b
|
725
|
*.f90 \
|
| leothedragon |
0:25fa8795676b
|
726
|
*.f \
|
| leothedragon |
0:25fa8795676b
|
727
|
*.for \
|
| leothedragon |
0:25fa8795676b
|
728
|
*.vhd \
|
| leothedragon |
0:25fa8795676b
|
729
|
*.vhdl
|
| leothedragon |
0:25fa8795676b
|
730
|
|
| leothedragon |
0:25fa8795676b
|
731
|
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
| leothedragon |
0:25fa8795676b
|
732
|
# should be searched for input files as well. Possible values are YES and NO.
|
| leothedragon |
0:25fa8795676b
|
733
|
# If left blank NO is used.
|
| leothedragon |
0:25fa8795676b
|
734
|
|
| leothedragon |
0:25fa8795676b
|
735
|
RECURSIVE = YES
|
| leothedragon |
0:25fa8795676b
|
736
|
|
| leothedragon |
0:25fa8795676b
|
737
|
# The EXCLUDE tag can be used to specify files and/or directories that should be
|
| leothedragon |
0:25fa8795676b
|
738
|
# excluded from the INPUT source files. This way you can easily exclude a
|
| leothedragon |
0:25fa8795676b
|
739
|
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
| leothedragon |
0:25fa8795676b
|
740
|
# Note that relative paths are relative to the directory from which doxygen is
|
| leothedragon |
0:25fa8795676b
|
741
|
# run.
|
| leothedragon |
0:25fa8795676b
|
742
|
|
| leothedragon |
0:25fa8795676b
|
743
|
EXCLUDE =
|
| leothedragon |
0:25fa8795676b
|
744
|
|
| leothedragon |
0:25fa8795676b
|
745
|
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
| leothedragon |
0:25fa8795676b
|
746
|
# directories that are symbolic links (a Unix file system feature) are excluded
|
| leothedragon |
0:25fa8795676b
|
747
|
# from the input.
|
| leothedragon |
0:25fa8795676b
|
748
|
|
| leothedragon |
0:25fa8795676b
|
749
|
EXCLUDE_SYMLINKS = NO
|
| leothedragon |
0:25fa8795676b
|
750
|
|
| leothedragon |
0:25fa8795676b
|
751
|
# If the value of the INPUT tag contains directories, you can use the
|
| leothedragon |
0:25fa8795676b
|
752
|
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
| leothedragon |
0:25fa8795676b
|
753
|
# certain files from those directories. Note that the wildcards are matched
|
| leothedragon |
0:25fa8795676b
|
754
|
# against the file with absolute path, so to exclude all test directories
|
| leothedragon |
0:25fa8795676b
|
755
|
# for example use the pattern */test/*
|
| leothedragon |
0:25fa8795676b
|
756
|
|
| leothedragon |
0:25fa8795676b
|
757
|
EXCLUDE_PATTERNS =
|
| leothedragon |
0:25fa8795676b
|
758
|
|
| leothedragon |
0:25fa8795676b
|
759
|
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
| leothedragon |
0:25fa8795676b
|
760
|
# (namespaces, classes, functions, etc.) that should be excluded from the
|
| leothedragon |
0:25fa8795676b
|
761
|
# output. The symbol name can be a fully qualified name, a word, or if the
|
| leothedragon |
0:25fa8795676b
|
762
|
# wildcard * is used, a substring. Examples: ANamespace, AClass,
|
| leothedragon |
0:25fa8795676b
|
763
|
# AClass::ANamespace, ANamespace::*Test
|
| leothedragon |
0:25fa8795676b
|
764
|
|
| leothedragon |
0:25fa8795676b
|
765
|
EXCLUDE_SYMBOLS =
|
| leothedragon |
0:25fa8795676b
|
766
|
|
| leothedragon |
0:25fa8795676b
|
767
|
# The EXAMPLE_PATH tag can be used to specify one or more files or
|
| leothedragon |
0:25fa8795676b
|
768
|
# directories that contain example code fragments that are included (see
|
| leothedragon |
0:25fa8795676b
|
769
|
# the \include command).
|
| leothedragon |
0:25fa8795676b
|
770
|
|
| leothedragon |
0:25fa8795676b
|
771
|
EXAMPLE_PATH =
|
| leothedragon |
0:25fa8795676b
|
772
|
|
| leothedragon |
0:25fa8795676b
|
773
|
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
| leothedragon |
0:25fa8795676b
|
774
|
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
| leothedragon |
0:25fa8795676b
|
775
|
# and *.h) to filter out the source-files in the directories. If left
|
| leothedragon |
0:25fa8795676b
|
776
|
# blank all files are included.
|
| leothedragon |
0:25fa8795676b
|
777
|
|
| leothedragon |
0:25fa8795676b
|
778
|
EXAMPLE_PATTERNS = *
|
| leothedragon |
0:25fa8795676b
|
779
|
|
| leothedragon |
0:25fa8795676b
|
780
|
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
| leothedragon |
0:25fa8795676b
|
781
|
# searched for input files to be used with the \include or \dontinclude
|
| leothedragon |
0:25fa8795676b
|
782
|
# commands irrespective of the value of the RECURSIVE tag.
|
| leothedragon |
0:25fa8795676b
|
783
|
# Possible values are YES and NO. If left blank NO is used.
|
| leothedragon |
0:25fa8795676b
|
784
|
|
| leothedragon |
0:25fa8795676b
|
785
|
EXAMPLE_RECURSIVE = NO
|
| leothedragon |
0:25fa8795676b
|
786
|
|
| leothedragon |
0:25fa8795676b
|
787
|
# The IMAGE_PATH tag can be used to specify one or more files or
|
| leothedragon |
0:25fa8795676b
|
788
|
# directories that contain image that are included in the documentation (see
|
| leothedragon |
0:25fa8795676b
|
789
|
# the \image command).
|
| leothedragon |
0:25fa8795676b
|
790
|
|
| leothedragon |
0:25fa8795676b
|
791
|
IMAGE_PATH =
|
| leothedragon |
0:25fa8795676b
|
792
|
|
| leothedragon |
0:25fa8795676b
|
793
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
| leothedragon |
0:25fa8795676b
|
794
|
# invoke to filter for each input file. Doxygen will invoke the filter program
|
| leothedragon |
0:25fa8795676b
|
795
|
# by executing (via popen()) the command <filter> <input-file>, where <filter>
|
| leothedragon |
0:25fa8795676b
|
796
|
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
| leothedragon |
0:25fa8795676b
|
797
|
# input file. Doxygen will then use the output that the filter program writes
|
| leothedragon |
0:25fa8795676b
|
798
|
# to standard output. If FILTER_PATTERNS is specified, this tag will be
|
| leothedragon |
0:25fa8795676b
|
799
|
# ignored.
|
| leothedragon |
0:25fa8795676b
|
800
|
|
| leothedragon |
0:25fa8795676b
|
801
|
INPUT_FILTER =
|
| leothedragon |
0:25fa8795676b
|
802
|
|
| leothedragon |
0:25fa8795676b
|
803
|
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
| leothedragon |
0:25fa8795676b
|
804
|
# basis. Doxygen will compare the file name with each pattern and apply the
|
| leothedragon |
0:25fa8795676b
|
805
|
# filter if there is a match. The filters are a list of the form:
|
| leothedragon |
0:25fa8795676b
|
806
|
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
|
| leothedragon |
0:25fa8795676b
|
807
|
# info on how filters are used. If FILTER_PATTERNS is empty or if
|
| leothedragon |
0:25fa8795676b
|
808
|
# non of the patterns match the file name, INPUT_FILTER is applied.
|
| leothedragon |
0:25fa8795676b
|
809
|
|
| leothedragon |
0:25fa8795676b
|
810
|
FILTER_PATTERNS =
|
| leothedragon |
0:25fa8795676b
|
811
|
|
| leothedragon |
0:25fa8795676b
|
812
|
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
| leothedragon |
0:25fa8795676b
|
813
|
# INPUT_FILTER) will be used to filter the input files when producing source
|
| leothedragon |
0:25fa8795676b
|
814
|
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
| leothedragon |
0:25fa8795676b
|
815
|
|
| leothedragon |
0:25fa8795676b
|
816
|
FILTER_SOURCE_FILES = NO
|
| leothedragon |
0:25fa8795676b
|
817
|
|
| leothedragon |
0:25fa8795676b
|
818
|
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
|
| leothedragon |
0:25fa8795676b
|
819
|
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
|
| leothedragon |
0:25fa8795676b
|
820
|
# and it is also possible to disable source filtering for a specific pattern
|
| leothedragon |
0:25fa8795676b
|
821
|
# using *.ext= (so without naming a filter). This option only has effect when
|
| leothedragon |
0:25fa8795676b
|
822
|
# FILTER_SOURCE_FILES is enabled.
|
| leothedragon |
0:25fa8795676b
|
823
|
|
| leothedragon |
0:25fa8795676b
|
824
|
FILTER_SOURCE_PATTERNS =
|
| leothedragon |
0:25fa8795676b
|
825
|
|
| leothedragon |
0:25fa8795676b
|
826
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
827
|
# configuration options related to source browsing
|
| leothedragon |
0:25fa8795676b
|
828
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
829
|
|
| leothedragon |
0:25fa8795676b
|
830
|
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
| leothedragon |
0:25fa8795676b
|
831
|
# be generated. Documented entities will be cross-referenced with these sources.
|
| leothedragon |
0:25fa8795676b
|
832
|
# Note: To get rid of all source code in the generated output, make sure also
|
| leothedragon |
0:25fa8795676b
|
833
|
# VERBATIM_HEADERS is set to NO.
|
| leothedragon |
0:25fa8795676b
|
834
|
|
| leothedragon |
0:25fa8795676b
|
835
|
SOURCE_BROWSER = NO
|
| leothedragon |
0:25fa8795676b
|
836
|
|
| leothedragon |
0:25fa8795676b
|
837
|
# Setting the INLINE_SOURCES tag to YES will include the body
|
| leothedragon |
0:25fa8795676b
|
838
|
# of functions and classes directly in the documentation.
|
| leothedragon |
0:25fa8795676b
|
839
|
|
| leothedragon |
0:25fa8795676b
|
840
|
INLINE_SOURCES = NO
|
| leothedragon |
0:25fa8795676b
|
841
|
|
| leothedragon |
0:25fa8795676b
|
842
|
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
| leothedragon |
0:25fa8795676b
|
843
|
# doxygen to hide any special comment blocks from generated source code
|
| leothedragon |
0:25fa8795676b
|
844
|
# fragments. Normal C, C++ and Fortran comments will always remain visible.
|
| leothedragon |
0:25fa8795676b
|
845
|
|
| leothedragon |
0:25fa8795676b
|
846
|
STRIP_CODE_COMMENTS = YES
|
| leothedragon |
0:25fa8795676b
|
847
|
|
| leothedragon |
0:25fa8795676b
|
848
|
# If the REFERENCED_BY_RELATION tag is set to YES
|
| leothedragon |
0:25fa8795676b
|
849
|
# then for each documented function all documented
|
| leothedragon |
0:25fa8795676b
|
850
|
# functions referencing it will be listed.
|
| leothedragon |
0:25fa8795676b
|
851
|
|
| leothedragon |
0:25fa8795676b
|
852
|
REFERENCED_BY_RELATION = NO
|
| leothedragon |
0:25fa8795676b
|
853
|
|
| leothedragon |
0:25fa8795676b
|
854
|
# If the REFERENCES_RELATION tag is set to YES
|
| leothedragon |
0:25fa8795676b
|
855
|
# then for each documented function all documented entities
|
| leothedragon |
0:25fa8795676b
|
856
|
# called/used by that function will be listed.
|
| leothedragon |
0:25fa8795676b
|
857
|
|
| leothedragon |
0:25fa8795676b
|
858
|
REFERENCES_RELATION = NO
|
| leothedragon |
0:25fa8795676b
|
859
|
|
| leothedragon |
0:25fa8795676b
|
860
|
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
|
| leothedragon |
0:25fa8795676b
|
861
|
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
|
| leothedragon |
0:25fa8795676b
|
862
|
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
|
| leothedragon |
0:25fa8795676b
|
863
|
# link to the source code. Otherwise they will link to the documentation.
|
| leothedragon |
0:25fa8795676b
|
864
|
|
| leothedragon |
0:25fa8795676b
|
865
|
REFERENCES_LINK_SOURCE = YES
|
| leothedragon |
0:25fa8795676b
|
866
|
|
| leothedragon |
0:25fa8795676b
|
867
|
# If the USE_HTAGS tag is set to YES then the references to source code
|
| leothedragon |
0:25fa8795676b
|
868
|
# will point to the HTML generated by the htags(1) tool instead of doxygen
|
| leothedragon |
0:25fa8795676b
|
869
|
# built-in source browser. The htags tool is part of GNU's global source
|
| leothedragon |
0:25fa8795676b
|
870
|
# tagging system (see http://www.gnu.org/software/global/global.html). You
|
| leothedragon |
0:25fa8795676b
|
871
|
# will need version 4.8.6 or higher.
|
| leothedragon |
0:25fa8795676b
|
872
|
|
| leothedragon |
0:25fa8795676b
|
873
|
USE_HTAGS = NO
|
| leothedragon |
0:25fa8795676b
|
874
|
|
| leothedragon |
0:25fa8795676b
|
875
|
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
| leothedragon |
0:25fa8795676b
|
876
|
# will generate a verbatim copy of the header file for each class for
|
| leothedragon |
0:25fa8795676b
|
877
|
# which an include is specified. Set to NO to disable this.
|
| leothedragon |
0:25fa8795676b
|
878
|
|
| leothedragon |
0:25fa8795676b
|
879
|
VERBATIM_HEADERS = YES
|
| leothedragon |
0:25fa8795676b
|
880
|
|
| leothedragon |
0:25fa8795676b
|
881
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
882
|
# configuration options related to the alphabetical class index
|
| leothedragon |
0:25fa8795676b
|
883
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
884
|
|
| leothedragon |
0:25fa8795676b
|
885
|
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
| leothedragon |
0:25fa8795676b
|
886
|
# of all compounds will be generated. Enable this if the project
|
| leothedragon |
0:25fa8795676b
|
887
|
# contains a lot of classes, structs, unions or interfaces.
|
| leothedragon |
0:25fa8795676b
|
888
|
|
| leothedragon |
0:25fa8795676b
|
889
|
ALPHABETICAL_INDEX = YES
|
| leothedragon |
0:25fa8795676b
|
890
|
|
| leothedragon |
0:25fa8795676b
|
891
|
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
| leothedragon |
0:25fa8795676b
|
892
|
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
| leothedragon |
0:25fa8795676b
|
893
|
# in which this list will be split (can be a number in the range [1..20])
|
| leothedragon |
0:25fa8795676b
|
894
|
|
| leothedragon |
0:25fa8795676b
|
895
|
COLS_IN_ALPHA_INDEX = 5
|
| leothedragon |
0:25fa8795676b
|
896
|
|
| leothedragon |
0:25fa8795676b
|
897
|
# In case all classes in a project start with a common prefix, all
|
| leothedragon |
0:25fa8795676b
|
898
|
# classes will be put under the same header in the alphabetical index.
|
| leothedragon |
0:25fa8795676b
|
899
|
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
| leothedragon |
0:25fa8795676b
|
900
|
# should be ignored while generating the index headers.
|
| leothedragon |
0:25fa8795676b
|
901
|
|
| leothedragon |
0:25fa8795676b
|
902
|
IGNORE_PREFIX =
|
| leothedragon |
0:25fa8795676b
|
903
|
|
| leothedragon |
0:25fa8795676b
|
904
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
905
|
# configuration options related to the HTML output
|
| leothedragon |
0:25fa8795676b
|
906
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
907
|
|
| leothedragon |
0:25fa8795676b
|
908
|
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
| leothedragon |
0:25fa8795676b
|
909
|
# generate HTML output.
|
| leothedragon |
0:25fa8795676b
|
910
|
|
| leothedragon |
0:25fa8795676b
|
911
|
GENERATE_HTML = YES
|
| leothedragon |
0:25fa8795676b
|
912
|
|
| leothedragon |
0:25fa8795676b
|
913
|
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
| leothedragon |
0:25fa8795676b
|
914
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| leothedragon |
0:25fa8795676b
|
915
|
# put in front of it. If left blank `html' will be used as the default path.
|
| leothedragon |
0:25fa8795676b
|
916
|
|
| leothedragon |
0:25fa8795676b
|
917
|
HTML_OUTPUT = html
|
| leothedragon |
0:25fa8795676b
|
918
|
|
| leothedragon |
0:25fa8795676b
|
919
|
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
| leothedragon |
0:25fa8795676b
|
920
|
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
| leothedragon |
0:25fa8795676b
|
921
|
# doxygen will generate files with .html extension.
|
| leothedragon |
0:25fa8795676b
|
922
|
|
| leothedragon |
0:25fa8795676b
|
923
|
HTML_FILE_EXTENSION = .html
|
| leothedragon |
0:25fa8795676b
|
924
|
|
| leothedragon |
0:25fa8795676b
|
925
|
# The HTML_HEADER tag can be used to specify a personal HTML header for
|
| leothedragon |
0:25fa8795676b
|
926
|
# each generated HTML page. If it is left blank doxygen will generate a
|
| leothedragon |
0:25fa8795676b
|
927
|
# standard header. Note that when using a custom header you are responsible
|
| leothedragon |
0:25fa8795676b
|
928
|
# for the proper inclusion of any scripts and style sheets that doxygen
|
| leothedragon |
0:25fa8795676b
|
929
|
# needs, which is dependent on the configuration options used.
|
| leothedragon |
0:25fa8795676b
|
930
|
# It is advised to generate a default header using "doxygen -w html
|
| leothedragon |
0:25fa8795676b
|
931
|
# header.html footer.html stylesheet.css YourConfigFile" and then modify
|
| leothedragon |
0:25fa8795676b
|
932
|
# that header. Note that the header is subject to change so you typically
|
| leothedragon |
0:25fa8795676b
|
933
|
# have to redo this when upgrading to a newer version of doxygen or when
|
| leothedragon |
0:25fa8795676b
|
934
|
# changing the value of configuration settings such as GENERATE_TREEVIEW!
|
| leothedragon |
0:25fa8795676b
|
935
|
|
| leothedragon |
0:25fa8795676b
|
936
|
HTML_HEADER =
|
| leothedragon |
0:25fa8795676b
|
937
|
|
| leothedragon |
0:25fa8795676b
|
938
|
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
| leothedragon |
0:25fa8795676b
|
939
|
# each generated HTML page. If it is left blank doxygen will generate a
|
| leothedragon |
0:25fa8795676b
|
940
|
# standard footer.
|
| leothedragon |
0:25fa8795676b
|
941
|
|
| leothedragon |
0:25fa8795676b
|
942
|
HTML_FOOTER =
|
| leothedragon |
0:25fa8795676b
|
943
|
|
| leothedragon |
0:25fa8795676b
|
944
|
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
| leothedragon |
0:25fa8795676b
|
945
|
# style sheet that is used by each HTML page. It can be used to
|
| leothedragon |
0:25fa8795676b
|
946
|
# fine-tune the look of the HTML output. If left blank doxygen will
|
| leothedragon |
0:25fa8795676b
|
947
|
# generate a default style sheet. Note that it is recommended to use
|
| leothedragon |
0:25fa8795676b
|
948
|
# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
|
| leothedragon |
0:25fa8795676b
|
949
|
# tag will in the future become obsolete.
|
| leothedragon |
0:25fa8795676b
|
950
|
|
| leothedragon |
0:25fa8795676b
|
951
|
HTML_STYLESHEET =
|
| leothedragon |
0:25fa8795676b
|
952
|
|
| leothedragon |
0:25fa8795676b
|
953
|
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
|
| leothedragon |
0:25fa8795676b
|
954
|
# user-defined cascading style sheet that is included after the standard
|
| leothedragon |
0:25fa8795676b
|
955
|
# style sheets created by doxygen. Using this option one can overrule
|
| leothedragon |
0:25fa8795676b
|
956
|
# certain style aspects. This is preferred over using HTML_STYLESHEET
|
| leothedragon |
0:25fa8795676b
|
957
|
# since it does not replace the standard style sheet and is therefor more
|
| leothedragon |
0:25fa8795676b
|
958
|
# robust against future updates. Doxygen will copy the style sheet file to
|
| leothedragon |
0:25fa8795676b
|
959
|
# the output directory.
|
| leothedragon |
0:25fa8795676b
|
960
|
|
| leothedragon |
0:25fa8795676b
|
961
|
HTML_EXTRA_STYLESHEET =
|
| leothedragon |
0:25fa8795676b
|
962
|
|
| leothedragon |
0:25fa8795676b
|
963
|
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
| leothedragon |
0:25fa8795676b
|
964
|
# other source files which should be copied to the HTML output directory. Note
|
| leothedragon |
0:25fa8795676b
|
965
|
# that these files will be copied to the base HTML output directory. Use the
|
| leothedragon |
0:25fa8795676b
|
966
|
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
|
| leothedragon |
0:25fa8795676b
|
967
|
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
|
| leothedragon |
0:25fa8795676b
|
968
|
# the files will be copied as-is; there are no commands or markers available.
|
| leothedragon |
0:25fa8795676b
|
969
|
|
| leothedragon |
0:25fa8795676b
|
970
|
HTML_EXTRA_FILES =
|
| leothedragon |
0:25fa8795676b
|
971
|
|
| leothedragon |
0:25fa8795676b
|
972
|
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
|
| leothedragon |
0:25fa8795676b
|
973
|
# Doxygen will adjust the colors in the style sheet and background images
|
| leothedragon |
0:25fa8795676b
|
974
|
# according to this color. Hue is specified as an angle on a colorwheel,
|
| leothedragon |
0:25fa8795676b
|
975
|
# see http://en.wikipedia.org/wiki/Hue for more information.
|
| leothedragon |
0:25fa8795676b
|
976
|
# For instance the value 0 represents red, 60 is yellow, 120 is green,
|
| leothedragon |
0:25fa8795676b
|
977
|
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
|
| leothedragon |
0:25fa8795676b
|
978
|
# The allowed range is 0 to 359.
|
| leothedragon |
0:25fa8795676b
|
979
|
|
| leothedragon |
0:25fa8795676b
|
980
|
HTML_COLORSTYLE_HUE = 220
|
| leothedragon |
0:25fa8795676b
|
981
|
|
| leothedragon |
0:25fa8795676b
|
982
|
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
|
| leothedragon |
0:25fa8795676b
|
983
|
# the colors in the HTML output. For a value of 0 the output will use
|
| leothedragon |
0:25fa8795676b
|
984
|
# grayscales only. A value of 255 will produce the most vivid colors.
|
| leothedragon |
0:25fa8795676b
|
985
|
|
| leothedragon |
0:25fa8795676b
|
986
|
HTML_COLORSTYLE_SAT = 100
|
| leothedragon |
0:25fa8795676b
|
987
|
|
| leothedragon |
0:25fa8795676b
|
988
|
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
|
| leothedragon |
0:25fa8795676b
|
989
|
# the luminance component of the colors in the HTML output. Values below
|
| leothedragon |
0:25fa8795676b
|
990
|
# 100 gradually make the output lighter, whereas values above 100 make
|
| leothedragon |
0:25fa8795676b
|
991
|
# the output darker. The value divided by 100 is the actual gamma applied,
|
| leothedragon |
0:25fa8795676b
|
992
|
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
|
| leothedragon |
0:25fa8795676b
|
993
|
# and 100 does not change the gamma.
|
| leothedragon |
0:25fa8795676b
|
994
|
|
| leothedragon |
0:25fa8795676b
|
995
|
HTML_COLORSTYLE_GAMMA = 80
|
| leothedragon |
0:25fa8795676b
|
996
|
|
| leothedragon |
0:25fa8795676b
|
997
|
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
| leothedragon |
0:25fa8795676b
|
998
|
# page will contain the date and time when the page was generated. Setting
|
| leothedragon |
0:25fa8795676b
|
999
|
# this to NO can help when comparing the output of multiple runs.
|
| leothedragon |
0:25fa8795676b
|
1000
|
|
| leothedragon |
0:25fa8795676b
|
1001
|
HTML_TIMESTAMP = YES
|
| leothedragon |
0:25fa8795676b
|
1002
|
|
| leothedragon |
0:25fa8795676b
|
1003
|
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
|
| leothedragon |
0:25fa8795676b
|
1004
|
# documentation will contain sections that can be hidden and shown after the
|
| leothedragon |
0:25fa8795676b
|
1005
|
# page has loaded.
|
| leothedragon |
0:25fa8795676b
|
1006
|
|
| leothedragon |
0:25fa8795676b
|
1007
|
HTML_DYNAMIC_SECTIONS = NO
|
| leothedragon |
0:25fa8795676b
|
1008
|
|
| leothedragon |
0:25fa8795676b
|
1009
|
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
|
| leothedragon |
0:25fa8795676b
|
1010
|
# entries shown in the various tree structured indices initially; the user
|
| leothedragon |
0:25fa8795676b
|
1011
|
# can expand and collapse entries dynamically later on. Doxygen will expand
|
| leothedragon |
0:25fa8795676b
|
1012
|
# the tree to such a level that at most the specified number of entries are
|
| leothedragon |
0:25fa8795676b
|
1013
|
# visible (unless a fully collapsed tree already exceeds this amount).
|
| leothedragon |
0:25fa8795676b
|
1014
|
# So setting the number of entries 1 will produce a full collapsed tree by
|
| leothedragon |
0:25fa8795676b
|
1015
|
# default. 0 is a special value representing an infinite number of entries
|
| leothedragon |
0:25fa8795676b
|
1016
|
# and will result in a full expanded tree by default.
|
| leothedragon |
0:25fa8795676b
|
1017
|
|
| leothedragon |
0:25fa8795676b
|
1018
|
HTML_INDEX_NUM_ENTRIES = 100
|
| leothedragon |
0:25fa8795676b
|
1019
|
|
| leothedragon |
0:25fa8795676b
|
1020
|
# If the GENERATE_DOCSET tag is set to YES, additional index files
|
| leothedragon |
0:25fa8795676b
|
1021
|
# will be generated that can be used as input for Apple's Xcode 3
|
| leothedragon |
0:25fa8795676b
|
1022
|
# integrated development environment, introduced with OSX 10.5 (Leopard).
|
| leothedragon |
0:25fa8795676b
|
1023
|
# To create a documentation set, doxygen will generate a Makefile in the
|
| leothedragon |
0:25fa8795676b
|
1024
|
# HTML output directory. Running make will produce the docset in that
|
| leothedragon |
0:25fa8795676b
|
1025
|
# directory and running "make install" will install the docset in
|
| leothedragon |
0:25fa8795676b
|
1026
|
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
|
| leothedragon |
0:25fa8795676b
|
1027
|
# it at startup.
|
| leothedragon |
0:25fa8795676b
|
1028
|
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
|
| leothedragon |
0:25fa8795676b
|
1029
|
# for more information.
|
| leothedragon |
0:25fa8795676b
|
1030
|
|
| leothedragon |
0:25fa8795676b
|
1031
|
GENERATE_DOCSET = NO
|
| leothedragon |
0:25fa8795676b
|
1032
|
|
| leothedragon |
0:25fa8795676b
|
1033
|
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
|
| leothedragon |
0:25fa8795676b
|
1034
|
# feed. A documentation feed provides an umbrella under which multiple
|
| leothedragon |
0:25fa8795676b
|
1035
|
# documentation sets from a single provider (such as a company or product suite)
|
| leothedragon |
0:25fa8795676b
|
1036
|
# can be grouped.
|
| leothedragon |
0:25fa8795676b
|
1037
|
|
| leothedragon |
0:25fa8795676b
|
1038
|
DOCSET_FEEDNAME = "Doxygen generated docs"
|
| leothedragon |
0:25fa8795676b
|
1039
|
|
| leothedragon |
0:25fa8795676b
|
1040
|
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
|
| leothedragon |
0:25fa8795676b
|
1041
|
# should uniquely identify the documentation set bundle. This should be a
|
| leothedragon |
0:25fa8795676b
|
1042
|
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
|
| leothedragon |
0:25fa8795676b
|
1043
|
# will append .docset to the name.
|
| leothedragon |
0:25fa8795676b
|
1044
|
|
| leothedragon |
0:25fa8795676b
|
1045
|
DOCSET_BUNDLE_ID = org.doxygen.Project
|
| leothedragon |
0:25fa8795676b
|
1046
|
|
| leothedragon |
0:25fa8795676b
|
1047
|
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
|
| leothedragon |
0:25fa8795676b
|
1048
|
# identify the documentation publisher. This should be a reverse domain-name
|
| leothedragon |
0:25fa8795676b
|
1049
|
# style string, e.g. com.mycompany.MyDocSet.documentation.
|
| leothedragon |
0:25fa8795676b
|
1050
|
|
| leothedragon |
0:25fa8795676b
|
1051
|
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
| leothedragon |
0:25fa8795676b
|
1052
|
|
| leothedragon |
0:25fa8795676b
|
1053
|
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
|
| leothedragon |
0:25fa8795676b
|
1054
|
|
| leothedragon |
0:25fa8795676b
|
1055
|
DOCSET_PUBLISHER_NAME = Publisher
|
| leothedragon |
0:25fa8795676b
|
1056
|
|
| leothedragon |
0:25fa8795676b
|
1057
|
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
| leothedragon |
0:25fa8795676b
|
1058
|
# will be generated that can be used as input for tools like the
|
| leothedragon |
0:25fa8795676b
|
1059
|
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
|
| leothedragon |
0:25fa8795676b
|
1060
|
# of the generated HTML documentation.
|
| leothedragon |
0:25fa8795676b
|
1061
|
|
| leothedragon |
0:25fa8795676b
|
1062
|
GENERATE_HTMLHELP = NO
|
| leothedragon |
0:25fa8795676b
|
1063
|
|
| leothedragon |
0:25fa8795676b
|
1064
|
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
|
| leothedragon |
0:25fa8795676b
|
1065
|
# be used to specify the file name of the resulting .chm file. You
|
| leothedragon |
0:25fa8795676b
|
1066
|
# can add a path in front of the file if the result should not be
|
| leothedragon |
0:25fa8795676b
|
1067
|
# written to the html output directory.
|
| leothedragon |
0:25fa8795676b
|
1068
|
|
| leothedragon |
0:25fa8795676b
|
1069
|
CHM_FILE =
|
| leothedragon |
0:25fa8795676b
|
1070
|
|
| leothedragon |
0:25fa8795676b
|
1071
|
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
|
| leothedragon |
0:25fa8795676b
|
1072
|
# be used to specify the location (absolute path including file name) of
|
| leothedragon |
0:25fa8795676b
|
1073
|
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
|
| leothedragon |
0:25fa8795676b
|
1074
|
# the HTML help compiler on the generated index.hhp.
|
| leothedragon |
0:25fa8795676b
|
1075
|
|
| leothedragon |
0:25fa8795676b
|
1076
|
HHC_LOCATION =
|
| leothedragon |
0:25fa8795676b
|
1077
|
|
| leothedragon |
0:25fa8795676b
|
1078
|
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
|
| leothedragon |
0:25fa8795676b
|
1079
|
# controls if a separate .chi index file is generated (YES) or that
|
| leothedragon |
0:25fa8795676b
|
1080
|
# it should be included in the master .chm file (NO).
|
| leothedragon |
0:25fa8795676b
|
1081
|
|
| leothedragon |
0:25fa8795676b
|
1082
|
GENERATE_CHI = NO
|
| leothedragon |
0:25fa8795676b
|
1083
|
|
| leothedragon |
0:25fa8795676b
|
1084
|
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
|
| leothedragon |
0:25fa8795676b
|
1085
|
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
|
| leothedragon |
0:25fa8795676b
|
1086
|
# content.
|
| leothedragon |
0:25fa8795676b
|
1087
|
|
| leothedragon |
0:25fa8795676b
|
1088
|
CHM_INDEX_ENCODING =
|
| leothedragon |
0:25fa8795676b
|
1089
|
|
| leothedragon |
0:25fa8795676b
|
1090
|
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
| leothedragon |
0:25fa8795676b
|
1091
|
# controls whether a binary table of contents is generated (YES) or a
|
| leothedragon |
0:25fa8795676b
|
1092
|
# normal table of contents (NO) in the .chm file.
|
| leothedragon |
0:25fa8795676b
|
1093
|
|
| leothedragon |
0:25fa8795676b
|
1094
|
BINARY_TOC = NO
|
| leothedragon |
0:25fa8795676b
|
1095
|
|
| leothedragon |
0:25fa8795676b
|
1096
|
# The TOC_EXPAND flag can be set to YES to add extra items for group members
|
| leothedragon |
0:25fa8795676b
|
1097
|
# to the contents of the HTML help documentation and to the tree view.
|
| leothedragon |
0:25fa8795676b
|
1098
|
|
| leothedragon |
0:25fa8795676b
|
1099
|
TOC_EXPAND = NO
|
| leothedragon |
0:25fa8795676b
|
1100
|
|
| leothedragon |
0:25fa8795676b
|
1101
|
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
|
| leothedragon |
0:25fa8795676b
|
1102
|
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
|
| leothedragon |
0:25fa8795676b
|
1103
|
# that can be used as input for Qt's qhelpgenerator to generate a
|
| leothedragon |
0:25fa8795676b
|
1104
|
# Qt Compressed Help (.qch) of the generated HTML documentation.
|
| leothedragon |
0:25fa8795676b
|
1105
|
|
| leothedragon |
0:25fa8795676b
|
1106
|
GENERATE_QHP = NO
|
| leothedragon |
0:25fa8795676b
|
1107
|
|
| leothedragon |
0:25fa8795676b
|
1108
|
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
|
| leothedragon |
0:25fa8795676b
|
1109
|
# be used to specify the file name of the resulting .qch file.
|
| leothedragon |
0:25fa8795676b
|
1110
|
# The path specified is relative to the HTML output folder.
|
| leothedragon |
0:25fa8795676b
|
1111
|
|
| leothedragon |
0:25fa8795676b
|
1112
|
QCH_FILE =
|
| leothedragon |
0:25fa8795676b
|
1113
|
|
| leothedragon |
0:25fa8795676b
|
1114
|
# The QHP_NAMESPACE tag specifies the namespace to use when generating
|
| leothedragon |
0:25fa8795676b
|
1115
|
# Qt Help Project output. For more information please see
|
| leothedragon |
0:25fa8795676b
|
1116
|
# http://doc.trolltech.com/qthelpproject.html#namespace
|
| leothedragon |
0:25fa8795676b
|
1117
|
|
| leothedragon |
0:25fa8795676b
|
1118
|
QHP_NAMESPACE = org.doxygen.Project
|
| leothedragon |
0:25fa8795676b
|
1119
|
|
| leothedragon |
0:25fa8795676b
|
1120
|
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
|
| leothedragon |
0:25fa8795676b
|
1121
|
# Qt Help Project output. For more information please see
|
| leothedragon |
0:25fa8795676b
|
1122
|
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
|
| leothedragon |
0:25fa8795676b
|
1123
|
|
| leothedragon |
0:25fa8795676b
|
1124
|
QHP_VIRTUAL_FOLDER = doc
|
| leothedragon |
0:25fa8795676b
|
1125
|
|
| leothedragon |
0:25fa8795676b
|
1126
|
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
|
| leothedragon |
0:25fa8795676b
|
1127
|
# add. For more information please see
|
| leothedragon |
0:25fa8795676b
|
1128
|
# http://doc.trolltech.com/qthelpproject.html#custom-filters
|
| leothedragon |
0:25fa8795676b
|
1129
|
|
| leothedragon |
0:25fa8795676b
|
1130
|
QHP_CUST_FILTER_NAME =
|
| leothedragon |
0:25fa8795676b
|
1131
|
|
| leothedragon |
0:25fa8795676b
|
1132
|
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
|
| leothedragon |
0:25fa8795676b
|
1133
|
# custom filter to add. For more information please see
|
| leothedragon |
0:25fa8795676b
|
1134
|
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
|
| leothedragon |
0:25fa8795676b
|
1135
|
# Qt Help Project / Custom Filters</a>.
|
| leothedragon |
0:25fa8795676b
|
1136
|
|
| leothedragon |
0:25fa8795676b
|
1137
|
QHP_CUST_FILTER_ATTRS =
|
| leothedragon |
0:25fa8795676b
|
1138
|
|
| leothedragon |
0:25fa8795676b
|
1139
|
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
| leothedragon |
0:25fa8795676b
|
1140
|
# project's
|
| leothedragon |
0:25fa8795676b
|
1141
|
# filter section matches.
|
| leothedragon |
0:25fa8795676b
|
1142
|
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
|
| leothedragon |
0:25fa8795676b
|
1143
|
# Qt Help Project / Filter Attributes</a>.
|
| leothedragon |
0:25fa8795676b
|
1144
|
|
| leothedragon |
0:25fa8795676b
|
1145
|
QHP_SECT_FILTER_ATTRS =
|
| leothedragon |
0:25fa8795676b
|
1146
|
|
| leothedragon |
0:25fa8795676b
|
1147
|
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
|
| leothedragon |
0:25fa8795676b
|
1148
|
# be used to specify the location of Qt's qhelpgenerator.
|
| leothedragon |
0:25fa8795676b
|
1149
|
# If non-empty doxygen will try to run qhelpgenerator on the generated
|
| leothedragon |
0:25fa8795676b
|
1150
|
# .qhp file.
|
| leothedragon |
0:25fa8795676b
|
1151
|
|
| leothedragon |
0:25fa8795676b
|
1152
|
QHG_LOCATION =
|
| leothedragon |
0:25fa8795676b
|
1153
|
|
| leothedragon |
0:25fa8795676b
|
1154
|
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
|
| leothedragon |
0:25fa8795676b
|
1155
|
# will be generated, which together with the HTML files, form an Eclipse help
|
| leothedragon |
0:25fa8795676b
|
1156
|
# plugin. To install this plugin and make it available under the help contents
|
| leothedragon |
0:25fa8795676b
|
1157
|
# menu in Eclipse, the contents of the directory containing the HTML and XML
|
| leothedragon |
0:25fa8795676b
|
1158
|
# files needs to be copied into the plugins directory of eclipse. The name of
|
| leothedragon |
0:25fa8795676b
|
1159
|
# the directory within the plugins directory should be the same as
|
| leothedragon |
0:25fa8795676b
|
1160
|
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
|
| leothedragon |
0:25fa8795676b
|
1161
|
# the help appears.
|
| leothedragon |
0:25fa8795676b
|
1162
|
|
| leothedragon |
0:25fa8795676b
|
1163
|
GENERATE_ECLIPSEHELP = NO
|
| leothedragon |
0:25fa8795676b
|
1164
|
|
| leothedragon |
0:25fa8795676b
|
1165
|
# A unique identifier for the eclipse help plugin. When installing the plugin
|
| leothedragon |
0:25fa8795676b
|
1166
|
# the directory name containing the HTML and XML files should also have
|
| leothedragon |
0:25fa8795676b
|
1167
|
# this name.
|
| leothedragon |
0:25fa8795676b
|
1168
|
|
| leothedragon |
0:25fa8795676b
|
1169
|
ECLIPSE_DOC_ID = org.doxygen.Project
|
| leothedragon |
0:25fa8795676b
|
1170
|
|
| leothedragon |
0:25fa8795676b
|
1171
|
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
|
| leothedragon |
0:25fa8795676b
|
1172
|
# at top of each HTML page. The value NO (the default) enables the index and
|
| leothedragon |
0:25fa8795676b
|
1173
|
# the value YES disables it. Since the tabs have the same information as the
|
| leothedragon |
0:25fa8795676b
|
1174
|
# navigation tree you can set this option to NO if you already set
|
| leothedragon |
0:25fa8795676b
|
1175
|
# GENERATE_TREEVIEW to YES.
|
| leothedragon |
0:25fa8795676b
|
1176
|
|
| leothedragon |
0:25fa8795676b
|
1177
|
DISABLE_INDEX = NO
|
| leothedragon |
0:25fa8795676b
|
1178
|
|
| leothedragon |
0:25fa8795676b
|
1179
|
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
| leothedragon |
0:25fa8795676b
|
1180
|
# structure should be generated to display hierarchical information.
|
| leothedragon |
0:25fa8795676b
|
1181
|
# If the tag value is set to YES, a side panel will be generated
|
| leothedragon |
0:25fa8795676b
|
1182
|
# containing a tree-like index structure (just like the one that
|
| leothedragon |
0:25fa8795676b
|
1183
|
# is generated for HTML Help). For this to work a browser that supports
|
| leothedragon |
0:25fa8795676b
|
1184
|
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
|
| leothedragon |
0:25fa8795676b
|
1185
|
# Windows users are probably better off using the HTML help feature.
|
| leothedragon |
0:25fa8795676b
|
1186
|
# Since the tree basically has the same information as the tab index you
|
| leothedragon |
0:25fa8795676b
|
1187
|
# could consider to set DISABLE_INDEX to NO when enabling this option.
|
| leothedragon |
0:25fa8795676b
|
1188
|
|
| leothedragon |
0:25fa8795676b
|
1189
|
GENERATE_TREEVIEW = NO
|
| leothedragon |
0:25fa8795676b
|
1190
|
|
| leothedragon |
0:25fa8795676b
|
1191
|
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
|
| leothedragon |
0:25fa8795676b
|
1192
|
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
|
| leothedragon |
0:25fa8795676b
|
1193
|
# documentation. Note that a value of 0 will completely suppress the enum
|
| leothedragon |
0:25fa8795676b
|
1194
|
# values from appearing in the overview section.
|
| leothedragon |
0:25fa8795676b
|
1195
|
|
| leothedragon |
0:25fa8795676b
|
1196
|
ENUM_VALUES_PER_LINE = 4
|
| leothedragon |
0:25fa8795676b
|
1197
|
|
| leothedragon |
0:25fa8795676b
|
1198
|
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
| leothedragon |
0:25fa8795676b
|
1199
|
# used to set the initial width (in pixels) of the frame in which the tree
|
| leothedragon |
0:25fa8795676b
|
1200
|
# is shown.
|
| leothedragon |
0:25fa8795676b
|
1201
|
|
| leothedragon |
0:25fa8795676b
|
1202
|
TREEVIEW_WIDTH = 250
|
| leothedragon |
0:25fa8795676b
|
1203
|
|
| leothedragon |
0:25fa8795676b
|
1204
|
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
|
| leothedragon |
0:25fa8795676b
|
1205
|
# links to external symbols imported via tag files in a separate window.
|
| leothedragon |
0:25fa8795676b
|
1206
|
|
| leothedragon |
0:25fa8795676b
|
1207
|
EXT_LINKS_IN_WINDOW = NO
|
| leothedragon |
0:25fa8795676b
|
1208
|
|
| leothedragon |
0:25fa8795676b
|
1209
|
# Use this tag to change the font size of Latex formulas included
|
| leothedragon |
0:25fa8795676b
|
1210
|
# as images in the HTML documentation. The default is 10. Note that
|
| leothedragon |
0:25fa8795676b
|
1211
|
# when you change the font size after a successful doxygen run you need
|
| leothedragon |
0:25fa8795676b
|
1212
|
# to manually remove any form_*.png images from the HTML output directory
|
| leothedragon |
0:25fa8795676b
|
1213
|
# to force them to be regenerated.
|
| leothedragon |
0:25fa8795676b
|
1214
|
|
| leothedragon |
0:25fa8795676b
|
1215
|
FORMULA_FONTSIZE = 10
|
| leothedragon |
0:25fa8795676b
|
1216
|
|
| leothedragon |
0:25fa8795676b
|
1217
|
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
| leothedragon |
0:25fa8795676b
|
1218
|
# generated for formulas are transparent PNGs. Transparent PNGs are
|
| leothedragon |
0:25fa8795676b
|
1219
|
# not supported properly for IE 6.0, but are supported on all modern browsers.
|
| leothedragon |
0:25fa8795676b
|
1220
|
# Note that when changing this option you need to delete any form_*.png files
|
| leothedragon |
0:25fa8795676b
|
1221
|
# in the HTML output before the changes have effect.
|
| leothedragon |
0:25fa8795676b
|
1222
|
|
| leothedragon |
0:25fa8795676b
|
1223
|
FORMULA_TRANSPARENT = YES
|
| leothedragon |
0:25fa8795676b
|
1224
|
|
| leothedragon |
0:25fa8795676b
|
1225
|
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
|
| leothedragon |
0:25fa8795676b
|
1226
|
# (see http://www.mathjax.org) which uses client side Javascript for the
|
| leothedragon |
0:25fa8795676b
|
1227
|
# rendering instead of using prerendered bitmaps. Use this if you do not
|
| leothedragon |
0:25fa8795676b
|
1228
|
# have LaTeX installed or if you want to formulas look prettier in the HTML
|
| leothedragon |
0:25fa8795676b
|
1229
|
# output. When enabled you may also need to install MathJax separately and
|
| leothedragon |
0:25fa8795676b
|
1230
|
# configure the path to it using the MATHJAX_RELPATH option.
|
| leothedragon |
0:25fa8795676b
|
1231
|
|
| leothedragon |
0:25fa8795676b
|
1232
|
USE_MATHJAX = NO
|
| leothedragon |
0:25fa8795676b
|
1233
|
|
| leothedragon |
0:25fa8795676b
|
1234
|
# When MathJax is enabled you need to specify the location relative to the
|
| leothedragon |
0:25fa8795676b
|
1235
|
# HTML output directory using the MATHJAX_RELPATH option. The destination
|
| leothedragon |
0:25fa8795676b
|
1236
|
# directory should contain the MathJax.js script. For instance, if the mathjax
|
| leothedragon |
0:25fa8795676b
|
1237
|
# directory is located at the same level as the HTML output directory, then
|
| leothedragon |
0:25fa8795676b
|
1238
|
# MATHJAX_RELPATH should be ../mathjax. The default value points to
|
| leothedragon |
0:25fa8795676b
|
1239
|
# the MathJax Content Delivery Network so you can quickly see the result without
|
| leothedragon |
0:25fa8795676b
|
1240
|
# installing MathJax. However, it is strongly recommended to install a local
|
| leothedragon |
0:25fa8795676b
|
1241
|
# copy of MathJax from http://www.mathjax.org before deployment.
|
| leothedragon |
0:25fa8795676b
|
1242
|
|
| leothedragon |
0:25fa8795676b
|
1243
|
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
| leothedragon |
0:25fa8795676b
|
1244
|
|
| leothedragon |
0:25fa8795676b
|
1245
|
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
|
| leothedragon |
0:25fa8795676b
|
1246
|
# names that should be enabled during MathJax rendering.
|
| leothedragon |
0:25fa8795676b
|
1247
|
|
| leothedragon |
0:25fa8795676b
|
1248
|
MATHJAX_EXTENSIONS =
|
| leothedragon |
0:25fa8795676b
|
1249
|
|
| leothedragon |
0:25fa8795676b
|
1250
|
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
|
| leothedragon |
0:25fa8795676b
|
1251
|
# for the HTML output. The underlying search engine uses javascript
|
| leothedragon |
0:25fa8795676b
|
1252
|
# and DHTML and should work on any modern browser. Note that when using
|
| leothedragon |
0:25fa8795676b
|
1253
|
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
|
| leothedragon |
0:25fa8795676b
|
1254
|
# (GENERATE_DOCSET) there is already a search function so this one should
|
| leothedragon |
0:25fa8795676b
|
1255
|
# typically be disabled. For large projects the javascript based search engine
|
| leothedragon |
0:25fa8795676b
|
1256
|
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
|
| leothedragon |
0:25fa8795676b
|
1257
|
|
| leothedragon |
0:25fa8795676b
|
1258
|
SEARCHENGINE = YES
|
| leothedragon |
0:25fa8795676b
|
1259
|
|
| leothedragon |
0:25fa8795676b
|
1260
|
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
| leothedragon |
0:25fa8795676b
|
1261
|
# implemented using a PHP enabled web server instead of at the web client
|
| leothedragon |
0:25fa8795676b
|
1262
|
# using Javascript. Doxygen will generate the search PHP script and index
|
| leothedragon |
0:25fa8795676b
|
1263
|
# file to put on the web server. The advantage of the server
|
| leothedragon |
0:25fa8795676b
|
1264
|
# based approach is that it scales better to large projects and allows
|
| leothedragon |
0:25fa8795676b
|
1265
|
# full text search. The disadvantages are that it is more difficult to setup
|
| leothedragon |
0:25fa8795676b
|
1266
|
# and does not have live searching capabilities.
|
| leothedragon |
0:25fa8795676b
|
1267
|
|
| leothedragon |
0:25fa8795676b
|
1268
|
SERVER_BASED_SEARCH = NO
|
| leothedragon |
0:25fa8795676b
|
1269
|
|
| leothedragon |
0:25fa8795676b
|
1270
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1271
|
# configuration options related to the LaTeX output
|
| leothedragon |
0:25fa8795676b
|
1272
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1273
|
|
| leothedragon |
0:25fa8795676b
|
1274
|
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1275
|
# generate Latex output.
|
| leothedragon |
0:25fa8795676b
|
1276
|
|
| leothedragon |
0:25fa8795676b
|
1277
|
GENERATE_LATEX = NO
|
| leothedragon |
0:25fa8795676b
|
1278
|
|
| leothedragon |
0:25fa8795676b
|
1279
|
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
| leothedragon |
0:25fa8795676b
|
1280
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| leothedragon |
0:25fa8795676b
|
1281
|
# put in front of it. If left blank `latex' will be used as the default path.
|
| leothedragon |
0:25fa8795676b
|
1282
|
|
| leothedragon |
0:25fa8795676b
|
1283
|
LATEX_OUTPUT = latex
|
| leothedragon |
0:25fa8795676b
|
1284
|
|
| leothedragon |
0:25fa8795676b
|
1285
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
| leothedragon |
0:25fa8795676b
|
1286
|
# invoked. If left blank `latex' will be used as the default command name.
|
| leothedragon |
0:25fa8795676b
|
1287
|
# Note that when enabling USE_PDFLATEX this option is only used for
|
| leothedragon |
0:25fa8795676b
|
1288
|
# generating bitmaps for formulas in the HTML output, but not in the
|
| leothedragon |
0:25fa8795676b
|
1289
|
# Makefile that is written to the output directory.
|
| leothedragon |
0:25fa8795676b
|
1290
|
|
| leothedragon |
0:25fa8795676b
|
1291
|
LATEX_CMD_NAME = latex
|
| leothedragon |
0:25fa8795676b
|
1292
|
|
| leothedragon |
0:25fa8795676b
|
1293
|
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
| leothedragon |
0:25fa8795676b
|
1294
|
# generate index for LaTeX. If left blank `makeindex' will be used as the
|
| leothedragon |
0:25fa8795676b
|
1295
|
# default command name.
|
| leothedragon |
0:25fa8795676b
|
1296
|
|
| leothedragon |
0:25fa8795676b
|
1297
|
MAKEINDEX_CMD_NAME = makeindex
|
| leothedragon |
0:25fa8795676b
|
1298
|
|
| leothedragon |
0:25fa8795676b
|
1299
|
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
| leothedragon |
0:25fa8795676b
|
1300
|
# LaTeX documents. This may be useful for small projects and may help to
|
| leothedragon |
0:25fa8795676b
|
1301
|
# save some trees in general.
|
| leothedragon |
0:25fa8795676b
|
1302
|
|
| leothedragon |
0:25fa8795676b
|
1303
|
COMPACT_LATEX = NO
|
| leothedragon |
0:25fa8795676b
|
1304
|
|
| leothedragon |
0:25fa8795676b
|
1305
|
# The PAPER_TYPE tag can be used to set the paper type that is used
|
| leothedragon |
0:25fa8795676b
|
1306
|
# by the printer. Possible values are: a4, letter, legal and
|
| leothedragon |
0:25fa8795676b
|
1307
|
# executive. If left blank a4wide will be used.
|
| leothedragon |
0:25fa8795676b
|
1308
|
|
| leothedragon |
0:25fa8795676b
|
1309
|
PAPER_TYPE = a4
|
| leothedragon |
0:25fa8795676b
|
1310
|
|
| leothedragon |
0:25fa8795676b
|
1311
|
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
| leothedragon |
0:25fa8795676b
|
1312
|
# packages that should be included in the LaTeX output.
|
| leothedragon |
0:25fa8795676b
|
1313
|
|
| leothedragon |
0:25fa8795676b
|
1314
|
EXTRA_PACKAGES =
|
| leothedragon |
0:25fa8795676b
|
1315
|
|
| leothedragon |
0:25fa8795676b
|
1316
|
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
| leothedragon |
0:25fa8795676b
|
1317
|
# the generated latex document. The header should contain everything until
|
| leothedragon |
0:25fa8795676b
|
1318
|
# the first chapter. If it is left blank doxygen will generate a
|
| leothedragon |
0:25fa8795676b
|
1319
|
# standard header. Notice: only use this tag if you know what you are doing!
|
| leothedragon |
0:25fa8795676b
|
1320
|
|
| leothedragon |
0:25fa8795676b
|
1321
|
LATEX_HEADER =
|
| leothedragon |
0:25fa8795676b
|
1322
|
|
| leothedragon |
0:25fa8795676b
|
1323
|
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
|
| leothedragon |
0:25fa8795676b
|
1324
|
# the generated latex document. The footer should contain everything after
|
| leothedragon |
0:25fa8795676b
|
1325
|
# the last chapter. If it is left blank doxygen will generate a
|
| leothedragon |
0:25fa8795676b
|
1326
|
# standard footer. Notice: only use this tag if you know what you are doing!
|
| leothedragon |
0:25fa8795676b
|
1327
|
|
| leothedragon |
0:25fa8795676b
|
1328
|
LATEX_FOOTER =
|
| leothedragon |
0:25fa8795676b
|
1329
|
|
| leothedragon |
0:25fa8795676b
|
1330
|
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
| leothedragon |
0:25fa8795676b
|
1331
|
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
| leothedragon |
0:25fa8795676b
|
1332
|
# contain links (just like the HTML output) instead of page references
|
| leothedragon |
0:25fa8795676b
|
1333
|
# This makes the output suitable for online browsing using a pdf viewer.
|
| leothedragon |
0:25fa8795676b
|
1334
|
|
| leothedragon |
0:25fa8795676b
|
1335
|
PDF_HYPERLINKS = YES
|
| leothedragon |
0:25fa8795676b
|
1336
|
|
| leothedragon |
0:25fa8795676b
|
1337
|
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
| leothedragon |
0:25fa8795676b
|
1338
|
# plain latex in the generated Makefile. Set this option to YES to get a
|
| leothedragon |
0:25fa8795676b
|
1339
|
# higher quality PDF documentation.
|
| leothedragon |
0:25fa8795676b
|
1340
|
|
| leothedragon |
0:25fa8795676b
|
1341
|
USE_PDFLATEX = YES
|
| leothedragon |
0:25fa8795676b
|
1342
|
|
| leothedragon |
0:25fa8795676b
|
1343
|
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
| leothedragon |
0:25fa8795676b
|
1344
|
# command to the generated LaTeX files. This will instruct LaTeX to keep
|
| leothedragon |
0:25fa8795676b
|
1345
|
# running if errors occur, instead of asking the user for help.
|
| leothedragon |
0:25fa8795676b
|
1346
|
# This option is also used when generating formulas in HTML.
|
| leothedragon |
0:25fa8795676b
|
1347
|
|
| leothedragon |
0:25fa8795676b
|
1348
|
LATEX_BATCHMODE = NO
|
| leothedragon |
0:25fa8795676b
|
1349
|
|
| leothedragon |
0:25fa8795676b
|
1350
|
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
|
| leothedragon |
0:25fa8795676b
|
1351
|
# include the index chapters (such as File Index, Compound Index, etc.)
|
| leothedragon |
0:25fa8795676b
|
1352
|
# in the output.
|
| leothedragon |
0:25fa8795676b
|
1353
|
|
| leothedragon |
0:25fa8795676b
|
1354
|
LATEX_HIDE_INDICES = NO
|
| leothedragon |
0:25fa8795676b
|
1355
|
|
| leothedragon |
0:25fa8795676b
|
1356
|
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
|
| leothedragon |
0:25fa8795676b
|
1357
|
# source code with syntax highlighting in the LaTeX output.
|
| leothedragon |
0:25fa8795676b
|
1358
|
# Note that which sources are shown also depends on other settings
|
| leothedragon |
0:25fa8795676b
|
1359
|
# such as SOURCE_BROWSER.
|
| leothedragon |
0:25fa8795676b
|
1360
|
|
| leothedragon |
0:25fa8795676b
|
1361
|
LATEX_SOURCE_CODE = NO
|
| leothedragon |
0:25fa8795676b
|
1362
|
|
| leothedragon |
0:25fa8795676b
|
1363
|
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
|
| leothedragon |
0:25fa8795676b
|
1364
|
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
|
| leothedragon |
0:25fa8795676b
|
1365
|
# http://en.wikipedia.org/wiki/BibTeX for more info.
|
| leothedragon |
0:25fa8795676b
|
1366
|
|
| leothedragon |
0:25fa8795676b
|
1367
|
LATEX_BIB_STYLE = plain
|
| leothedragon |
0:25fa8795676b
|
1368
|
|
| leothedragon |
0:25fa8795676b
|
1369
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1370
|
# configuration options related to the RTF output
|
| leothedragon |
0:25fa8795676b
|
1371
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1372
|
|
| leothedragon |
0:25fa8795676b
|
1373
|
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
| leothedragon |
0:25fa8795676b
|
1374
|
# The RTF output is optimized for Word 97 and may not look very pretty with
|
| leothedragon |
0:25fa8795676b
|
1375
|
# other RTF readers or editors.
|
| leothedragon |
0:25fa8795676b
|
1376
|
|
| leothedragon |
0:25fa8795676b
|
1377
|
GENERATE_RTF = NO
|
| leothedragon |
0:25fa8795676b
|
1378
|
|
| leothedragon |
0:25fa8795676b
|
1379
|
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
| leothedragon |
0:25fa8795676b
|
1380
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| leothedragon |
0:25fa8795676b
|
1381
|
# put in front of it. If left blank `rtf' will be used as the default path.
|
| leothedragon |
0:25fa8795676b
|
1382
|
|
| leothedragon |
0:25fa8795676b
|
1383
|
RTF_OUTPUT = rtf
|
| leothedragon |
0:25fa8795676b
|
1384
|
|
| leothedragon |
0:25fa8795676b
|
1385
|
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
| leothedragon |
0:25fa8795676b
|
1386
|
# RTF documents. This may be useful for small projects and may help to
|
| leothedragon |
0:25fa8795676b
|
1387
|
# save some trees in general.
|
| leothedragon |
0:25fa8795676b
|
1388
|
|
| leothedragon |
0:25fa8795676b
|
1389
|
COMPACT_RTF = NO
|
| leothedragon |
0:25fa8795676b
|
1390
|
|
| leothedragon |
0:25fa8795676b
|
1391
|
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
| leothedragon |
0:25fa8795676b
|
1392
|
# will contain hyperlink fields. The RTF file will
|
| leothedragon |
0:25fa8795676b
|
1393
|
# contain links (just like the HTML output) instead of page references.
|
| leothedragon |
0:25fa8795676b
|
1394
|
# This makes the output suitable for online browsing using WORD or other
|
| leothedragon |
0:25fa8795676b
|
1395
|
# programs which support those fields.
|
| leothedragon |
0:25fa8795676b
|
1396
|
# Note: wordpad (write) and others do not support links.
|
| leothedragon |
0:25fa8795676b
|
1397
|
|
| leothedragon |
0:25fa8795676b
|
1398
|
RTF_HYPERLINKS = NO
|
| leothedragon |
0:25fa8795676b
|
1399
|
|
| leothedragon |
0:25fa8795676b
|
1400
|
# Load style sheet definitions from file. Syntax is similar to doxygen's
|
| leothedragon |
0:25fa8795676b
|
1401
|
# config file, i.e. a series of assignments. You only have to provide
|
| leothedragon |
0:25fa8795676b
|
1402
|
# replacements, missing definitions are set to their default value.
|
| leothedragon |
0:25fa8795676b
|
1403
|
|
| leothedragon |
0:25fa8795676b
|
1404
|
RTF_STYLESHEET_FILE =
|
| leothedragon |
0:25fa8795676b
|
1405
|
|
| leothedragon |
0:25fa8795676b
|
1406
|
# Set optional variables used in the generation of an rtf document.
|
| leothedragon |
0:25fa8795676b
|
1407
|
# Syntax is similar to doxygen's config file.
|
| leothedragon |
0:25fa8795676b
|
1408
|
|
| leothedragon |
0:25fa8795676b
|
1409
|
RTF_EXTENSIONS_FILE =
|
| leothedragon |
0:25fa8795676b
|
1410
|
|
| leothedragon |
0:25fa8795676b
|
1411
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1412
|
# configuration options related to the man page output
|
| leothedragon |
0:25fa8795676b
|
1413
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1414
|
|
| leothedragon |
0:25fa8795676b
|
1415
|
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1416
|
# generate man pages
|
| leothedragon |
0:25fa8795676b
|
1417
|
|
| leothedragon |
0:25fa8795676b
|
1418
|
GENERATE_MAN = NO
|
| leothedragon |
0:25fa8795676b
|
1419
|
|
| leothedragon |
0:25fa8795676b
|
1420
|
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
| leothedragon |
0:25fa8795676b
|
1421
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| leothedragon |
0:25fa8795676b
|
1422
|
# put in front of it. If left blank `man' will be used as the default path.
|
| leothedragon |
0:25fa8795676b
|
1423
|
|
| leothedragon |
0:25fa8795676b
|
1424
|
MAN_OUTPUT = man
|
| leothedragon |
0:25fa8795676b
|
1425
|
|
| leothedragon |
0:25fa8795676b
|
1426
|
# The MAN_EXTENSION tag determines the extension that is added to
|
| leothedragon |
0:25fa8795676b
|
1427
|
# the generated man pages (default is the subroutine's section .3)
|
| leothedragon |
0:25fa8795676b
|
1428
|
|
| leothedragon |
0:25fa8795676b
|
1429
|
MAN_EXTENSION = .3
|
| leothedragon |
0:25fa8795676b
|
1430
|
|
| leothedragon |
0:25fa8795676b
|
1431
|
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
|
| leothedragon |
0:25fa8795676b
|
1432
|
# then it will generate one additional man file for each entity
|
| leothedragon |
0:25fa8795676b
|
1433
|
# documented in the real man page(s). These additional files
|
| leothedragon |
0:25fa8795676b
|
1434
|
# only source the real man page, but without them the man command
|
| leothedragon |
0:25fa8795676b
|
1435
|
# would be unable to find the correct page. The default is NO.
|
| leothedragon |
0:25fa8795676b
|
1436
|
|
| leothedragon |
0:25fa8795676b
|
1437
|
MAN_LINKS = NO
|
| leothedragon |
0:25fa8795676b
|
1438
|
|
| leothedragon |
0:25fa8795676b
|
1439
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1440
|
# configuration options related to the XML output
|
| leothedragon |
0:25fa8795676b
|
1441
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1442
|
|
| leothedragon |
0:25fa8795676b
|
1443
|
# If the GENERATE_XML tag is set to YES Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1444
|
# generate an XML file that captures the structure of
|
| leothedragon |
0:25fa8795676b
|
1445
|
# the code including all documentation.
|
| leothedragon |
0:25fa8795676b
|
1446
|
|
| leothedragon |
0:25fa8795676b
|
1447
|
GENERATE_XML = NO
|
| leothedragon |
0:25fa8795676b
|
1448
|
|
| leothedragon |
0:25fa8795676b
|
1449
|
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
|
| leothedragon |
0:25fa8795676b
|
1450
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| leothedragon |
0:25fa8795676b
|
1451
|
# put in front of it. If left blank `xml' will be used as the default path.
|
| leothedragon |
0:25fa8795676b
|
1452
|
|
| leothedragon |
0:25fa8795676b
|
1453
|
XML_OUTPUT = xml
|
| leothedragon |
0:25fa8795676b
|
1454
|
|
| leothedragon |
0:25fa8795676b
|
1455
|
# The XML_SCHEMA tag can be used to specify an XML schema,
|
| leothedragon |
0:25fa8795676b
|
1456
|
# which can be used by a validating XML parser to check the
|
| leothedragon |
0:25fa8795676b
|
1457
|
# syntax of the XML files.
|
| leothedragon |
0:25fa8795676b
|
1458
|
|
| leothedragon |
0:25fa8795676b
|
1459
|
XML_SCHEMA =
|
| leothedragon |
0:25fa8795676b
|
1460
|
|
| leothedragon |
0:25fa8795676b
|
1461
|
# The XML_DTD tag can be used to specify an XML DTD,
|
| leothedragon |
0:25fa8795676b
|
1462
|
# which can be used by a validating XML parser to check the
|
| leothedragon |
0:25fa8795676b
|
1463
|
# syntax of the XML files.
|
| leothedragon |
0:25fa8795676b
|
1464
|
|
| leothedragon |
0:25fa8795676b
|
1465
|
XML_DTD =
|
| leothedragon |
0:25fa8795676b
|
1466
|
|
| leothedragon |
0:25fa8795676b
|
1467
|
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1468
|
# dump the program listings (including syntax highlighting
|
| leothedragon |
0:25fa8795676b
|
1469
|
# and cross-referencing information) to the XML output. Note that
|
| leothedragon |
0:25fa8795676b
|
1470
|
# enabling this will significantly increase the size of the XML output.
|
| leothedragon |
0:25fa8795676b
|
1471
|
|
| leothedragon |
0:25fa8795676b
|
1472
|
XML_PROGRAMLISTING = YES
|
| leothedragon |
0:25fa8795676b
|
1473
|
|
| leothedragon |
0:25fa8795676b
|
1474
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1475
|
# configuration options for the AutoGen Definitions output
|
| leothedragon |
0:25fa8795676b
|
1476
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1477
|
|
| leothedragon |
0:25fa8795676b
|
1478
|
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1479
|
# generate an AutoGen Definitions (see autogen.sf.net) file
|
| leothedragon |
0:25fa8795676b
|
1480
|
# that captures the structure of the code including all
|
| leothedragon |
0:25fa8795676b
|
1481
|
# documentation. Note that this feature is still experimental
|
| leothedragon |
0:25fa8795676b
|
1482
|
# and incomplete at the moment.
|
| leothedragon |
0:25fa8795676b
|
1483
|
|
| leothedragon |
0:25fa8795676b
|
1484
|
GENERATE_AUTOGEN_DEF = NO
|
| leothedragon |
0:25fa8795676b
|
1485
|
|
| leothedragon |
0:25fa8795676b
|
1486
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1487
|
# configuration options related to the Perl module output
|
| leothedragon |
0:25fa8795676b
|
1488
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1489
|
|
| leothedragon |
0:25fa8795676b
|
1490
|
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1491
|
# generate a Perl module file that captures the structure of
|
| leothedragon |
0:25fa8795676b
|
1492
|
# the code including all documentation. Note that this
|
| leothedragon |
0:25fa8795676b
|
1493
|
# feature is still experimental and incomplete at the
|
| leothedragon |
0:25fa8795676b
|
1494
|
# moment.
|
| leothedragon |
0:25fa8795676b
|
1495
|
|
| leothedragon |
0:25fa8795676b
|
1496
|
GENERATE_PERLMOD = NO
|
| leothedragon |
0:25fa8795676b
|
1497
|
|
| leothedragon |
0:25fa8795676b
|
1498
|
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
|
| leothedragon |
0:25fa8795676b
|
1499
|
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
|
| leothedragon |
0:25fa8795676b
|
1500
|
# to generate PDF and DVI output from the Perl module output.
|
| leothedragon |
0:25fa8795676b
|
1501
|
|
| leothedragon |
0:25fa8795676b
|
1502
|
PERLMOD_LATEX = NO
|
| leothedragon |
0:25fa8795676b
|
1503
|
|
| leothedragon |
0:25fa8795676b
|
1504
|
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
| leothedragon |
0:25fa8795676b
|
1505
|
# nicely formatted so it can be parsed by a human reader. This is useful
|
| leothedragon |
0:25fa8795676b
|
1506
|
# if you want to understand what is going on. On the other hand, if this
|
| leothedragon |
0:25fa8795676b
|
1507
|
# tag is set to NO the size of the Perl module output will be much smaller
|
| leothedragon |
0:25fa8795676b
|
1508
|
# and Perl will parse it just the same.
|
| leothedragon |
0:25fa8795676b
|
1509
|
|
| leothedragon |
0:25fa8795676b
|
1510
|
PERLMOD_PRETTY = YES
|
| leothedragon |
0:25fa8795676b
|
1511
|
|
| leothedragon |
0:25fa8795676b
|
1512
|
# The names of the make variables in the generated doxyrules.make file
|
| leothedragon |
0:25fa8795676b
|
1513
|
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
|
| leothedragon |
0:25fa8795676b
|
1514
|
# This is useful so different doxyrules.make files included by the same
|
| leothedragon |
0:25fa8795676b
|
1515
|
# Makefile don't overwrite each other's variables.
|
| leothedragon |
0:25fa8795676b
|
1516
|
|
| leothedragon |
0:25fa8795676b
|
1517
|
PERLMOD_MAKEVAR_PREFIX =
|
| leothedragon |
0:25fa8795676b
|
1518
|
|
| leothedragon |
0:25fa8795676b
|
1519
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1520
|
# Configuration options related to the preprocessor
|
| leothedragon |
0:25fa8795676b
|
1521
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1522
|
|
| leothedragon |
0:25fa8795676b
|
1523
|
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1524
|
# evaluate all C-preprocessor directives found in the sources and include
|
| leothedragon |
0:25fa8795676b
|
1525
|
# files.
|
| leothedragon |
0:25fa8795676b
|
1526
|
|
| leothedragon |
0:25fa8795676b
|
1527
|
ENABLE_PREPROCESSING = YES
|
| leothedragon |
0:25fa8795676b
|
1528
|
|
| leothedragon |
0:25fa8795676b
|
1529
|
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
| leothedragon |
0:25fa8795676b
|
1530
|
# names in the source code. If set to NO (the default) only conditional
|
| leothedragon |
0:25fa8795676b
|
1531
|
# compilation will be performed. Macro expansion can be done in a controlled
|
| leothedragon |
0:25fa8795676b
|
1532
|
# way by setting EXPAND_ONLY_PREDEF to YES.
|
| leothedragon |
0:25fa8795676b
|
1533
|
|
| leothedragon |
0:25fa8795676b
|
1534
|
MACRO_EXPANSION = NO
|
| leothedragon |
0:25fa8795676b
|
1535
|
|
| leothedragon |
0:25fa8795676b
|
1536
|
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
| leothedragon |
0:25fa8795676b
|
1537
|
# then the macro expansion is limited to the macros specified with the
|
| leothedragon |
0:25fa8795676b
|
1538
|
# PREDEFINED and EXPAND_AS_DEFINED tags.
|
| leothedragon |
0:25fa8795676b
|
1539
|
|
| leothedragon |
0:25fa8795676b
|
1540
|
EXPAND_ONLY_PREDEF = NO
|
| leothedragon |
0:25fa8795676b
|
1541
|
|
| leothedragon |
0:25fa8795676b
|
1542
|
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
| leothedragon |
0:25fa8795676b
|
1543
|
# pointed to by INCLUDE_PATH will be searched when a #include is found.
|
| leothedragon |
0:25fa8795676b
|
1544
|
|
| leothedragon |
0:25fa8795676b
|
1545
|
SEARCH_INCLUDES = YES
|
| leothedragon |
0:25fa8795676b
|
1546
|
|
| leothedragon |
0:25fa8795676b
|
1547
|
# The INCLUDE_PATH tag can be used to specify one or more directories that
|
| leothedragon |
0:25fa8795676b
|
1548
|
# contain include files that are not input files but should be processed by
|
| leothedragon |
0:25fa8795676b
|
1549
|
# the preprocessor.
|
| leothedragon |
0:25fa8795676b
|
1550
|
|
| leothedragon |
0:25fa8795676b
|
1551
|
INCLUDE_PATH =
|
| leothedragon |
0:25fa8795676b
|
1552
|
|
| leothedragon |
0:25fa8795676b
|
1553
|
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
| leothedragon |
0:25fa8795676b
|
1554
|
# patterns (like *.h and *.hpp) to filter out the header-files in the
|
| leothedragon |
0:25fa8795676b
|
1555
|
# directories. If left blank, the patterns specified with FILE_PATTERNS will
|
| leothedragon |
0:25fa8795676b
|
1556
|
# be used.
|
| leothedragon |
0:25fa8795676b
|
1557
|
|
| leothedragon |
0:25fa8795676b
|
1558
|
INCLUDE_FILE_PATTERNS =
|
| leothedragon |
0:25fa8795676b
|
1559
|
|
| leothedragon |
0:25fa8795676b
|
1560
|
# The PREDEFINED tag can be used to specify one or more macro names that
|
| leothedragon |
0:25fa8795676b
|
1561
|
# are defined before the preprocessor is started (similar to the -D option of
|
| leothedragon |
0:25fa8795676b
|
1562
|
# gcc). The argument of the tag is a list of macros of the form: name
|
| leothedragon |
0:25fa8795676b
|
1563
|
# or name=definition (no spaces). If the definition and the = are
|
| leothedragon |
0:25fa8795676b
|
1564
|
# omitted =1 is assumed. To prevent a macro definition from being
|
| leothedragon |
0:25fa8795676b
|
1565
|
# undefined via #undef or recursively expanded use the := operator
|
| leothedragon |
0:25fa8795676b
|
1566
|
# instead of the = operator.
|
| leothedragon |
0:25fa8795676b
|
1567
|
|
| leothedragon |
0:25fa8795676b
|
1568
|
PREDEFINED =
|
| leothedragon |
0:25fa8795676b
|
1569
|
|
| leothedragon |
0:25fa8795676b
|
1570
|
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
| leothedragon |
0:25fa8795676b
|
1571
|
# this tag can be used to specify a list of macro names that should be expanded.
|
| leothedragon |
0:25fa8795676b
|
1572
|
# The macro definition that is found in the sources will be used.
|
| leothedragon |
0:25fa8795676b
|
1573
|
# Use the PREDEFINED tag if you want to use a different macro definition that
|
| leothedragon |
0:25fa8795676b
|
1574
|
# overrules the definition found in the source code.
|
| leothedragon |
0:25fa8795676b
|
1575
|
|
| leothedragon |
0:25fa8795676b
|
1576
|
EXPAND_AS_DEFINED =
|
| leothedragon |
0:25fa8795676b
|
1577
|
|
| leothedragon |
0:25fa8795676b
|
1578
|
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
| leothedragon |
0:25fa8795676b
|
1579
|
# doxygen's preprocessor will remove all references to function-like macros
|
| leothedragon |
0:25fa8795676b
|
1580
|
# that are alone on a line, have an all uppercase name, and do not end with a
|
| leothedragon |
0:25fa8795676b
|
1581
|
# semicolon, because these will confuse the parser if not removed.
|
| leothedragon |
0:25fa8795676b
|
1582
|
|
| leothedragon |
0:25fa8795676b
|
1583
|
SKIP_FUNCTION_MACROS = YES
|
| leothedragon |
0:25fa8795676b
|
1584
|
|
| leothedragon |
0:25fa8795676b
|
1585
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1586
|
# Configuration::additions related to external references
|
| leothedragon |
0:25fa8795676b
|
1587
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1588
|
|
| leothedragon |
0:25fa8795676b
|
1589
|
# The TAGFILES option can be used to specify one or more tagfiles. For each
|
| leothedragon |
0:25fa8795676b
|
1590
|
# tag file the location of the external documentation should be added. The
|
| leothedragon |
0:25fa8795676b
|
1591
|
# format of a tag file without this location is as follows:
|
| leothedragon |
0:25fa8795676b
|
1592
|
# TAGFILES = file1 file2 ...
|
| leothedragon |
0:25fa8795676b
|
1593
|
# Adding location for the tag files is done as follows:
|
| leothedragon |
0:25fa8795676b
|
1594
|
# TAGFILES = file1=loc1 "file2 = loc2" ...
|
| leothedragon |
0:25fa8795676b
|
1595
|
# where "loc1" and "loc2" can be relative or absolute paths
|
| leothedragon |
0:25fa8795676b
|
1596
|
# or URLs. Note that each tag file must have a unique name (where the name does
|
| leothedragon |
0:25fa8795676b
|
1597
|
# NOT include the path). If a tag file is not located in the directory in which
|
| leothedragon |
0:25fa8795676b
|
1598
|
# doxygen is run, you must also specify the path to the tagfile here.
|
| leothedragon |
0:25fa8795676b
|
1599
|
|
| leothedragon |
0:25fa8795676b
|
1600
|
TAGFILES =
|
| leothedragon |
0:25fa8795676b
|
1601
|
|
| leothedragon |
0:25fa8795676b
|
1602
|
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
| leothedragon |
0:25fa8795676b
|
1603
|
# a tag file that is based on the input files it reads.
|
| leothedragon |
0:25fa8795676b
|
1604
|
|
| leothedragon |
0:25fa8795676b
|
1605
|
GENERATE_TAGFILE =
|
| leothedragon |
0:25fa8795676b
|
1606
|
|
| leothedragon |
0:25fa8795676b
|
1607
|
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
| leothedragon |
0:25fa8795676b
|
1608
|
# in the class index. If set to NO only the inherited external classes
|
| leothedragon |
0:25fa8795676b
|
1609
|
# will be listed.
|
| leothedragon |
0:25fa8795676b
|
1610
|
|
| leothedragon |
0:25fa8795676b
|
1611
|
ALLEXTERNALS = NO
|
| leothedragon |
0:25fa8795676b
|
1612
|
|
| leothedragon |
0:25fa8795676b
|
1613
|
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
| leothedragon |
0:25fa8795676b
|
1614
|
# in the modules index. If set to NO, only the current project's groups will
|
| leothedragon |
0:25fa8795676b
|
1615
|
# be listed.
|
| leothedragon |
0:25fa8795676b
|
1616
|
|
| leothedragon |
0:25fa8795676b
|
1617
|
EXTERNAL_GROUPS = YES
|
| leothedragon |
0:25fa8795676b
|
1618
|
|
| leothedragon |
0:25fa8795676b
|
1619
|
# The PERL_PATH should be the absolute path and name of the perl script
|
| leothedragon |
0:25fa8795676b
|
1620
|
# interpreter (i.e. the result of `which perl').
|
| leothedragon |
0:25fa8795676b
|
1621
|
|
| leothedragon |
0:25fa8795676b
|
1622
|
PERL_PATH = /usr/bin/perl
|
| leothedragon |
0:25fa8795676b
|
1623
|
|
| leothedragon |
0:25fa8795676b
|
1624
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1625
|
# Configuration options related to the dot tool
|
| leothedragon |
0:25fa8795676b
|
1626
|
#---------------------------------------------------------------------------
|
| leothedragon |
0:25fa8795676b
|
1627
|
|
| leothedragon |
0:25fa8795676b
|
1628
|
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1629
|
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
| leothedragon |
0:25fa8795676b
|
1630
|
# or super classes. Setting the tag to NO turns the diagrams off. Note that
|
| leothedragon |
0:25fa8795676b
|
1631
|
# this option also works with HAVE_DOT disabled, but it is recommended to
|
| leothedragon |
0:25fa8795676b
|
1632
|
# install and use dot, since it yields more powerful graphs.
|
| leothedragon |
0:25fa8795676b
|
1633
|
|
| leothedragon |
0:25fa8795676b
|
1634
|
CLASS_DIAGRAMS = NO
|
| leothedragon |
0:25fa8795676b
|
1635
|
|
| leothedragon |
0:25fa8795676b
|
1636
|
# You can define message sequence charts within doxygen comments using the \msc
|
| leothedragon |
0:25fa8795676b
|
1637
|
# command. Doxygen will then run the mscgen tool (see
|
| leothedragon |
0:25fa8795676b
|
1638
|
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
|
| leothedragon |
0:25fa8795676b
|
1639
|
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
|
| leothedragon |
0:25fa8795676b
|
1640
|
# the mscgen tool resides. If left empty the tool is assumed to be found in the
|
| leothedragon |
0:25fa8795676b
|
1641
|
# default search path.
|
| leothedragon |
0:25fa8795676b
|
1642
|
|
| leothedragon |
0:25fa8795676b
|
1643
|
MSCGEN_PATH =
|
| leothedragon |
0:25fa8795676b
|
1644
|
|
| leothedragon |
0:25fa8795676b
|
1645
|
# If set to YES, the inheritance and collaboration graphs will hide
|
| leothedragon |
0:25fa8795676b
|
1646
|
# inheritance and usage relations if the target is undocumented
|
| leothedragon |
0:25fa8795676b
|
1647
|
# or is not a class.
|
| leothedragon |
0:25fa8795676b
|
1648
|
|
| leothedragon |
0:25fa8795676b
|
1649
|
HIDE_UNDOC_RELATIONS = YES
|
| leothedragon |
0:25fa8795676b
|
1650
|
|
| leothedragon |
0:25fa8795676b
|
1651
|
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
| leothedragon |
0:25fa8795676b
|
1652
|
# available from the path. This tool is part of Graphviz, a graph visualization
|
| leothedragon |
0:25fa8795676b
|
1653
|
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
| leothedragon |
0:25fa8795676b
|
1654
|
# have no effect if this option is set to NO (the default)
|
| leothedragon |
0:25fa8795676b
|
1655
|
|
| leothedragon |
0:25fa8795676b
|
1656
|
HAVE_DOT = NO
|
| leothedragon |
0:25fa8795676b
|
1657
|
|
| leothedragon |
0:25fa8795676b
|
1658
|
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
|
| leothedragon |
0:25fa8795676b
|
1659
|
# allowed to run in parallel. When set to 0 (the default) doxygen will
|
| leothedragon |
0:25fa8795676b
|
1660
|
# base this on the number of processors available in the system. You can set it
|
| leothedragon |
0:25fa8795676b
|
1661
|
# explicitly to a value larger than 0 to get control over the balance
|
| leothedragon |
0:25fa8795676b
|
1662
|
# between CPU load and processing speed.
|
| leothedragon |
0:25fa8795676b
|
1663
|
|
| leothedragon |
0:25fa8795676b
|
1664
|
DOT_NUM_THREADS = 0
|
| leothedragon |
0:25fa8795676b
|
1665
|
|
| leothedragon |
0:25fa8795676b
|
1666
|
# By default doxygen will use the Helvetica font for all dot files that
|
| leothedragon |
0:25fa8795676b
|
1667
|
# doxygen generates. When you want a differently looking font you can specify
|
| leothedragon |
0:25fa8795676b
|
1668
|
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
|
| leothedragon |
0:25fa8795676b
|
1669
|
# the font, which can be done by putting it in a standard location or by setting
|
| leothedragon |
0:25fa8795676b
|
1670
|
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
|
| leothedragon |
0:25fa8795676b
|
1671
|
# directory containing the font.
|
| leothedragon |
0:25fa8795676b
|
1672
|
|
| leothedragon |
0:25fa8795676b
|
1673
|
DOT_FONTNAME = Helvetica
|
| leothedragon |
0:25fa8795676b
|
1674
|
|
| leothedragon |
0:25fa8795676b
|
1675
|
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
|
| leothedragon |
0:25fa8795676b
|
1676
|
# The default size is 10pt.
|
| leothedragon |
0:25fa8795676b
|
1677
|
|
| leothedragon |
0:25fa8795676b
|
1678
|
DOT_FONTSIZE = 10
|
| leothedragon |
0:25fa8795676b
|
1679
|
|
| leothedragon |
0:25fa8795676b
|
1680
|
# By default doxygen will tell dot to use the Helvetica font.
|
| leothedragon |
0:25fa8795676b
|
1681
|
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
|
| leothedragon |
0:25fa8795676b
|
1682
|
# set the path where dot can find it.
|
| leothedragon |
0:25fa8795676b
|
1683
|
|
| leothedragon |
0:25fa8795676b
|
1684
|
DOT_FONTPATH =
|
| leothedragon |
0:25fa8795676b
|
1685
|
|
| leothedragon |
0:25fa8795676b
|
1686
|
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
| leothedragon |
0:25fa8795676b
|
1687
|
# will generate a graph for each documented class showing the direct and
|
| leothedragon |
0:25fa8795676b
|
1688
|
# indirect inheritance relations. Setting this tag to YES will force the
|
| leothedragon |
0:25fa8795676b
|
1689
|
# CLASS_DIAGRAMS tag to NO.
|
| leothedragon |
0:25fa8795676b
|
1690
|
|
| leothedragon |
0:25fa8795676b
|
1691
|
CLASS_GRAPH = YES
|
| leothedragon |
0:25fa8795676b
|
1692
|
|
| leothedragon |
0:25fa8795676b
|
1693
|
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
| leothedragon |
0:25fa8795676b
|
1694
|
# will generate a graph for each documented class showing the direct and
|
| leothedragon |
0:25fa8795676b
|
1695
|
# indirect implementation dependencies (inheritance, containment, and
|
| leothedragon |
0:25fa8795676b
|
1696
|
# class references variables) of the class with other documented classes.
|
| leothedragon |
0:25fa8795676b
|
1697
|
|
| leothedragon |
0:25fa8795676b
|
1698
|
COLLABORATION_GRAPH = YES
|
| leothedragon |
0:25fa8795676b
|
1699
|
|
| leothedragon |
0:25fa8795676b
|
1700
|
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
|
| leothedragon |
0:25fa8795676b
|
1701
|
# will generate a graph for groups, showing the direct groups dependencies
|
| leothedragon |
0:25fa8795676b
|
1702
|
|
| leothedragon |
0:25fa8795676b
|
1703
|
GROUP_GRAPHS = YES
|
| leothedragon |
0:25fa8795676b
|
1704
|
|
| leothedragon |
0:25fa8795676b
|
1705
|
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
| leothedragon |
0:25fa8795676b
|
1706
|
# collaboration diagrams in a style similar to the OMG's Unified Modeling
|
| leothedragon |
0:25fa8795676b
|
1707
|
# Language.
|
| leothedragon |
0:25fa8795676b
|
1708
|
|
| leothedragon |
0:25fa8795676b
|
1709
|
UML_LOOK = NO
|
| leothedragon |
0:25fa8795676b
|
1710
|
|
| leothedragon |
0:25fa8795676b
|
1711
|
# If the UML_LOOK tag is enabled, the fields and methods are shown inside
|
| leothedragon |
0:25fa8795676b
|
1712
|
# the class node. If there are many fields or methods and many nodes the
|
| leothedragon |
0:25fa8795676b
|
1713
|
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
|
| leothedragon |
0:25fa8795676b
|
1714
|
# threshold limits the number of items for each type to make the size more
|
| leothedragon |
0:25fa8795676b
|
1715
|
# managable. Set this to 0 for no limit. Note that the threshold may be
|
| leothedragon |
0:25fa8795676b
|
1716
|
# exceeded by 50% before the limit is enforced.
|
| leothedragon |
0:25fa8795676b
|
1717
|
|
| leothedragon |
0:25fa8795676b
|
1718
|
UML_LIMIT_NUM_FIELDS = 10
|
| leothedragon |
0:25fa8795676b
|
1719
|
|
| leothedragon |
0:25fa8795676b
|
1720
|
# If set to YES, the inheritance and collaboration graphs will show the
|
| leothedragon |
0:25fa8795676b
|
1721
|
# relations between templates and their instances.
|
| leothedragon |
0:25fa8795676b
|
1722
|
|
| leothedragon |
0:25fa8795676b
|
1723
|
TEMPLATE_RELATIONS = NO
|
| leothedragon |
0:25fa8795676b
|
1724
|
|
| leothedragon |
0:25fa8795676b
|
1725
|
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
| leothedragon |
0:25fa8795676b
|
1726
|
# tags are set to YES then doxygen will generate a graph for each documented
|
| leothedragon |
0:25fa8795676b
|
1727
|
# file showing the direct and indirect include dependencies of the file with
|
| leothedragon |
0:25fa8795676b
|
1728
|
# other documented files.
|
| leothedragon |
0:25fa8795676b
|
1729
|
|
| leothedragon |
0:25fa8795676b
|
1730
|
INCLUDE_GRAPH = YES
|
| leothedragon |
0:25fa8795676b
|
1731
|
|
| leothedragon |
0:25fa8795676b
|
1732
|
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
| leothedragon |
0:25fa8795676b
|
1733
|
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
| leothedragon |
0:25fa8795676b
|
1734
|
# documented header file showing the documented files that directly or
|
| leothedragon |
0:25fa8795676b
|
1735
|
# indirectly include this file.
|
| leothedragon |
0:25fa8795676b
|
1736
|
|
| leothedragon |
0:25fa8795676b
|
1737
|
INCLUDED_BY_GRAPH = YES
|
| leothedragon |
0:25fa8795676b
|
1738
|
|
| leothedragon |
0:25fa8795676b
|
1739
|
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
|
| leothedragon |
0:25fa8795676b
|
1740
|
# doxygen will generate a call dependency graph for every global function
|
| leothedragon |
0:25fa8795676b
|
1741
|
# or class method. Note that enabling this option will significantly increase
|
| leothedragon |
0:25fa8795676b
|
1742
|
# the time of a run. So in most cases it will be better to enable call graphs
|
| leothedragon |
0:25fa8795676b
|
1743
|
# for selected functions only using the \callgraph command.
|
| leothedragon |
0:25fa8795676b
|
1744
|
|
| leothedragon |
0:25fa8795676b
|
1745
|
CALL_GRAPH = YES
|
| leothedragon |
0:25fa8795676b
|
1746
|
|
| leothedragon |
0:25fa8795676b
|
1747
|
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
|
| leothedragon |
0:25fa8795676b
|
1748
|
# doxygen will generate a caller dependency graph for every global function
|
| leothedragon |
0:25fa8795676b
|
1749
|
# or class method. Note that enabling this option will significantly increase
|
| leothedragon |
0:25fa8795676b
|
1750
|
# the time of a run. So in most cases it will be better to enable caller
|
| leothedragon |
0:25fa8795676b
|
1751
|
# graphs for selected functions only using the \callergraph command.
|
| leothedragon |
0:25fa8795676b
|
1752
|
|
| leothedragon |
0:25fa8795676b
|
1753
|
CALLER_GRAPH = YES
|
| leothedragon |
0:25fa8795676b
|
1754
|
|
| leothedragon |
0:25fa8795676b
|
1755
|
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
| leothedragon |
0:25fa8795676b
|
1756
|
# will generate a graphical hierarchy of all classes instead of a textual one.
|
| leothedragon |
0:25fa8795676b
|
1757
|
|
| leothedragon |
0:25fa8795676b
|
1758
|
GRAPHICAL_HIERARCHY = YES
|
| leothedragon |
0:25fa8795676b
|
1759
|
|
| leothedragon |
0:25fa8795676b
|
1760
|
# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
|
| leothedragon |
0:25fa8795676b
|
1761
|
# then doxygen will show the dependencies a directory has on other directories
|
| leothedragon |
0:25fa8795676b
|
1762
|
# in a graphical way. The dependency relations are determined by the #include
|
| leothedragon |
0:25fa8795676b
|
1763
|
# relations between the files in the directories.
|
| leothedragon |
0:25fa8795676b
|
1764
|
|
| leothedragon |
0:25fa8795676b
|
1765
|
DIRECTORY_GRAPH = YES
|
| leothedragon |
0:25fa8795676b
|
1766
|
|
| leothedragon |
0:25fa8795676b
|
1767
|
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
| leothedragon |
0:25fa8795676b
|
1768
|
# generated by dot. Possible values are svg, png, jpg, or gif.
|
| leothedragon |
0:25fa8795676b
|
1769
|
# If left blank png will be used. If you choose svg you need to set
|
| leothedragon |
0:25fa8795676b
|
1770
|
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
|
| leothedragon |
0:25fa8795676b
|
1771
|
# visible in IE 9+ (other browsers do not have this requirement).
|
| leothedragon |
0:25fa8795676b
|
1772
|
|
| leothedragon |
0:25fa8795676b
|
1773
|
DOT_IMAGE_FORMAT = png
|
| leothedragon |
0:25fa8795676b
|
1774
|
|
| leothedragon |
0:25fa8795676b
|
1775
|
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
| leothedragon |
0:25fa8795676b
|
1776
|
# enable generation of interactive SVG images that allow zooming and panning.
|
| leothedragon |
0:25fa8795676b
|
1777
|
# Note that this requires a modern browser other than Internet Explorer.
|
| leothedragon |
0:25fa8795676b
|
1778
|
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
|
| leothedragon |
0:25fa8795676b
|
1779
|
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
|
| leothedragon |
0:25fa8795676b
|
1780
|
# visible. Older versions of IE do not have SVG support.
|
| leothedragon |
0:25fa8795676b
|
1781
|
|
| leothedragon |
0:25fa8795676b
|
1782
|
INTERACTIVE_SVG = NO
|
| leothedragon |
0:25fa8795676b
|
1783
|
|
| leothedragon |
0:25fa8795676b
|
1784
|
# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
| leothedragon |
0:25fa8795676b
|
1785
|
# found. If left blank, it is assumed the dot tool can be found in the path.
|
| leothedragon |
0:25fa8795676b
|
1786
|
|
| leothedragon |
0:25fa8795676b
|
1787
|
DOT_PATH =
|
| leothedragon |
0:25fa8795676b
|
1788
|
|
| leothedragon |
0:25fa8795676b
|
1789
|
# The DOTFILE_DIRS tag can be used to specify one or more directories that
|
| leothedragon |
0:25fa8795676b
|
1790
|
# contain dot files that are included in the documentation (see the
|
| leothedragon |
0:25fa8795676b
|
1791
|
# \dotfile command).
|
| leothedragon |
0:25fa8795676b
|
1792
|
|
| leothedragon |
0:25fa8795676b
|
1793
|
DOTFILE_DIRS =
|
| leothedragon |
0:25fa8795676b
|
1794
|
|
| leothedragon |
0:25fa8795676b
|
1795
|
# The MSCFILE_DIRS tag can be used to specify one or more directories that
|
| leothedragon |
0:25fa8795676b
|
1796
|
# contain msc files that are included in the documentation (see the
|
| leothedragon |
0:25fa8795676b
|
1797
|
# \mscfile command).
|
| leothedragon |
0:25fa8795676b
|
1798
|
|
| leothedragon |
0:25fa8795676b
|
1799
|
MSCFILE_DIRS =
|
| leothedragon |
0:25fa8795676b
|
1800
|
|
| leothedragon |
0:25fa8795676b
|
1801
|
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
|
| leothedragon |
0:25fa8795676b
|
1802
|
# nodes that will be shown in the graph. If the number of nodes in a graph
|
| leothedragon |
0:25fa8795676b
|
1803
|
# becomes larger than this value, doxygen will truncate the graph, which is
|
| leothedragon |
0:25fa8795676b
|
1804
|
# visualized by representing a node as a red box. Note that doxygen if the
|
| leothedragon |
0:25fa8795676b
|
1805
|
# number of direct children of the root node in a graph is already larger than
|
| leothedragon |
0:25fa8795676b
|
1806
|
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
|
| leothedragon |
0:25fa8795676b
|
1807
|
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
|
| leothedragon |
0:25fa8795676b
|
1808
|
|
| leothedragon |
0:25fa8795676b
|
1809
|
DOT_GRAPH_MAX_NODES = 44
|
| leothedragon |
0:25fa8795676b
|
1810
|
|
| leothedragon |
0:25fa8795676b
|
1811
|
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
|
| leothedragon |
0:25fa8795676b
|
1812
|
# graphs generated by dot. A depth value of 3 means that only nodes reachable
|
| leothedragon |
0:25fa8795676b
|
1813
|
# from the root by following a path via at most 3 edges will be shown. Nodes
|
| leothedragon |
0:25fa8795676b
|
1814
|
# that lay further from the root node will be omitted. Note that setting this
|
| leothedragon |
0:25fa8795676b
|
1815
|
# option to 1 or 2 may greatly reduce the computation time needed for large
|
| leothedragon |
0:25fa8795676b
|
1816
|
# code bases. Also note that the size of a graph can be further restricted by
|
| leothedragon |
0:25fa8795676b
|
1817
|
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
|
| leothedragon |
0:25fa8795676b
|
1818
|
|
| leothedragon |
0:25fa8795676b
|
1819
|
MAX_DOT_GRAPH_DEPTH = 0
|
| leothedragon |
0:25fa8795676b
|
1820
|
|
| leothedragon |
0:25fa8795676b
|
1821
|
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
| leothedragon |
0:25fa8795676b
|
1822
|
# background. This is disabled by default, because dot on Windows does not
|
| leothedragon |
0:25fa8795676b
|
1823
|
# seem to support this out of the box. Warning: Depending on the platform used,
|
| leothedragon |
0:25fa8795676b
|
1824
|
# enabling this option may lead to badly anti-aliased labels on the edges of
|
| leothedragon |
0:25fa8795676b
|
1825
|
# a graph (i.e. they become hard to read).
|
| leothedragon |
0:25fa8795676b
|
1826
|
|
| leothedragon |
0:25fa8795676b
|
1827
|
DOT_TRANSPARENT = NO
|
| leothedragon |
0:25fa8795676b
|
1828
|
|
| leothedragon |
0:25fa8795676b
|
1829
|
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
|
| leothedragon |
0:25fa8795676b
|
1830
|
# files in one run (i.e. multiple -o and -T options on the command line). This
|
| leothedragon |
0:25fa8795676b
|
1831
|
# makes dot run faster, but since only newer versions of dot (>1.8.10)
|
| leothedragon |
0:25fa8795676b
|
1832
|
# support this, this feature is disabled by default.
|
| leothedragon |
0:25fa8795676b
|
1833
|
|
| leothedragon |
0:25fa8795676b
|
1834
|
DOT_MULTI_TARGETS = NO
|
| leothedragon |
0:25fa8795676b
|
1835
|
|
| leothedragon |
0:25fa8795676b
|
1836
|
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1837
|
# generate a legend page explaining the meaning of the various boxes and
|
| leothedragon |
0:25fa8795676b
|
1838
|
# arrows in the dot generated graphs.
|
| leothedragon |
0:25fa8795676b
|
1839
|
|
| leothedragon |
0:25fa8795676b
|
1840
|
GENERATE_LEGEND = YES
|
| leothedragon |
0:25fa8795676b
|
1841
|
|
| leothedragon |
0:25fa8795676b
|
1842
|
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
| leothedragon |
0:25fa8795676b
|
1843
|
# remove the intermediate dot files that are used to generate
|
| leothedragon |
0:25fa8795676b
|
1844
|
# the various graphs.
|
| leothedragon |
0:25fa8795676b
|
1845
|
|
| leothedragon |
0:25fa8795676b
|
1846
|
DOT_CLEANUP = YES
|