Doxygen.conf 65.9 KB
Newer Older
1
# Doxyfile 1.6.2
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

17
18
19
20
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
21
22
23
24
# http://www.gnu.org/software/libiconv for the list of possible encodings.

DOXYFILE_ENCODING      = UTF-8

25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
27
# by quotes) that should identify the project.

28
PROJECT_NAME           = "LUFA (Formerly MyUSB) Library"
29

30
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
32
33
# if some version control system is used.

34
PROJECT_NUMBER         = 000000
35

36
37
38
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
39
40
41
42
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = ./Documentation/

43
44
45
46
47
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of
# source files, where putting all generated files in the same directory would
48
49
# otherwise cause performance problems for the file system.

50
CREATE_SUBDIRS         = NO
51

52
53
54
55
56
57
58
59
60
61
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62
63
64

OUTPUT_LANGUAGE        = English

65
66
67
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
68
69
70
71
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

72
73
74
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
76
# brief descriptions will be completely suppressed.

77
REPEAT_BRIEF           = NO
78

79
80
81
82
83
84
85
86
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is
# used as the annotated text. Otherwise, the brief description is used as-is.
# If left blank, the following values are used ("$name" is automatically
# replaced with the name of the entity): "The $name class" "The $name widget"
# "The $name file" "is" "provides" "specifies" "contains"
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# "represents" "a" "an" "the"

ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the

101
102
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
103
104
105
106
# description.

ALWAYS_DETAILED_SEC    = NO

107
108
109
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
110
111
112
113
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

114
115
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
116
117
118
119
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

120
121
122
123
124
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
125
126
# path to strip.

127
STRIP_FROM_PATH        =
128

129
130
131
132
133
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
# the reader which header file to include in order to use a class.
# If left blank only the name of the header file containing the class
# definition is used. Otherwise one should specify the include paths that
134
135
# are normally passed to the compiler using the -I flag.

136
STRIP_FROM_INC_PATH    =
137

138
139
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
140
141
# doesn't support long names like on DOS, Mac, or CD-ROM.

142
SHORT_NAMES            = NO
143

144
145
146
147
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like regular Qt-style comments
148
149
150
151
# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

152
153
154
155
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
156
157
158
159
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

160
161
162
163
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
164
165
166
167
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

168
169
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
170
171
172
173
# re-implements.

INHERIT_DOCS           = YES

174
175
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
# a new page for each member. If set to NO, the documentation of a member will
176
177
178
179
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

180
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181
182
183
184
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 4

185
186
187
188
189
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
190
191
# You can put \n's in the value part of an alias to insert newlines.

192
ALIASES                =
193

194
195
196
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
197
198
199
200
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = YES

201
202
203
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# Java. For instance, namespaces will be presented as packages, qualified
204
205
206
207
# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

208
209
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
210
211
212
213
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

214
215
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
216
217
218
219
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# Doxygen selects the parser to use depending on the extension of the files it parses.
# With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
# The format is ext=language, where ext is a file extension, and language is one of
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.

EXTENSION_MAPPING      =

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
236
237
238
239
240
241
242
243
244
# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.

CPP_CLI_SUPPORT        = NO

245
246
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
247
248
249
250
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

251
252
253
254
255
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
256
257
258
259
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

260
261
262
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
263
264
265
266
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

267
268
269
270
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
271
272
273
274
# the \nosubgrouping command.

SUBGROUPING            = YES

275
276
277
278
279
280
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
281
282
# types are typedef'ed and only the typedef is referenced, never the tag name.

283
TYPEDEF_HIDES_STRUCT   = YES
284

285
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
286
287
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
288
289
290
291
292
293
294
295
296
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
297
298
# corresponding to a cache size of 2^16 = 65536 symbols

299
SYMBOL_CACHE_SIZE      = 1
300
301
302
303
304

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

305
306
307
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
308
309
310
311
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = YES

312
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
313
314
315
316
# will be included in the documentation.

EXTRACT_PRIVATE        = YES

317
# If the EXTRACT_STATIC tag is set to YES all static members of a file
318
319
320
321
# will be included in the documentation.

EXTRACT_STATIC         = YES

322
323
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
324
325
326
327
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

328
329
330
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
331
332
333
334
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

335
336
337
338
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
339
340
341
342
# anonymous namespace are hidden.

EXTRACT_ANON_NSPACES   = NO

343
344
345
346
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
347
348
349
350
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

351
352
353
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
354
355
356
357
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

358
359
360
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
361
362
363
364
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

365
366
367
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
368
369
370
371
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

372
373
374
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
375
376
377
378
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

379
380
381
382
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
383
384
385
386
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = NO

