1 # Doxyfile 1.4.7
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 (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = Kaldi
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
26 PROJECT_NUMBER =
29 # Using the PROJECT_BRIEF tag one can provide an optional one line description
30 # for a project that appears at the top of each page and should give viewer
31 # a quick idea about the purpose of the project. Keep the description short.
33 # PROJECT_BRIEF = "Open source speech recognition"
35 # With the PROJECT_LOGO tag one can specify an logo or icon that is
36 # included in the documentation. The maximum height of the logo should not
37 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
38 # Doxygen will copy the logo to the output directory.
40 PROJECT_LOGO = ../misc/logo/KaldiTextAndLogoSmall.png
42 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
43 # base path where the generated documentation will be put.
44 # If a relative path is entered, it will be relative to the location
45 # where doxygen was started. If left blank the current directory will be used.
47 OUTPUT_DIRECTORY =
49 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
50 # 4096 sub-directories (in 2 levels) under the output directory of each output
51 # format and will distribute the generated files over these directories.
52 # Enabling this option can be useful when feeding doxygen a huge amount of
53 # source files, where putting all generated files in the same directory would
54 # otherwise cause performance problems for the file system.
56 CREATE_SUBDIRS = NO
58 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
59 # documentation generated by doxygen is written. Doxygen will use this
60 # information to generate all constant output in the proper language.
61 # The default language is English, other supported languages are:
62 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
63 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
64 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
65 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
66 # Swedish, and Ukrainian.
68 OUTPUT_LANGUAGE = English
70 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
71 # include brief member descriptions after the members that are listed in
72 # the file and class documentation (similar to JavaDoc).
73 # Set to NO to disable this.
75 BRIEF_MEMBER_DESC = YES
77 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
78 # the brief description of a member or function before the detailed description.
79 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
80 # brief descriptions will be completely suppressed.
82 REPEAT_BRIEF = YES
84 # This tag implements a quasi-intelligent brief description abbreviator
85 # that is used to form the text in various listings. Each string
86 # in this list, if found as the leading text of the brief description, will be
87 # stripped from the text and the result after processing the whole list, is
88 # used as the annotated text. Otherwise, the brief description is used as-is.
89 # If left blank, the following values are used ("$name" is automatically
90 # replaced with the name of the entity): "The $name class" "The $name widget"
91 # "The $name file" "is" "provides" "specifies" "contains"
92 # "represents" "a" "an" "the"
94 ABBREVIATE_BRIEF =
96 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
97 # Doxygen will generate a detailed section even if there is only a brief
98 # description.
100 ALWAYS_DETAILED_SEC = NO
102 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
103 # inherited members of a class in the documentation of that class as if those
104 # members were ordinary class members. Constructors, destructors and assignment
105 # operators of the base classes will not be shown.
107 INLINE_INHERITED_MEMB = NO
109 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
110 # path before files name in the file list and in the header files. If set
111 # to NO the shortest path that makes the file name unique will be used.
113 FULL_PATH_NAMES = YES
115 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
116 # can be used to strip a user-defined part of the path. Stripping is
117 # only done if one of the specified strings matches the left-hand part of
118 # the path. The tag can be used to show relative paths in the file list.
119 # If left blank the directory from which doxygen is run is used as the
120 # path to strip.
122 STRIP_FROM_PATH = .
124 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
125 # the path mentioned in the documentation of a class, which tells
126 # the reader which header file to include in order to use a class.
127 # If left blank only the name of the header file containing the class
128 # definition is used. Otherwise one should specify the include paths that
129 # are normally passed to the compiler using the -I flag.
131 STRIP_FROM_INC_PATH =
133 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
134 # (but less readable) file names. This can be useful is your file systems
135 # doesn't support long names like on DOS, Mac, or CD-ROM.
137 SHORT_NAMES = NO
139 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
140 # will interpret the first line (until the first dot) of a JavaDoc-style
141 # comment as the brief description. If set to NO, the JavaDoc
142 # comments will behave just like the Qt-style comments (thus requiring an
143 # explicit @brief command for a brief description.
145 JAVADOC_AUTOBRIEF = YES
147 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
148 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
149 # comments) as a brief description. This used to be the default behaviour.
150 # The new default is to treat a multi-line C++ comment block as a detailed
151 # description. Set this tag to YES if you prefer the old behaviour instead.
153 MULTILINE_CPP_IS_BRIEF = NO
155 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
156 # member inherits the documentation from any documented member that it
157 # re-implements.
159 INHERIT_DOCS = YES
161 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
162 # a new page for each member. If set to NO, the documentation of a member will
163 # be part of the file/class/namespace that contains it.
165 SEPARATE_MEMBER_PAGES = NO
167 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
168 # Doxygen uses this value to replace tabs by spaces in code fragments.
170 TAB_SIZE = 8
172 # This tag can be used to specify a number of aliases that acts
173 # as commands in the documentation. An alias has the form "name=value".
174 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
175 # put the command \sideeffect (or @sideeffect) in the documentation, which
176 # will result in a user-defined paragraph with heading "Side Effects:".
177 # You can put \n's in the value part of an alias to insert newlines.
179 ALIASES = "copy=\par Copyright:\n©"
181 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
182 # sources only. Doxygen will then generate output that is more tailored for C.
183 # For instance, some of the names that are used will be different. The list
184 # of all members will be omitted, etc.
186 OPTIMIZE_OUTPUT_FOR_C = NO
188 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
189 # sources only. Doxygen will then generate output that is more tailored for Java.
190 # For instance, namespaces will be presented as packages, qualified scopes
191 # will look different, etc.
193 OPTIMIZE_OUTPUT_JAVA = NO
195 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
196 # include (a tag file for) the STL sources as input, then you should
197 # set this tag to YES in order to let doxygen match functions declarations and
198 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
199 # func(std::string) {}). This also make the inheritance and collaboration
200 # diagrams that involve STL classes more complete and accurate.
202 BUILTIN_STL_SUPPORT = NO
204 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
205 # tag is set to YES, then doxygen will reuse the documentation of the first
206 # member in the group (if any) for the other members of the group. By default
207 # all members of a group must be documented explicitly.
209 DISTRIBUTE_GROUP_DOC = NO
211 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
212 # the same type (for instance a group of public functions) to be put as a
213 # subgroup of that type (e.g. under the Public Functions section). Set it to
214 # NO to prevent subgrouping. Alternatively, this can be done per class using
215 # the \nosubgrouping command.
217 SUBGROUPING = YES
219 #---------------------------------------------------------------------------
220 # Build related configuration options
221 #---------------------------------------------------------------------------
223 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
224 # documentation are documented, even if no documentation was available.
225 # Private class members and static file members will be hidden unless
226 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
228 EXTRACT_ALL = YES
230 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
231 # will be included in the documentation.
233 EXTRACT_PRIVATE = YES
235 # If the EXTRACT_STATIC tag is set to YES all static members of a file
236 # will be included in the documentation.
238 EXTRACT_STATIC = YES
240 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
241 # defined locally in source files will be included in the documentation.
242 # If set to NO only classes defined in header files are included.
244 EXTRACT_LOCAL_CLASSES = YES
246 # This flag is only useful for Objective-C code. When set to YES local
247 # methods, which are defined in the implementation section but not in
248 # the interface are included in the documentation.
249 # If set to NO (the default) only methods in the interface are included.
251 EXTRACT_LOCAL_METHODS = NO
253 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
254 # undocumented members of documented classes, files or namespaces.
255 # If set to NO (the default) these members will be included in the
256 # various overviews, but no documentation section is generated.
257 # This option has no effect if EXTRACT_ALL is enabled.
259 HIDE_UNDOC_MEMBERS = NO
261 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
262 # undocumented classes that are normally visible in the class hierarchy.
263 # If set to NO (the default) these classes will be included in the various
264 # overviews. This option has no effect if EXTRACT_ALL is enabled.
266 HIDE_UNDOC_CLASSES = NO
268 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
269 # friend (class|struct|union) declarations.
270 # If set to NO (the default) these declarations will be included in the
271 # documentation.
273 HIDE_FRIEND_COMPOUNDS = NO
275 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
276 # documentation blocks found inside the body of a function.
277 # If set to NO (the default) these blocks will be appended to the
278 # function's detailed documentation block.
280 HIDE_IN_BODY_DOCS = NO
282 # The INTERNAL_DOCS tag determines if documentation
283 # that is typed after a \internal command is included. If the tag is set
284 # to NO (the default) then the documentation will be excluded.
285 # Set it to YES to include the internal documentation.
287 INTERNAL_DOCS = NO
289 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
290 # file names in lower-case letters. If set to YES upper-case letters are also
291 # allowed. This is useful if you have classes or files whose names only differ
292 # in case and if your file system supports case sensitive file names. Windows
293 # and Mac users are advised to set this option to NO.
295 CASE_SENSE_NAMES = YES
297 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
298 # will show members with their full class and namespace scopes in the
299 # documentation. If set to YES the scope will be hidden.
301 HIDE_SCOPE_NAMES = YES
303 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
304 # will put a list of the files that are included by a file in the documentation
305 # of that file.
307 SHOW_INCLUDE_FILES = YES
309 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
310 # is inserted in the documentation for inline members.
312 INLINE_INFO = YES
314 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
315 # will sort the (detailed) documentation of file and class members
316 # alphabetically by member name. If set to NO the members will appear in
317 # declaration order.
319 SORT_MEMBER_DOCS = YES
321 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
322 # brief documentation of file, namespace and class members alphabetically
323 # by member name. If set to NO (the default) the members will appear in
324 # declaration order.
326 SORT_BRIEF_DOCS = NO
328 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
329 # sorted by fully-qualified names, including namespaces. If set to
330 # NO (the default), the class list will be sorted only by class name,
331 # not including the namespace part.
332 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
333 # Note: This option applies only to the class list, not to the
334 # alphabetical list.
336 SORT_BY_SCOPE_NAME = NO
338 # The GENERATE_TODOLIST tag can be used to enable (YES) or
339 # disable (NO) the todo list. This list is created by putting \todo
340 # commands in the documentation.
342 GENERATE_TODOLIST = YES
344 # The GENERATE_TESTLIST tag can be used to enable (YES) or
345 # disable (NO) the test list. This list is created by putting \test
346 # commands in the documentation.
348 GENERATE_TESTLIST = YES
350 # The GENERATE_BUGLIST tag can be used to enable (YES) or
351 # disable (NO) the bug list. This list is created by putting \bug
352 # commands in the documentation.
354 GENERATE_BUGLIST = YES
356 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
357 # disable (NO) the deprecated list. This list is created by putting
358 # \deprecated commands in the documentation.
360 GENERATE_DEPRECATEDLIST= YES
362 # The ENABLED_SECTIONS tag can be used to enable conditional
363 # documentation sections, marked by \if sectionname ... \endif.
365 ENABLED_SECTIONS =
367 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
368 # the initial value of a variable or define consists of for it to appear in
369 # the documentation. If the initializer consists of more lines than specified
370 # here it will be hidden. Use a value of 0 to hide initializers completely.
371 # The appearance of the initializer of individual variables and defines in the
372 # documentation can be controlled using \showinitializer or \hideinitializer
373 # command in the documentation regardless of this setting.
375 MAX_INITIALIZER_LINES = 30
377 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
378 # at the bottom of the documentation of classes and structs. If set to YES the
379 # list will mention the files that were used to generate the documentation.
381 SHOW_USED_FILES = YES
384 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
385 # doxygen should invoke to get the current version for each file (typically from the
386 # version control system). Doxygen will invoke the program by executing (via
387 # popen()) the command <command> <input-file>, where <command> is the value of
388 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
389 # provided by doxygen. Whatever the program writes to standard output
390 # is used as the file version. See the manual for examples.
392 FILE_VERSION_FILTER =
394 #---------------------------------------------------------------------------
395 # configuration options related to warning and progress messages
396 #---------------------------------------------------------------------------
398 # The QUIET tag can be used to turn on/off the messages that are generated
399 # by doxygen. Possible values are YES and NO. If left blank NO is used.
401 QUIET = NO
403 # The WARNINGS tag can be used to turn on/off the warning messages that are
404 # generated by doxygen. Possible values are YES and NO. If left blank
405 # NO is used.
407 WARNINGS = YES
409 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
410 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
411 # automatically be disabled.
413 WARN_IF_UNDOCUMENTED = YES
415 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
416 # potential errors in the documentation, such as not documenting some
417 # parameters in a documented function, or documenting parameters that
418 # don't exist or using markup commands wrongly.
420 WARN_IF_DOC_ERROR = YES
422 # This WARN_NO_PARAMDOC option can be abled to get warnings for
423 # functions that are documented, but have no documentation for their parameters
424 # or return value. If set to NO (the default) doxygen will only warn about
425 # wrong or incomplete parameter documentation, but not about the absence of
426 # documentation.
428 WARN_NO_PARAMDOC = NO
430 # The WARN_FORMAT tag determines the format of the warning messages that
431 # doxygen can produce. The string should contain the $file, $line, and $text
432 # tags, which will be replaced by the file and line number from which the
433 # warning originated and the warning text. Optionally the format may contain
434 # $version, which will be replaced by the version of the file (if it could
435 # be obtained via FILE_VERSION_FILTER)
437 WARN_FORMAT =
439 # The WARN_LOGFILE tag can be used to specify a file to which warning
440 # and error messages should be written. If left blank the output is written
441 # to stderr.
443 WARN_LOGFILE =
445 #---------------------------------------------------------------------------
446 # configuration options related to the input files
447 #---------------------------------------------------------------------------
449 # The INPUT tag can be used to specify the files and/or directories that contain
450 # documented source files. You may enter file names like "myfile.cpp" or
451 # directories like "/usr/src/myproject". Separate the files or directories
452 # with spaces.
454 # the lines after "doc itf" are copied from SUBDIRS in the Makefile.
455 INPUT = doc itf \
456 base matrix util feat tree thread gmm transform \
457 fstext hmm lm decoder lat cudamatrix nnet \
458 bin fstbin gmmbin fgmmbin featbin \
459 nnetbin latbin sgmm2 sgmm2bin nnet2 nnet2bin nnet3 nnet3bin \
460 kwsbin ivector ivectorbin
462 # If the value of the INPUT tag contains directories, you can use the
463 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
464 # and *.h) to filter out the source-files in the directories. If left
465 # blank the following patterns are tested:
466 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
467 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
469 FILE_PATTERNS = *.cc \
470 *.h \
471 *.dox
473 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
474 # should be searched for input files as well. Possible values are YES and NO.
475 # If left blank NO is used.
477 RECURSIVE = NO
479 # The EXCLUDE tag can be used to specify files and/or directories that should
480 # excluded from the INPUT source files. This way you can easily exclude a
481 # subdirectory from a directory tree whose root is specified with the INPUT tag.
483 EXCLUDE = decoders/fst-kaldi.cc \
484 decoders/fst-kaldidecoder.cc
486 EXCLUDE_SYMBOLS = Kaldi
488 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
489 # directories that are symbolic links (a Unix filesystem feature) are excluded
490 # from the input.
492 EXCLUDE_SYMLINKS = NO
494 # If the value of the INPUT tag contains directories, you can use the
495 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
496 # certain files from those directories. Note that the wildcards are matched
497 # against the file with absolute path, so to exclude all test directories
498 # for example use the pattern */test/*
500 EXCLUDE_PATTERNS =
502 # The EXAMPLE_PATH tag can be used to specify one or more files or
503 # directories that contain example code fragments that are included (see
504 # the \include command).
506 EXAMPLE_PATH = doc
508 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
509 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
510 # and *.h) to filter out the source-files in the directories. If left
511 # blank all files are included.
513 EXAMPLE_PATTERNS =
515 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
516 # searched for input files to be used with the \include or \dontinclude
517 # commands irrespective of the value of the RECURSIVE tag.
518 # Possible values are YES and NO. If left blank NO is used.
520 EXAMPLE_RECURSIVE = NO
522 # The IMAGE_PATH tag can be used to specify one or more files or
523 # directories that contain image that are included in the documentation (see
524 # the \image command).
526 IMAGE_PATH =
528 # The INPUT_FILTER tag can be used to specify a program that doxygen should
529 # invoke to filter for each input file. Doxygen will invoke the filter program
530 # by executing (via popen()) the command <filter> <input-file>, where <filter>
531 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
532 # input file. Doxygen will then use the output that the filter program writes
533 # to standard output. If FILTER_PATTERNS is specified, this tag will be
534 # ignored.
536 INPUT_FILTER =
538 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
539 # basis. Doxygen will compare the file name with each pattern and apply the
540 # filter if there is a match. The filters are a list of the form:
541 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
542 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
543 # is applied to all files.
545 FILTER_PATTERNS =
547 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
548 # INPUT_FILTER) will be used to filter the input files when producing source
549 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
551 FILTER_SOURCE_FILES = NO
553 #---------------------------------------------------------------------------
554 # configuration options related to source browsing
555 #---------------------------------------------------------------------------
557 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
558 # be generated. Documented entities will be cross-referenced with these sources.
559 # Note: To get rid of all source code in the generated output, make sure also
560 # VERBATIM_HEADERS is set to NO.
562 SOURCE_BROWSER = YES
564 # Setting the INLINE_SOURCES tag to YES will include the body
565 # of functions and classes directly in the documentation.
567 INLINE_SOURCES = YES
569 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
570 # doxygen to hide any special comment blocks from generated source code
571 # fragments. Normal C and C++ comments will always remain visible.
573 STRIP_CODE_COMMENTS = YES
575 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
576 # then for each documented function all documented
577 # functions referencing it will be listed.
579 REFERENCED_BY_RELATION = YES
581 # If the REFERENCES_RELATION tag is set to YES (the default)
582 # then for each documented function all documented entities
583 # called/used by that function will be listed.
585 REFERENCES_RELATION = YES
587 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
588 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
589 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
590 # link to the source code. Otherwise they will link to the documentstion.
592 REFERENCES_LINK_SOURCE = YES
594 # If the USE_HTAGS tag is set to YES then the references to source code
595 # will point to the HTML generated by the htags(1) tool instead of doxygen
596 # built-in source browser. The htags tool is part of GNU's global source
597 # tagging system (see http://www.gnu.org/software/global/global.html). You
598 # will need version 4.8.6 or higher.
600 USE_HTAGS = NO
602 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
603 # will generate a verbatim copy of the header file for each class for
604 # which an include is specified. Set to NO to disable this.
606 VERBATIM_HEADERS = YES
608 #---------------------------------------------------------------------------
609 # configuration options related to the alphabetical class index
610 #---------------------------------------------------------------------------
612 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
613 # of all compounds will be generated. Enable this if the project
614 # contains a lot of classes, structs, unions or interfaces.
616 ALPHABETICAL_INDEX = YES
618 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
619 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
620 # in which this list will be split (can be a number in the range [1..20])
622 COLS_IN_ALPHA_INDEX = 5
624 # In case all classes in a project start with a common prefix, all
625 # classes will be put under the same header in the alphabetical index.
626 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
627 # should be ignored while generating the index headers.
629 IGNORE_PREFIX =
631 #---------------------------------------------------------------------------
632 # configuration options related to the HTML output
633 #---------------------------------------------------------------------------
635 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
636 # generate HTML output.
638 GENERATE_HTML = YES
640 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
641 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
642 # put in front of it. If left blank `html' will be used as the default path.
644 HTML_OUTPUT =
646 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
647 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
648 # doxygen will generate files with .html extension.
650 HTML_FILE_EXTENSION = .html
652 # The HTML_HEADER tag can be used to specify a personal HTML header for
653 # each generated HTML page. If it is left blank doxygen will generate a
654 # standard header.
656 ## Note: doc/header.html is a modified version of the standard header which was generated
657 ## using "doxygen -w html header.html footer.html stylesheet.css Doxyfile" (note, this may
658 ## have to be updated if the doxygen version changes), and then the following line was added:
659 ## <link rel="icon" type="image/png" href="http://kaldi.sf.net/favicon.ico">
661 HTML_HEADER = doc/header.html
664 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
665 # Doxygen will adjust the colors in the style sheet and background images
666 # according to this color. Hue is specified as an angle on a colorwheel,
667 # see http://en.wikipedia.org/wiki/Hue for more information.
668 # For instance the value 0 represents red, 60 is yellow, 120 is green,
669 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
670 # The allowed range is 0 to 359.
672 HTML_COLORSTYLE_HUE = 31
674 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
675 # the colors in the HTML output. For a value of 0 the output will use
676 # grayscales only. A value of 255 will produce the most vivid colors.
678 HTML_COLORSTYLE_SAT = 115
680 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
681 # the luminance component of the colors in the HTML output. Values below
682 # 100 gradually make the output lighter, whereas values above 100 make
683 # the output darker. The value divided by 100 is the actual gamma applied,
684 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
685 # and 100 does not change the gamma.
687 HTML_COLORSTYLE_GAMMA = 80
691 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
692 # each generated HTML page. If it is left blank doxygen will generate a
693 # standard footer.
695 HTML_FOOTER =
697 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
698 # style sheet that is used by each HTML page. It can be used to
699 # fine-tune the look of the HTML output. If the tag is left blank doxygen
700 # will generate a default style sheet. Note that doxygen will try to copy
701 # the style sheet file to the HTML output directory, so don't put your own
702 # stylesheet in the HTML output directory as well, or it will be erased!
704 HTML_STYLESHEET =
706 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
707 # will be generated that can be used as input for tools like the
708 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
709 # of the generated HTML documentation.
711 GENERATE_HTMLHELP = NO
713 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
714 # be used to specify the file name of the resulting .chm file. You
715 # can add a path in front of the file if the result should not be
716 # written to the html output directory.
718 CHM_FILE =
720 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
721 # be used to specify the location (absolute path including file name) of
722 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
723 # the HTML help compiler on the generated index.hhp.
725 HHC_LOCATION =
727 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
728 # controls if a separate .chi index file is generated (YES) or that
729 # it should be included in the master .chm file (NO).
731 GENERATE_CHI = NO
733 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
734 # controls whether a binary table of contents is generated (YES) or a
735 # normal table of contents (NO) in the .chm file.
737 BINARY_TOC = NO
739 # The TOC_EXPAND flag can be set to YES to add extra items for group members
740 # to the contents of the HTML help documentation and to the tree view.
742 TOC_EXPAND = NO
744 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
745 # top of each HTML page. The value NO (the default) enables the index and
746 # the value YES disables it.
748 DISABLE_INDEX = NO
750 # This tag can be used to set the number of enum values (range [1..20])
751 # that doxygen will group on one line in the generated HTML documentation.
753 ENUM_VALUES_PER_LINE = 4
755 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
756 # generated containing a tree-like index structure (just like the one that
757 # is generated for HTML Help). For this to work a browser that supports
758 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
759 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
760 # probably better off using the HTML help feature.
762 GENERATE_TREEVIEW = YES
764 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
765 # used to set the initial width (in pixels) of the frame in which the tree
766 # is shown.
768 TREEVIEW_WIDTH = 250
770 #---------------------------------------------------------------------------
771 # configuration options related to the LaTeX output
772 #---------------------------------------------------------------------------
774 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
775 # generate Latex output.
777 GENERATE_LATEX = NO
779 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
780 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
781 # put in front of it. If left blank `latex' will be used as the default path.
783 LATEX_OUTPUT =
785 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
786 # invoked. If left blank `latex' will be used as the default command name.
788 LATEX_CMD_NAME = latex
790 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
791 # generate index for LaTeX. If left blank `makeindex' will be used as the
792 # default command name.
794 MAKEINDEX_CMD_NAME = makeindex
796 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
797 # LaTeX documents. This may be useful for small projects and may help to
798 # save some trees in general.
800 COMPACT_LATEX = NO
802 # The PAPER_TYPE tag can be used to set the paper type that is used
803 # by the printer. Possible values are: a4, a4wide, letter, legal and
804 # executive. If left blank a4wide will be used.
806 PAPER_TYPE = a4wide
808 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
809 # packages that should be included in the LaTeX output.
811 EXTRA_PACKAGES =
813 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
814 # the generated latex document. The header should contain everything until
815 # the first chapter. If it is left blank doxygen will generate a
816 # standard header. Notice: only use this tag if you know what you are doing!
818 LATEX_HEADER =
820 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
821 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
822 # contain links (just like the HTML output) instead of page references
823 # This makes the output suitable for online browsing using a pdf viewer.
825 PDF_HYPERLINKS = NO
827 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
828 # plain latex in the generated Makefile. Set this option to YES to get a
829 # higher quality PDF documentation.
831 USE_PDFLATEX = YES
833 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
834 # command to the generated LaTeX files. This will instruct LaTeX to keep
835 # running if errors occur, instead of asking the user for help.
836 # This option is also used when generating formulas in HTML.
838 LATEX_BATCHMODE = NO
840 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
841 # include the index chapters (such as File Index, Compound Index, etc.)
842 # in the output.
844 LATEX_HIDE_INDICES = NO
846 #---------------------------------------------------------------------------
847 # configuration options related to the RTF output
848 #---------------------------------------------------------------------------
850 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
851 # The RTF output is optimized for Word 97 and may not look very pretty with
852 # other RTF readers or editors.
854 GENERATE_RTF = NO
856 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
857 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
858 # put in front of it. If left blank `rtf' will be used as the default path.
860 RTF_OUTPUT =
862 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
863 # RTF documents. This may be useful for small projects and may help to
864 # save some trees in general.
866 COMPACT_RTF = NO
868 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
869 # will contain hyperlink fields. The RTF file will
870 # contain links (just like the HTML output) instead of page references.
871 # This makes the output suitable for online browsing using WORD or other
872 # programs which support those fields.
873 # Note: wordpad (write) and others do not support links.
875 RTF_HYPERLINKS = NO
877 # Load stylesheet definitions from file. Syntax is similar to doxygen's
878 # config file, i.e. a series of assignments. You only have to provide
879 # replacements, missing definitions are set to their default value.
881 RTF_STYLESHEET_FILE =
883 # Set optional variables used in the generation of an rtf document.
884 # Syntax is similar to doxygen's config file.
886 RTF_EXTENSIONS_FILE =
888 #---------------------------------------------------------------------------
889 # configuration options related to the man page output
890 #---------------------------------------------------------------------------
892 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
893 # generate man pages
895 GENERATE_MAN = NO
897 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
898 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
899 # put in front of it. If left blank `man' will be used as the default path.
901 MAN_OUTPUT =
903 # The MAN_EXTENSION tag determines the extension that is added to
904 # the generated man pages (default is the subroutine's section .3)
906 MAN_EXTENSION =
908 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
909 # then it will generate one additional man file for each entity
910 # documented in the real man page(s). These additional files
911 # only source the real man page, but without them the man command
912 # would be unable to find the correct page. The default is NO.
914 MAN_LINKS = NO
916 #---------------------------------------------------------------------------
917 # configuration options related to the XML output
918 #---------------------------------------------------------------------------
920 # If the GENERATE_XML tag is set to YES Doxygen will
921 # generate an XML file that captures the structure of
922 # the code including all documentation.
924 GENERATE_XML = NO
926 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
927 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
928 # put in front of it. If left blank `xml' will be used as the default path.
930 XML_OUTPUT = xml
932 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
933 # dump the program listings (including syntax highlighting
934 # and cross-referencing information) to the XML output. Note that
935 # enabling this will significantly increase the size of the XML output.
937 XML_PROGRAMLISTING = YES
939 #---------------------------------------------------------------------------
940 # configuration options for the AutoGen Definitions output
941 #---------------------------------------------------------------------------
943 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
944 # generate an AutoGen Definitions (see autogen.sf.net) file
945 # that captures the structure of the code including all
946 # documentation. Note that this feature is still experimental
947 # and incomplete at the moment.
949 GENERATE_AUTOGEN_DEF = NO
951 #---------------------------------------------------------------------------
952 # configuration options related to the Perl module output
953 #---------------------------------------------------------------------------
955 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
956 # generate a Perl module file that captures the structure of
957 # the code including all documentation. Note that this
958 # feature is still experimental and incomplete at the
959 # moment.
961 GENERATE_PERLMOD = NO
963 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
964 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
965 # to generate PDF and DVI output from the Perl module output.
967 PERLMOD_LATEX = NO
969 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
970 # nicely formatted so it can be parsed by a human reader. This is useful
971 # if you want to understand what is going on. On the other hand, if this
972 # tag is set to NO the size of the Perl module output will be much smaller
973 # and Perl will parse it just the same.
975 PERLMOD_PRETTY = YES
977 # The names of the make variables in the generated doxyrules.make file
978 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
979 # This is useful so different doxyrules.make files included by the same
980 # Makefile don't overwrite each other's variables.
982 PERLMOD_MAKEVAR_PREFIX =
984 #---------------------------------------------------------------------------
985 # Configuration options related to the preprocessor
986 #---------------------------------------------------------------------------
988 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
989 # evaluate all C-preprocessor directives found in the sources and include
990 # files.
992 ENABLE_PREPROCESSING = YES
994 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
995 # names in the source code. If set to NO (the default) only conditional
996 # compilation will be performed. Macro expansion can be done in a controlled
997 # way by setting EXPAND_ONLY_PREDEF to YES.
999 MACRO_EXPANSION = NO
1001 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1002 # then the macro expansion is limited to the macros specified with the
1003 # PREDEFINED and EXPAND_AS_DEFINED tags.
1005 EXPAND_ONLY_PREDEF = NO
1007 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1008 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1010 SEARCH_INCLUDES = NO
1012 # The INCLUDE_PATH tag can be used to specify one or more directories that
1013 # contain include files that are not input files but should be processed by
1014 # the preprocessor.
1016 INCLUDE_PATH =
1018 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1019 # patterns (like *.h and *.hpp) to filter out the header-files in the
1020 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1021 # be used.
1023 INCLUDE_FILE_PATTERNS =
1025 # The PREDEFINED tag can be used to specify one or more macro names that
1026 # are defined before the preprocessor is started (similar to the -D option of
1027 # gcc). The argument of the tag is a list of macros of the form: name
1028 # or name=definition (no spaces). If the definition and the = are
1029 # omitted =1 is assumed. To prevent a macro definition from being
1030 # undefined via #undef or recursively expanded use the := operator
1031 # instead of the = operator.
1033 PREDEFINED =
1035 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1036 # this tag can be used to specify a list of macro names that should be expanded.
1037 # The macro definition that is found in the sources will be used.
1038 # Use the PREDEFINED tag if you want to use a different macro definition.
1040 EXPAND_AS_DEFINED =
1042 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1043 # doxygen's preprocessor will remove all function-like macros that are alone
1044 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1045 # function macros are typically used for boiler-plate code, and will confuse
1046 # the parser if not removed.
1048 SKIP_FUNCTION_MACROS = YES
1050 #---------------------------------------------------------------------------
1051 # Configuration::additions related to external references
1052 #---------------------------------------------------------------------------
1054 # The TAGFILES option can be used to specify one or more tagfiles.
1055 # Optionally an initial location of the external documentation
1056 # can be added for each tagfile. The format of a tag file without
1057 # this location is as follows:
1058 # TAGFILES = file1 file2 ...
1059 # Adding location for the tag files is done as follows:
1060 # TAGFILES = file1=loc1 "file2 = loc2" ...
1061 # where "loc1" and "loc2" can be relative or absolute paths or
1062 # URLs. If a location is present for each tag, the installdox tool
1063 # does not have to be run to correct the links.
1064 # Note that each tag file must have a unique name
1065 # (where the name does NOT include the path)
1066 # If a tag file is not located in the directory in which doxygen
1067 # is run, you must also specify the path to the tagfile here.
1069 TAGFILES =
1071 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1072 # a tag file that is based on the input files it reads.
1074 GENERATE_TAGFILE =
1076 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1077 # in the class index. If set to NO only the inherited external classes
1078 # will be listed.
1080 ALLEXTERNALS = NO
1082 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1083 # in the modules index. If set to NO, only the current project's groups will
1084 # be listed.
1086 EXTERNAL_GROUPS = YES
1088 # The PERL_PATH should be the absolute path and name of the perl script
1089 # interpreter (i.e. the result of `which perl').
1091 PERL_PATH =
1093 #---------------------------------------------------------------------------
1094 # Configuration options related to the dot tool
1095 #---------------------------------------------------------------------------
1097 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1098 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1099 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1100 # this option is superseded by the HAVE_DOT option below. This is only a
1101 # fallback. It is recommended to install and use dot, since it yields more
1102 # powerful graphs.
1104 CLASS_DIAGRAMS = YES
1106 # If set to YES, the inheritance and collaboration graphs will hide
1107 # inheritance and usage relations if the target is undocumented
1108 # or is not a class.
1110 HIDE_UNDOC_RELATIONS = NO
1112 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1113 # available from the path. This tool is part of Graphviz, a graph visualization
1114 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1115 # have no effect if this option is set to NO (the default)
1117 HAVE_DOT = YES
1119 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1120 # will generate a graph for each documented class showing the direct and
1121 # indirect inheritance relations. Setting this tag to YES will force the
1122 # the CLASS_DIAGRAMS tag to NO.
1124 CLASS_GRAPH = YES
1126 # If the COLLABORATION_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 implementation dependencies (inheritance, containment, and
1129 # class references variables) of the class with other documented classes.
1131 COLLABORATION_GRAPH = YES
1133 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1134 # will generate a graph for groups, showing the direct groups dependencies
1136 GROUP_GRAPHS = YES
1138 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1139 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1140 # Language.
1142 UML_LOOK = NO
1144 # If set to YES, the inheritance and collaboration graphs will show the
1145 # relations between templates and their instances.
1147 TEMPLATE_RELATIONS = NO
1149 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1150 # tags are set to YES then doxygen will generate a graph for each documented
1151 # file showing the direct and indirect include dependencies of the file with
1152 # other documented files.
1154 INCLUDE_GRAPH = YES
1156 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1157 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1158 # documented header file showing the documented files that directly or
1159 # indirectly include this file.
1161 INCLUDED_BY_GRAPH = YES
1163 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1164 # generate a call dependency graph for every global function or class method.
1165 # Note that enabling this option will significantly increase the time of a run.
1166 # So in most cases it will be better to enable call graphs for selected
1167 # functions only using the \callgraph command.
1169 CALL_GRAPH = NO
1171 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1172 # generate a caller dependency graph for every global function or class method.
1173 # Note that enabling this option will significantly increase the time of a run.
1174 # So in most cases it will be better to enable caller graphs for selected
1175 # functions only using the \callergraph command.
1177 CALLER_GRAPH = NO
1179 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1180 # will graphical hierarchy of all classes instead of a textual one.
1182 GRAPHICAL_HIERARCHY = YES
1184 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1185 # then doxygen will show the dependencies a directory has on other directories
1186 # in a graphical way. The dependency relations are determined by the #include
1187 # relations between the files in the directories.
1189 DIRECTORY_GRAPH = YES
1191 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1192 # generated by dot. Possible values are png, jpg, or gif
1193 # If left blank png will be used.
1195 DOT_IMAGE_FORMAT = png
1197 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1198 # found. If left blank, it is assumed the dot tool can be found in the path.
1200 DOT_PATH = /usr/bin/
1202 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1203 # contain dot files that are included in the documentation (see the
1204 # \dotfile command).
1206 DOTFILE_DIRS =
1208 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1209 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1210 # from the root by following a path via at most 3 edges will be shown. Nodes
1211 # that lay further from the root node will be omitted. Note that setting this
1212 # option to 1 or 2 may greatly reduce the computation time needed for large
1213 # code bases. Also note that a graph may be further truncated if the graph's
1214 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1215 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1216 # the graph is not depth-constrained.
1218 MAX_DOT_GRAPH_DEPTH = 0
1220 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1221 # background. This is disabled by default, which results in a white background.
1222 # Warning: Depending on the platform used, enabling this option may lead to
1223 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1224 # read).
1226 DOT_TRANSPARENT = NO
1228 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1229 # files in one run (i.e. multiple -o and -T options on the command line). This
1230 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1231 # support this, this feature is disabled by default.
1233 DOT_MULTI_TARGETS = NO
1235 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1236 # generate a legend page explaining the meaning of the various boxes and
1237 # arrows in the dot generated graphs.
1239 GENERATE_LEGEND = YES
1241 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1242 # remove the intermediate dot files that are used to generate
1243 # the various graphs.
1245 DOT_CLEANUP = YES
1247 #---------------------------------------------------------------------------
1248 # Configuration::additions related to the search engine
1249 #---------------------------------------------------------------------------
1251 # The SEARCHENGINE tag specifies whether or not a search engine should be
1252 # used. If set to NO the values of all tags below this one will be ignored.
1254 SEARCHENGINE = YES
1256 MARKDOWN_SUPPORT = NO