|
5
|
1 # Doxyfile 1.4.4
|
|
|
2
|
|
|
3 # This file describes the settings to be used by the documentation system
|
|
|
4 # doxygen (www.doxygen.org) for a project
|
|
|
5 #
|
|
|
6 # All text after a hash (#) is considered a comment and will be ignored
|
|
|
7 # The format is:
|
|
|
8 # TAG = value [value, ...]
|
|
|
9 # For lists items can also be appended using:
|
|
|
10 # TAG += value [value, ...]
|
|
|
11 # Values that contain spaces should be placed between quotes (" ")
|
|
|
12
|
|
|
13 #---------------------------------------------------------------------------
|
|
|
14 # Project related configuration options
|
|
|
15 #---------------------------------------------------------------------------
|
|
|
16
|
|
|
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
|
|
18 # by quotes) that should identify the project.
|
|
|
19
|
|
|
20 PROJECT_NAME = libspandsp
|
|
|
21
|
|
|
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
|
|
23 # This could be handy for archiving the generated documentation or
|
|
|
24 # if some version control system is used.
|
|
|
25
|
|
|
26 PROJECT_NUMBER = 0.0.3
|
|
|
27
|
|
|
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
|
|
29 # base path where the generated documentation will be put.
|
|
|
30 # If a relative path is entered, it will be relative to the location
|
|
|
31 # where doxygen was started. If left blank the current directory will be used.
|
|
|
32
|
|
|
33 OUTPUT_DIRECTORY = api
|
|
|
34
|
|
|
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
|
|
36 # 4096 sub-directories (in 2 levels) under the output directory of each output
|
|
|
37 # format and will distribute the generated files over these directories.
|
|
|
38 # Enabling this option can be useful when feeding doxygen a huge amount of
|
|
|
39 # source files, where putting all generated files in the same directory would
|
|
|
40 # otherwise cause performance problems for the file system.
|
|
|
41
|
|
|
42 CREATE_SUBDIRS = NO
|
|
|
43
|
|
|
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
|
|
45 # documentation generated by doxygen is written. Doxygen will use this
|
|
|
46 # information to generate all constant output in the proper language.
|
|
|
47 # The default language is English, other supported languages are:
|
|
|
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
|
|
|
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
|
|
|
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
|
|
|
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
|
|
|
52 # Swedish, and Ukrainian.
|
|
|
53
|
|
|
54 OUTPUT_LANGUAGE = English
|
|
|
55
|
|
|
56 # This tag can be used to specify the encoding used in the generated output.
|
|
|
57 # The encoding is not always determined by the language that is chosen,
|
|
|
58 # but also whether or not the output is meant for Windows or non-Windows users.
|
|
|
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
|
|
|
60 # forces the Windows encoding (this is the default for the Windows binary),
|
|
|
61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
|
|
|
62 # all platforms other than Windows).
|
|
|
63
|
|
|
64 USE_WINDOWS_ENCODING = YES
|
|
|
65
|
|
|
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
|
|
67 # include brief member descriptions after the members that are listed in
|
|
|
68 # the file and class documentation (similar to JavaDoc).
|
|
|
69 # Set to NO to disable this.
|
|
|
70
|
|
|
71 BRIEF_MEMBER_DESC = YES
|
|
|
72
|
|
|
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
|
|
74 # the brief description of a member or function before the detailed description.
|
|
|
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
|
|
76 # brief descriptions will be completely suppressed.
|
|
|
77
|
|
|
78 REPEAT_BRIEF = YES
|
|
|
79
|
|
|
80 # This tag implements a quasi-intelligent brief description abbreviator
|
|
|
81 # that is used to form the text in various listings. Each string
|
|
|
82 # in this list, if found as the leading text of the brief description, will be
|
|
|
83 # stripped from the text and the result after processing the whole list, is
|
|
|
84 # used as the annotated text. Otherwise, the brief description is used as-is.
|
|
|
85 # If left blank, the following values are used ("$name" is automatically
|
|
|
86 # replaced with the name of the entity): "The $name class" "The $name widget"
|
|
|
87 # "The $name file" "is" "provides" "specifies" "contains"
|
|
|
88 # "represents" "a" "an" "the"
|
|
|
89
|
|
|
90 ABBREVIATE_BRIEF =
|
|
|
91
|
|
|
92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
|
|
93 # Doxygen will generate a detailed section even if there is only a brief
|
|
|
94 # description.
|
|
|
95
|
|
|
96 ALWAYS_DETAILED_SEC = NO
|
|
|
97
|
|
|
98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
|
|
99 # inherited members of a class in the documentation of that class as if those
|
|
|
100 # members were ordinary class members. Constructors, destructors and assignment
|
|
|
101 # operators of the base classes will not be shown.
|
|
|
102
|
|
|
103 INLINE_INHERITED_MEMB = NO
|
|
|
104
|
|
|
105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
|
|
106 # path before files name in the file list and in the header files. If set
|
|
|
107 # to NO the shortest path that makes the file name unique will be used.
|
|
|
108
|
|
|
109 FULL_PATH_NAMES = NO
|
|
|
110
|
|
|
111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
|
|
|
112 # can be used to strip a user-defined part of the path. Stripping is
|
|
|
113 # only done if one of the specified strings matches the left-hand part of
|
|
|
114 # the path. The tag can be used to show relative paths in the file list.
|
|
|
115 # If left blank the directory from which doxygen is run is used as the
|
|
|
116 # path to strip.
|
|
|
117
|
|
|
118 STRIP_FROM_PATH =
|
|
|
119
|
|
|
120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
|
|
|
121 # the path mentioned in the documentation of a class, which tells
|
|
|
122 # the reader which header file to include in order to use a class.
|
|
|
123 # If left blank only the name of the header file containing the class
|
|
|
124 # definition is used. Otherwise one should specify the include paths that
|
|
|
125 # are normally passed to the compiler using the -I flag.
|
|
|
126
|
|
|
127 STRIP_FROM_INC_PATH =
|
|
|
128
|
|
|
129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
|
|
130 # (but less readable) file names. This can be useful is your file systems
|
|
|
131 # doesn't support long names like on DOS, Mac, or CD-ROM.
|
|
|
132
|
|
|
133 SHORT_NAMES = NO
|
|
|
134
|
|
|
135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
|
|
136 # will interpret the first line (until the first dot) of a JavaDoc-style
|
|
|
137 # comment as the brief description. If set to NO, the JavaDoc
|
|
|
138 # comments will behave just like the Qt-style comments (thus requiring an
|
|
|
139 # explicit @brief command for a brief description.
|
|
|
140
|
|
|
141 JAVADOC_AUTOBRIEF = NO
|
|
|
142
|
|
|
143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
|
|
|
144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
|
|
|
145 # comments) as a brief description. This used to be the default behaviour.
|
|
|
146 # The new default is to treat a multi-line C++ comment block as a detailed
|
|
|
147 # description. Set this tag to YES if you prefer the old behaviour instead.
|
|
|
148
|
|
|
149 MULTILINE_CPP_IS_BRIEF = NO
|
|
|
150
|
|
|
151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
|
|
|
152 # will output the detailed description near the top, like JavaDoc.
|
|
|
153 # If set to NO, the detailed description appears after the member
|
|
|
154 # documentation.
|
|
|
155
|
|
|
156 DETAILS_AT_TOP = NO
|
|
|
157
|
|
|
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
|
|
159 # member inherits the documentation from any documented member that it
|
|
|
160 # re-implements.
|
|
|
161
|
|
|
162 INHERIT_DOCS = YES
|
|
|
163
|
|
|
164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
|
|
165 # tag is set to YES, then doxygen will reuse the documentation of the first
|
|
|
166 # member in the group (if any) for the other members of the group. By default
|
|
|
167 # all members of a group must be documented explicitly.
|
|
|
168
|
|
|
169 DISTRIBUTE_GROUP_DOC = NO
|
|
|
170
|
|
|
171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
|
|
|
172 # a new page for each member. If set to NO, the documentation of a member will
|
|
|
173 # be part of the file/class/namespace that contains it.
|
|
|
174
|
|
|
175 SEPARATE_MEMBER_PAGES = NO
|
|
|
176
|
|
|
177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
|
|
178 # Doxygen uses this value to replace tabs by spaces in code fragments.
|
|
|
179
|
|
|
180 TAB_SIZE = 8
|
|
|
181
|
|
|
182 # This tag can be used to specify a number of aliases that acts
|
|
|
183 # as commands in the documentation. An alias has the form "name=value".
|
|
|
184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
|
|
185 # put the command \sideeffect (or @sideeffect) in the documentation, which
|
|
|
186 # will result in a user-defined paragraph with heading "Side Effects:".
|
|
|
187 # You can put \n's in the value part of an alias to insert newlines.
|
|
|
188
|
|
|
189 ALIASES =
|
|
|
190
|
|
|
191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
|
|
|
192 # sources only. Doxygen will then generate output that is more tailored for C.
|
|
|
193 # For instance, some of the names that are used will be different. The list
|
|
|
194 # of all members will be omitted, etc.
|
|
|
195
|
|
|
196 OPTIMIZE_OUTPUT_FOR_C = NO
|
|
|
197
|
|
|
198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
|
|
|
199 # only. Doxygen will then generate output that is more tailored for Java.
|
|
|
200 # For instance, namespaces will be presented as packages, qualified scopes
|
|
|
201 # will look different, etc.
|
|
|
202
|
|
|
203 OPTIMIZE_OUTPUT_JAVA = NO
|
|
|
204
|
|
|
205 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
|
|
|
206 # the same type (for instance a group of public functions) to be put as a
|
|
|
207 # subgroup of that type (e.g. under the Public Functions section). Set it to
|
|
|
208 # NO to prevent subgrouping. Alternatively, this can be done per class using
|
|
|
209 # the \nosubgrouping command.
|
|
|
210
|
|
|
211 SUBGROUPING = YES
|
|
|
212
|
|
|
213 #---------------------------------------------------------------------------
|
|
|
214 # Build related configuration options
|
|
|
215 #---------------------------------------------------------------------------
|
|
|
216
|
|
|
217 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
|
|
218 # documentation are documented, even if no documentation was available.
|
|
|
219 # Private class members and static file members will be hidden unless
|
|
|
220 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
|
|
221
|
|
|
222 EXTRACT_ALL = NO
|
|
|
223
|
|
|
224 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
|
|
225 # will be included in the documentation.
|
|
|
226
|
|
|
227 EXTRACT_PRIVATE = NO
|
|
|
228
|
|
|
229 # If the EXTRACT_STATIC tag is set to YES all static members of a file
|
|
|
230 # will be included in the documentation.
|
|
|
231
|
|
|
232 EXTRACT_STATIC = NO
|
|
|
233
|
|
|
234 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
|
|
|
235 # defined locally in source files will be included in the documentation.
|
|
|
236 # If set to NO only classes defined in header files are included.
|
|
|
237
|
|
|
238 EXTRACT_LOCAL_CLASSES = YES
|
|
|
239
|
|
|
240 # This flag is only useful for Objective-C code. When set to YES local
|
|
|
241 # methods, which are defined in the implementation section but not in
|
|
|
242 # the interface are included in the documentation.
|
|
|
243 # If set to NO (the default) only methods in the interface are included.
|
|
|
244
|
|
|
245 EXTRACT_LOCAL_METHODS = NO
|
|
|
246
|
|
|
247 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
|
|
248 # undocumented members of documented classes, files or namespaces.
|
|
|
249 # If set to NO (the default) these members will be included in the
|
|
|
250 # various overviews, but no documentation section is generated.
|
|
|
251 # This option has no effect if EXTRACT_ALL is enabled.
|
|
|
252
|
|
|
253 HIDE_UNDOC_MEMBERS = NO
|
|
|
254
|
|
|
255 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
|
|
256 # undocumented classes that are normally visible in the class hierarchy.
|
|
|
257 # If set to NO (the default) these classes will be included in the various
|
|
|
258 # overviews. This option has no effect if EXTRACT_ALL is enabled.
|
|
|
259
|
|
|
260 HIDE_UNDOC_CLASSES = NO
|
|
|
261
|
|
|
262 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
|
|
|
263 # friend (class|struct|union) declarations.
|
|
|
264 # If set to NO (the default) these declarations will be included in the
|
|
|
265 # documentation.
|
|
|
266
|
|
|
267 HIDE_FRIEND_COMPOUNDS = NO
|
|
|
268
|
|
|
269 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
|
|
|
270 # documentation blocks found inside the body of a function.
|
|
|
271 # If set to NO (the default) these blocks will be appended to the
|
|
|
272 # function's detailed documentation block.
|
|
|
273
|
|
|
274 HIDE_IN_BODY_DOCS = NO
|
|
|
275
|
|
|
276 # The INTERNAL_DOCS tag determines if documentation
|
|
|
277 # that is typed after a \internal command is included. If the tag is set
|
|
|
278 # to NO (the default) then the documentation will be excluded.
|
|
|
279 # Set it to YES to include the internal documentation.
|
|
|
280
|
|
|
281 INTERNAL_DOCS = NO
|
|
|
282
|
|
|
283 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
|
|
284 # file names in lower-case letters. If set to YES upper-case letters are also
|
|
|
285 # allowed. This is useful if you have classes or files whose names only differ
|
|
|
286 # in case and if your file system supports case sensitive file names. Windows
|
|
|
287 # and Mac users are advised to set this option to NO.
|
|
|
288
|
|
|
289 CASE_SENSE_NAMES = YES
|
|
|
290
|
|
|
291 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
|
|
292 # will show members with their full class and namespace scopes in the
|
|
|
293 # documentation. If set to YES the scope will be hidden.
|
|
|
294
|
|
|
295 HIDE_SCOPE_NAMES = NO
|
|
|
296
|
|
|
297 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
|
|
|
298 # will put a list of the files that are included by a file in the documentation
|
|
|
299 # of that file.
|
|
|
300
|
|
|
301 SHOW_INCLUDE_FILES = YES
|
|
|
302
|
|
|
303 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
|
|
304 # is inserted in the documentation for inline members.
|
|
|
305
|
|
|
306 INLINE_INFO = YES
|
|
|
307
|
|
|
308 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
|
|
309 # will sort the (detailed) documentation of file and class members
|
|
|
310 # alphabetically by member name. If set to NO the members will appear in
|
|
|
311 # declaration order.
|
|
|
312
|
|
|
313 SORT_MEMBER_DOCS = YES
|
|
|
314
|
|
|
315 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
|
|
|
316 # brief documentation of file, namespace and class members alphabetically
|
|
|
317 # by member name. If set to NO (the default) the members will appear in
|
|
|
318 # declaration order.
|
|
|
319
|
|
|
320 SORT_BRIEF_DOCS = NO
|
|
|
321
|
|
|
322 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
|
|
|
323 # sorted by fully-qualified names, including namespaces. If set to
|
|
|
324 # NO (the default), the class list will be sorted only by class name,
|
|
|
325 # not including the namespace part.
|
|
|
326 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
|
|
327 # Note: This option applies only to the class list, not to the
|
|
|
328 # alphabetical list.
|
|
|
329
|
|
|
330 SORT_BY_SCOPE_NAME = NO
|
|
|
331
|
|
|
332 # The GENERATE_TODOLIST tag can be used to enable (YES) or
|
|
|
333 # disable (NO) the todo list. This list is created by putting \todo
|
|
|
334 # commands in the documentation.
|
|
|
335
|
|
|
336 GENERATE_TODOLIST = YES
|
|
|
337
|
|
|
338 # The GENERATE_TESTLIST tag can be used to enable (YES) or
|
|
|
339 # disable (NO) the test list. This list is created by putting \test
|
|
|
340 # commands in the documentation.
|
|
|
341
|
|
|
342 GENERATE_TESTLIST = YES
|
|
|
343
|
|
|
344 # The GENERATE_BUGLIST tag can be used to enable (YES) or
|
|
|
345 # disable (NO) the bug list. This list is created by putting \bug
|
|
|
346 # commands in the documentation.
|
|
|
347
|
|
|
348 GENERATE_BUGLIST = YES
|
|
|
349
|
|
|
350 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
|
|
|
351 # disable (NO) the deprecated list. This list is created by putting
|
|
|
352 # \deprecated commands in the documentation.
|
|
|
353
|
|
|
354 GENERATE_DEPRECATEDLIST= YES
|
|
|
355
|
|
|
356 # The ENABLED_SECTIONS tag can be used to enable conditional
|
|
|
357 # documentation sections, marked by \if sectionname ... \endif.
|
|
|
358
|
|
|
359 ENABLED_SECTIONS =
|
|
|
360
|
|
|
361 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
|
|
362 # the initial value of a variable or define consists of for it to appear in
|
|
|
363 # the documentation. If the initializer consists of more lines than specified
|
|
|
364 # here it will be hidden. Use a value of 0 to hide initializers completely.
|
|
|
365 # The appearance of the initializer of individual variables and defines in the
|
|
|
366 # documentation can be controlled using \showinitializer or \hideinitializer
|
|
|
367 # command in the documentation regardless of this setting.
|
|
|
368
|
|
|
369 MAX_INITIALIZER_LINES = 30
|
|
|
370
|
|
|
371 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
|
|
372 # at the bottom of the documentation of classes and structs. If set to YES the
|
|
|
373 # list will mention the files that were used to generate the documentation.
|
|
|
374
|
|
|
375 SHOW_USED_FILES = YES
|
|
|
376
|
|
|
377 # If the sources in your project are distributed over multiple directories
|
|
|
378 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
|
|
|
379 # in the documentation. The default is YES.
|
|
|
380
|
|
|
381 SHOW_DIRECTORIES = YES
|
|
|
382
|
|
|
383 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
|
|
384 # doxygen should invoke to get the current version for each file (typically from the
|
|
|
385 # version control system). Doxygen will invoke the program by executing (via
|
|
|
386 # popen()) the command <command> <input-file>, where <command> is the value of
|
|
|
387 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
|
|
|
388 # provided by doxygen. Whatever the progam writes to standard output
|
|
|
389 # is used as the file version. See the manual for examples.
|
|
|
390
|
|
|
391 FILE_VERSION_FILTER =
|
|
|
392
|
|
|
393 #---------------------------------------------------------------------------
|
|
|
394 # configuration options related to warning and progress messages
|
|
|
395 #---------------------------------------------------------------------------
|
|
|
396
|
|
|
397 # The QUIET tag can be used to turn on/off the messages that are generated
|
|
|
398 # by doxygen. Possible values are YES and NO. If left blank NO is used.
|
|
|
399
|
|
|
400 QUIET = NO
|
|
|
401
|
|
|
402 # The WARNINGS tag can be used to turn on/off the warning messages that are
|
|
|
403 # generated by doxygen. Possible values are YES and NO. If left blank
|
|
|
404 # NO is used.
|
|
|
405
|
|
|
406 WARNINGS = YES
|
|
|
407
|
|
|
408 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
|
|
409 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
|
|
410 # automatically be disabled.
|
|
|
411
|
|
|
412 WARN_IF_UNDOCUMENTED = YES
|
|
|
413
|
|
|
414 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
|
|
|
415 # potential errors in the documentation, such as not documenting some
|
|
|
416 # parameters in a documented function, or documenting parameters that
|
|
|
417 # don't exist or using markup commands wrongly.
|
|
|
418
|
|
|
419 WARN_IF_DOC_ERROR = YES
|
|
|
420
|
|
|
421 # This WARN_NO_PARAMDOC option can be abled to get warnings for
|
|
|
422 # functions that are documented, but have no documentation for their parameters
|
|
|
423 # or return value. If set to NO (the default) doxygen will only warn about
|
|
|
424 # wrong or incomplete parameter documentation, but not about the absence of
|
|
|
425 # documentation.
|
|
|
426
|
|
|
427 WARN_NO_PARAMDOC = NO
|
|
|
428
|
|
|
429 # The WARN_FORMAT tag determines the format of the warning messages that
|
|
|
430 # doxygen can produce. The string should contain the $file, $line, and $text
|
|
|
431 # tags, which will be replaced by the file and line number from which the
|
|
|
432 # warning originated and the warning text. Optionally the format may contain
|
|
|
433 # $version, which will be replaced by the version of the file (if it could
|
|
|
434 # be obtained via FILE_VERSION_FILTER)
|
|
|
435
|
|
|
436 WARN_FORMAT =
|
|
|
437
|
|
|
438 # The WARN_LOGFILE tag can be used to specify a file to which warning
|
|
|
439 # and error messages should be written. If left blank the output is written
|
|
|
440 # to stderr.
|
|
|
441
|
|
|
442 WARN_LOGFILE =
|
|
|
443
|
|
|
444 #---------------------------------------------------------------------------
|
|
|
445 # configuration options related to the input files
|
|
|
446 #---------------------------------------------------------------------------
|
|
|
447
|
|
|
448 # The INPUT tag can be used to specify the files and/or directories that contain
|
|
|
449 # documented source files. You may enter file names like "myfile.cpp" or
|
|
|
450 # directories like "/usr/src/myproject". Separate the files or directories
|
|
|
451 # with spaces.
|
|
|
452
|
|
|
453 INPUT = ..
|
|
|
454
|
|
|
455 # If the value of the INPUT tag contains directories, you can use the
|
|
|
456 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
|
|
457 # and *.h) to filter out the source-files in the directories. If left
|
|
|
458 # blank the following patterns are tested:
|
|
|
459 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
|
|
|
460 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
|
|
|
461
|
|
|
462 FILE_PATTERNS = *.c \
|
|
|
463 *.h
|
|
|
464
|
|
|
465 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
|
|
466 # should be searched for input files as well. Possible values are YES and NO.
|
|
|
467 # If left blank NO is used.
|
|
|
468
|
|
|
469 RECURSIVE = YES
|
|
|
470
|
|
|
471 # The EXCLUDE tag can be used to specify files and/or directories that should
|
|
|
472 # excluded from the INPUT source files. This way you can easily exclude a
|
|
|
473 # subdirectory from a directory tree whose root is specified with the INPUT tag.
|
|
|
474
|
|
|
475 EXCLUDE =
|
|
|
476
|
|
|
477 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
|
|
|
478 # directories that are symbolic links (a Unix filesystem feature) are excluded
|
|
|
479 # from the input.
|
|
|
480
|
|
|
481 EXCLUDE_SYMLINKS = NO
|
|
|
482
|
|
|
483 # If the value of the INPUT tag contains directories, you can use the
|
|
|
484 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
|
|
485 # certain files from those directories. Note that the wildcards are matched
|
|
|
486 # against the file with absolute path, so to exclude all test directories
|
|
|
487 # for example use the pattern */test/*
|
|
|
488
|
|
|
489 EXCLUDE_PATTERNS =
|
|
|
490
|
|
|
491 # The EXAMPLE_PATH tag can be used to specify one or more files or
|
|
|
492 # directories that contain example code fragments that are included (see
|
|
|
493 # the \include command).
|
|
|
494
|
|
|
495 EXAMPLE_PATH =
|
|
|
496
|
|
|
497 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
|
|
498 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
|
|
499 # and *.h) to filter out the source-files in the directories. If left
|
|
|
500 # blank all files are included.
|
|
|
501
|
|
|
502 EXAMPLE_PATTERNS =
|
|
|
503
|
|
|
504 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
|
|
505 # searched for input files to be used with the \include or \dontinclude
|
|
|
506 # commands irrespective of the value of the RECURSIVE tag.
|
|
|
507 # Possible values are YES and NO. If left blank NO is used.
|
|
|
508
|
|
|
509 EXAMPLE_RECURSIVE = NO
|
|
|
510
|
|
|
511 # The IMAGE_PATH tag can be used to specify one or more files or
|
|
|
512 # directories that contain image that are included in the documentation (see
|
|
|
513 # the \image command).
|
|
|
514
|
|
|
515 IMAGE_PATH =
|
|
|
516
|
|
|
517 # The INPUT_FILTER tag can be used to specify a program that doxygen should
|
|
|
518 # invoke to filter for each input file. Doxygen will invoke the filter program
|
|
|
519 # by executing (via popen()) the command <filter> <input-file>, where <filter>
|
|
|
520 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
|
|
521 # input file. Doxygen will then use the output that the filter program writes
|
|
|
522 # to standard output. If FILTER_PATTERNS is specified, this tag will be
|
|
|
523 # ignored.
|
|
|
524
|
|
|
525 INPUT_FILTER =
|
|
|
526
|
|
|
527 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
|
|
528 # basis. Doxygen will compare the file name with each pattern and apply the
|
|
|
529 # filter if there is a match. The filters are a list of the form:
|
|
|
530 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
|
|
|
531 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
|
|
|
532 # is applied to all files.
|
|
|
533
|
|
|
534 FILTER_PATTERNS =
|
|
|
535
|
|
|
536 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
|
|
537 # INPUT_FILTER) will be used to filter the input files when producing source
|
|
|
538 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
|
|
539
|
|
|
540 FILTER_SOURCE_FILES = NO
|
|
|
541
|
|
|
542 #---------------------------------------------------------------------------
|
|
|
543 # configuration options related to source browsing
|
|
|
544 #---------------------------------------------------------------------------
|
|
|
545
|
|
|
546 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
|
|
547 # be generated. Documented entities will be cross-referenced with these sources.
|
|
|
548 # Note: To get rid of all source code in the generated output, make sure also
|
|
|
549 # VERBATIM_HEADERS is set to NO.
|
|
|
550
|
|
|
551 SOURCE_BROWSER = NO
|
|
|
552
|
|
|
553 # Setting the INLINE_SOURCES tag to YES will include the body
|
|
|
554 # of functions and classes directly in the documentation.
|
|
|
555
|
|
|
556 INLINE_SOURCES = NO
|
|
|
557
|
|
|
558 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
|
|
559 # doxygen to hide any special comment blocks from generated source code
|
|
|
560 # fragments. Normal C and C++ comments will always remain visible.
|
|
|
561
|
|
|
562 STRIP_CODE_COMMENTS = NO
|
|
|
563
|
|
|
564 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
|
|
|
565 # then for each documented function all documented
|
|
|
566 # functions referencing it will be listed.
|
|
|
567
|
|
|
568 REFERENCED_BY_RELATION = YES
|
|
|
569
|
|
|
570 # If the REFERENCES_RELATION tag is set to YES (the default)
|
|
|
571 # then for each documented function all documented entities
|
|
|
572 # called/used by that function will be listed.
|
|
|
573
|
|
|
574 REFERENCES_RELATION = YES
|
|
|
575
|
|
|
576 # If the USE_HTAGS tag is set to YES then the references to source code
|
|
|
577 # will point to the HTML generated by the htags(1) tool instead of doxygen
|
|
|
578 # built-in source browser. The htags tool is part of GNU's global source
|
|
|
579 # tagging system (see http://www.gnu.org/software/global/global.html). You
|
|
|
580 # will need version 4.8.6 or higher.
|
|
|
581
|
|
|
582 USE_HTAGS = NO
|
|
|
583
|
|
|
584 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
|
|
585 # will generate a verbatim copy of the header file for each class for
|
|
|
586 # which an include is specified. Set to NO to disable this.
|
|
|
587
|
|
|
588 VERBATIM_HEADERS = YES
|
|
|
589
|
|
|
590 #---------------------------------------------------------------------------
|
|
|
591 # configuration options related to the alphabetical class index
|
|
|
592 #---------------------------------------------------------------------------
|
|
|
593
|
|
|
594 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
|
|
595 # of all compounds will be generated. Enable this if the project
|
|
|
596 # contains a lot of classes, structs, unions or interfaces.
|
|
|
597
|
|
|
598 ALPHABETICAL_INDEX = YES
|
|
|
599
|
|
|
600 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
|
|
601 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
|
|
602 # in which this list will be split (can be a number in the range [1..20])
|
|
|
603
|
|
|
604 COLS_IN_ALPHA_INDEX = 2
|
|
|
605
|
|
|
606 # In case all classes in a project start with a common prefix, all
|
|
|
607 # classes will be put under the same header in the alphabetical index.
|
|
|
608 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
|
|
609 # should be ignored while generating the index headers.
|
|
|
610
|
|
|
611 IGNORE_PREFIX =
|
|
|
612
|
|
|
613 #---------------------------------------------------------------------------
|
|
|
614 # configuration options related to the HTML output
|
|
|
615 #---------------------------------------------------------------------------
|
|
|
616
|
|
|
617 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
|
|
618 # generate HTML output.
|
|
|
619
|
|
|
620 GENERATE_HTML = YES
|
|
|
621
|
|
|
622 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
|
|
623 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
624 # put in front of it. If left blank `html' will be used as the default path.
|
|
|
625
|
|
|
626 HTML_OUTPUT =
|
|
|
627
|
|
|
628 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
|
|
629 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
|
|
630 # doxygen will generate files with .html extension.
|
|
|
631
|
|
|
632 HTML_FILE_EXTENSION = .html
|
|
|
633
|
|
|
634 # The HTML_HEADER tag can be used to specify a personal HTML header for
|
|
|
635 # each generated HTML page. If it is left blank doxygen will generate a
|
|
|
636 # standard header.
|
|
|
637
|
|
|
638 HTML_HEADER =
|
|
|
639
|
|
|
640 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
|
|
641 # each generated HTML page. If it is left blank doxygen will generate a
|
|
|
642 # standard footer.
|
|
|
643
|
|
|
644 HTML_FOOTER =
|
|
|
645
|
|
|
646 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
|
|
647 # style sheet that is used by each HTML page. It can be used to
|
|
|
648 # fine-tune the look of the HTML output. If the tag is left blank doxygen
|
|
|
649 # will generate a default style sheet. Note that doxygen will try to copy
|
|
|
650 # the style sheet file to the HTML output directory, so don't put your own
|
|
|
651 # stylesheet in the HTML output directory as well, or it will be erased!
|
|
|
652
|
|
|
653 HTML_STYLESHEET = css.css
|
|
|
654
|
|
|
655 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
|
|
656 # files or namespaces will be aligned in HTML using tables. If set to
|
|
|
657 # NO a bullet list will be used.
|
|
|
658
|
|
|
659 HTML_ALIGN_MEMBERS = YES
|
|
|
660
|
|
|
661 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
|
|
662 # will be generated that can be used as input for tools like the
|
|
|
663 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
|
|
|
664 # of the generated HTML documentation.
|
|
|
665
|
|
|
666 GENERATE_HTMLHELP = NO
|
|
|
667
|
|
|
668 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
|
|
|
669 # be used to specify the file name of the resulting .chm file. You
|
|
|
670 # can add a path in front of the file if the result should not be
|
|
|
671 # written to the html output directory.
|
|
|
672
|
|
|
673 CHM_FILE =
|
|
|
674
|
|
|
675 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
|
|
|
676 # be used to specify the location (absolute path including file name) of
|
|
|
677 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
|
|
|
678 # the HTML help compiler on the generated index.hhp.
|
|
|
679
|
|
|
680 HHC_LOCATION =
|
|
|
681
|
|
|
682 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
|
|
|
683 # controls if a separate .chi index file is generated (YES) or that
|
|
|
684 # it should be included in the master .chm file (NO).
|
|
|
685
|
|
|
686 GENERATE_CHI = NO
|
|
|
687
|
|
|
688 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
|
|
689 # controls whether a binary table of contents is generated (YES) or a
|
|
|
690 # normal table of contents (NO) in the .chm file.
|
|
|
691
|
|
|
692 BINARY_TOC = NO
|
|
|
693
|
|
|
694 # The TOC_EXPAND flag can be set to YES to add extra items for group members
|
|
|
695 # to the contents of the HTML help documentation and to the tree view.
|
|
|
696
|
|
|
697 TOC_EXPAND = NO
|
|
|
698
|
|
|
699 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
|
|
700 # top of each HTML page. The value NO (the default) enables the index and
|
|
|
701 # the value YES disables it.
|
|
|
702
|
|
|
703 DISABLE_INDEX = NO
|
|
|
704
|
|
|
705 # This tag can be used to set the number of enum values (range [1..20])
|
|
|
706 # that doxygen will group on one line in the generated HTML documentation.
|
|
|
707
|
|
|
708 ENUM_VALUES_PER_LINE = 4
|
|
|
709
|
|
|
710 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
|
|
|
711 # generated containing a tree-like index structure (just like the one that
|
|
|
712 # is generated for HTML Help). For this to work a browser that supports
|
|
|
713 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
|
|
|
714 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
|
|
|
715 # probably better off using the HTML help feature.
|
|
|
716
|
|
|
717 GENERATE_TREEVIEW = YES
|
|
|
718
|
|
|
719 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
|
|
720 # used to set the initial width (in pixels) of the frame in which the tree
|
|
|
721 # is shown.
|
|
|
722
|
|
|
723 TREEVIEW_WIDTH = 250
|
|
|
724
|
|
|
725 #---------------------------------------------------------------------------
|
|
|
726 # configuration options related to the LaTeX output
|
|
|
727 #---------------------------------------------------------------------------
|
|
|
728
|
|
|
729 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
|
|
730 # generate Latex output.
|
|
|
731
|
|
|
732 GENERATE_LATEX = NO
|
|
|
733
|
|
|
734 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
|
|
735 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
736 # put in front of it. If left blank `latex' will be used as the default path.
|
|
|
737
|
|
|
738 LATEX_OUTPUT =
|
|
|
739
|
|
|
740 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
|
|
741 # invoked. If left blank `latex' will be used as the default command name.
|
|
|
742
|
|
|
743 LATEX_CMD_NAME = latex
|
|
|
744
|
|
|
745 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
|
|
746 # generate index for LaTeX. If left blank `makeindex' will be used as the
|
|
|
747 # default command name.
|
|
|
748
|
|
|
749 MAKEINDEX_CMD_NAME = makeindex
|
|
|
750
|
|
|
751 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
|
|
752 # LaTeX documents. This may be useful for small projects and may help to
|
|
|
753 # save some trees in general.
|
|
|
754
|
|
|
755 COMPACT_LATEX = NO
|
|
|
756
|
|
|
757 # The PAPER_TYPE tag can be used to set the paper type that is used
|
|
|
758 # by the printer. Possible values are: a4, a4wide, letter, legal and
|
|
|
759 # executive. If left blank a4wide will be used.
|
|
|
760
|
|
|
761 PAPER_TYPE = a4wide
|
|
|
762
|
|
|
763 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
|
|
764 # packages that should be included in the LaTeX output.
|
|
|
765
|
|
|
766 EXTRA_PACKAGES =
|
|
|
767
|
|
|
768 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
|
|
769 # the generated latex document. The header should contain everything until
|
|
|
770 # the first chapter. If it is left blank doxygen will generate a
|
|
|
771 # standard header. Notice: only use this tag if you know what you are doing!
|
|
|
772
|
|
|
773 LATEX_HEADER =
|
|
|
774
|
|
|
775 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
|
|
776 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
|
|
777 # contain links (just like the HTML output) instead of page references
|
|
|
778 # This makes the output suitable for online browsing using a pdf viewer.
|
|
|
779
|
|
|
780 PDF_HYPERLINKS = NO
|
|
|
781
|
|
|
782 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
|
|
783 # plain latex in the generated Makefile. Set this option to YES to get a
|
|
|
784 # higher quality PDF documentation.
|
|
|
785
|
|
|
786 USE_PDFLATEX = NO
|
|
|
787
|
|
|
788 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
|
|
789 # command to the generated LaTeX files. This will instruct LaTeX to keep
|
|
|
790 # running if errors occur, instead of asking the user for help.
|
|
|
791 # This option is also used when generating formulas in HTML.
|
|
|
792
|
|
|
793 LATEX_BATCHMODE = NO
|
|
|
794
|
|
|
795 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
|
|
|
796 # include the index chapters (such as File Index, Compound Index, etc.)
|
|
|
797 # in the output.
|
|
|
798
|
|
|
799 LATEX_HIDE_INDICES = NO
|
|
|
800
|
|
|
801 #---------------------------------------------------------------------------
|
|
|
802 # configuration options related to the RTF output
|
|
|
803 #---------------------------------------------------------------------------
|
|
|
804
|
|
|
805 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
|
|
806 # The RTF output is optimized for Word 97 and may not look very pretty with
|
|
|
807 # other RTF readers or editors.
|
|
|
808
|
|
|
809 GENERATE_RTF = NO
|
|
|
810
|
|
|
811 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
|
|
812 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
813 # put in front of it. If left blank `rtf' will be used as the default path.
|
|
|
814
|
|
|
815 RTF_OUTPUT =
|
|
|
816
|
|
|
817 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
|
|
818 # RTF documents. This may be useful for small projects and may help to
|
|
|
819 # save some trees in general.
|
|
|
820
|
|
|
821 COMPACT_RTF = NO
|
|
|
822
|
|
|
823 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
|
|
824 # will contain hyperlink fields. The RTF file will
|
|
|
825 # contain links (just like the HTML output) instead of page references.
|
|
|
826 # This makes the output suitable for online browsing using WORD or other
|
|
|
827 # programs which support those fields.
|
|
|
828 # Note: wordpad (write) and others do not support links.
|
|
|
829
|
|
|
830 RTF_HYPERLINKS = NO
|
|
|
831
|
|
|
832 # Load stylesheet definitions from file. Syntax is similar to doxygen's
|
|
|
833 # config file, i.e. a series of assignments. You only have to provide
|
|
|
834 # replacements, missing definitions are set to their default value.
|
|
|
835
|
|
|
836 RTF_STYLESHEET_FILE =
|
|
|
837
|
|
|
838 # Set optional variables used in the generation of an rtf document.
|
|
|
839 # Syntax is similar to doxygen's config file.
|
|
|
840
|
|
|
841 RTF_EXTENSIONS_FILE =
|
|
|
842
|
|
|
843 #---------------------------------------------------------------------------
|
|
|
844 # configuration options related to the man page output
|
|
|
845 #---------------------------------------------------------------------------
|
|
|
846
|
|
|
847 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
|
|
848 # generate man pages
|
|
|
849
|
|
|
850 GENERATE_MAN = NO
|
|
|
851
|
|
|
852 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
|
|
853 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
854 # put in front of it. If left blank `man' will be used as the default path.
|
|
|
855
|
|
|
856 MAN_OUTPUT =
|
|
|
857
|
|
|
858 # The MAN_EXTENSION tag determines the extension that is added to
|
|
|
859 # the generated man pages (default is the subroutine's section .3)
|
|
|
860
|
|
|
861 MAN_EXTENSION =
|
|
|
862
|
|
|
863 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
|
|
|
864 # then it will generate one additional man file for each entity
|
|
|
865 # documented in the real man page(s). These additional files
|
|
|
866 # only source the real man page, but without them the man command
|
|
|
867 # would be unable to find the correct page. The default is NO.
|
|
|
868
|
|
|
869 MAN_LINKS = NO
|
|
|
870
|
|
|
871 #---------------------------------------------------------------------------
|
|
|
872 # configuration options related to the XML output
|
|
|
873 #---------------------------------------------------------------------------
|
|
|
874
|
|
|
875 # If the GENERATE_XML tag is set to YES Doxygen will
|
|
|
876 # generate an XML file that captures the structure of
|
|
|
877 # the code including all documentation.
|
|
|
878
|
|
|
879 GENERATE_XML = NO
|
|
|
880
|
|
|
881 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
|
|
|
882 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
|
883 # put in front of it. If left blank `xml' will be used as the default path.
|
|
|
884
|
|
|
885 XML_OUTPUT = xml
|
|
|
886
|
|
|
887 # The XML_SCHEMA tag can be used to specify an XML schema,
|
|
|
888 # which can be used by a validating XML parser to check the
|
|
|
889 # syntax of the XML files.
|
|
|
890
|
|
|
891 XML_SCHEMA =
|
|
|
892
|
|
|
893 # The XML_DTD tag can be used to specify an XML DTD,
|
|
|
894 # which can be used by a validating XML parser to check the
|
|
|
895 # syntax of the XML files.
|
|
|
896
|
|
|
897 XML_DTD =
|
|
|
898
|
|
|
899 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
|
|
|
900 # dump the program listings (including syntax highlighting
|
|
|
901 # and cross-referencing information) to the XML output. Note that
|
|
|
902 # enabling this will significantly increase the size of the XML output.
|
|
|
903
|
|
|
904 XML_PROGRAMLISTING = YES
|
|
|
905
|
|
|
906 #---------------------------------------------------------------------------
|
|
|
907 # configuration options for the AutoGen Definitions output
|
|
|
908 #---------------------------------------------------------------------------
|
|
|
909
|
|
|
910 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
|
|
911 # generate an AutoGen Definitions (see autogen.sf.net) file
|
|
|
912 # that captures the structure of the code including all
|
|
|
913 # documentation. Note that this feature is still experimental
|
|
|
914 # and incomplete at the moment.
|
|
|
915
|
|
|
916 GENERATE_AUTOGEN_DEF = NO
|
|
|
917
|
|
|
918 #---------------------------------------------------------------------------
|
|
|
919 # configuration options related to the Perl module output
|
|
|
920 #---------------------------------------------------------------------------
|
|
|
921
|
|
|
922 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
|
|
|
923 # generate a Perl module file that captures the structure of
|
|
|
924 # the code including all documentation. Note that this
|
|
|
925 # feature is still experimental and incomplete at the
|
|
|
926 # moment.
|
|
|
927
|
|
|
928 GENERATE_PERLMOD = NO
|
|
|
929
|
|
|
930 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
|
|
|
931 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
|
|
|
932 # to generate PDF and DVI output from the Perl module output.
|
|
|
933
|
|
|
934 PERLMOD_LATEX = NO
|
|
|
935
|
|
|
936 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
|
|
937 # nicely formatted so it can be parsed by a human reader. This is useful
|
|
|
938 # if you want to understand what is going on. On the other hand, if this
|
|
|
939 # tag is set to NO the size of the Perl module output will be much smaller
|
|
|
940 # and Perl will parse it just the same.
|
|
|
941
|
|
|
942 PERLMOD_PRETTY = YES
|
|
|
943
|
|
|
944 # The names of the make variables in the generated doxyrules.make file
|
|
|
945 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
|
|
|
946 # This is useful so different doxyrules.make files included by the same
|
|
|
947 # Makefile don't overwrite each other's variables.
|
|
|
948
|
|
|
949 PERLMOD_MAKEVAR_PREFIX =
|
|
|
950
|
|
|
951 #---------------------------------------------------------------------------
|
|
|
952 # Configuration options related to the preprocessor
|
|
|
953 #---------------------------------------------------------------------------
|
|
|
954
|
|
|
955 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
|
|
956 # evaluate all C-preprocessor directives found in the sources and include
|
|
|
957 # files.
|
|
|
958
|
|
|
959 ENABLE_PREPROCESSING = YES
|
|
|
960
|
|
|
961 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
|
|
962 # names in the source code. If set to NO (the default) only conditional
|
|
|
963 # compilation will be performed. Macro expansion can be done in a controlled
|
|
|
964 # way by setting EXPAND_ONLY_PREDEF to YES.
|
|
|
965
|
|
|
966 MACRO_EXPANSION = NO
|
|
|
967
|
|
|
968 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
|
|
969 # then the macro expansion is limited to the macros specified with the
|
|
|
970 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
|
|
|
971
|
|
|
972 EXPAND_ONLY_PREDEF = NO
|
|
|
973
|
|
|
974 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
|
|
975 # in the INCLUDE_PATH (see below) will be search if a #include is found.
|
|
|
976
|
|
|
977 SEARCH_INCLUDES = YES
|
|
|
978
|
|
|
979 # The INCLUDE_PATH tag can be used to specify one or more directories that
|
|
|
980 # contain include files that are not input files but should be processed by
|
|
|
981 # the preprocessor.
|
|
|
982
|
|
|
983 INCLUDE_PATH =
|
|
|
984
|
|
|
985 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
|
|
986 # patterns (like *.h and *.hpp) to filter out the header-files in the
|
|
|
987 # directories. If left blank, the patterns specified with FILE_PATTERNS will
|
|
|
988 # be used.
|
|
|
989
|
|
|
990 INCLUDE_FILE_PATTERNS =
|
|
|
991
|
|
|
992 # The PREDEFINED tag can be used to specify one or more macro names that
|
|
|
993 # are defined before the preprocessor is started (similar to the -D option of
|
|
|
994 # gcc). The argument of the tag is a list of macros of the form: name
|
|
|
995 # or name=definition (no spaces). If the definition and the = are
|
|
|
996 # omitted =1 is assumed. To prevent a macro definition from being
|
|
|
997 # undefined via #undef or recursively expanded use the := operator
|
|
|
998 # instead of the = operator.
|
|
|
999
|
|
|
1000 PREDEFINED =
|
|
|
1001
|
|
|
1002 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
|
|
1003 # this tag can be used to specify a list of macro names that should be expanded.
|
|
|
1004 # The macro definition that is found in the sources will be used.
|
|
|
1005 # Use the PREDEFINED tag if you want to use a different macro definition.
|
|
|
1006
|
|
|
1007 EXPAND_AS_DEFINED =
|
|
|
1008
|
|
|
1009 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
|
|
1010 # doxygen's preprocessor will remove all function-like macros that are alone
|
|
|
1011 # on a line, have an all uppercase name, and do not end with a semicolon. Such
|
|
|
1012 # function macros are typically used for boiler-plate code, and will confuse
|
|
|
1013 # the parser if not removed.
|
|
|
1014
|
|
|
1015 SKIP_FUNCTION_MACROS = YES
|
|
|
1016
|
|
|
1017 #---------------------------------------------------------------------------
|
|
|
1018 # Configuration::additions related to external references
|
|
|
1019 #---------------------------------------------------------------------------
|
|
|
1020
|
|
|
1021 # The TAGFILES option can be used to specify one or more tagfiles.
|
|
|
1022 # Optionally an initial location of the external documentation
|
|
|
1023 # can be added for each tagfile. The format of a tag file without
|
|
|
1024 # this location is as follows:
|
|
|
1025 # TAGFILES = file1 file2 ...
|
|
|
1026 # Adding location for the tag files is done as follows:
|
|
|
1027 # TAGFILES = file1=loc1 "file2 = loc2" ...
|
|
|
1028 # where "loc1" and "loc2" can be relative or absolute paths or
|
|
|
1029 # URLs. If a location is present for each tag, the installdox tool
|
|
|
1030 # does not have to be run to correct the links.
|
|
|
1031 # Note that each tag file must have a unique name
|
|
|
1032 # (where the name does NOT include the path)
|
|
|
1033 # If a tag file is not located in the directory in which doxygen
|
|
|
1034 # is run, you must also specify the path to the tagfile here.
|
|
|
1035
|
|
|
1036 TAGFILES =
|
|
|
1037
|
|
|
1038 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
|
|
1039 # a tag file that is based on the input files it reads.
|
|
|
1040
|
|
|
1041 GENERATE_TAGFILE =
|
|
|
1042
|
|
|
1043 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
|
|
1044 # in the class index. If set to NO only the inherited external classes
|
|
|
1045 # will be listed.
|
|
|
1046
|
|
|
1047 ALLEXTERNALS = NO
|
|
|
1048
|
|
|
1049 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
|
|
1050 # in the modules index. If set to NO, only the current project's groups will
|
|
|
1051 # be listed.
|
|
|
1052
|
|
|
1053 EXTERNAL_GROUPS = YES
|
|
|
1054
|
|
|
1055 # The PERL_PATH should be the absolute path and name of the perl script
|
|
|
1056 # interpreter (i.e. the result of `which perl').
|
|
|
1057
|
|
|
1058 PERL_PATH = /usr/bin/perl
|
|
|
1059
|
|
|
1060 #---------------------------------------------------------------------------
|
|
|
1061 # Configuration options related to the dot tool
|
|
|
1062 #---------------------------------------------------------------------------
|
|
|
1063
|
|
|
1064 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
|
|
1065 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
|
|
1066 # or super classes. Setting the tag to NO turns the diagrams off. Note that
|
|
|
1067 # this option is superseded by the HAVE_DOT option below. This is only a
|
|
|
1068 # fallback. It is recommended to install and use dot, since it yields more
|
|
|
1069 # powerful graphs.
|
|
|
1070
|
|
|
1071 CLASS_DIAGRAMS = YES
|
|
|
1072
|
|
|
1073 # If set to YES, the inheritance and collaboration graphs will hide
|
|
|
1074 # inheritance and usage relations if the target is undocumented
|
|
|
1075 # or is not a class.
|
|
|
1076
|
|
|
1077 HIDE_UNDOC_RELATIONS = YES
|
|
|
1078
|
|
|
1079 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
|
|
1080 # available from the path. This tool is part of Graphviz, a graph visualization
|
|
|
1081 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
|
|
1082 # have no effect if this option is set to NO (the default)
|
|
|
1083
|
|
|
1084 HAVE_DOT = NO
|
|
|
1085
|
|
|
1086 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
|
1087 # will generate a graph for each documented class showing the direct and
|
|
|
1088 # indirect inheritance relations. Setting this tag to YES will force the
|
|
|
1089 # the CLASS_DIAGRAMS tag to NO.
|
|
|
1090
|
|
|
1091 CLASS_GRAPH = YES
|
|
|
1092
|
|
|
1093 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
|
1094 # will generate a graph for each documented class showing the direct and
|
|
|
1095 # indirect implementation dependencies (inheritance, containment, and
|
|
|
1096 # class references variables) of the class with other documented classes.
|
|
|
1097
|
|
|
1098 COLLABORATION_GRAPH = YES
|
|
|
1099
|
|
|
1100 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
|
|
|
1101 # will generate a graph for groups, showing the direct groups dependencies
|
|
|
1102
|
|
|
1103 GROUP_GRAPHS = YES
|
|
|
1104
|
|
|
1105 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
|
|
1106 # collaboration diagrams in a style similar to the OMG's Unified Modeling
|
|
|
1107 # Language.
|
|
|
1108
|
|
|
1109 UML_LOOK = NO
|
|
|
1110
|
|
|
1111 # If set to YES, the inheritance and collaboration graphs will show the
|
|
|
1112 # relations between templates and their instances.
|
|
|
1113
|
|
|
1114 TEMPLATE_RELATIONS = YES
|
|
|
1115
|
|
|
1116 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
|
|
1117 # tags are set to YES then doxygen will generate a graph for each documented
|
|
|
1118 # file showing the direct and indirect include dependencies of the file with
|
|
|
1119 # other documented files.
|
|
|
1120
|
|
|
1121 INCLUDE_GRAPH = YES
|
|
|
1122
|
|
|
1123 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
|
|
1124 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
|
|
1125 # documented header file showing the documented files that directly or
|
|
|
1126 # indirectly include this file.
|
|
|
1127
|
|
|
1128 INCLUDED_BY_GRAPH = YES
|
|
|
1129
|
|
|
1130 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
|
|
|
1131 # generate a call dependency graph for every global function or class method.
|
|
|
1132 # Note that enabling this option will significantly increase the time of a run.
|
|
|
1133 # So in most cases it will be better to enable call graphs for selected
|
|
|
1134 # functions only using the \callgraph command.
|
|
|
1135
|
|
|
1136 CALL_GRAPH = NO
|
|
|
1137
|
|
|
1138 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
|
|
1139 # will graphical hierarchy of all classes instead of a textual one.
|
|
|
1140
|
|
|
1141 GRAPHICAL_HIERARCHY = YES
|
|
|
1142
|
|
|
1143 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
|
|
|
1144 # then doxygen will show the dependencies a directory has on other directories
|
|
|
1145 # in a graphical way. The dependency relations are determined by the #include
|
|
|
1146 # relations between the files in the directories.
|
|
|
1147
|
|
|
1148 DIRECTORY_GRAPH = YES
|
|
|
1149
|
|
|
1150 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
|
|
1151 # generated by dot. Possible values are png, jpg, or gif
|
|
|
1152 # If left blank png will be used.
|
|
|
1153
|
|
|
1154 DOT_IMAGE_FORMAT = png
|
|
|
1155
|
|
|
1156 # The tag DOT_PATH can be used to specify the path where the dot tool can be
|
|
|
1157 # found. If left blank, it is assumed the dot tool can be found in the path.
|
|
|
1158
|
|
|
1159 DOT_PATH =
|
|
|
1160
|
|
|
1161 # The DOTFILE_DIRS tag can be used to specify one or more directories that
|
|
|
1162 # contain dot files that are included in the documentation (see the
|
|
|
1163 # \dotfile command).
|
|
|
1164
|
|
|
1165 DOTFILE_DIRS =
|
|
|
1166
|
|
|
1167 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
|
|
|
1168 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
|
|
1169 # this value, doxygen will try to truncate the graph, so that it fits within
|
|
|
1170 # the specified constraint. Beware that most browsers cannot cope with very
|
|
|
1171 # large images.
|
|
|
1172
|
|
|
1173 MAX_DOT_GRAPH_WIDTH = 1024
|
|
|
1174
|
|
|
1175 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
|
|
|
1176 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
|
|
1177 # this value, doxygen will try to truncate the graph, so that it fits within
|
|
|
1178 # the specified constraint. Beware that most browsers cannot cope with very
|
|
|
1179 # large images.
|
|
|
1180
|
|
|
1181 MAX_DOT_GRAPH_HEIGHT = 1024
|
|
|
1182
|
|
|
1183 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
|
|
|
1184 # graphs generated by dot. A depth value of 3 means that only nodes reachable
|
|
|
1185 # from the root by following a path via at most 3 edges will be shown. Nodes
|
|
|
1186 # that lay further from the root node will be omitted. Note that setting this
|
|
|
1187 # option to 1 or 2 may greatly reduce the computation time needed for large
|
|
|
1188 # code bases. Also note that a graph may be further truncated if the graph's
|
|
|
1189 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
|
|
|
1190 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
|
|
|
1191 # the graph is not depth-constrained.
|
|
|
1192
|
|
|
1193 MAX_DOT_GRAPH_DEPTH = 0
|
|
|
1194
|
|
|
1195 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
|
|
1196 # background. This is disabled by default, which results in a white background.
|
|
|
1197 # Warning: Depending on the platform used, enabling this option may lead to
|
|
|
1198 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
|
|
|
1199 # read).
|
|
|
1200
|
|
|
1201 DOT_TRANSPARENT = NO
|
|
|
1202
|
|
|
1203 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
|
|
|
1204 # files in one run (i.e. multiple -o and -T options on the command line). This
|
|
|
1205 # makes dot run faster, but since only newer versions of dot (>1.8.10)
|
|
|
1206 # support this, this feature is disabled by default.
|
|
|
1207
|
|
|
1208 DOT_MULTI_TARGETS = NO
|
|
|
1209
|
|
|
1210 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
|
|
1211 # generate a legend page explaining the meaning of the various boxes and
|
|
|
1212 # arrows in the dot generated graphs.
|
|
|
1213
|
|
|
1214 GENERATE_LEGEND = YES
|
|
|
1215
|
|
|
1216 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
|
|
1217 # remove the intermediate dot files that are used to generate
|
|
|
1218 # the various graphs.
|
|
|
1219
|
|
|
1220 DOT_CLEANUP = YES
|
|
|
1221
|
|
|
1222 #---------------------------------------------------------------------------
|
|
|
1223 # Configuration::additions related to the search engine
|
|
|
1224 #---------------------------------------------------------------------------
|
|
|
1225
|
|
|
1226 # The SEARCHENGINE tag specifies whether or not a search engine should be
|
|
|
1227 # used. If set to NO the values of all tags below this one will be ignored.
|
|
|
1228
|
|
|
1229 SEARCHENGINE = NO
|