387
388
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
389
390
391
392
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

393
394
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
395
396
397
398
# of that file.

SHOW_INCLUDE_FILES     = YES

399
400
401
402
403
404
405
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
406
407
408
409
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

410
411
412
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
413
414
415
416
# declaration order.

SORT_MEMBER_DOCS       = YES

417
418
419
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
420
421
422
423
# declaration order.

SORT_BRIEF_DOCS        = NO

424
425
426
427
428
429
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = NO

# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
430
431
# the group names will appear in their defined order.

432
SORT_GROUP_NAMES       = YES
433

434
435
436
437
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# not including the namespace part.
438
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
439
# Note: This option applies only to the class list, not to the
440
441
442
443
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

444
445
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
446
447
448
449
# commands in the documentation.

GENERATE_TODOLIST      = NO

450
451
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
452
453
454
455
# commands in the documentation.

GENERATE_TESTLIST      = NO

456
457
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
458
459
460
461
# commands in the documentation.

GENERATE_BUGLIST       = NO

462
463
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
464
465
466
467
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

468
# The ENABLED_SECTIONS tag can be used to enable conditional
469
470
# documentation sections, marked by \if sectionname ... \endif.

471
ENABLED_SECTIONS       =
472

473
474
475
476
477
478
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
479
480
481
482
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

483
484
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
485
486
487
488
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

489
490
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
491
492
493
494
495
# in the documentation. The default is NO.

SHOW_DIRECTORIES       = YES

# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
496
# This will remove the Files entry from the Quick Index and from the
497
498
# Folder Tree View (if specified). The default is YES.

499
SHOW_FILES             = YES
500

501
502
503
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
504
505
506
507
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

508
509
510
511
512
513
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command <command> <input-file>, where <command> is the value of
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
# provided by doxygen. Whatever the program writes to standard output
514
515
# is used as the file version. See the manual for examples.

516
FILE_VERSION_FILTER    =
517

518
519
520
521
522
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
# doxygen. The layout file controls the global structure of the generated output files
# in an output format independent way. The create the layout file that represents
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
523
524
# of the layout file.

525
LAYOUT_FILE            =
526
527
528
529
530

#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

531
# The QUIET tag can be used to turn on/off the messages that are generated
532
533
534
535
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = YES

536
537
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
538
539
540
541
# NO is used.

WARNINGS               = YES

542
543
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
544
545
546
547
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

548
549
550
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
551
552
553
554
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

555
556
557
558
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
559
560
561
562
# documentation.

WARN_NO_PARAMDOC       = YES

563
564
565
566
567
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text. Optionally the format may contain
# $version, which will be replaced by the version of the file (if it could
568
569
570
571
# be obtained via FILE_VERSION_FILTER)

WARN_FORMAT            = "$file:$line: $text"

572
573
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
574
575
# to stderr.

576
WARN_LOGFILE           =
577
578
579
580
581

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

582
583
584
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
585
586
587
588
# with spaces.

INPUT                  = ./

589
590
591
592
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
593
594
595
596
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

597
598
599
600
601
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
602
603
604
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90

FILE_PATTERNS          = *.h \
605
                         *.txt
606

607
608
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
609
610
611
612
# If left blank NO is used.

RECURSIVE              = YES

613
614
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
615
616
# subdirectory from a directory tree whose root is specified with the INPUT tag.

617
EXCLUDE                = Documentation/
618

619
620
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
621
622
623
624
# from the input.

EXCLUDE_SYMLINKS       = NO

625
626
627
628
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
629
630
# for example use the pattern */test/*

631
EXCLUDE_PATTERNS       =
632

633
634
635
636
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
637
638
# AClass::ANamespace, ANamespace::*Test

639
EXCLUDE_SYMBOLS        = __*
640

641
642
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
643
644
# the \include command).

645
EXAMPLE_PATH           = ../
646

647
648
649
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
650
651
652
653
# blank all files are included.

EXAMPLE_PATTERNS       = *

654
655
656
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
657
658
659
660
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

661
662
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
663
664
# the \image command).

665
IMAGE_PATH             = ./
666

667
668
669
670
671
672
673
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter>
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.
# If FILTER_PATTERNS is specified, this tag will be
674
675
# ignored.

676
INPUT_FILTER           =
677

678
679
680
681
682
683
684
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.
# Doxygen will compare the file name with each pattern and apply the
# filter if there is a match.
# The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
685
686
# is applied to all files.

687
FILTER_PATTERNS        =
688

689
690
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
691
692
693
694
695
696
697
698
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

699
700
701
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also
702
703
704
705
# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = NO

