Updates to enable Yocto parallel build
[keystone-rtos/fault_mgmt.git] / docs / doxyfile.xdt
1 %%{
2 /*!
3  *  This template implements the Doxyfile
4  */  
5   /* Versioning */
6   var ver = this;
7   var packageVersion = ver[0]+"."+ver[1]+"."+ver[2]+"."+ver[3];
9 %%}
12 # Doxyfile 1.7.3
14 # This file describes the settings to be used by the documentation system
15 # doxygen (www.doxygen.org) for a project
16 #
17 # All text after a hash (#) is considered a comment and will be ignored
18 # The format is:
19 #       TAG = value [value, ...]
20 # For lists items can also be appended using:
21 #       TAG += value [value, ...]
22 # Values that contain spaces should be placed between quotes (" ")
24 #---------------------------------------------------------------------------
25 # Project related configuration options
26 #---------------------------------------------------------------------------
28 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
29 # by quotes) that should identify the project.
31 PROJECT_NAME           = "Fault Management Library"
33 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
34 # This could be handy for archiving the generated documentation or 
35 # if some version control system is used.
37 PROJECT_NUMBER         =  `packageVersion`
39 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
40 # base path where the generated documentation will be put. 
41 # If a relative path is entered, it will be relative to the location 
42 # where doxygen was started. If left blank the current directory will be used.
44 OUTPUT_DIRECTORY       = ./docs/doxygen
46 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
47 # 4096 sub-directories (in 2 levels) under the output directory of each output 
48 # format and will distribute the generated files over these directories. 
49 # Enabling this option can be useful when feeding doxygen a huge amount of 
50 # source files, where putting all generated files in the same directory would 
51 # otherwise cause performance problems for the file system.
53 CREATE_SUBDIRS         = NO
55 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
56 # documentation generated by doxygen is written. Doxygen will use this 
57 # information to generate all constant output in the proper language. 
58 # The default language is English, other supported languages are: 
59 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
60 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
61 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
62 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
63 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 
64 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
66 OUTPUT_LANGUAGE        = English
68 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
69 # include brief member descriptions after the members that are listed in 
70 # the file and class documentation (similar to JavaDoc). 
71 # Set to NO to disable this.
73 BRIEF_MEMBER_DESC      = YES
75 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
76 # the brief description of a member or function before the detailed description. 
77 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
78 # brief descriptions will be completely suppressed.
80 REPEAT_BRIEF           = YES
82 # This tag implements a quasi-intelligent brief description abbreviator 
83 # that is used to form the text in various listings. Each string 
84 # in this list, if found as the leading text of the brief description, will be 
85 # stripped from the text and the result after processing the whole list, is 
86 # used as the annotated text. Otherwise, the brief description is used as-is. 
87 # If left blank, the following values are used ("$name" is automatically 
88 # replaced with the name of the entity): "The $name class" "The $name widget" 
89 # "The $name file" "is" "provides" "specifies" "contains" 
90 # "represents" "a" "an" "the"
92 ABBREVIATE_BRIEF       = "The $name class" \
93                          "The $name widget" \
94                          "The $name file" \
95                          is \
96                          provides \
97                          specifies \
98                          contains \
99                          represents \
100                          a \
101                          an \
102                          the
104 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
105 # Doxygen will generate a detailed section even if there is only a brief 
106 # description.
108 ALWAYS_DETAILED_SEC    = NO
110 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
111 # inherited members of a class in the documentation of that class as if those 
112 # members were ordinary class members. Constructors, destructors and assignment 
113 # operators of the base classes will not be shown.
115 INLINE_INHERITED_MEMB  = NO
117 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
118 # path before files name in the file list and in the header files. If set 
119 # to NO the shortest path that makes the file name unique will be used.
121 FULL_PATH_NAMES        = NO
123 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
124 # can be used to strip a user-defined part of the path. Stripping is 
125 # only done if one of the specified strings matches the left-hand part of 
126 # the path. The tag can be used to show relative paths in the file list. 
127 # If left blank the directory from which doxygen is run is used as the 
128 # path to strip.
130 STRIP_FROM_PATH        = 
132 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
133 # the path mentioned in the documentation of a class, which tells 
134 # the reader which header file to include in order to use a class. 
135 # If left blank only the name of the header file containing the class 
136 # definition is used. Otherwise one should specify the include paths that 
137 # are normally passed to the compiler using the -I flag.
139 STRIP_FROM_INC_PATH    = 
141 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
142 # (but less readable) file names. This can be useful if your file system 
143 # doesn't support long names like on DOS, Mac, or CD-ROM.
145 SHORT_NAMES            = NO
147 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
148 # will interpret the first line (until the first dot) of a JavaDoc-style 
149 # comment as the brief description. If set to NO, the JavaDoc 
150 # comments will behave just like regular Qt-style comments 
151 # (thus requiring an explicit @brief command for a brief description.)
153 JAVADOC_AUTOBRIEF      = NO
155 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
156 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
157 # comments) as a brief description. This used to be the default behaviour. 
158 # The new default is to treat a multi-line C++ comment block as a detailed 
159 # description. Set this tag to YES if you prefer the old behaviour instead.
161 MULTILINE_CPP_IS_BRIEF = NO
163 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
164 # member inherits the documentation from any documented member that it 
165 # re-implements.
167 INHERIT_DOCS           = YES
169 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
170 # a new page for each member. If set to NO, the documentation of a member will 
171 # be part of the file/class/namespace that contains it.
173 SEPARATE_MEMBER_PAGES  = NO
175 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
176 # Doxygen uses this value to replace tabs by spaces in code fragments.
178 TAB_SIZE               = 8
180 # This tag can be used to specify a number of aliases that acts 
181 # as commands in the documentation. An alias has the form "name=value". 
182 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
183 # put the command \sideeffect (or @sideeffect) in the documentation, which 
184 # will result in a user-defined paragraph with heading "Side Effects:". 
185 # You can put \n's in the value part of an alias to insert newlines.
187 ALIASES                = 
189 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
190 # sources only. Doxygen will then generate output that is more tailored for C. 
191 # For instance, some of the names that are used will be different. The list 
192 # of all members will be omitted, etc.
194 OPTIMIZE_OUTPUT_FOR_C  = YES
196 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
197 # sources only. Doxygen will then generate output that is more tailored for 
198 # Java. For instance, namespaces will be presented as packages, qualified 
199 # scopes will look different, etc.
201 OPTIMIZE_OUTPUT_JAVA   = NO
203 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
204 # to include (a tag file for) the STL sources as input, then you should 
205 # set this tag to YES in order to let doxygen match functions declarations and 
206 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
207 # func(std::string) {}). This also makes the inheritance and collaboration 
208 # diagrams that involve STL classes more complete and accurate.
210 BUILTIN_STL_SUPPORT    = NO
212 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
213 # tag is set to YES, then doxygen will reuse the documentation of the first 
214 # member in the group (if any) for the other members of the group. By default 
215 # all members of a group must be documented explicitly.
217 DISTRIBUTE_GROUP_DOC   = NO
219 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
220 # the same type (for instance a group of public functions) to be put as a 
221 # subgroup of that type (e.g. under the Public Functions section). Set it to 
222 # NO to prevent subgrouping. Alternatively, this can be done per class using 
223 # the \nosubgrouping command.
225 SUBGROUPING            = YES
227 #---------------------------------------------------------------------------
228 # Build related configuration options
229 #---------------------------------------------------------------------------
231 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
232 # documentation are documented, even if no documentation was available. 
233 # Private class members and static file members will be hidden unless 
234 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
236 EXTRACT_ALL            = NO
238 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
239 # will be included in the documentation.
241 EXTRACT_PRIVATE        = NO
243 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
244 # will be included in the documentation.
246 EXTRACT_STATIC         = YES
248 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
249 # defined locally in source files will be included in the documentation. 
250 # If set to NO only classes defined in header files are included.
252 EXTRACT_LOCAL_CLASSES  = YES
254 # This flag is only useful for Objective-C code. When set to YES local 
255 # methods, which are defined in the implementation section but not in 
256 # the interface are included in the documentation. 
257 # If set to NO (the default) only methods in the interface are included.
259 EXTRACT_LOCAL_METHODS  = NO
261 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
262 # undocumented members of documented classes, files or namespaces. 
263 # If set to NO (the default) these members will be included in the 
264 # various overviews, but no documentation section is generated. 
265 # This option has no effect if EXTRACT_ALL is enabled.
267 HIDE_UNDOC_MEMBERS     = YES
269 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
270 # undocumented classes that are normally visible in the class hierarchy. 
271 # If set to NO (the default) these classes will be included in the various 
272 # overviews. This option has no effect if EXTRACT_ALL is enabled.
274 HIDE_UNDOC_CLASSES     = YES
276 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
277 # friend (class|struct|union) declarations. 
278 # If set to NO (the default) these declarations will be included in the 
279 # documentation.
281 HIDE_FRIEND_COMPOUNDS  = NO
283 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
284 # documentation blocks found inside the body of a function. 
285 # If set to NO (the default) these blocks will be appended to the 
286 # function's detailed documentation block.
288 HIDE_IN_BODY_DOCS      = NO
290 # The INTERNAL_DOCS tag determines if documentation 
291 # that is typed after a \internal command is included. If the tag is set 
292 # to NO (the default) then the documentation will be excluded. 
293 # Set it to YES to include the internal documentation.
295 INTERNAL_DOCS          = NO
297 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
298 # file names in lower-case letters. If set to YES upper-case letters are also 
299 # allowed. This is useful if you have classes or files whose names only differ 
300 # in case and if your file system supports case sensitive file names. Windows 
301 # and Mac users are advised to set this option to NO.
303 CASE_SENSE_NAMES       = NO
305 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
306 # will show members with their full class and namespace scopes in the 
307 # documentation. If set to YES the scope will be hidden.
309 HIDE_SCOPE_NAMES       = NO
311 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
312 # will put a list of the files that are included by a file in the documentation 
313 # of that file.
315 SHOW_INCLUDE_FILES     = YES
317 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
318 # is inserted in the documentation for inline members.
320 INLINE_INFO            = YES
322 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
323 # will sort the (detailed) documentation of file and class members 
324 # alphabetically by member name. If set to NO the members will appear in 
325 # declaration order.
327 SORT_MEMBER_DOCS       = YES
329 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
330 # brief documentation of file, namespace and class members alphabetically 
331 # by member name. If set to NO (the default) the members will appear in 
332 # declaration order.
334 SORT_BRIEF_DOCS        = NO
336 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
337 # sorted by fully-qualified names, including namespaces. If set to 
338 # NO (the default), the class list will be sorted only by class name, 
339 # not including the namespace part. 
340 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
341 # Note: This option applies only to the class list, not to the 
342 # alphabetical list.
344 SORT_BY_SCOPE_NAME     = NO
346 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
347 # disable (NO) the todo list. This list is created by putting \todo 
348 # commands in the documentation.
350 GENERATE_TODOLIST      = YES
352 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
353 # disable (NO) the test list. This list is created by putting \test 
354 # commands in the documentation.
356 GENERATE_TESTLIST      = YES
358 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
359 # disable (NO) the bug list. This list is created by putting \bug 
360 # commands in the documentation.
362 GENERATE_BUGLIST       = YES
364 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
365 # disable (NO) the deprecated list. This list is created by putting 
366 # \deprecated commands in the documentation.
368 GENERATE_DEPRECATEDLIST= YES
370 # The ENABLED_SECTIONS tag can be used to enable conditional 
371 # documentation sections, marked by \if sectionname ... \endif.
373 ENABLED_SECTIONS       = 
375 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
376 # the initial value of a variable or macro consists of for it to appear in 
377 # the documentation. If the initializer consists of more lines than specified 
378 # here it will be hidden. Use a value of 0 to hide initializers completely. 
379 # The appearance of the initializer of individual variables and macros in the 
380 # documentation can be controlled using \showinitializer or \hideinitializer 
381 # command in the documentation regardless of this setting.
383 MAX_INITIALIZER_LINES  = 30
385 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
386 # at the bottom of the documentation of classes and structs. If set to YES the 
387 # list will mention the files that were used to generate the documentation.
389 SHOW_USED_FILES        = YES
391 # If the sources in your project are distributed over multiple directories 
392 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
393 # in the documentation. The default is NO.
395 SHOW_DIRECTORIES       = NO
397 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
398 # doxygen should invoke to get the current version for each file (typically from 
399 # the version control system). Doxygen will invoke the program by executing (via 
400 # popen()) the command <command> <input-file>, where <command> is the value of 
401 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
402 # provided by doxygen. Whatever the program writes to standard output 
403 # is used as the file version. See the manual for examples.
405 FILE_VERSION_FILTER    = 
407 #---------------------------------------------------------------------------
408 # configuration options related to warning and progress messages
409 #---------------------------------------------------------------------------
411 # The QUIET tag can be used to turn on/off the messages that are generated 
412 # by doxygen. Possible values are YES and NO. If left blank NO is used.
414 QUIET                  = NO
416 # The WARNINGS tag can be used to turn on/off the warning messages that are 
417 # generated by doxygen. Possible values are YES and NO. If left blank 
418 # NO is used.
420 WARNINGS               = YES
422 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
423 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
424 # automatically be disabled.
426 WARN_IF_UNDOCUMENTED   = YES
428 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
429 # potential errors in the documentation, such as not documenting some 
430 # parameters in a documented function, or documenting parameters that 
431 # don't exist or using markup commands wrongly.
433 WARN_IF_DOC_ERROR      = YES
435 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 
436 # functions that are documented, but have no documentation for their parameters 
437 # or return value. If set to NO (the default) doxygen will only warn about 
438 # wrong or incomplete parameter documentation, but not about the absence of 
439 # documentation.
441 WARN_NO_PARAMDOC       = NO
443 # The WARN_FORMAT tag determines the format of the warning messages that 
444 # doxygen can produce. The string should contain the $file, $line, and $text 
445 # tags, which will be replaced by the file and line number from which the 
446 # warning originated and the warning text. Optionally the format may contain 
447 # $version, which will be replaced by the version of the file (if it could 
448 # be obtained via FILE_VERSION_FILTER)
450 WARN_FORMAT            = "$file:$line: $text"
452 # The WARN_LOGFILE tag can be used to specify a file to which warning 
453 # and error messages should be written. If left blank the output is written 
454 # to stderr.
456 WARN_LOGFILE           = 
458 #---------------------------------------------------------------------------
459 # configuration options related to the input files
460 #---------------------------------------------------------------------------
462 # The INPUT tag can be used to specify the files and/or directories that contain 
463 # documented source files. You may enter file names like "myfile.cpp" or 
464 # directories like "/usr/src/myproject". Separate the files or directories 
465 # with spaces.
467 INPUT                  = ./src \
468                               . 
470 # If the value of the INPUT tag contains directories, you can use the 
471 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
472 # and *.h) to filter out the source-files in the directories. If left 
473 # blank the following patterns are tested: 
474 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 
475 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 
476 # *.f90 *.f *.for *.vhd *.vhdl
478 FILE_PATTERNS          = *.h 
480 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
481 # should be searched for input files as well. Possible values are YES and NO. 
482 # If left blank NO is used.
484 RECURSIVE              = NO
486 # The EXCLUDE tag can be used to specify files and/or directories that should 
487 # excluded from the INPUT source files. This way you can easily exclude a 
488 # subdirectory from a directory tree whose root is specified with the INPUT tag.
490 EXCLUDE                = YES \
491                          ./test \
492                          ./package \
493                          ./packages
495 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
496 # directories that are symbolic links (a Unix file system feature) are excluded 
497 # from the input.
499 EXCLUDE_SYMLINKS       = NO
501 # If the value of the INPUT tag contains directories, you can use the 
502 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
503 # certain files from those directories. Note that the wildcards are matched 
504 # against the file with absolute path, so to exclude all test directories 
505 # for example use the pattern */test/*
507 EXCLUDE_PATTERNS       = 
509 # The EXAMPLE_PATH tag can be used to specify one or more files or 
510 # directories that contain example code fragments that are included (see 
511 # the \include command).
513 EXAMPLE_PATH           = 
515 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
516 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
517 # and *.h) to filter out the source-files in the directories. If left 
518 # blank all files are included.
520 EXAMPLE_PATTERNS       = *
522 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
523 # searched for input files to be used with the \include or \dontinclude 
524 # commands irrespective of the value of the RECURSIVE tag. 
525 # Possible values are YES and NO. If left blank NO is used.
527 EXAMPLE_RECURSIVE      = NO
529 # The IMAGE_PATH tag can be used to specify one or more files or 
530 # directories that contain image that are included in the documentation (see 
531 # the \image command).
533 IMAGE_PATH             = 
535 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
536 # invoke to filter for each input file. Doxygen will invoke the filter program 
537 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
538 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
539 # input file. Doxygen will then use the output that the filter program writes 
540 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
541 # ignored.
543 INPUT_FILTER           = 
545 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
546 # basis.  Doxygen will compare the file name with each pattern and apply the 
547 # filter if there is a match.  The filters are a list of the form: 
548 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
549 # info on how filters are used. If FILTER_PATTERNS is empty or if 
550 # non of the patterns match the file name, INPUT_FILTER is applied.
552 FILTER_PATTERNS        = 
554 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
555 # INPUT_FILTER) will be used to filter the input files when producing source 
556 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
558 FILTER_SOURCE_FILES    = NO
560 #---------------------------------------------------------------------------
561 # configuration options related to source browsing
562 #---------------------------------------------------------------------------
564 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
565 # be generated. Documented entities will be cross-referenced with these sources. 
566 # Note: To get rid of all source code in the generated output, make sure also 
567 # VERBATIM_HEADERS is set to NO.
569 SOURCE_BROWSER         = NO
571 # Setting the INLINE_SOURCES tag to YES will include the body 
572 # of functions and classes directly in the documentation.
574 INLINE_SOURCES         = NO
576 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
577 # doxygen to hide any special comment blocks from generated source code 
578 # fragments. Normal C and C++ comments will always remain visible.
580 STRIP_CODE_COMMENTS    = YES
582 # If the REFERENCED_BY_RELATION tag is set to YES 
583 # then for each documented function all documented 
584 # functions referencing it will be listed.
586 REFERENCED_BY_RELATION = NO
588 # If the REFERENCES_RELATION tag is set to YES 
589 # then for each documented function all documented entities 
590 # called/used by that function will be listed.
592 REFERENCES_RELATION    = NO
594 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
595 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
596 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
597 # link to the source code.  Otherwise they will link to the documentation.
599 REFERENCES_LINK_SOURCE = YES
601 # If the USE_HTAGS tag is set to YES then the references to source code 
602 # will point to the HTML generated by the htags(1) tool instead of doxygen 
603 # built-in source browser. The htags tool is part of GNU's global source 
604 # tagging system (see http://www.gnu.org/software/global/global.html). You 
605 # will need version 4.8.6 or higher.
607 USE_HTAGS              = NO
609 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
610 # will generate a verbatim copy of the header file for each class for 
611 # which an include is specified. Set to NO to disable this.
613 VERBATIM_HEADERS       = NO
615 #---------------------------------------------------------------------------
616 # configuration options related to the alphabetical class index
617 #---------------------------------------------------------------------------
619 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
620 # of all compounds will be generated. Enable this if the project 
621 # contains a lot of classes, structs, unions or interfaces.
623 ALPHABETICAL_INDEX     = NO
625 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
626 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
627 # in which this list will be split (can be a number in the range [1..20])
629 COLS_IN_ALPHA_INDEX    = 5
631 # In case all classes in a project start with a common prefix, all 
632 # classes will be put under the same header in the alphabetical index. 
633 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
634 # should be ignored while generating the index headers.
636 IGNORE_PREFIX          = 
638 #---------------------------------------------------------------------------
639 # configuration options related to the HTML output
640 #---------------------------------------------------------------------------
642 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
643 # generate HTML output.
645 GENERATE_HTML          = YES
647 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
648 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
649 # put in front of it. If left blank `html' will be used as the default path.
651 HTML_OUTPUT            = html
653 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
654 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
655 # doxygen will generate files with .html extension.
657 HTML_FILE_EXTENSION    = .html
659 # The HTML_HEADER tag can be used to specify a personal HTML header for 
660 # each generated HTML page. If it is left blank doxygen will generate a 
661 # standard header.
663 HTML_HEADER            = ./docs/tiheader.htm
665 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
666 # each generated HTML page. If it is left blank doxygen will generate a 
667 # standard footer.
669 HTML_FOOTER            = ./docs/tifooter.htm
671 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
672 # style sheet that is used by each HTML page. It can be used to 
673 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
674 # will generate a default style sheet. Note that doxygen will try to copy 
675 # the style sheet file to the HTML output directory, so don't put your own 
676 # stylesheet in the HTML output directory as well, or it will be erased!
678 HTML_STYLESHEET        = 
680 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
681 # files or namespaces will be aligned in HTML using tables. If set to 
682 # NO a bullet list will be used.
684 HTML_ALIGN_MEMBERS     = YES
686 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
687 # will be generated that can be used as input for tools like the 
688 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
689 # of the generated HTML documentation.
691 GENERATE_HTMLHELP      = YES
693 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
694 # be used to specify the file name of the resulting .chm file. You 
695 # can add a path in front of the file if the result should not be 
696 # written to the html output directory.
698 CHM_FILE               = ..\..\fault_mgmtlibDocs.chm
700 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
701 # be used to specify the location (absolute path including file name) of 
702 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
703 # the HTML help compiler on the generated index.hhp.
705 HHC_LOCATION           = hhc.exe
707 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
708 # controls if a separate .chi index file is generated (YES) or that 
709 # it should be included in the master .chm file (NO).
711 GENERATE_CHI           = NO
713 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
714 # controls whether a binary table of contents is generated (YES) or a 
715 # normal table of contents (NO) in the .chm file.
717 BINARY_TOC             = NO
719 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
720 # to the contents of the HTML help documentation and to the tree view.
722 TOC_EXPAND             = NO
724 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
725 # top of each HTML page. The value NO (the default) enables the index and 
726 # the value YES disables it.
728 DISABLE_INDEX          = NO
730 # This tag can be used to set the number of enum values (range [0,1..20]) 
731 # that doxygen will group on one line in the generated HTML documentation. 
732 # Note that a value of 0 will completely suppress the enum values from
733 # appearing in the overview section.
735 ENUM_VALUES_PER_LINE   = 4
737 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
738 # structure should be generated to display hierarchical information. 
739 # If the tag value is set to YES, a side panel will be generated 
740 # containing a tree-like index structure (just like the one that 
741 # is generated for HTML Help). For this to work a browser that supports 
742 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 
743 # Windows users are probably better off using the HTML help feature.
745 GENERATE_TREEVIEW      = NO
747 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
748 # used to set the initial width (in pixels) of the frame in which the tree 
749 # is shown.
751 TREEVIEW_WIDTH         = 250
753 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 
754 # for the HTML output. The underlying search engine uses javascript 
755 # and DHTML and should work on any modern browser. Note that when using 
756 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 
757 # (GENERATE_DOCSET) there is already a search function so this one should 
758 # typically be disabled. For large projects the javascript based search engine 
759 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
761 SEARCHENGINE           = NO
763 #---------------------------------------------------------------------------
764 # configuration options related to the LaTeX output
765 #---------------------------------------------------------------------------
767 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
768 # generate Latex output.
770 GENERATE_LATEX         = NO
772 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
773 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
774 # put in front of it. If left blank `latex' will be used as the default path.
776 LATEX_OUTPUT           = latex
778 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
779 # invoked. If left blank `latex' will be used as the default command name. 
780 # Note that when enabling USE_PDFLATEX this option is only used for 
781 # generating bitmaps for formulas in the HTML output, but not in the 
782 # Makefile that is written to the output directory.
784 LATEX_CMD_NAME         = latex
786 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
787 # generate index for LaTeX. If left blank `makeindex' will be used as the 
788 # default command name.
790 MAKEINDEX_CMD_NAME     = makeindex
792 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
793 # LaTeX documents. This may be useful for small projects and may help to 
794 # save some trees in general.
796 COMPACT_LATEX          = NO
798 # The PAPER_TYPE tag can be used to set the paper type that is used 
799 # by the printer. Possible values are: a4, letter, legal and 
800 # executive. If left blank a4wide will be used.
802 PAPER_TYPE             = a4wide
804 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
805 # packages that should be included in the LaTeX output.
807 EXTRA_PACKAGES         = 
809 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
810 # the generated latex document. The header should contain everything until 
811 # the first chapter. If it is left blank doxygen will generate a 
812 # standard header. Notice: only use this tag if you know what you are doing!
814 LATEX_HEADER           = 
816 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
817 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
818 # contain links (just like the HTML output) instead of page references 
819 # This makes the output suitable for online browsing using a pdf viewer.
821 PDF_HYPERLINKS         = NO
823 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
824 # plain latex in the generated Makefile. Set this option to YES to get a 
825 # higher quality PDF documentation.
827 USE_PDFLATEX           = NO
829 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
830 # command to the generated LaTeX files. This will instruct LaTeX to keep 
831 # running if errors occur, instead of asking the user for help. 
832 # This option is also used when generating formulas in HTML.
834 LATEX_BATCHMODE        = NO
836 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
837 # include the index chapters (such as File Index, Compound Index, etc.) 
838 # in the output.
840 LATEX_HIDE_INDICES     = NO
842 #---------------------------------------------------------------------------
843 # configuration options related to the RTF output
844 #---------------------------------------------------------------------------
846 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
847 # The RTF output is optimized for Word 97 and may not look very pretty with 
848 # other RTF readers or editors.
850 GENERATE_RTF           = NO
852 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
853 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
854 # put in front of it. If left blank `rtf' will be used as the default path.
856 RTF_OUTPUT             = rtf
858 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
859 # RTF documents. This may be useful for small projects and may help to 
860 # save some trees in general.
862 COMPACT_RTF            = NO
864 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
865 # will contain hyperlink fields. The RTF file will 
866 # contain links (just like the HTML output) instead of page references. 
867 # This makes the output suitable for online browsing using WORD or other 
868 # programs which support those fields. 
869 # Note: wordpad (write) and others do not support links.
871 RTF_HYPERLINKS         = NO
873 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
874 # config file, i.e. a series of assignments. You only have to provide 
875 # replacements, missing definitions are set to their default value.
877 RTF_STYLESHEET_FILE    = 
879 # Set optional variables used in the generation of an rtf document. 
880 # Syntax is similar to doxygen's config file.
882 RTF_EXTENSIONS_FILE    = 
884 #---------------------------------------------------------------------------
885 # configuration options related to the man page output
886 #---------------------------------------------------------------------------
888 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
889 # generate man pages
891 GENERATE_MAN           = NO
893 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
894 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
895 # put in front of it. If left blank `man' will be used as the default path.
897 MAN_OUTPUT             = man
899 # The MAN_EXTENSION tag determines the extension that is added to 
900 # the generated man pages (default is the subroutine's section .3)
902 MAN_EXTENSION          = .3
904 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
905 # then it will generate one additional man file for each entity 
906 # documented in the real man page(s). These additional files 
907 # only source the real man page, but without them the man command 
908 # would be unable to find the correct page. The default is NO.
910 MAN_LINKS              = NO
912 #---------------------------------------------------------------------------
913 # configuration options related to the XML output
914 #---------------------------------------------------------------------------
916 # If the GENERATE_XML tag is set to YES Doxygen will 
917 # generate an XML file that captures the structure of 
918 # the code including all documentation.
920 GENERATE_XML           = NO
922 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
923 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
924 # put in front of it. If left blank `xml' will be used as the default path.
926 XML_OUTPUT             = xml
928 # The XML_SCHEMA tag can be used to specify an XML schema, 
929 # which can be used by a validating XML parser to check the 
930 # syntax of the XML files.
932 XML_SCHEMA             = 
934 # The XML_DTD tag can be used to specify an XML DTD, 
935 # which can be used by a validating XML parser to check the 
936 # syntax of the XML files.
938 XML_DTD                = 
940 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
941 # dump the program listings (including syntax highlighting 
942 # and cross-referencing information) to the XML output. Note that 
943 # enabling this will significantly increase the size of the XML output.
945 XML_PROGRAMLISTING     = YES
947 #---------------------------------------------------------------------------
948 # configuration options for the AutoGen Definitions output
949 #---------------------------------------------------------------------------
951 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
952 # generate an AutoGen Definitions (see autogen.sf.net) file 
953 # that captures the structure of the code including all 
954 # documentation. Note that this feature is still experimental 
955 # and incomplete at the moment.
957 GENERATE_AUTOGEN_DEF   = NO
959 #---------------------------------------------------------------------------
960 # configuration options related to the Perl module output
961 #---------------------------------------------------------------------------
963 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
964 # generate a Perl module file that captures the structure of 
965 # the code including all documentation. Note that this 
966 # feature is still experimental and incomplete at the 
967 # moment.
969 GENERATE_PERLMOD       = NO
971 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
972 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
973 # to generate PDF and DVI output from the Perl module output.
975 PERLMOD_LATEX          = NO
977 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
978 # nicely formatted so it can be parsed by a human reader.  This is useful 
979 # if you want to understand what is going on.  On the other hand, if this 
980 # tag is set to NO the size of the Perl module output will be much smaller 
981 # and Perl will parse it just the same.
983 PERLMOD_PRETTY         = YES
985 # The names of the make variables in the generated doxyrules.make file 
986 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
987 # This is useful so different doxyrules.make files included by the same 
988 # Makefile don't overwrite each other's variables.
990 PERLMOD_MAKEVAR_PREFIX = 
992 #---------------------------------------------------------------------------
993 # Configuration options related to the preprocessor
994 #---------------------------------------------------------------------------
996 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
997 # evaluate all C-preprocessor directives found in the sources and include 
998 # files.
1000 ENABLE_PREPROCESSING   = YES
1002 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1003 # names in the source code. If set to NO (the default) only conditional 
1004 # compilation will be performed. Macro expansion can be done in a controlled 
1005 # way by setting EXPAND_ONLY_PREDEF to YES.
1007 MACRO_EXPANSION        = NO
1009 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1010 # then the macro expansion is limited to the macros specified with the 
1011 # PREDEFINED and EXPAND_AS_DEFINED tags.
1013 EXPAND_ONLY_PREDEF     = NO
1015 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1016 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1018 SEARCH_INCLUDES        = YES
1020 # The INCLUDE_PATH tag can be used to specify one or more directories that 
1021 # contain include files that are not input files but should be processed by 
1022 # the preprocessor.
1024 INCLUDE_PATH           = 
1026 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1027 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1028 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1029 # be used.
1031 INCLUDE_FILE_PATTERNS  = 
1033 # The PREDEFINED tag can be used to specify one or more macro names that 
1034 # are defined before the preprocessor is started (similar to the -D option of 
1035 # gcc). The argument of the tag is a list of macros of the form: name 
1036 # or name=definition (no spaces). If the definition and the = are 
1037 # omitted =1 is assumed. To prevent a macro definition from being 
1038 # undefined via #undef or recursively expanded use the := operator 
1039 # instead of the = operator.
1041 PREDEFINED             = 
1043 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1044 # this tag can be used to specify a list of macro names that should be expanded. 
1045 # The macro definition that is found in the sources will be used. 
1046 # Use the PREDEFINED tag if you want to use a different macro definition that
1047 # overrules the definition found in the source code.
1049 EXPAND_AS_DEFINED      = 
1051 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1052 # doxygen's preprocessor will remove all references to function-like macros 
1053 # that are alone on a line, have an all uppercase name, and do not end with a 
1054 # semicolon, because these will confuse the parser if not removed.
1056 SKIP_FUNCTION_MACROS   = YES
1058 #---------------------------------------------------------------------------
1059 # Configuration::additions related to external references
1060 #---------------------------------------------------------------------------
1062 # The TAGFILES option can be used to specify one or more tagfiles. 
1063 # Optionally an initial location of the external documentation 
1064 # can be added for each tagfile. The format of a tag file without 
1065 # this location is as follows: 
1066 #   TAGFILES = file1 file2 ... 
1067 # Adding location for the tag files is done as follows: 
1068 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1069 # where "loc1" and "loc2" can be relative or absolute paths or 
1070 # URLs. If a location is present for each tag, the installdox tool 
1071 # does not have to be run to correct the links. 
1072 # Note that each tag file must have a unique name 
1073 # (where the name does NOT include the path) 
1074 # If a tag file is not located in the directory in which doxygen 
1075 # is run, you must also specify the path to the tagfile here.
1077 TAGFILES               = 
1079 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1080 # a tag file that is based on the input files it reads.
1082 GENERATE_TAGFILE       = 
1084 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1085 # in the class index. If set to NO only the inherited external classes 
1086 # will be listed.
1088 ALLEXTERNALS           = NO
1090 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1091 # in the modules index. If set to NO, only the current project's groups will 
1092 # be listed.
1094 EXTERNAL_GROUPS        = YES
1096 # The PERL_PATH should be the absolute path and name of the perl script 
1097 # interpreter (i.e. the result of `which perl').
1099 PERL_PATH              = /usr/bin/perl
1101 #---------------------------------------------------------------------------
1102 # Configuration options related to the dot tool
1103 #---------------------------------------------------------------------------
1105 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1106 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1107 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1108 # this option also works with HAVE_DOT disabled, but it is recommended to 
1109 # install and use dot, since it yields more powerful graphs.
1111 CLASS_DIAGRAMS         = YES
1113 # If set to YES, the inheritance and collaboration graphs will hide 
1114 # inheritance and usage relations if the target is undocumented 
1115 # or is not a class.
1117 HIDE_UNDOC_RELATIONS   = YES
1119 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1120 # available from the path. This tool is part of Graphviz, a graph visualization 
1121 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1122 # have no effect if this option is set to NO (the default)
1124 HAVE_DOT               = NO
1126 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1127 # will generate a graph for each documented class showing the direct and 
1128 # indirect inheritance relations. Setting this tag to YES will force the 
1129 # the CLASS_DIAGRAMS tag to NO.
1131 CLASS_GRAPH            = YES
1133 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1134 # will generate a graph for each documented class showing the direct and 
1135 # indirect implementation dependencies (inheritance, containment, and 
1136 # class references variables) of the class with other documented classes.
1138 COLLABORATION_GRAPH    = YES
1140 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1141 # will generate a graph for groups, showing the direct groups dependencies
1143 GROUP_GRAPHS           = YES
1145 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1146 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1147 # Language.
1149 UML_LOOK               = NO
1151 # If set to YES, the inheritance and collaboration graphs will show the 
1152 # relations between templates and their instances.
1154 TEMPLATE_RELATIONS     = NO
1156 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1157 # tags are set to YES then doxygen will generate a graph for each documented 
1158 # file showing the direct and indirect include dependencies of the file with 
1159 # other documented files.
1161 INCLUDE_GRAPH          = YES
1163 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1164 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1165 # documented header file showing the documented files that directly or 
1166 # indirectly include this file.
1168 INCLUDED_BY_GRAPH      = YES
1170 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 
1171 # doxygen will generate a call dependency graph for every global function 
1172 # or class method. Note that enabling this option will significantly increase 
1173 # the time of a run. So in most cases it will be better to enable call graphs 
1174 # for selected functions only using the \callgraph command.
1176 CALL_GRAPH             = NO
1178 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
1179 # doxygen will generate a caller dependency graph for every global function 
1180 # or class method. Note that enabling this option will significantly increase 
1181 # the time of a run. So in most cases it will be better to enable caller 
1182 # graphs for selected functions only using the \callergraph command.
1184 CALLER_GRAPH           = NO
1186 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1187 # will generate a graphical hierarchy of all classes instead of a textual one.
1189 GRAPHICAL_HIERARCHY    = YES
1191 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1192 # then doxygen will show the dependencies a directory has on other directories 
1193 # in a graphical way. The dependency relations are determined by the #include 
1194 # relations between the files in the directories.
1196 DIRECTORY_GRAPH        = YES
1198 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1199 # generated by dot. Possible values are png, svg, gif or svg. 
1200 # If left blank png will be used.
1202 DOT_IMAGE_FORMAT       = png
1204 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1205 # found. If left blank, it is assumed the dot tool can be found in the path.
1207 DOT_PATH               = 
1209 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1210 # contain dot files that are included in the documentation (see the 
1211 # \dotfile command).
1213 DOTFILE_DIRS           = 
1215 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1216 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1217 # from the root by following a path via at most 3 edges will be shown. Nodes 
1218 # that lay further from the root node will be omitted. Note that setting this 
1219 # option to 1 or 2 may greatly reduce the computation time needed for large 
1220 # code bases. Also note that the size of a graph can be further restricted by 
1221 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1223 MAX_DOT_GRAPH_DEPTH    = 1000
1225 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1226 # background. This is disabled by default, because dot on Windows does not 
1227 # seem to support this out of the box. Warning: Depending on the platform used, 
1228 # enabling this option may lead to badly anti-aliased labels on the edges of 
1229 # a graph (i.e. they become hard to read).
1231 DOT_TRANSPARENT        = NO
1233 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1234 # files in one run (i.e. multiple -o and -T options on the command line). This 
1235 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1236 # support this, this feature is disabled by default.
1238 DOT_MULTI_TARGETS      = NO
1240 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1241 # generate a legend page explaining the meaning of the various boxes and 
1242 # arrows in the dot generated graphs.
1244 GENERATE_LEGEND        = YES
1246 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1247 # remove the intermediate dot files that are used to generate 
1248 # the various graphs.
1250 DOT_CLEANUP            = YES