Statistics
| Branch: | Tag: | Revision:

root / LUFA / Doxygen.conf @ 978b99e5

History | View | Annotate | Download (73 KB)

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

    
23
DOXYFILE_ENCODING      = UTF-8
24

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

    
28
PROJECT_NAME           = "LUFA Library"
29

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

    
34
PROJECT_NUMBER         = 000000
35

    
36
# Using the PROJECT_BRIEF tag one can provide an optional one line description
37
# for a project that appears at the top of each page and should give viewer
38
# a quick idea about the purpose of the project. Keep the description short.
39

    
40
PROJECT_BRIEF          =
41

    
42
# With the PROJECT_LOGO tag one can specify an logo or icon that is
43
# included in the documentation. The maximum height of the logo should not
44
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
45
# Doxygen will copy the logo to the output directory.
46

    
47
PROJECT_LOGO           = ./ManPages/LUFA_thumb.png
48

    
49
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
50
# base path where the generated documentation will be put.
51
# If a relative path is entered, it will be relative to the location
52
# where doxygen was started. If left blank the current directory will be used.
53

    
54
OUTPUT_DIRECTORY       = ./Documentation/
55

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

    
63
CREATE_SUBDIRS         = NO
64

    
65
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
66
# documentation generated by doxygen is written. Doxygen will use this
67
# information to generate all constant output in the proper language.
68
# The default language is English, other supported languages are:
69
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
70
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
71
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
72
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
73
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
74
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
75

    
76
OUTPUT_LANGUAGE        = English
77

    
78
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
79
# include brief member descriptions after the members that are listed in
80
# the file and class documentation (similar to JavaDoc).
81
# Set to NO to disable this.
82

    
83
BRIEF_MEMBER_DESC      = YES
84

    
85
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
86
# the brief description of a member or function before the detailed description.
87
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
88
# brief descriptions will be completely suppressed.
89

    
90
REPEAT_BRIEF           = NO
91

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

    
102
ABBREVIATE_BRIEF       = "The $name class" \
103
                         "The $name widget" \
104
                         "The $name file" \
105
                         is \
106
                         provides \
107
                         specifies \
108
                         contains \
109
                         represents \
110
                         a \
111
                         an \
112
                         the
