"Fossies" - the Fresh Open Source Software Archive

Member "fuse-3.2.1/doc/Doxyfile" (14 Nov 2017, 51657 Bytes) of package /linux/misc/fuse-3.2.1.tar.xz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "Doxyfile": 3.2.0_vs_3.2.1.

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