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