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