113

    
114
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
115
# Doxygen will generate a detailed section even if there is only a brief
116
# description.
117

    
118
ALWAYS_DETAILED_SEC    = NO
119

    
120
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
121
# inherited members of a class in the documentation of that class as if those
122
# members were ordinary class members. Constructors, destructors and assignment
123
# operators of the base classes will not be shown.
124

    
125
INLINE_INHERITED_MEMB  = NO
126

    
127
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
128
# path before files name in the file list and in the header files. If set
129
# to NO the shortest path that makes the file name unique will be used.
130

    
131
FULL_PATH_NAMES        = YES
132

    
133
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
134
# can be used to strip a user-defined part of the path. Stripping is
135
# only done if one of the specified strings matches the left-hand part of
136
# the path. The tag can be used to show relative paths in the file list.
137
# If left blank the directory from which doxygen is run is used as the
138
# path to strip.
139

    
140
STRIP_FROM_PATH        =
141

    
142
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
143
# the path mentioned in the documentation of a class, which tells
144
# the reader which header file to include in order to use a class.
145
# If left blank only the name of the header file containing the class
146
# definition is used. Otherwise one should specify the include paths that
147
# are normally passed to the compiler using the -I flag.
148

    
149
STRIP_FROM_INC_PATH    =
150

    
151
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
152
# (but less readable) file names. This can be useful if your file system
153
# doesn't support long names like on DOS, Mac, or CD-ROM.
154

    
155
SHORT_NAMES            = NO
156

    
157
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
158
# will interpret the first line (until the first dot) of a JavaDoc-style
159
# comment as the brief description. If set to NO, the JavaDoc
160
# comments will behave just like regular Qt-style comments
161
# (thus requiring an explicit @brief command for a brief description.)
162

    
163
JAVADOC_AUTOBRIEF      = NO
164

    
165
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
166
# interpret the first line (until the first dot) of a Qt-style
167
# comment as the brief description. If set to NO, the comments
168
# will behave just like regular Qt-style comments (thus requiring
169
# an explicit \brief command for a brief description.)
170

    
171
QT_AUTOBRIEF           = NO
172

    
173
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
174
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
175
# comments) as a brief description. This used to be the default behaviour.
176
# The new default is to treat a multi-line C++ comment block as a detailed
177
# description. Set this tag to YES if you prefer the old behaviour instead.
178

    
179
MULTILINE_CPP_IS_BRIEF = NO
180

    
181
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
182
# member inherits the documentation from any documented member that it
183
# re-implements.
184

    
185
INHERIT_DOCS           = YES
186

    
187
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
188
# a new page for each member. If set to NO, the documentation of a member will
189
# be part of the file/class/namespace that contains it.
190

    
191
SEPARATE_MEMBER_PAGES  = NO
192

    
193
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
194
# Doxygen uses this value to replace tabs by spaces in code fragments.
195

    
196
TAB_SIZE               = 4
197

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

    
205
ALIASES                =
206

    
207
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
208
# sources only. Doxygen will then generate output that is more tailored for C.
209
# For instance, some of the names that are used will be different. The list
210
# of all members will be omitted, etc.
211

    
212
OPTIMIZE_OUTPUT_FOR_C  = YES
213

    
214
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
215
# sources only. Doxygen will then generate output that is more tailored for
216
# Java. For instance, namespaces will be presented as packages, qualified
217
# scopes will look different, etc.
218

    
219
OPTIMIZE_OUTPUT_JAVA   = NO
220

    
221
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
222
# sources only. Doxygen will then generate output that is more tailored for
223
# Fortran.
224

    
225
OPTIMIZE_FOR_FORTRAN   = NO
226

    
227
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
228
# sources. Doxygen will then generate output that is tailored for
229
# VHDL.
230

    
231
OPTIMIZE_OUTPUT_VHDL   = NO
232

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

    
243
EXTENSION_MAPPING      =
244

    
245
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
246
# to include (a tag file for) the STL sources as input, then you should
247
# set this tag to YES in order to let doxygen match functions declarations and
248
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
249
# func(std::string) {}). This also makes the inheritance and collaboration
250
# diagrams that involve STL classes more complete and accurate.
251

    
252
BUILTIN_STL_SUPPORT    = NO
253

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

    
257
CPP_CLI_SUPPORT        = NO
258

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

    
263
SIP_SUPPORT            = NO
264

    
265
# For Microsoft's IDL there are propget and propput attributes to indicate getter
266
# and setter methods for a property. Setting this option to YES (the default)
267
# will make doxygen replace the get and set methods by a property in the
268
# documentation. This will only work if the methods are indeed getting or
269
# setting a simple type. If this is not the case, or you want to show the
270
# methods anyway, you should set this option to NO.
271

    
272
IDL_PROPERTY_SUPPORT   = YES
273

    
274
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
275
# tag is set to YES, then doxygen will reuse the documentation of the first
276
# member in the group (if any) for the other members of the group. By default
277
# all members of a group must be documented explicitly.
278

    
279
DISTRIBUTE_GROUP_DOC   = NO
280

    
281
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
282
# the same type (for instance a group of public functions) to be put as a
283
# subgroup of that type (e.g. under the Public Functions section). Set it to
284
# NO to prevent subgrouping. Alternatively, this can be done per class using
285
# the \nosubgrouping command.
286

    
287
SUBGROUPING            = YES
288

    
289
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
290
# unions are shown inside the group in which they are included (e.g. using
291
# @ingroup) instead of on a separate page (for HTML and Man pages) or
292
# section (for LaTeX and RTF).
293

    
294
INLINE_GROUPED_CLASSES = NO
295

    
296
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
297
# is documented as struct, union, or enum with the name of the typedef. So
298
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
299
# with name TypeT. When disabled the typedef will appear as a member of a file,
300
# namespace, or class. And the struct will be named TypeS. This can typically
301
# be useful for C code in case the coding convention dictates that all compound
302
# types are typedef'ed and only the typedef is referenced, never the tag name.
303

    
304
TYPEDEF_HIDES_STRUCT   = YES
305

    
306
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
307
# determine which symbols to keep in memory and which to flush to disk.
308
# When the cache is full, less often used symbols will be written to disk.
309
# For small to medium size projects (<1000 input files) the default value is
310
# probably good enough. For larger projects a too small cache size can cause
311
# doxygen to be busy swapping symbols to and from disk most of the time
312
# causing a significant performance penalty.
313
# If the system has enough physical memory increasing the cache will improve the
314
# performance by keeping more symbols in memory. Note that the value works on
315
# a logarithmic scale so increasing the size by one will roughly double the
316
# memory usage. The cache size is given by this formula:
317
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
318
# corresponding to a cache size of 2^16 = 65536 symbols
319

    
320
SYMBOL_CACHE_SIZE      = 1
321

    
322
#---------------------------------------------------------------------------
323
# Build related configuration options
324
#---------------------------------------------------------------------------
325

    
326
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
327
# documentation are documented, even if no documentation was available.
328
# Private class members and static file members will be hidden unless
329
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
330

    
331
EXTRACT_ALL            = YES
332

    
333
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
334
# will be included in the documentation.
335

    
336
EXTRACT_PRIVATE        = YES
337

    
338
# If the EXTRACT_STATIC tag is set to YES all static members of a file
339
# will be included in the documentation.
340

    
341
EXTRACT_STATIC         = YES
342

    
343
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
344
# defined locally in source files will be included in the documentation.
345
# If set to NO only classes defined in header files are included.
346

    
347
EXTRACT_LOCAL_CLASSES  = YES
348

    
349
# This flag is only useful for Objective-C code. When set to YES local
350
# methods, which are defined in the implementation section but not in
351
# the interface are included in the documentation.
352
# If set to NO (the default) only methods in the interface are included.
353

    
354
EXTRACT_LOCAL_METHODS  = NO
355

    
356
# If this flag is set to YES, the members of anonymous namespaces will be
357
# extracted and appear in the documentation as a namespace called
358
# 'anonymous_namespace{file}', where file will be replaced with the base
359
# name of the file that contains the anonymous namespace. By default
360
# anonymous namespaces are hidden.
361

    
362
EXTRACT_ANON_NSPACES   = NO
363

    
364
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
365
# undocumented members of documented classes, files or namespaces.
366
# If set to NO (the default) these members will be included in the
367
# various overviews, but no documentation section is generated.
368
# This option has no effect if EXTRACT_ALL is enabled.
369

    
370
HIDE_UNDOC_MEMBERS     = NO
371

    
372
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
373
# undocumented classes that are normally visible in the class hierarchy.
374
# If set to NO (the default) these classes will be included in the various
375
# overviews. This option has no effect if EXTRACT_ALL is enabled.
376

    
377
HIDE_UNDOC_CLASSES     = NO
378

    
379
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
380
# friend (class|struct|union) declarations.
381
# If set to NO (the default) these declarations will be included in the
382
# documentation.
383

    
384
HIDE_FRIEND_COMPOUNDS  = NO
385

    
386
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
387
# documentation blocks found inside the body of a function.
388
# If set to NO (the default) these blocks will be appended to the
389
# function's detailed documentation block.
390

    
391
HIDE_IN_BODY_DOCS      = NO
392

    
393
# The INTERNAL_DOCS tag determines if documentation
394
# that is typed after a \internal command is included. If the tag is set
395
# to NO (the default) then the documentation will be excluded.
396
# Set it to YES to include the internal documentation.
397

    
398
INTERNAL_DOCS          = NO
399

    
400
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
401
# file names in lower-case letters. If set to YES upper-case letters are also
402
# allowed. This is useful if you have classes or files whose names only differ
403
# in case and if your file system supports case sensitive file names. Windows
404
# and Mac users are advised to set this option to NO.
405

    
406
CASE_SENSE_NAMES       = NO
407

    
408
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
409
# will show members with their full class and namespace scopes in the
410
# documentation. If set to YES the scope will be hidden.
411

    
412
HIDE_SCOPE_NAMES       = NO
413

    
414
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
415
# will put a list of the files that are included by a file in the documentation
416
# of that file.
417

    
418
SHOW_INCLUDE_FILES     = YES
419

    
420
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
421
# will list include files with double quotes in the documentation
422
# rather than with sharp brackets.
423

    
424
FORCE_LOCAL_INCLUDES   = NO
425

    
426
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
427
# is inserted in the documentation for inline members.
428

    
429
INLINE_INFO            = YES
430

    
431
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
432
# will sort the (detailed) documentation of file and class members
433
# alphabetically by member name. If set to NO the members will appear in
434
# declaration order.
435

    
436
SORT_MEMBER_DOCS       = YES
437

    
438
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
439
# brief documentation of file, namespace and class members alphabetically
440
# by member name. If set to NO (the default) the members will appear in
441
# declaration order.
442

    
443
SORT_BRIEF_DOCS        = NO
444

    
445
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
446
# will sort the (brief and detailed) documentation of class members so that
447
# constructors and destructors are listed first. If set to NO (the default)
448
# the constructors will appear in the respective orders defined by
449
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
450
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
451
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
452

    
453
SORT_MEMBERS_CTORS_1ST = NO
454

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

    
459
SORT_GROUP_NAMES       = YES
460

    
461
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
462
# sorted by fully-qualified names, including namespaces. If set to
463
# NO (the default), the class list will be sorted only by class name,
464
# not including the namespace part.
465
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
466
# Note: This option applies only to the class list, not to the
467
# alphabetical list.
468

    
469
SORT_BY_SCOPE_NAME     = NO
470

    
471
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
472
# do proper type resolution of all parameters of a function it will reject a
473
# match between the prototype and the implementation of a member function even
474
# if there is only one candidate or it is obvious which candidate to choose
475
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
476
# will still accept a match between prototype and implementation in such cases.
477

    
478
STRICT_PROTO_MATCHING  = NO
479

    
480
# The GENERATE_TODOLIST tag can be used to enable (YES) or
481
# disable (NO) the todo list. This list is created by putting \todo
482
# commands in the documentation.
483

    
484
GENERATE_TODOLIST      = NO
485

    
486
# The GENERATE_TESTLIST tag can be used to enable (YES) or
487
# disable (NO) the test list. This list is created by putting \test
488
# commands in the documentation.
489

    
490
GENERATE_TESTLIST      = NO
491

    
492
# The GENERATE_BUGLIST tag can be used to enable (YES) or
493
# disable (NO) the bug list. This list is created by putting \bug
494
# commands in the documentation.
495

    
496
GENERATE_BUGLIST       = NO
497

    
498
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
499
# disable (NO) the deprecated list. This list is created by putting
500
# \deprecated commands in the documentation.
501

    
502
GENERATE_DEPRECATEDLIST= YES
503

    
504
# The ENABLED_SECTIONS tag can be used to enable conditional
505
# documentation sections, marked by \if sectionname ... \endif.
506

    
507
ENABLED_SECTIONS       =
508

    
509
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
510
# the initial value of a variable or macro consists of for it to appear in
511
# the documentation. If the initializer consists of more lines than specified
512
# here it will be hidden. Use a value of 0 to hide initializers completely.
513
# The appearance of the initializer of individual variables and macros in the
514
# documentation can be controlled using \showinitializer or \hideinitializer
515
# command in the documentation regardless of this setting.
516

    
517
MAX_INITIALIZER_LINES  = 15
518

    
519
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
520
# at the bottom of the documentation of classes and structs. If set to YES the
521
# list will mention the files that were used to generate the documentation.
522

    
523
SHOW_USED_FILES        = YES
524

    
525
# If the sources in your project are distributed over multiple directories
526
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
527
# in the documentation. The default is NO.
528

    
529
SHOW_DIRECTORIES       = YES
530

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

    
535
SHOW_FILES             = YES
536

    
537
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
538
# Namespaces page.
539
# This will remove the Namespaces entry from the Quick Index
540
# and from the Folder Tree View (if specified). The default is YES.
541

    
542
SHOW_NAMESPACES        = YES
543

    
544
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
545
# doxygen should invoke to get the current version for each file (typically from
546
# the version control system). Doxygen will invoke the program by executing (via
547
# popen()) the command <command> <input-file>, where <command> is the value of
548
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
549
# provided by doxygen. Whatever the program writes to standard output
550
# is used as the file version. See the manual for examples.
551

    
552
FILE_VERSION_FILTER    =
553

    
554
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
555
# by doxygen. The layout file controls the global structure of the generated
556
# output files in an output format independent way. The create the layout file
557
# that represents doxygen's defaults, run doxygen with the -l option.
558
# You can optionally specify a file name after the option, if omitted
559
# DoxygenLayout.xml will be used as the name of the layout file.
560

    
561
LAYOUT_FILE            =
562

    
563
#---------------------------------------------------------------------------
564
# configuration options related to warning and progress messages
565
#---------------------------------------------------------------------------
566

    
567
# The QUIET tag can be used to turn on/off the messages that are generated
568
# by doxygen. Possible values are YES and NO. If left blank NO is used.
569

    
570
QUIET                  = YES
571

    
572
# The WARNINGS tag can be used to turn on/off the warning messages that are
573
# generated by doxygen. Possible values are YES and NO. If left blank
574
# NO is used.
575

    
576
WARNINGS               = YES
577

    
578
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
579
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
580
# automatically be disabled.
581

    
582
WARN_IF_UNDOCUMENTED   = YES
583

    
584
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
585
# potential errors in the documentation, such as not documenting some
586
# parameters in a documented function, or documenting parameters that
587
# don't exist or using markup commands wrongly.
588

    
589
WARN_IF_DOC_ERROR      = YES
590

    
591
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
592
# functions that are documented, but have no documentation for their parameters
593
# or return value. If set to NO (the default) doxygen will only warn about
594
# wrong or incomplete parameter documentation, but not about the absence of
595
# documentation.
596

    
597
WARN_NO_PARAMDOC       = YES
598

    
599
# The WARN_FORMAT tag determines the format of the warning messages that
600
# doxygen can produce. The string should contain the $file, $line, and $text
601
# tags, which will be replaced by the file and line number from which the
602
# warning originated and the warning text. Optionally the format may contain
603
# $version, which will be replaced by the version of the file (if it could
604
# be obtained via FILE_VERSION_FILTER)
605

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

    
608
# The WARN_LOGFILE tag can be used to specify a file to which warning
609
# and error messages should be written. If left blank the output is written
610
# to stderr.
611

    
612
WARN_LOGFILE           =
613

    
614
#---------------------------------------------------------------------------
615
# configuration options related to the input files
616
#---------------------------------------------------------------------------
617

    
618
# The INPUT tag can be used to specify the files and/or directories that contain
619
# documented source files. You may enter file names like "myfile.cpp" or
620
# directories like "/usr/src/myproject". Separate the files or directories
621
# with spaces.
622

    
623
INPUT                  = ./
624

    
625
# This tag can be used to specify the character encoding of the source files
626
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
627
# also the default input encoding. Doxygen uses libiconv (or the iconv built
628
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
629
# the list of possible encodings.
630

    
631
INPUT_ENCODING         = UTF-8
632

    
633
# If the value of the INPUT tag contains directories, you can use the
634
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
635
# and *.h) to filter out the source-files in the directories. If left
636
# blank the following patterns are tested:
637
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
638
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
639
# *.f90 *.f *.for *.vhd *.vhdl
640

    
641
FILE_PATTERNS          = *.h \
642
                         *.txt