706
# Setting the INLINE_SOURCES tag to YES will include the body
707
708
709
710
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

711
712
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
713
714
715
716
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

717
718
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
719
720
721
722
# functions referencing it will be listed.

REFERENCED_BY_RELATION = NO

723
724
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
725
726
727
728
729
730
731
# called/used by that function will be listed.

REFERENCES_RELATION    = NO

# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
732
733
# link to the source code.
# Otherwise they will link to the documentation.
734
735
736

REFERENCES_LINK_SOURCE = NO

737
738
739
740
# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
741
742
743
744
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

745
746
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
747
748
749
750
751
752
753
754
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = NO

#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

755
756
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
757
758
759
760
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

761
762
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
763
764
765
766
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

767
768
769
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
770
771
# should be ignored while generating the index headers.

772
IGNORE_PREFIX          =
773
774
775
776
777

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

778
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
779
780
781
782
# generate HTML output.

GENERATE_HTML          = YES

783
784
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
785
786
787
788
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

789
790
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
791
792
793
794
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

795
796
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
797
798
# standard header.

799
HTML_HEADER            =
800

801
802
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
803
804
# standard footer.

805
HTML_FOOTER            =
806

807
808
809
810
811
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
812
813
# stylesheet in the HTML output directory as well, or it will be erased!

814
HTML_STYLESHEET        = Doxygen.css
815
816
817
818

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.
819

820
821
822
823
HTML_TIMESTAMP         = NO

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
824
825
826
827
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     = YES

828
829
830
831
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
832
833
834
835
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

HTML_DYNAMIC_SECTIONS  = YES

836
837
838
839
840
841
842
843
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
844
845
846
847
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.

GENERATE_DOCSET        = NO

848
849
850
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
851
852
853
854
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

855
856
857
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
858
859
860
861
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

862
863
864
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
865
866
867
868
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

869
870
871
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
872
873
# written to the html output directory.

874
CHM_FILE               = ../LUFA.chm
875

876
877
878
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
879
880
# the HTML help compiler on the generated index.hhp.

881
HHC_LOCATION           = 
882

883
884
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
885
886
887
888
889
890
891
892
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.

893
CHM_INDEX_ENCODING     =
894

895
896
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
897
898
899
900
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

901
# The TOC_EXPAND flag can be set to YES to add extra items for group members
902
903
904
905
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = YES

906
907
908
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
909
910
911
912
# HTML documentation.

GENERATE_QHP           = NO

913
914
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
915
916
# The path specified is relative to the HTML output folder.

917
QCH_FILE               =
918

919
920
921
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace
922
923
924

QHP_NAMESPACE          = org.doxygen.Project

925
926
927
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
928
929
930

QHP_VIRTUAL_FOLDER     = doc

931
932
933
934
935
936
937
938
939
940
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
# For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters

QHP_CUST_FILTER_NAME   =

# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.

QHP_CUST_FILTER_ATTRS  =
941

942
943
944
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
# filter section matches.
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
945

946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
QHP_SECT_FILTER_ATTRS  =

# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file.

QHG_LOCATION           =

# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
#  will be generated, which together with the HTML files, form an Eclipse help
#  plugin. To install this plugin and make it available under the help contents
# menu in Eclipse, the contents of the directory containing the HTML and XML
# files needs to be copied into the plugins directory of eclipse. The name of
# the directory within the plugins directory should be the same as
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.

GENERATE_ECLIPSEHELP   = NO

# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
# this name.

ECLIPSE_DOC_ID         = org.doxygen.Project

# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
973
974
975
976
# the value YES disables it.

DISABLE_INDEX          = NO

977
# This tag can be used to set the number of enum values (range [1..20])
978
979
980
981
982
983
# that doxygen will group on one line in the generated HTML documentation.

ENUM_VALUES_PER_LINE   = 1

# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
984
985
986
987
988
# If the tag value is set to YES, a side panel will be generated
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
989
990
991

GENERATE_TREEVIEW      = YES

992
993
994
995
996
997
998
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.

USE_INLINE_TREES       = NO

# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
999
1000
# is shown.

1001
TREEVIEW_WIDTH         = 300
1002

1003
1004
1005
1006
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
1007
1008
1009
1010
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

SEARCHENGINE           = YES

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
# and does not have live searching capabilities.

SERVER_BASED_SEARCH    = NO

1024
1025
1026
1027
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

1028
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1029
1030
1031
1032
# generate Latex output.

GENERATE_LATEX         = NO

1033
1034
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1035
1036
1037
1038
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

1039
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1040
# invoked. If left blank `latex' will be used as the default command name.
1041
1042
1043
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
1044
1045
1046

LATEX_CMD_NAME         = latex

