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