643

    
644
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
645
# should be searched for input files as well. Possible values are YES and NO.
646
# If left blank NO is used.
647

    
648
RECURSIVE              = YES
649

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

    
654
EXCLUDE                = Documentation/ \
655
                         License.txt
656

    
657
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
658
# directories that are symbolic links (a Unix file system feature) are excluded
659
# from the input.
660

    
661
EXCLUDE_SYMLINKS       = NO
662

    
663
# If the value of the INPUT tag contains directories, you can use the
664
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
665
# certain files from those directories. Note that the wildcards are matched
666
# against the file with absolute path, so to exclude all test directories
667
# for example use the pattern */test/*
668

    
669
EXCLUDE_PATTERNS       =
670

    
671
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
672
# (namespaces, classes, functions, etc.) that should be excluded from the
673
# output. The symbol name can be a fully qualified name, a word, or if the
674
# wildcard * is used, a substring. Examples: ANamespace, AClass,
675
# AClass::ANamespace, ANamespace::*Test
676

    
677
EXCLUDE_SYMBOLS        = _* \
678
                         __*
679

    
680
# The EXAMPLE_PATH tag can be used to specify one or more files or
681
# directories that contain example code fragments that are included (see
682
# the \include command).
683

    
684
EXAMPLE_PATH           = ../
685

    
686
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
687
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
688
# and *.h) to filter out the source-files in the directories. If left
689
# blank all files are included.
690

    
691
EXAMPLE_PATTERNS       = *
692

    
693
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
694
# searched for input files to be used with the \include or \dontinclude
695
# commands irrespective of the value of the RECURSIVE tag.
696
# Possible values are YES and NO. If left blank NO is used.
697

    
698
EXAMPLE_RECURSIVE      = NO
699

    
700
# The IMAGE_PATH tag can be used to specify one or more files or
701
# directories that contain image that are included in the documentation (see
702
# the \image command).
703

    
704
IMAGE_PATH             = ./
705

    
706
# The INPUT_FILTER tag can be used to specify a program that doxygen should
707
# invoke to filter for each input file. Doxygen will invoke the filter program
708
# by executing (via popen()) the command <filter> <input-file>, where <filter>
709
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
710
# input file. Doxygen will then use the output that the filter program writes
711
# to standard output.
712
# If FILTER_PATTERNS is specified, this tag will be
713
# ignored.
714

    
715
INPUT_FILTER           =
716

    
717
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
718
# basis.
719
# Doxygen will compare the file name with each pattern and apply the
720
# filter if there is a match.
721
# The filters are a list of the form:
722
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
723
# info on how filters are used. If FILTER_PATTERNS is empty or if
724
# non of the patterns match the file name, INPUT_FILTER is applied.
725

    
726
FILTER_PATTERNS        =
727

    
728
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
729
# INPUT_FILTER) will be used to filter the input files when producing source
730
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
731

    
732
FILTER_SOURCE_FILES    = NO
733

    
734
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
735
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
736
# and it is also possible to disable source filtering for a specific pattern
737
# using *.ext= (so without naming a filter). This option only has effect when
738
# FILTER_SOURCE_FILES is enabled.
739

    
740
FILTER_SOURCE_PATTERNS =
741

    
742
#---------------------------------------------------------------------------
743
# configuration options related to source browsing
744
#---------------------------------------------------------------------------
745

    
746
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
747
# be generated. Documented entities will be cross-referenced with these sources.
748
# Note: To get rid of all source code in the generated output, make sure also
749
# VERBATIM_HEADERS is set to NO.
750

    
751
SOURCE_BROWSER         = NO
752

    
753
# Setting the INLINE_SOURCES tag to YES will include the body
754
# of functions and classes directly in the documentation.
755

    
756
INLINE_SOURCES         = NO
757

    
758
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
759
# doxygen to hide any special comment blocks from generated source code
760
# fragments. Normal C and C++ comments will always remain visible.
761

    
762
STRIP_CODE_COMMENTS    = YES
763

    
764
# If the REFERENCED_BY_RELATION tag is set to YES
765
# then for each documented function all documented
766
# functions referencing it will be listed.
767

    
768
REFERENCED_BY_RELATION = NO
769

    
770
# If the REFERENCES_RELATION tag is set to YES
771
# then for each documented function all documented entities
772
# called/used by that function will be listed.
773

    
774
REFERENCES_RELATION    = NO
775

    
776
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
777
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
778
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
779
# link to the source code.
780
# Otherwise they will link to the documentation.
781

    
782
REFERENCES_LINK_SOURCE = NO
783

    
784
# If the USE_HTAGS tag is set to YES then the references to source code
785
# will point to the HTML generated by the htags(1) tool instead of doxygen
786
# built-in source browser. The htags tool is part of GNU's global source
787
# tagging system (see http://www.gnu.org/software/global/global.html). You
788
# will need version 4.8.6 or higher.
789

    
790
USE_HTAGS              = NO
791

    
792
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
793
# will generate a verbatim copy of the header file for each class for
794
# which an include is specified. Set to NO to disable this.
795

    
796
VERBATIM_HEADERS       = NO
797

    
798
#---------------------------------------------------------------------------
799
# configuration options related to the alphabetical class index
800
#---------------------------------------------------------------------------
801

    
802
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
803
# of all compounds will be generated. Enable this if the project
804
# contains a lot of classes, structs, unions or interfaces.
805

    
806
ALPHABETICAL_INDEX     = YES
807

    
808
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
809
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
810
# in which this list will be split (can be a number in the range [1..20])
811

    
812
COLS_IN_ALPHA_INDEX    = 5
813

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

    
819
IGNORE_PREFIX          =
820

    
821
#---------------------------------------------------------------------------
822
# configuration options related to the HTML output
823
#---------------------------------------------------------------------------
824

    
825
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
826
# generate HTML output.
827

    
828
GENERATE_HTML          = YES
829

    
830
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
831
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
832
# put in front of it. If left blank `html' will be used as the default path.
833

    
834
HTML_OUTPUT            = html
835

    
836
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
837
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
838
# doxygen will generate files with .html extension.
839

    
840
HTML_FILE_EXTENSION    = .html
841

    
842
# The HTML_HEADER tag can be used to specify a personal HTML header for
843
# each generated HTML page. If it is left blank doxygen will generate a
844
# standard header. Note that when using a custom header you are responsible
845
# for the proper inclusion of any scripts and style sheets that doxygen
846
# needs, which is dependent on the configuration options used.
847
# It is adviced to generate a default header using "doxygen -w html
848
# header.html footer.html stylesheet.css YourConfigFile" and then modify
849
# that header. Note that the header is subject to change so you typically
850
# have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
851

    
852
HTML_HEADER            =
853

    
854
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
855
# each generated HTML page. If it is left blank doxygen will generate a
856
# standard footer.
857

    
858
HTML_FOOTER            = ./ManPages/footer.htm
859

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

    
867
HTML_STYLESHEET        =
868

    
869
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
870
# other source files which should be copied to the HTML output directory. Note
871
# that these files will be copied to the base HTML output directory. Use the
872
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
873
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
874
# the files will be copied as-is; there are no commands or markers available.
875

    
876
HTML_EXTRA_FILES       =
877

    
878
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
879
# Doxygen will adjust the colors in the stylesheet and background images
880
# according to this color. Hue is specified as an angle on a colorwheel,
881
# see http://en.wikipedia.org/wiki/Hue for more information.
882
# For instance the value 0 represents red, 60 is yellow, 120 is green,
883
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
884
# The allowed range is 0 to 359.
885

    
886
HTML_COLORSTYLE_HUE    = 220
887

    
888
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
889
# the colors in the HTML output. For a value of 0 the output will use
890
# grayscales only. A value of 255 will produce the most vivid colors.
891

    
892
HTML_COLORSTYLE_SAT    = 120
893

    
894
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
895
# the luminance component of the colors in the HTML output. Values below
896
# 100 gradually make the output lighter, whereas values above 100 make
897
# the output darker. The value divided by 100 is the actual gamma applied,
898
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
899
# and 100 does not change the gamma.
900

    
901
HTML_COLORSTYLE_GAMMA  = 80
902

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

    
907
HTML_TIMESTAMP         = NO
908

    
909
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
910
# files or namespaces will be aligned in HTML using tables. If set to
911
# NO a bullet list will be used.
912

    
913
HTML_ALIGN_MEMBERS     = YES
914

    
915
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
916
# documentation will contain sections that can be hidden and shown after the
917
# page has loaded. For this to work a browser that supports
918
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
919
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
920

    
921
HTML_DYNAMIC_SECTIONS  = YES
922

    
923
# If the GENERATE_DOCSET tag is set to YES, additional index files
924
# will be generated that can be used as input for Apple's Xcode 3
925
# integrated development environment, introduced with OSX 10.5 (Leopard).
926
# To create a documentation set, doxygen will generate a Makefile in the
927
# HTML output directory. Running make will produce the docset in that
928
# directory and running "make install" will install the docset in
929
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
930
# it at startup.
931
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
932
# for more information.
933

    
934
GENERATE_DOCSET        = NO
935

    
936
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
937
# feed. A documentation feed provides an umbrella under which multiple
938
# documentation sets from a single provider (such as a company or product suite)
939
# can be grouped.
940

    
941
DOCSET_FEEDNAME        = "Doxygen generated docs"
942

    
943
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
944
# should uniquely identify the documentation set bundle. This should be a
945
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
946
# will append .docset to the name.
947

    
948
DOCSET_BUNDLE_ID       = org.doxygen.Project
949

    
950
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
951
# the documentation publisher. This should be a reverse domain-name style
952
# string, e.g. com.mycompany.MyDocSet.documentation.
953

    
954
DOCSET_PUBLISHER_ID    = com.lufa-lib.library.documentation
955

    
956
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
957

    
958
DOCSET_PUBLISHER_NAME  = DeanCamera
959

    
960
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
961
# will be generated that can be used as input for tools like the
962
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
963
# of the generated HTML documentation.
964

    
965
GENERATE_HTMLHELP      = NO
966

    
967
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
968
# be used to specify the file name of the resulting .chm file. You
969
# can add a path in front of the file if the result should not be
970
# written to the html output directory.
971

    
972
CHM_FILE               = ../LUFA.chm
973

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

    
979
HHC_LOCATION           =
980

    
981
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
982
# controls if a separate .chi index file is generated (YES) or that
983
# it should be included in the master .chm file (NO).
984

    
985
GENERATE_CHI           = NO
986

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

    
991
CHM_INDEX_ENCODING     =
992

    
993
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
994
# controls whether a binary table of contents is generated (YES) or a
995
# normal table of contents (NO) in the .chm file.
996

    
997
BINARY_TOC             = NO
998

    
999
# The TOC_EXPAND flag can be set to YES to add extra items for group members
1000
# to the contents of the HTML help documentation and to the tree view.
1001

    
1002
TOC_EXPAND             = YES
1003

    
1004
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1005
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1006
# that can be used as input for Qt's qhelpgenerator to generate a
1007
# Qt Compressed Help (.qch) of the generated HTML documentation.
1008

    
1009
GENERATE_QHP           = NO
1010

    
1011
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1012
# be used to specify the file name of the resulting .qch file.
1013
# The path specified is relative to the HTML output folder.
1014

    
1015
QCH_FILE               =
1016

    
1017
# The QHP_NAMESPACE tag specifies the namespace to use when generating
1018
# Qt Help Project output. For more information please see
1019
# http://doc.trolltech.com/qthelpproject.html#namespace
1020

    
1021
QHP_NAMESPACE          = org.doxygen.Project
1022

    
1023
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1024
# Qt Help Project output. For more information please see
1025
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1026

    
1027
QHP_VIRTUAL_FOLDER     = doc
1028

    
1029
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1030
# add. For more information please see
1031
# http://doc.trolltech.com/qthelpproject.html#custom-filters
1032

    
1033
QHP_CUST_FILTER_NAME   =
1034

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

    
1040
QHP_CUST_FILTER_ATTRS  =
1041

    
1042
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1043
# project's
1044
# filter section matches.
1045
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1046
# Qt Help Project / Filter Attributes</a>.
1047

    
1048
QHP_SECT_FILTER_ATTRS  =
1049

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

    
1055
QHG_LOCATION           =
1056

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

    
1066
GENERATE_ECLIPSEHELP   = NO
1067

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

    
1072
ECLIPSE_DOC_ID         = org.doxygen.Project
1073

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

    
1078
DISABLE_INDEX          = NO
1079

    
1080
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1081
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1082
# documentation. Note that a value of 0 will completely suppress the enum
1083
# values from appearing in the overview section.
1084

    
1085
ENUM_VALUES_PER_LINE   = 1
1086

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

    
1095
GENERATE_TREEVIEW      = YES
1096

    
1097
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1098
# and Class Hierarchy pages using a tree view instead of an ordered list.
1099

    
1100
USE_INLINE_TREES       = YES
1101

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

    
1106
TREEVIEW_WIDTH         = 300
1107

    
1108
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1109
# links to external symbols imported via tag files in a separate window.
1110

    
1111
EXT_LINKS_IN_WINDOW    = NO
1112

    
1113
# Use this tag to change the font size of Latex formulas included
1114
# as images in the HTML documentation. The default is 10. Note that
1115
# when you change the font size after a successful doxygen run you need
1116
# to manually remove any form_*.png images from the HTML output directory
1117
# to force them to be regenerated.
1118

    
1119
FORMULA_FONTSIZE       = 10
1120

    
1121
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1122
# generated for formulas are transparent PNGs. Transparent PNGs are
1123
# not supported properly for IE 6.0, but are supported on all modern browsers.
1124
# Note that when changing this option you need to delete any form_*.png files
1125
# in the HTML output before the changes have effect.
1126

    
1127
FORMULA_TRANSPARENT    = YES
1128

    
1129
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1130
# (see http://www.mathjax.org) which uses client side Javascript for the
1131
# rendering instead of using prerendered bitmaps. Use this if you do not
1132
# have LaTeX installed or if you want to formulas look prettier in the HTML
1133
# output. When enabled you also need to install MathJax separately and
1134
# configure the path to it using the MATHJAX_RELPATH option.
1135

    
1136
USE_MATHJAX            = NO
1137

    
1138
# When MathJax is enabled you need to specify the location relative to the
1139
# HTML output directory using the MATHJAX_RELPATH option. The destination
1140
# directory should contain the MathJax.js script. For instance, if the mathjax
1141
# directory is located at the same level as the HTML output directory, then
1142
# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1143
# mathjax.org site, so you can quickly see the result without installing
1144
# MathJax, but it is strongly recommended to install a local copy of MathJax
1145
# before deployment.
1146

    
1147
MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1148

    
1149
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1150
# for the HTML output. The underlying search engine uses javascript
1151
# and DHTML and should work on any modern browser. Note that when using
1152
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1153
# (GENERATE_DOCSET) there is already a search function so this one should
1154
# typically be disabled. For large projects the javascript based search engine
1155
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1156

    
1157
SEARCHENGINE           = YES
1158

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

    
1167
SERVER_BASED_SEARCH    = NO
1168

    
1169
#---------------------------------------------------------------------------
1170
# configuration options related to the LaTeX output
1171
#---------------------------------------------------------------------------
1172

    
1173
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1174
# generate Latex output.
1175

    
1176
GENERATE_LATEX         = NO
1177

    
1178
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1179
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1180
# put in front of it. If left blank `latex' will be used as the default path.
1181

    
1182
LATEX_OUTPUT           = latex
1183

    
1184
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1185
# invoked. If left blank `latex' will be used as the default command name.
1186
# Note that when enabling USE_PDFLATEX this option is only used for
1187
# generating bitmaps for formulas in the HTML output, but not in the
1188
# Makefile that is written to the output directory.
1189

    
1190
LATEX_CMD_NAME         = latex
1191

    
1192
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1193
# generate index for LaTeX. If left blank `makeindex' will be used as the
1194
# default command name.
1195

    
1196
MAKEINDEX_CMD_NAME     = makeindex
1197

    
1198
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1199
# LaTeX documents. This may be useful for small projects and may help to
1200
# save some trees in general.
1201

    
1202
COMPACT_LATEX          = NO
1203

    
1204
# The PAPER_TYPE tag can be used to set the paper type that is used
1205
# by the printer. Possible values are: a4, letter, legal and
1206
# executive. If left blank a4wide will be used.
1207

    
1208
PAPER_TYPE             = a4wide
1209

    
1210
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1211
# packages that should be included in the LaTeX output.
1212

    
1213
EXTRA_PACKAGES         =
1214

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

    
1220
LATEX_HEADER           =
1221

    
1222
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1223
# the generated latex document. The footer should contain everything after
1224
# the last chapter. If it is left blank doxygen will generate a
1225
# standard footer. Notice: only use this tag if you know what you are doing!
1226

    
1227
LATEX_FOOTER           =
1228

    
1229
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1230
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1231
# contain links (just like the HTML output) instead of page references
1232
# This makes the output suitable for online browsing using a pdf viewer.
1233

    
1234
PDF_HYPERLINKS         = YES
1235

    
1236
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1237
# plain latex in the generated Makefile. Set this option to YES to get a
1238
# higher quality PDF documentation.
1239

    
1240
USE_PDFLATEX           = YES
1241

    
1242
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1243
# command to the generated LaTeX files. This will instruct LaTeX to keep
1244
# running if errors occur, instead of asking the user for help.
1245
# This option is also used when generating formulas in HTML.
1246

    
1247
LATEX_BATCHMODE        = NO
1248

    
1249
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1250
# include the index chapters (such as File Index, Compound Index, etc.)
1251
# in the output.
1252

    
1253
LATEX_HIDE_INDICES     = NO
1254

    
1255
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1256
# source code with syntax highlighting in the LaTeX output.
1257
# Note that which sources are shown also depends on other settings
1258
# such as SOURCE_BROWSER.
1259

    
1260
LATEX_SOURCE_CODE      = NO
1261

    
1262
#---------------------------------------------------------------------------
1263
# configuration options related to the RTF output
1264
#---------------------------------------------------------------------------
1265

    
1266
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1267
# The RTF output is optimized for Word 97 and may not look very pretty with
1268
# other RTF readers or editors.
1269

    
1270
GENERATE_RTF           = NO
1271

    
1272
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1273
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1274
# put in front of it. If left blank `rtf' will be used as the default path.
1275

    
1276
RTF_OUTPUT             = rtf
1277

    
1278
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1279
# RTF documents. This may be useful for small projects and may help to
1280
# save some trees in general.
1281

    
1282
COMPACT_RTF            = NO
1283

    
1284
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1285
# will contain hyperlink fields. The RTF file will
1286
# contain links (just like the HTML output) instead of page references.
1287
# This makes the output suitable for online browsing using WORD or other
1288
# programs which support those fields.
1289
# Note: wordpad (write) and others do not support links.
1290

    
1291
RTF_HYPERLINKS         = NO
1292

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

    
1297
RTF_STYLESHEET_FILE    =
1298

    
1299
# Set optional variables used in the generation of an rtf document.
1300
# Syntax is similar to doxygen's config file.
1301

    
1302
RTF_EXTENSIONS_FILE    =
1303

    
1304
#---------------------------------------------------------------------------
1305
# configuration options related to the man page output
1306
#---------------------------------------------------------------------------
1307

    
1308
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1309
# generate man pages
1310

    
1311
GENERATE_MAN           = NO
1312

    
1313
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1314
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1315
# put in front of it. If left blank `man' will be used as the default path.
1316

    
1317
MAN_OUTPUT             = man
1318

    
1319
# The MAN_EXTENSION tag determines the extension that is added to
1320
# the generated man pages (default is the subroutine's section .3)
1321

    
1322
MAN_EXTENSION          = .3
1323

    
1324
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1325
# then it will generate one additional man file for each entity
1326
# documented in the real man page(s). These additional files
1327
# only source the real man page, but without them the man command
1328
# would be unable to find the correct page. The default is NO.
1329

    
1330
MAN_LINKS              = NO
1331

    
1332
#---------------------------------------------------------------------------
1333
# configuration options related to the XML output
1334
#---------------------------------------------------------------------------
1335

    
1336
# If the GENERATE_XML tag is set to YES Doxygen will
1337
# generate an XML file that captures the structure of
1338
# the code including all documentation.
1339

    
1340
GENERATE_XML           = NO
1341

    
1342
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1343
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1344
# put in front of it. If left blank `xml' will be used as the default path.
1345

    
1346
XML_OUTPUT             = xml
1347

    
1348
# The XML_SCHEMA tag can be used to specify an XML schema,
1349
# which can be used by a validating XML parser to check the
1350
# syntax of the XML files.
1351

    
1352
XML_SCHEMA             =
1353

    
1354
# The XML_DTD tag can be used to specify an XML DTD,
1355
# which can be used by a validating XML parser to check the
1356
# syntax of the XML files.
1357

    
1358
XML_DTD                =
1359

    
1360
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1361
# dump the program listings (including syntax highlighting
1362
# and cross-referencing information) to the XML output. Note that
1363
# enabling this will significantly increase the size of the XML output.
1364

    
1365
XML_PROGRAMLISTING     = YES
1366

    
1367
#---------------------------------------------------------------------------
1368
# configuration options for the AutoGen Definitions output
1369
#---------------------------------------------------------------------------
1370

    
1371
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1372
# generate an AutoGen Definitions (see autogen.sf.net) file
1373
# that captures the structure of the code including all
1374
# documentation. Note that this feature is still experimental
1375
# and incomplete at the moment.
1376

    
1377
GENERATE_AUTOGEN_DEF   = NO
1378

    
1379
#---------------------------------------------------------------------------
1380
# configuration options related to the Perl module output
1381
#---------------------------------------------------------------------------
1382

    
1383
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1384
# generate a Perl module file that captures the structure of
1385
# the code including all documentation. Note that this
1386
# feature is still experimental and incomplete at the
1387
# moment.
1388

    
1389
GENERATE_PERLMOD       = NO
1390

    
1391
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1392
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1393
# to generate PDF and DVI output from the Perl module output.
1394

    
1395
PERLMOD_LATEX          = NO
1396

    
1397
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1398
# nicely formatted so it can be parsed by a human reader.
1399
# This is useful
1400
# if you want to understand what is going on.
1401
# On the other hand, if this
1402
# tag is set to NO the size of the Perl module output will be much smaller
1403
# and Perl will parse it just the same.
1404

    
1405
PERLMOD_PRETTY         = YES
1406

    
1407
# The names of the make variables in the generated doxyrules.make file
1408
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1409
# This is useful so different doxyrules.make files included by the same
1410
# Makefile don't overwrite each other's variables.
1411

    
1412
PERLMOD_MAKEVAR_PREFIX =
1413

    
1414
#---------------------------------------------------------------------------
1415
# Configuration options related to the preprocessor
1416
#---------------------------------------------------------------------------
1417

    
1418
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1419
# evaluate all C-preprocessor directives found in the sources and include
1420
# files.
1421

    
1422
ENABLE_PREPROCESSING   = YES
1423

    
1424
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1425
# names in the source code. If set to NO (the default) only conditional
1426
# compilation will be performed. Macro expansion can be done in a controlled
1427
# way by setting EXPAND_ONLY_PREDEF to YES.
1428

    
1429
MACRO_EXPANSION        = YES
1430

    
1431
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1432
# then the macro expansion is limited to the macros specified with the
1433
# PREDEFINED and EXPAND_AS_DEFINED tags.
1434

    
1435
EXPAND_ONLY_PREDEF     = YES
1436

    
1437
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1438
# pointed to by INCLUDE_PATH will be searched when a #include is found.
1439

    
1440
SEARCH_INCLUDES        = YES
1441

    
1442
# The INCLUDE_PATH tag can be used to specify one or more directories that
1443
# contain include files that are not input files but should be processed by
1444
# the preprocessor.
1445

    
1446
INCLUDE_PATH           =
1447

    
1448
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1449
# patterns (like *.h and *.hpp) to filter out the header-files in the
1450
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1451
# be used.
1452

    
1453
INCLUDE_FILE_PATTERNS  =
1454

    
1455
# The PREDEFINED tag can be used to specify one or more macro names that
1456
# are defined before the preprocessor is started (similar to the -D option of
1457
# gcc). The argument of the tag is a list of macros of the form: name
1458
# or name=definition (no spaces). If the definition and the = are
1459
# omitted =1 is assumed. To prevent a macro definition from being
1460
# undefined via #undef or recursively expanded use the := operator
1461
# instead of the = operator.
1462

    
1463
PREDEFINED             = __DOXYGEN__ \
1464
                         PROGMEM \