1047
1048
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
1049
1050
1051
1052
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

1053
1054
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
1055
1056
1057
1058
# save some trees in general.

COMPACT_LATEX          = NO

1059
1060
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
1061
1062
1063
1064
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

1065
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1066
1067
# packages that should be included in the LaTeX output.

1068
EXTRA_PACKAGES         =
1069

1070
1071
1072
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
1073
1074
# standard header. Notice: only use this tag if you know what you are doing!

1075
LATEX_HEADER           =
1076

1077
1078
1079
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
1080
1081
1082
1083
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = YES

1084
1085
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
1086
1087
1088
1089
# higher quality PDF documentation.

USE_PDFLATEX           = YES

1090
1091
1092
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
1093
1094
1095
1096
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

1097
1098
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
1099
1100
1101
1102
# in the output.

LATEX_HIDE_INDICES     = NO

1103
1104
1105
1106
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.

LATEX_SOURCE_CODE      = NO

1107
1108
1109
1110
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

1111
1112
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimized for Word 97 and may not look very pretty with
1113
1114
1115
1116
# other RTF readers or editors.

GENERATE_RTF           = NO

1117
1118
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1119
1120
1121
1122
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

1123
1124
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
1125
1126
1127
1128
# save some trees in general.

COMPACT_RTF            = NO

1129
1130
1131
1132
1133
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
1134
1135
1136
1137
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

1138
1139
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
1140
1141
# replacements, missing definitions are set to their default value.

1142
RTF_STYLESHEET_FILE    =
1143

1144
# Set optional variables used in the generation of an rtf document.
1145
1146
# Syntax is similar to doxygen's config file.

1147
RTF_EXTENSIONS_FILE    =
1148
1149
1150
1151
1152

#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------

1153
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1154
1155
1156
1157
# generate man pages

GENERATE_MAN           = NO

1158
1159
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1160
1161
1162
1163
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

1164
# The MAN_EXTENSION tag determines the extension that is added to
1165
1166
1167
1168
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

1169
1170
1171
1172
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
1173
1174
1175
1176
1177
1178
1179
1180
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------

1181
1182
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
1183
1184
1185
1186
# the code including all documentation.

GENERATE_XML           = NO

1187
1188
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1189
1190
1191
1192
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

1193
1194
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
1195
1196
# syntax of the XML files.

1197
XML_SCHEMA             =
1198

1199
1200
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
1201
1202
# syntax of the XML files.

1203
XML_DTD                =
1204

1205
1206
1207
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that
1208
1209
1210
1211
1212
1213
1214
1215
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

1216
1217
1218
1219
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
1220
1221
1222
1223
1224
1225
1226
1227
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------

1228
1229
1230
1231
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
1232
1233
1234
1235
# moment.

GENERATE_PERLMOD       = NO

1236
1237
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1238
1239
1240
1241
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

1242
1243
1244
1245
1246
1247
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader.
# This is useful
# if you want to understand what is going on.
# On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
1248
1249
1250
1251
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

1252
1253
1254
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
1255
1256
# Makefile don't overwrite each other's variables.

1257
PERLMOD_MAKEVAR_PREFIX =
1258
1259

#---------------------------------------------------------------------------
1260
# Configuration options related to the preprocessor
1261
1262
#---------------------------------------------------------------------------

1263
1264
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
1265
1266
1267
1268
# files.

ENABLE_PREPROCESSING   = YES

1269
1270
1271
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
1272
1273
1274
1275
# way by setting EXPAND_ONLY_PREDEF to YES.

MACRO_EXPANSION        = YES

1276
1277
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
1278
1279
1280
1281
# PREDEFINED and EXPAND_AS_DEFINED tags.

EXPAND_ONLY_PREDEF     = YES

1282
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1283
1284
1285
1286
# in the INCLUDE_PATH (see below) will be search if a #include is found.

SEARCH_INCLUDES        = YES

1287
1288
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
1289
1290
# the preprocessor.

1291
INCLUDE_PATH           =
1292

1293
1294
1295
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1296
1297
# be used.

1298
INCLUDE_FILE_PATTERNS  =
1299

1300
1301
1302
1303
1304
1305
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
1306
1307
1308
1309
# instead of the = operator.

PREDEFINED             = __DOXYGEN__

1310
1311
1312
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
1313
1314
# Use the PREDEFINED tag if you want to use a different macro definition.

Dean Camera's avatar
Dean Camera committed
1315
EXPAND_AS_DEFINED      = __CALLBACK_PARAM
1316

1317
1318
1319
1320
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse
1321
1322
1323
1324
1325
# the parser if not removed.

SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
1326