1465
                         EEMEM \
1466
                         ATTR_PACKED
1467

    
1468
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1469
# this tag can be used to specify a list of macro names that should be expanded.
1470
# The macro definition that is found in the sources will be used.
1471
# Use the PREDEFINED tag if you want to use a different macro definition that
1472
# overrules the definition found in the source code.
1473

    
1474
EXPAND_AS_DEFINED      =
1475

    
1476
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1477
# doxygen's preprocessor will remove all references to function-like macros
1478
# that are alone on a line, have an all uppercase name, and do not end with a
1479
# semicolon, because these will confuse the parser if not removed.
1480

    
1481
SKIP_FUNCTION_MACROS   = YES
1482

    
1483
#---------------------------------------------------------------------------
1484
# Configuration::additions related to external references
1485
#---------------------------------------------------------------------------
1486

    
1487
# The TAGFILES option can be used to specify one or more tagfiles.
1488
# Optionally an initial location of the external documentation
1489
# can be added for each tagfile. The format of a tag file without
1490
# this location is as follows:
1491
#
1492
# TAGFILES = file1 file2 ...
1493
# Adding location for the tag files is done as follows:
1494
#
1495
# TAGFILES = file1=loc1 "file2 = loc2" ...
1496
# where "loc1" and "loc2" can be relative or absolute paths or
1497
# URLs. If a location is present for each tag, the installdox tool
1498
# does not have to be run to correct the links.
1499
# Note that each tag file must have a unique name
1500
# (where the name does NOT include the path)
1501
# If a tag file is not located in the directory in which doxygen
1502
# is run, you must also specify the path to the tagfile here.
1503

    
1504
TAGFILES               =
1505

    
1506
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1507
# a tag file that is based on the input files it reads.
1508

    
1509
GENERATE_TAGFILE       =
1510

    
1511
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1512
# in the class index. If set to NO only the inherited external classes
1513
# will be listed.
1514

    
1515
ALLEXTERNALS           = NO
1516

    
1517
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1518
# in the modules index. If set to NO, only the current project's groups will
1519
# be listed.
1520

    
1521
EXTERNAL_GROUPS        = YES
1522

    
1523
# The PERL_PATH should be the absolute path and name of the perl script
1524
# interpreter (i.e. the result of `which perl').
1525

    
1526
PERL_PATH              = /usr/bin/perl
1527

    
1528
#---------------------------------------------------------------------------
1529
# Configuration options related to the dot tool
1530
#---------------------------------------------------------------------------
1531

    
1532
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1533
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1534
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1535
# this option also works with HAVE_DOT disabled, but it is recommended to
1536
# install and use dot, since it yields more powerful graphs.
1537

    
1538
CLASS_DIAGRAMS         = NO
1539

    
1540
# You can define message sequence charts within doxygen comments using the \msc
1541
# command. Doxygen will then run the mscgen tool (see
1542
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1543
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1544
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1545
# default search path.
1546

    
1547
MSCGEN_PATH            =
1548

    
1549
# If set to YES, the inheritance and collaboration graphs will hide
1550
# inheritance and usage relations if the target is undocumented
1551
# or is not a class.
1552

    
1553
HIDE_UNDOC_RELATIONS   = YES
1554

    
1555
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1556
# available from the path. This tool is part of Graphviz, a graph visualization
1557
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1558
# have no effect if this option is set to NO (the default)
1559

    
1560
HAVE_DOT               = NO
1561

    
1562
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1563
# allowed to run in parallel. When set to 0 (the default) doxygen will
1564
# base this on the number of processors available in the system. You can set it
1565
# explicitly to a value larger than 0 to get control over the balance
1566
# between CPU load and processing speed.
1567

    
1568
DOT_NUM_THREADS        = 0
1569

    
1570
# By default doxygen will write a font called Helvetica to the output
1571
# directory and reference it in all dot files that doxygen generates.
1572
# When you want a differently looking font you can specify the font name
1573
# using DOT_FONTNAME. You need to make sure dot is able to find the font,
1574
# which can be done by putting it in a standard location or by setting the
1575
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1576
# containing the font.
1577

    
1578
DOT_FONTNAME           = FreeSans
1579

    
1580
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1581
# The default size is 10pt.
1582

    
1583
DOT_FONTSIZE           = 10
1584

    
1585
# By default doxygen will tell dot to use the output directory to look for the
1586
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1587
# different font using DOT_FONTNAME you can set the path where dot
1588
# can find it using this tag.
1589

    
1590
DOT_FONTPATH           =
1591

    
1592
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1593
# will generate a graph for each documented class showing the direct and
1594
# indirect inheritance relations. Setting this tag to YES will force the
1595
# the CLASS_DIAGRAMS tag to NO.
1596

    
1597
CLASS_GRAPH            = NO
1598

    
1599
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1600
# will generate a graph for each documented class showing the direct and
1601
# indirect implementation dependencies (inheritance, containment, and
1602
# class references variables) of the class with other documented classes.
1603

    
1604
COLLABORATION_GRAPH    = NO
1605

    
1606
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1607
# will generate a graph for groups, showing the direct groups dependencies
1608

    
1609
GROUP_GRAPHS           = YES
1610

    
1611
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1612
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1613
# Language.
1614

    
1615
UML_LOOK               = NO
1616

    
1617
# If set to YES, the inheritance and collaboration graphs will show the
1618
# relations between templates and their instances.
1619

    
1620
TEMPLATE_RELATIONS     = NO
1621

    
1622
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1623
# tags are set to YES then doxygen will generate a graph for each documented
1624
# file showing the direct and indirect include dependencies of the file with
1625
# other documented files.
1626

    
1627
INCLUDE_GRAPH          = YES
1628

    
1629
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1630
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1631
# documented header file showing the documented files that directly or
1632
# indirectly include this file.
1633

    
1634
INCLUDED_BY_GRAPH      = YES
1635

    
1636
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1637
# doxygen will generate a call dependency graph for every global function
1638
# or class method. Note that enabling this option will significantly increase
1639
# the time of a run. So in most cases it will be better to enable call graphs
1640
# for selected functions only using the \callgraph command.
1641

    
1642
CALL_GRAPH             = NO
1643

    
1644
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1645
# doxygen will generate a caller dependency graph for every global function
1646
# or class method. Note that enabling this option will significantly increase
1647
# the time of a run. So in most cases it will be better to enable caller
1648
# graphs for selected functions only using the \callergraph command.
1649

    
1650
CALLER_GRAPH           = NO
1651

    
1652
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1653
# will generate a graphical hierarchy of all classes instead of a textual one.
1654

    
1655
GRAPHICAL_HIERARCHY    = NO
1656

    
1657
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1658
# then doxygen will show the dependencies a directory has on other directories
1659
# in a graphical way. The dependency relations are determined by the #include
1660
# relations between the files in the directories.
1661

    
1662
DIRECTORY_GRAPH        = YES
1663

    
1664
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1665
# generated by dot. Possible values are svg, png, jpg, or gif.
1666
# If left blank png will be used.
1667

    
1668
DOT_IMAGE_FORMAT       = png
1669

    
1670
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1671
# found. If left blank, it is assumed the dot tool can be found in the path.
1672

    
1673
DOT_PATH               =
1674

    
1675
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1676
# contain dot files that are included in the documentation (see the
1677
# \dotfile command).
1678

    
1679
DOTFILE_DIRS           =
1680

    
1681
# The MSCFILE_DIRS tag can be used to specify one or more directories that
1682
# contain msc files that are included in the documentation (see the
1683
# \mscfile command).
1684

    
1685
MSCFILE_DIRS           =
1686

    
1687
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1688
# nodes that will be shown in the graph. If the number of nodes in a graph
1689
# becomes larger than this value, doxygen will truncate the graph, which is
1690
# visualized by representing a node as a red box. Note that doxygen if the
1691
# number of direct children of the root node in a graph is already larger than
1692
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1693
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1694

    
1695
DOT_GRAPH_MAX_NODES    = 15
1696

    
1697
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1698
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1699
# from the root by following a path via at most 3 edges will be shown. Nodes
1700
# that lay further from the root node will be omitted. Note that setting this
1701
# option to 1 or 2 may greatly reduce the computation time needed for large
1702
# code bases. Also note that the size of a graph can be further restricted by
1703
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1704

    
1705
MAX_DOT_GRAPH_DEPTH    = 2
1706

    
1707
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1708
# background. This is disabled by default, because dot on Windows does not
1709
# seem to support this out of the box. Warning: Depending on the platform used,
1710
# enabling this option may lead to badly anti-aliased labels on the edges of
1711
# a graph (i.e. they become hard to read).
1712

    
1713
DOT_TRANSPARENT        = YES
1714

    
1715
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1716
# files in one run (i.e. multiple -o and -T options on the command line). This
1717
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1718
# support this, this feature is disabled by default.
1719

    
1720
DOT_MULTI_TARGETS      = NO
1721

    
1722
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1723
# generate a legend page explaining the meaning of the various boxes and
1724
# arrows in the dot generated graphs.
1725

    
1726
GENERATE_LEGEND        = YES
1727

    
1728
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1729
# remove the intermediate dot files that are used to generate
1730
# the various graphs.
1731

    
1732
DOT_CLEANUP            = YES