"Fossies" - the Fresh Open Source Software Archive

Member "flatbuffers-23.1.21/docs/source/doxyfile" (21 Jan 2023, 102594 Bytes) of package /linux/misc/flatbuffers-23.1.21.tar.gz:


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.

    1 # Doxyfile 1.8.5
    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 double hash (##) is considered a comment and is placed in
    7 # front of the TAG it is preceding.
    8 #
    9 # All text after a single hash (#) is considered a comment and will be ignored.
   10 # The format is:
   11 # TAG = value [value, ...]
   12 # For lists, items can also be appended using:
   13 # TAG += value [value, ...]
   14 # Values that contain spaces should be placed between quotes (\" \").
   15 
   16 #---------------------------------------------------------------------------
   17 # Project related configuration options
   18 #---------------------------------------------------------------------------
   19 
   20 # This tag specifies the encoding used for all characters in the config file
   21 # that follow. The default is UTF-8 which is also the encoding used for all text
   22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
   23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
   24 # for the list of possible encodings.
   25 # The default value is: UTF-8.
   26 
   27 DOXYFILE_ENCODING      = UTF-8
   28 
   29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
   30 # double-quotes, unless you are using Doxywizard) that should identify the
   31 # project for which the documentation is generated. This name is used in the
   32 # title of most generated pages and in a few other places.
   33 # The default value is: My Project.
   34 
   35 PROJECT_NAME           = "FlatBuffers"
   36 
   37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
   38 # could be handy for archiving the generated documentation or if some version
   39 # control system is used.
   40 
   41 PROJECT_NUMBER         =
   42 
   43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
   44 # for a project that appears at the top of each page and should give viewer a
   45 # quick idea about the purpose of the project. Keep the description short.
   46 
   47 PROJECT_BRIEF          =
   48 
   49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
   50 # the documentation. The maximum height of the logo should not exceed 55 pixels
   51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
   52 # to the output directory.
   53 
   54 PROJECT_LOGO           =
   55 
   56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
   57 # into which the generated documentation will be written. If a relative path is
   58 # entered, it will be relative to the location where doxygen was started. If
   59 # left blank the current directory will be used.
   60 
   61 OUTPUT_DIRECTORY       = ".."
   62 
   63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
   64 # directories (in 2 levels) under the output directory of each output format and
   65 # will distribute the generated files over these directories. Enabling this
   66 # option can be useful when feeding doxygen a huge amount of source files, where
   67 # putting all generated files in the same directory would otherwise causes
   68 # performance problems for the file system.
   69 # The default value is: NO.
   70 
   71 CREATE_SUBDIRS         = NO
   72 
   73 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
   74 # documentation generated by doxygen is written. Doxygen will use this
   75 # information to generate all constant output in the proper language.
   76 # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
   77 # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
   78 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
   79 # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
   80 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
   81 # Turkish, Ukrainian and Vietnamese.
   82 # The default value is: English.
   83 
   84 OUTPUT_LANGUAGE        = English
   85 
   86 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
   87 # descriptions after the members that are listed in the file and class
   88 # documentation (similar to Javadoc). Set to NO to disable this.
   89 # The default value is: YES.
   90 
   91 BRIEF_MEMBER_DESC      = YES
   92 
   93 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
   94 # description of a member or function before the detailed description
   95 #
   96 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
   97 # brief descriptions will be completely suppressed.
   98 # The default value is: YES.
   99 
  100 REPEAT_BRIEF           = YES
  101 
  102 # This tag implements a quasi-intelligent brief description abbreviator that is
  103 # used to form the text in various listings. Each string in this list, if found
  104 # as the leading text of the brief description, will be stripped from the text
  105 # and the result, after processing the whole list, is used as the annotated
  106 # text. Otherwise, the brief description is used as-is. If left blank, the
  107 # following values are used ($name is automatically replaced with the name of
  108 # the entity):The $name class, The $name widget, The $name file, is, provides,
  109 # specifies, contains, represents, a, an and the.
  110 
  111 ABBREVIATE_BRIEF       = "The $name class" \
  112                          "The $name widget" \
  113                          "The $name file" \
  114                          is \
  115                          provides \
  116                          specifies \
  117                          contains \
  118                          represents \
  119                          a \
  120                          an \
  121                          the
  122 
  123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  124 # doxygen will generate a detailed section even if there is only a brief
  125 # description.
  126 # The default value is: NO.
  127 
  128 ALWAYS_DETAILED_SEC    = NO
  129 
  130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  131 # inherited members of a class in the documentation of that class as if those
  132 # members were ordinary class members. Constructors, destructors and assignment
  133 # operators of the base classes will not be shown.
  134 # The default value is: NO.
  135 
  136 INLINE_INHERITED_MEMB  = NO
  137 
  138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
  139 # before files name in the file list and in the header files. If set to NO the
  140 # shortest path that makes the file name unique will be used
  141 # The default value is: YES.
  142 
  143 FULL_PATH_NAMES        = NO
  144 
  145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  146 # Stripping is only done if one of the specified strings matches the left-hand
  147 # part of the path. The tag can be used to show relative paths in the file list.
  148 # If left blank the directory from which doxygen is run is used as the path to
  149 # strip.
  150 #
  151 # Note that you can specify absolute paths here, but also relative paths, which
  152 # will be relative from the directory where doxygen is started.
  153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
  154 
  155 STRIP_FROM_PATH        =
  156 
  157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  158 # path mentioned in the documentation of a class, which tells the reader which
  159 # header file to include in order to use a class. If left blank only the name of
  160 # the header file containing the class definition is used. Otherwise one should
  161 # specify the list of include paths that are normally passed to the compiler
  162 # using the -I flag.
  163 
  164 STRIP_FROM_INC_PATH    =
  165 
  166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  167 # less readable) file names. This can be useful is your file systems doesn't
  168 # support long names like on DOS, Mac, or CD-ROM.
  169 # The default value is: NO.
  170 
  171 SHORT_NAMES            = NO
  172 
  173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  174 # first line (until the first dot) of a Javadoc-style comment as the brief
  175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
  176 # style comments (thus requiring an explicit @brief command for a brief
  177 # description.)
  178 # The default value is: NO.
  179 
  180 JAVADOC_AUTOBRIEF      = YES
  181 
  182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  183 # line (until the first dot) of a Qt-style comment as the brief description. If
  184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  185 # requiring an explicit \brief command for a brief description.)
  186 # The default value is: NO.
  187 
  188 QT_AUTOBRIEF           = NO
  189 
  190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  192 # a brief description. This used to be the default behavior. The new default is
  193 # to treat a multi-line C++ comment block as a detailed description. Set this
  194 # tag to YES if you prefer the old behavior instead.
  195 #
  196 # Note that setting this tag to YES also means that rational rose comments are
  197 # not recognized any more.
  198 # The default value is: NO.
  199 
  200 MULTILINE_CPP_IS_BRIEF = NO
  201 
  202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  203 # documentation from any documented member that it re-implements.
  204 # The default value is: YES.
  205 
  206 INHERIT_DOCS           = YES
  207 
  208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
  209 # new page for each member. If set to NO, the documentation of a member will be
  210 # part of the file/class/namespace that contains it.
  211 # The default value is: NO.
  212 
  213 SEPARATE_MEMBER_PAGES  = NO
  214 
  215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  216 # uses this value to replace tabs by spaces in code fragments.
  217 # Minimum value: 1, maximum value: 16, default value: 4.
  218 
  219 TAB_SIZE               = 2
  220 
  221 # This tag can be used to specify a number of aliases that act as commands in
  222 # the documentation. An alias has the form:
  223 # name=value
  224 # For example adding
  225 # "sideeffect=@par Side Effects:\n"
  226 # will allow you to put the command \sideeffect (or @sideeffect) in the
  227 # documentation, which will result in a user-defined paragraph with heading
  228 # "Side Effects:". You can put \n's in the value part of an alias to insert
  229 # newlines.
  230 
  231 ALIASES                =
  232 
  233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
  234 # A mapping has the form "name=value". For example adding "class=itcl::class"
  235 # will allow you to use the command class in the itcl::class meaning.
  236 
  237 TCL_SUBST              =
  238 
  239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  240 # only. Doxygen will then generate output that is more tailored for C. For
  241 # instance, some of the names that are used will be different. The list of all
  242 # members will be omitted, etc.
  243 # The default value is: NO.
  244 
  245 OPTIMIZE_OUTPUT_FOR_C  = NO
  246 
  247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  248 # Python sources only. Doxygen will then generate output that is more tailored
  249 # for that language. For instance, namespaces will be presented as packages,
  250 # qualified scopes will look different, etc.
  251 # The default value is: NO.
  252 
  253 OPTIMIZE_OUTPUT_JAVA   = NO
  254 
  255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  256 # sources. Doxygen will then generate output that is tailored for Fortran.
  257 # The default value is: NO.
  258 
  259 OPTIMIZE_FOR_FORTRAN   = NO
  260 
  261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  262 # sources. Doxygen will then generate output that is tailored for VHDL.
  263 # The default value is: NO.
  264 
  265 OPTIMIZE_OUTPUT_VHDL   = NO
  266 
  267 # Doxygen selects the parser to use depending on the extension of the files it
  268 # parses. With this tag you can assign which parser to use for a given
  269 # extension. Doxygen has a built-in mapping, but you can override or extend it
  270 # using this tag. The format is ext=language, where ext is a file extension, and
  271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
  273 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
  274 # (default is Fortran), use: inc=Fortran f=C.
  275 #
  276 # Note For files without extension you can use no_extension as a placeholder.
  277 #
  278 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  279 # the files are not read by doxygen.
  280 
  281 EXTENSION_MAPPING      =
  282 
  283 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  284 # according to the Markdown format, which allows for more readable
  285 # documentation. See http://daringfireball.net/projects/markdown/ for details.
  286 # The output of markdown processing is further processed by doxygen, so you can
  287 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  288 # case of backward compatibilities issues.
  289 # The default value is: YES.
  290 
  291 MARKDOWN_SUPPORT       = YES
  292 
  293 # When enabled doxygen tries to link words that correspond to documented
  294 # classes, or namespaces to their corresponding documentation. Such a link can
  295 # be prevented in individual cases by by putting a % sign in front of the word
  296 # or globally by setting AUTOLINK_SUPPORT to NO.
  297 # The default value is: YES.
  298 
  299 AUTOLINK_SUPPORT       = NO  # Due to the multiple languages included in the API
  300                              # reference for FlatBuffers, the Auto-links were
  301                              # wrong more often than not.
  302 
  303 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  304 # to include (a tag file for) the STL sources as input, then you should set this
  305 # tag to YES in order to let doxygen match functions declarations and
  306 # definitions whose arguments contain STL classes (e.g. func(std::string);
  307 # versus func(std::string) {}). This also make the inheritance and collaboration
  308 # diagrams that involve STL classes more complete and accurate.
  309 # The default value is: NO.
  310 
  311 BUILTIN_STL_SUPPORT    = NO
  312 
  313 # If you use Microsoft's C++/CLI language, you should set this option to YES to
  314 # enable parsing support.
  315 # The default value is: NO.
  316 
  317 CPP_CLI_SUPPORT        = NO
  318 
  319 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  320 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
  321 # will parse them like normal C++ but will assume all classes use public instead
  322 # of private inheritance when no explicit protection keyword is present.
  323 # The default value is: NO.
  324 
  325 SIP_SUPPORT            = NO
  326 
  327 # For Microsoft's IDL there are propget and propput attributes to indicate
  328 # getter and setter methods for a property. Setting this option to YES will make
  329 # doxygen to replace the get and set methods by a property in the documentation.
  330 # This will only work if the methods are indeed getting or setting a simple
  331 # type. If this is not the case, or you want to show the methods anyway, you
  332 # should set this option to NO.
  333 # The default value is: YES.
  334 
  335 IDL_PROPERTY_SUPPORT   = NO
  336 
  337 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  338 # tag is set to YES, then doxygen will reuse the documentation of the first
  339 # member in the group (if any) for the other members of the group. By default
  340 # all members of a group must be documented explicitly.
  341 # The default value is: NO.
  342 
  343 DISTRIBUTE_GROUP_DOC   = NO
  344 
  345 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
  346 # (for instance a group of public functions) to be put as a subgroup of that
  347 # type (e.g. under the Public Functions section). Set it to NO to prevent
  348 # subgrouping. Alternatively, this can be done per class using the
  349 # \nosubgrouping command.
  350 # The default value is: YES.
  351 
  352 SUBGROUPING            = YES
  353 
  354 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  355 # are shown inside the group in which they are included (e.g. using \ingroup)
  356 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  357 # and RTF).
  358 #
  359 # Note that this feature does not work in combination with
  360 # SEPARATE_MEMBER_PAGES.
  361 # The default value is: NO.
  362 
  363 INLINE_GROUPED_CLASSES = NO
  364 
  365 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  366 # with only public data fields or simple typedef fields will be shown inline in
  367 # the documentation of the scope in which they are defined (i.e. file,
  368 # namespace, or group documentation), provided this scope is documented. If set
  369 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
  370 # Man pages) or section (for LaTeX and RTF).
  371 # The default value is: NO.
  372 
  373 INLINE_SIMPLE_STRUCTS  = NO
  374 
  375 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  376 # enum is documented as struct, union, or enum with the name of the typedef. So
  377 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  378 # with name TypeT. When disabled the typedef will appear as a member of a file,
  379 # namespace, or class. And the struct will be named TypeS. This can typically be
  380 # useful for C code in case the coding convention dictates that all compound
  381 # types are typedef'ed and only the typedef is referenced, never the tag name.
  382 # The default value is: NO.
  383 
  384 TYPEDEF_HIDES_STRUCT   = NO
  385 
  386 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  387 # cache is used to resolve symbols given their name and scope. Since this can be
  388 # an expensive process and often the same symbol appears multiple times in the
  389 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  390 # doxygen will become slower. If the cache is too large, memory is wasted. The
  391 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  392 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  393 # symbols. At the end of a run doxygen will report the cache usage and suggest
  394 # the optimal cache size from a speed point of view.
  395 # Minimum value: 0, maximum value: 9, default value: 0.
  396 
  397 LOOKUP_CACHE_SIZE      = 0
  398 
  399 #---------------------------------------------------------------------------
  400 # Build related configuration options
  401 #---------------------------------------------------------------------------
  402 
  403 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  404 # documentation are documented, even if no documentation was available. Private
  405 # class members and static file members will be hidden unless the
  406 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  407 # Note: This will also disable the warnings about undocumented members that are
  408 # normally produced when WARNINGS is set to YES.
  409 # The default value is: NO.
  410 
  411 EXTRACT_ALL            = NO
  412 
  413 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
  414 # be included in the documentation.
  415 # The default value is: NO.
  416 
  417 EXTRACT_PRIVATE        = NO
  418 
  419 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
  420 # scope will be included in the documentation.
  421 # The default value is: NO.
  422 
  423 EXTRACT_PACKAGE        = NO
  424 
  425 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
  426 # included in the documentation.
  427 # The default value is: NO.
  428 
  429 EXTRACT_STATIC         = YES
  430 
  431 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
  432 # locally in source files will be included in the documentation. If set to NO
  433 # only classes defined in header files are included. Does not have any effect
  434 # for Java sources.
  435 # The default value is: YES.
  436 
  437 EXTRACT_LOCAL_CLASSES  = NO
  438 
  439 # This flag is only useful for Objective-C code. When set to YES local methods,
  440 # which are defined in the implementation section but not in the interface are
  441 # included in the documentation. If set to NO only methods in the interface are
  442 # included.
  443 # The default value is: NO.
  444 
  445 EXTRACT_LOCAL_METHODS  = NO
  446 
  447 # If this flag is set to YES, the members of anonymous namespaces will be
  448 # extracted and appear in the documentation as a namespace called
  449 # 'anonymous_namespace{file}', where file will be replaced with the base name of
  450 # the file that contains the anonymous namespace. By default anonymous namespace
  451 # are hidden.
  452 # The default value is: NO.
  453 
  454 EXTRACT_ANON_NSPACES   = NO
  455 
  456 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  457 # undocumented members inside documented classes or files. If set to NO these
  458 # members will be included in the various overviews, but no documentation
  459 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
  460 # The default value is: NO.
  461 
  462 HIDE_UNDOC_MEMBERS     = NO
  463 
  464 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  465 # undocumented classes that are normally visible in the class hierarchy. If set
  466 # to NO these classes will be included in the various overviews. This option has
  467 # no effect if EXTRACT_ALL is enabled.
  468 # The default value is: NO.
  469 
  470 HIDE_UNDOC_CLASSES     = NO
  471 
  472 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  473 # (class|struct|union) declarations. If set to NO these declarations will be
  474 # included in the documentation.
  475 # The default value is: NO.
  476 
  477 HIDE_FRIEND_COMPOUNDS  = NO
  478 
  479 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  480 # documentation blocks found inside the body of a function. If set to NO these
  481 # blocks will be appended to the function's detailed documentation block.
  482 # The default value is: NO.
  483 
  484 HIDE_IN_BODY_DOCS      = NO
  485 
  486 # The INTERNAL_DOCS tag determines if documentation that is typed after a
  487 # \internal command is included. If the tag is set to NO then the documentation
  488 # will be excluded. Set it to YES to include the internal documentation.
  489 # The default value is: NO.
  490 
  491 INTERNAL_DOCS          = NO
  492 
  493 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
  494 # names in lower-case letters. If set to YES upper-case letters are also
  495 # allowed. This is useful if you have classes or files whose names only differ
  496 # in case and if your file system supports case sensitive file names. Windows
  497 # and Mac users are advised to set this option to NO.
  498 # The default value is: system dependent.
  499 
  500 CASE_SENSE_NAMES       = NO
  501 
  502 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  503 # their full class and namespace scopes in the documentation. If set to YES the
  504 # scope will be hidden.
  505 # The default value is: NO.
  506 
  507 HIDE_SCOPE_NAMES       = NO
  508 
  509 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  510 # the files that are included by a file in the documentation of that file.
  511 # The default value is: YES.
  512 
  513 SHOW_INCLUDE_FILES     = YES
  514 
  515 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  516 # files with double quotes in the documentation rather than with sharp brackets.
  517 # The default value is: NO.
  518 
  519 FORCE_LOCAL_INCLUDES   = NO
  520 
  521 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  522 # documentation for inline members.
  523 # The default value is: YES.
  524 
  525 INLINE_INFO            = YES
  526 
  527 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  528 # (detailed) documentation of file and class members alphabetically by member
  529 # name. If set to NO the members will appear in declaration order.
  530 # The default value is: YES.
  531 
  532 SORT_MEMBER_DOCS       = YES
  533 
  534 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  535 # descriptions of file, namespace and class members alphabetically by member
  536 # name. If set to NO the members will appear in declaration order.
  537 # The default value is: NO.
  538 
  539 SORT_BRIEF_DOCS        = YES
  540 
  541 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  542 # (brief and detailed) documentation of class members so that constructors and
  543 # destructors are listed first. If set to NO the constructors will appear in the
  544 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  545 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  546 # member documentation.
  547 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  548 # detailed member documentation.
  549 # The default value is: NO.
  550 
  551 SORT_MEMBERS_CTORS_1ST = NO
  552 
  553 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  554 # of group names into alphabetical order. If set to NO the group names will
  555 # appear in their defined order.
  556 # The default value is: NO.
  557 
  558 SORT_GROUP_NAMES       = NO
  559 
  560 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  561 # fully-qualified names, including namespaces. If set to NO, the class list will
  562 # be sorted only by class name, not including the namespace part.
  563 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  564 # Note: This option applies only to the class list, not to the alphabetical
  565 # list.
  566 # The default value is: NO.
  567 
  568 SORT_BY_SCOPE_NAME     = NO
  569 
  570 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  571 # type resolution of all parameters of a function it will reject a match between
  572 # the prototype and the implementation of a member function even if there is
  573 # only one candidate or it is obvious which candidate to choose by doing a
  574 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  575 # accept a match between prototype and implementation in such cases.
  576 # The default value is: NO.
  577 
  578 STRICT_PROTO_MATCHING  = NO
  579 
  580 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
  581 # todo list. This list is created by putting \todo commands in the
  582 # documentation.
  583 # The default value is: YES.
  584 
  585 GENERATE_TODOLIST      = NO
  586 
  587 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
  588 # test list. This list is created by putting \test commands in the
  589 # documentation.
  590 # The default value is: YES.
  591 
  592 GENERATE_TESTLIST      = NO
  593 
  594 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
  595 # list. This list is created by putting \bug commands in the documentation.
  596 # The default value is: YES.
  597 
  598 GENERATE_BUGLIST       = NO
  599 
  600 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
  601 # the deprecated list. This list is created by putting \deprecated commands in
  602 # the documentation.
  603 # The default value is: YES.
  604 
  605 GENERATE_DEPRECATEDLIST= YES
  606 
  607 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
  608 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
  609 # ... \endcond blocks.
  610 
  611 ENABLED_SECTIONS       =
  612 
  613 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  614 # initial value of a variable or macro / define can have for it to appear in the
  615 # documentation. If the initializer consists of more lines than specified here
  616 # it will be hidden. Use a value of 0 to hide initializers completely. The
  617 # appearance of the value of individual variables and macros / defines can be
  618 # controlled using \showinitializer or \hideinitializer command in the
  619 # documentation regardless of this setting.
  620 # Minimum value: 0, maximum value: 10000, default value: 30.
  621 
  622 MAX_INITIALIZER_LINES  = 30
  623 
  624 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  625 # the bottom of the documentation of classes and structs. If set to YES the list
  626 # will mention the files that were used to generate the documentation.
  627 # The default value is: YES.
  628 
  629 SHOW_USED_FILES        = YES
  630 
  631 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  632 # will remove the Files entry from the Quick Index and from the Folder Tree View
  633 # (if specified).
  634 # The default value is: YES.
  635 
  636 SHOW_FILES             = YES
  637 
  638 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  639 # page. This will remove the Namespaces entry from the Quick Index and from the
  640 # Folder Tree View (if specified).
  641 # The default value is: YES.
  642 
  643 SHOW_NAMESPACES        = YES
  644 
  645 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  646 # doxygen should invoke to get the current version for each file (typically from
  647 # the version control system). Doxygen will invoke the program by executing (via
  648 # popen()) the command command input-file, where command is the value of the
  649 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  650 # by doxygen. Whatever the program writes to standard output is used as the file
  651 # version. For an example see the documentation.
  652 
  653 FILE_VERSION_FILTER    =
  654 
  655 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  656 # by doxygen. The layout file controls the global structure of the generated
  657 # output files in an output format independent way. To create the layout file
  658 # that represents doxygen's defaults, run doxygen with the -l option. You can
  659 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
  660 # will be used as the name of the layout file.
  661 #
  662 # Note that if you run doxygen from a directory containing a file called
  663 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  664 # tag is left empty.
  665 
  666 LAYOUT_FILE            = doxygen_layout.xml
  667 
  668 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  669 # the reference definitions. This must be a list of .bib files. The .bib
  670 # extension is automatically appended if omitted. This requires the bibtex tool
  671 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
  672 # For LaTeX the style of the bibliography can be controlled using
  673 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  674 # search path. Do not use file names with spaces, bibtex cannot handle them. See
  675 # also \cite for info how to create references.
  676 
  677 CITE_BIB_FILES         =
  678 
  679 #---------------------------------------------------------------------------
  680 # Configuration options related to warning and progress messages
  681 #---------------------------------------------------------------------------
  682 
  683 # The QUIET tag can be used to turn on/off the messages that are generated to
  684 # standard output by doxygen. If QUIET is set to YES this implies that the
  685 # messages are off.
  686 # The default value is: NO.
  687 
  688 QUIET                  = NO
  689 
  690 # The WARNINGS tag can be used to turn on/off the warning messages that are
  691 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
  692 # this implies that the warnings are on.
  693 #
  694 # Tip: Turn warnings on while writing the documentation.
  695 # The default value is: YES.
  696 
  697 WARNINGS               = YES
  698 
  699 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
  700 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  701 # will automatically be disabled.
  702 # The default value is: YES.
  703 
  704 WARN_IF_UNDOCUMENTED   = YES
  705 
  706 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  707 # potential errors in the documentation, such as not documenting some parameters
  708 # in a documented function, or documenting parameters that don't exist or using
  709 # markup commands wrongly.
  710 # The default value is: YES.
  711 
  712 WARN_IF_DOC_ERROR      = NO
  713 
  714 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  715 # are documented, but have no documentation for their parameters or return
  716 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
  717 # documentation, but not about the absence of documentation.
  718 # The default value is: NO.
  719 
  720 WARN_NO_PARAMDOC       = NO
  721 
  722 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
  723 # can produce. The string should contain the $file, $line, and $text tags, which
  724 # will be replaced by the file and line number from which the warning originated
  725 # and the warning text. Optionally the format may contain $version, which will
  726 # be replaced by the version of the file (if it could be obtained via
  727 # FILE_VERSION_FILTER)
  728 # The default value is: $file:$line: $text.
  729 
  730 WARN_FORMAT            = "$file:$line: $text"
  731 
  732 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
  733 # messages should be written. If left blank the output is written to standard
  734 # error (stderr).
  735 
  736 WARN_LOGFILE           =
  737 
  738 #---------------------------------------------------------------------------
  739 # Configuration options related to the input files
  740 #---------------------------------------------------------------------------
  741 
  742 # The INPUT tag is used to specify the files and/or directories that contain
  743 # documented source files. You may enter file names like myfile.cpp or
  744 # directories like /usr/src/myproject. Separate the files or directories with
  745 # spaces.
  746 # Note: If this tag is empty the current directory is searched.
  747 
  748 INPUT = "FlatBuffers.md" \
  749         "Building.md" \
  750         "Compiler.md" \
  751         "Schemas.md" \
  752         "CppUsage.md" \
  753         "CUsage.md" \
  754         "DartUsage.md" \
  755         "GoUsage.md" \
  756         "JavaUsage.md" \
  757         "CsharpUsage.md" \
  758         "SwiftUsage.md" \
  759         "JavaScriptUsage.md" \
  760         "TypeScriptUsage.md" \
  761         "PHPUsage.md" \
  762         "PythonUsage.md" \
  763         "LuaUsage.md" \
  764         "LobsterUsage.md" \
  765         "RustUsage.md" \
  766         "Support.md" \
  767         "Benchmarks.md" \
  768         "WhitePaper.md" \
  769         "FlexBuffers.md" \
  770         "Internals.md" \
  771         "IntermediateRepresentation.md" \
  772         "Grammar.md" \
  773         "../../CONTRIBUTING.md" \
  774         "Tutorial.md" \
  775         "GoApi.md" \
  776         "gRPC/CppUsage.md" \
  777         "groups" \
  778         "../../java/com/google/flatbuffers" \
  779         "../../python/flatbuffers/builder.py" \
  780         "../../js/flatbuffers.js" \
  781         "../../php/FlatbufferBuilder.php" \
  782         "../../net/FlatBuffers/FlatBufferBuilder.cs" \
  783         "../../include/flatbuffers/flatbuffers.h" \
  784         "../../go/builder.go" \
  785         "../../rust/flatbuffers/src/builder.rs"
  786 
  787 # This tag can be used to specify the character encoding of the source files
  788 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  789 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  790 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
  791 # possible encodings.
  792 # The default value is: UTF-8.
  793 
  794 INPUT_ENCODING         = UTF-8
  795 
  796 # If the value of the INPUT tag contains directories, you can use the
  797 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  798 # *.h) to filter out the source-files in the directories. If left blank the
  799 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
  800 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
  801 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
  802 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
  803 # *.qsf, *.as and *.js.
  804 
  805 FILE_PATTERNS          = *.c \
  806                          *.cc \
  807                          *.cxx \
  808                          *.cpp \
  809                          *.c++ \
  810                          *.java \
  811                          *.ii \
  812                          *.ixx \
  813                          *.ipp \
  814                          *.i++ \
  815                          *.inl \
  816                          *.idl \
  817                          *.ddl \
  818                          *.odl \
  819                          *.h \
  820                          *.hh \
  821                          *.hxx \
  822                          *.hpp \
  823                          *.h++ \
  824                          *.cs \
  825                          *.d \
  826                          *.php \
  827                          *.php4 \
  828                          *.php5 \
  829                          *.phtml \
  830                          *.inc \
  831                          *.m \
  832                          *.markdown \
  833                          *.md \
  834                          *.mm \
  835                          *.dox \
  836                          *.py \
  837                          *.f90 \
  838                          *.f \
  839                          *.for \
  840                          *.tcl \
  841                          *.vhd \
  842                          *.vhdl \
  843                          *.ucf \
  844                          *.qsf \
  845                          *.as \
  846                          *.js \
  847                          *.go
  848 
  849 # The RECURSIVE tag can be used to specify whether or not subdirectories should
  850 # be searched for input files as well.
  851 # The default value is: NO.
  852 
  853 RECURSIVE              = YES
  854 
  855 # The EXCLUDE tag can be used to specify files and/or directories that should be
  856 # excluded from the INPUT source files. This way you can easily exclude a
  857 # subdirectory from a directory tree whose root is specified with the INPUT tag.
  858 #
  859 # Note that relative paths are relative to the directory from which doxygen is
  860 # run.
  861 
  862 EXCLUDE                =
  863 
  864 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  865 # directories that are symbolic links (a Unix file system feature) are excluded
  866 # from the input.
  867 # The default value is: NO.
  868 
  869 EXCLUDE_SYMLINKS       = NO
  870 
  871 # If the value of the INPUT tag contains directories, you can use the
  872 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  873 # certain files from those directories.
  874 #
  875 # Note that the wildcards are matched against the file with absolute path, so to
  876 # exclude all test directories for example use the pattern */test/*
  877 
  878 EXCLUDE_PATTERNS       = *_test.py |
  879                          __init__.py
  880 
  881 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  882 # (namespaces, classes, functions, etc.) that should be excluded from the
  883 # output. The symbol name can be a fully qualified name, a word, or if the
  884 # wildcard * is used, a substring. Examples: ANamespace, AClass,
  885 # AClass::ANamespace, ANamespace::*Test
  886 #
  887 # Note that the wildcards are matched against the file with absolute path, so to
  888 # exclude all test directories use the pattern */test/*
  889 
  890 EXCLUDE_SYMBOLS        =
  891 
  892 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
  893 # that contain example code fragments that are included (see the \include
  894 # command).
  895 
  896 EXAMPLE_PATH           = "GoApi_generated.txt" "../../grpc/samples"
  897 
  898 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  899 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  900 # *.h) to filter out the source-files in the directories. If left blank all
  901 # files are included.
  902 
  903 EXAMPLE_PATTERNS       = *.cpp *.h *.txt *.fbs
  904 
  905 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  906 # searched for input files to be used with the \include or \dontinclude commands
  907 # irrespective of the value of the RECURSIVE tag.
  908 # The default value is: NO.
  909 
  910 EXAMPLE_RECURSIVE      = YES
  911 
  912 # The IMAGE_PATH tag can be used to specify one or more files or directories
  913 # that contain images that are to be included in the documentation (see the
  914 # \image command).
  915 
  916 IMAGE_PATH             =
  917 
  918 # The INPUT_FILTER tag can be used to specify a program that doxygen should
  919 # invoke to filter for each input file. Doxygen will invoke the filter program
  920 # by executing (via popen()) the command:
  921 #
  922 # <filter> <input-file>
  923 #
  924 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  925 # name of an input file. Doxygen will then use the output that the filter
  926 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
  927 # will be ignored.
  928 #
  929 # Note that the filter must not add or remove lines; it is applied before the
  930 # code is scanned, but not when the output code is generated. If lines are added
  931 # or removed, the anchors will not be placed correctly.
  932 
  933 INPUT_FILTER           =
  934 
  935 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  936 # basis. Doxygen will compare the file name with each pattern and apply the
  937 # filter if there is a match. The filters are a list of the form: pattern=filter
  938 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  939 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  940 # patterns match the file name, INPUT_FILTER is applied.
  941 
  942 FILTER_PATTERNS        = *.py=py_filter
  943 
  944 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  945 # INPUT_FILTER ) will also be used to filter the input files that are used for
  946 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  947 # The default value is: NO.
  948 
  949 FILTER_SOURCE_FILES    = NO
  950 
  951 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  952 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  953 # it is also possible to disable source filtering for a specific pattern using
  954 # *.ext= (so without naming a filter).
  955 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  956 
  957 FILTER_SOURCE_PATTERNS =
  958 
  959 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  960 # is part of the input, its contents will be placed on the main page
  961 # (index.html). This can be useful if you have a project on for instance GitHub
  962 # and want to reuse the introduction page also for the doxygen output.
  963 
  964 USE_MDFILE_AS_MAINPAGE = FlatBuffers.md
  965 
  966 #---------------------------------------------------------------------------
  967 # Configuration options related to source browsing
  968 #---------------------------------------------------------------------------
  969 
  970 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  971 # generated. Documented entities will be cross-referenced with these sources.
  972 #
  973 # Note: To get rid of all source code in the generated output, make sure that
  974 # also VERBATIM_HEADERS is set to NO.
  975 # The default value is: NO.
  976 
  977 SOURCE_BROWSER         = NO
  978 
  979 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
  980 # classes and enums directly into the documentation.
  981 # The default value is: NO.
  982 
  983 INLINE_SOURCES         = NO
  984 
  985 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  986 # special comment blocks from generated source code fragments. Normal C, C++ and
  987 # Fortran comments will always remain visible.
  988 # The default value is: YES.
  989 
  990 STRIP_CODE_COMMENTS    = NO
  991 
  992 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  993 # function all documented functions referencing it will be listed.
  994 # The default value is: NO.
  995 
  996 REFERENCED_BY_RELATION = NO
  997 
  998 # If the REFERENCES_RELATION tag is set to YES then for each documented function
  999 # all documented entities called/used by that function will be listed.
 1000 # The default value is: NO.
 1001 
 1002 REFERENCES_RELATION    = NO
 1003 
 1004 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
 1005 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
 1006 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
 1007 # link to the documentation.
 1008 # The default value is: YES.
 1009 
 1010 REFERENCES_LINK_SOURCE = YES
 1011 
 1012 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
 1013 # source code will show a tooltip with additional information such as prototype,
 1014 # brief description and links to the definition and documentation. Since this
 1015 # will make the HTML file larger and loading of large files a bit slower, you
 1016 # can opt to disable this feature.
 1017 # The default value is: YES.
 1018 # This tag requires that the tag SOURCE_BROWSER is set to YES.
 1019 
 1020 SOURCE_TOOLTIPS        = YES
 1021 
 1022 # If the USE_HTAGS tag is set to YES then the references to source code will
 1023 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
 1024 # source browser. The htags tool is part of GNU's global source tagging system
 1025 # (see http://www.gnu.org/software/global/global.html). You will need version
 1026 # 4.8.6 or higher.
 1027 #
 1028 # To use it do the following:
 1029 # - Install the latest version of global
 1030 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
 1031 # - Make sure the INPUT points to the root of the source tree
 1032 # - Run doxygen as normal
 1033 #
 1034 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
 1035 # tools must be available from the command line (i.e. in the search path).
 1036 #
 1037 # The result: instead of the source browser generated by doxygen, the links to
 1038 # source code will now point to the output of htags.
 1039 # The default value is: NO.
 1040 # This tag requires that the tag SOURCE_BROWSER is set to YES.
 1041 
 1042 USE_HTAGS              = NO
 1043 
 1044 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
 1045 # verbatim copy of the header file for each class for which an include is
 1046 # specified. Set to NO to disable this.
 1047 # See also: Section \class.
 1048 # The default value is: YES.
 1049 
 1050 VERBATIM_HEADERS       = YES
 1051 
 1052 #---------------------------------------------------------------------------
 1053 # Configuration options related to the alphabetical class index
 1054 #---------------------------------------------------------------------------
 1055 
 1056 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
 1057 # compounds will be generated. Enable this if the project contains a lot of
 1058 # classes, structs, unions or interfaces.
 1059 # The default value is: YES.
 1060 
 1061 ALPHABETICAL_INDEX     = YES
 1062 
 1063 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
 1064 # which the alphabetical index list will be split.
 1065 # Minimum value: 1, maximum value: 20, default value: 5.
 1066 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
 1067 
 1068 COLS_IN_ALPHA_INDEX    = 5
 1069 
 1070 # In case all classes in a project start with a common prefix, all classes will
 1071 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
 1072 # can be used to specify a prefix (or a list of prefixes) that should be ignored
 1073 # while generating the index headers.
 1074 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
 1075 
 1076 IGNORE_PREFIX          =
 1077 
 1078 #---------------------------------------------------------------------------
 1079 # Configuration options related to the HTML output
 1080 #---------------------------------------------------------------------------
 1081 
 1082 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
 1083 # The default value is: YES.
 1084 
 1085 GENERATE_HTML          = YES
 1086 
 1087 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
 1088 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 1089 # it.
 1090 # The default directory is: html.
 1091 # This tag requires that the tag GENERATE_HTML is set to YES.
 1092 
 1093 HTML_OUTPUT            = html
 1094 
 1095 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 1096 # generated HTML page (for example: .htm, .php, .asp).
 1097 # The default value is: .html.
 1098 # This tag requires that the tag GENERATE_HTML is set to YES.
 1099 
 1100 HTML_FILE_EXTENSION    = .html
 1101 
 1102 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
 1103 # each generated HTML page. If the tag is left blank doxygen will generate a
 1104 # standard header.
 1105 #
 1106 # To get valid HTML the header file that includes any scripts and style sheets
 1107 # that doxygen needs, which is dependent on the configuration options used (e.g.
 1108 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
 1109 # default header using
 1110 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
 1111 # YourConfigFile
 1112 # and then modify the file new_header.html. See also section "Doxygen usage"
 1113 # for information on how to generate the default header that doxygen normally
 1114 # uses.
 1115 # Note: The header is subject to change so you typically have to regenerate the
 1116 # default header when upgrading to a newer version of doxygen. For a description
 1117 # of the possible markers and block names see the documentation.
 1118 # This tag requires that the tag GENERATE_HTML is set to YES.
 1119 
 1120 HTML_HEADER            = ../header.html
 1121 
 1122 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 1123 # generated HTML page. If the tag is left blank doxygen will generate a standard
 1124 # footer. See HTML_HEADER for more information on how to generate a default
 1125 # footer and what special commands can be used inside the footer. See also
 1126 # section "Doxygen usage" for information on how to generate the default footer
 1127 # that doxygen normally uses.
 1128 # This tag requires that the tag GENERATE_HTML is set to YES.
 1129 
 1130 HTML_FOOTER            = ../footer.html
 1131 
 1132 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 1133 # sheet that is used by each HTML page. It can be used to fine-tune the look of
 1134 # the HTML output. If left blank doxygen will generate a default style sheet.
 1135 # See also section "Doxygen usage" for information on how to generate the style
 1136 # sheet that doxygen normally uses.
 1137 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
 1138 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
 1139 # obsolete.
 1140 # This tag requires that the tag GENERATE_HTML is set to YES.
 1141 
 1142 HTML_STYLESHEET        =
 1143 
 1144 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
 1145 # defined cascading style sheet that is included after the standard style sheets
 1146 # created by doxygen. Using this option one can overrule certain style aspects.
 1147 # This is preferred over using HTML_STYLESHEET since it does not replace the
 1148 # standard style sheet and is therefor more robust against future updates.
 1149 # Doxygen will copy the style sheet file to the output directory. For an example
 1150 # see the documentation.
 1151 # This tag requires that the tag GENERATE_HTML is set to YES.
 1152 
 1153 HTML_EXTRA_STYLESHEET  = style.css
 1154 
 1155 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 1156 # other source files which should be copied to the HTML output directory. Note
 1157 # that these files will be copied to the base HTML output directory. Use the
 1158 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
 1159 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
 1160 # files will be copied as-is; there are no commands or markers available.
 1161 # This tag requires that the tag GENERATE_HTML is set to YES.
 1162 
 1163 HTML_EXTRA_FILES       = "../images/fpl_logo_small.png" \
 1164                          "../images/ftv2mnode.png" \
 1165                          "../images/ftv2pnode.png"
 1166 
 1167 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 1168 # will adjust the colors in the stylesheet and background images according to
 1169 # this color. Hue is specified as an angle on a colorwheel, see
 1170 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
 1171 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
 1172 # purple, and 360 is red again.
 1173 # Minimum value: 0, maximum value: 359, default value: 220.
 1174 # This tag requires that the tag GENERATE_HTML is set to YES.
 1175 
 1176 HTML_COLORSTYLE_HUE    = 220
 1177 
 1178 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
 1179 # in the HTML output. For a value of 0 the output will use grayscales only. A
 1180 # value of 255 will produce the most vivid colors.
 1181 # Minimum value: 0, maximum value: 255, default value: 100.
 1182 # This tag requires that the tag GENERATE_HTML is set to YES.
 1183 
 1184 HTML_COLORSTYLE_SAT    = 100
 1185 
 1186 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
 1187 # luminance component of the colors in the HTML output. Values below 100
 1188 # gradually make the output lighter, whereas values above 100 make the output
 1189 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
 1190 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
 1191 # change the gamma.
 1192 # Minimum value: 40, maximum value: 240, default value: 80.
 1193 # This tag requires that the tag GENERATE_HTML is set to YES.
 1194 
 1195 HTML_COLORSTYLE_GAMMA  = 80
 1196 
 1197 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
 1198 # page will contain the date and time when the page was generated. Setting this
 1199 # to NO can help when comparing the output of multiple runs.
 1200 # The default value is: YES.
 1201 # This tag requires that the tag GENERATE_HTML is set to YES.
 1202 
 1203 HTML_TIMESTAMP         = YES
 1204 
 1205 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
 1206 # documentation will contain sections that can be hidden and shown after the
 1207 # page has loaded.
 1208 # The default value is: NO.
 1209 # This tag requires that the tag GENERATE_HTML is set to YES.
 1210 
 1211 HTML_DYNAMIC_SECTIONS  = NO
 1212 
 1213 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
 1214 # shown in the various tree structured indices initially; the user can expand
 1215 # and collapse entries dynamically later on. Doxygen will expand the tree to
 1216 # such a level that at most the specified number of entries are visible (unless
 1217 # a fully collapsed tree already exceeds this amount). So setting the number of
 1218 # entries 1 will produce a full collapsed tree by default. 0 is a special value
 1219 # representing an infinite number of entries and will result in a full expanded
 1220 # tree by default.
 1221 # Minimum value: 0, maximum value: 9999, default value: 100.
 1222 # This tag requires that the tag GENERATE_HTML is set to YES.
 1223 
 1224 HTML_INDEX_NUM_ENTRIES = 100
 1225 
 1226 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
 1227 # generated that can be used as input for Apple's Xcode 3 integrated development
 1228 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
 1229 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
 1230 # Makefile in the HTML output directory. Running make will produce the docset in
 1231 # that directory and running make install will install the docset in
 1232 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
 1233 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
 1234 # for more information.
 1235 # The default value is: NO.
 1236 # This tag requires that the tag GENERATE_HTML is set to YES.
 1237 
 1238 GENERATE_DOCSET        = NO
 1239 
 1240 # This tag determines the name of the docset feed. A documentation feed provides
 1241 # an umbrella under which multiple documentation sets from a single provider
 1242 # (such as a company or product suite) can be grouped.
 1243 # The default value is: Doxygen generated docs.
 1244 # This tag requires that the tag GENERATE_DOCSET is set to YES.
 1245 
 1246 DOCSET_FEEDNAME        = "Doxygen generated docs"
 1247 
 1248 # This tag specifies a string that should uniquely identify the documentation
 1249 # set bundle. This should be a reverse domain-name style string, e.g.
 1250 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
 1251 # The default value is: org.doxygen.Project.
 1252 # This tag requires that the tag GENERATE_DOCSET is set to YES.
 1253 
 1254 DOCSET_BUNDLE_ID       = org.doxygen.Project
 1255 
 1256 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
 1257 # the documentation publisher. This should be a reverse domain-name style
 1258 # string, e.g. com.mycompany.MyDocSet.documentation.
 1259 # The default value is: org.doxygen.Publisher.
 1260 # This tag requires that the tag GENERATE_DOCSET is set to YES.
 1261 
 1262 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 1263 
 1264 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
 1265 # The default value is: Publisher.
 1266 # This tag requires that the tag GENERATE_DOCSET is set to YES.
 1267 
 1268 DOCSET_PUBLISHER_NAME  = Publisher
 1269 
 1270 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
 1271 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
 1272 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
 1273 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
 1274 # Windows.
 1275 #
 1276 # The HTML Help Workshop contains a compiler that can convert all HTML output
 1277 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
 1278 # files are now used as the Windows 98 help format, and will replace the old
 1279 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
 1280 # HTML files also contain an index, a table of contents, and you can search for
 1281 # words in the documentation. The HTML workshop also contains a viewer for
 1282 # compressed HTML files.
 1283 # The default value is: NO.
 1284 # This tag requires that the tag GENERATE_HTML is set to YES.
 1285 
 1286 GENERATE_HTMLHELP      = NO
 1287 
 1288 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
 1289 # file. You can add a path in front of the file if the result should not be
 1290 # written to the html output directory.
 1291 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 1292 
 1293 CHM_FILE               =
 1294 
 1295 # The HHC_LOCATION tag can be used to specify the location (absolute path
 1296 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
 1297 # doxygen will try to run the HTML help compiler on the generated index.hhp.
 1298 # The file has to be specified with full path.
 1299 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 1300 
 1301 HHC_LOCATION           =
 1302 
 1303 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
 1304 # YES) or that it should be included in the master .chm file ( NO).
 1305 # The default value is: NO.
 1306 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 1307 
 1308 GENERATE_CHI           = NO
 1309 
 1310 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
 1311 # and project file content.
 1312 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 1313 
 1314 CHM_INDEX_ENCODING     =
 1315 
 1316 # The BINARY_TOC flag controls whether a binary table of contents is generated (
 1317 # YES) or a normal table of contents ( NO) in the .chm file.
 1318 # The default value is: NO.
 1319 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 1320 
 1321 BINARY_TOC             = NO
 1322 
 1323 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
 1324 # the table of contents of the HTML help documentation and to the tree view.
 1325 # The default value is: NO.
 1326 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 1327 
 1328 TOC_EXPAND             = NO
 1329 
 1330 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
 1331 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
 1332 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
 1333 # (.qch) of the generated HTML documentation.
 1334 # The default value is: NO.
 1335 # This tag requires that the tag GENERATE_HTML is set to YES.
 1336 
 1337 GENERATE_QHP           = NO
 1338 
 1339 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
 1340 # the file name of the resulting .qch file. The path specified is relative to
 1341 # the HTML output folder.
 1342 # This tag requires that the tag GENERATE_QHP is set to YES.
 1343 
 1344 QCH_FILE               =
 1345 
 1346 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
 1347 # Project output. For more information please see Qt Help Project / Namespace
 1348 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
 1349 # The default value is: org.doxygen.Project.
 1350 # This tag requires that the tag GENERATE_QHP is set to YES.
 1351 
 1352 QHP_NAMESPACE          = org.doxygen.Project
 1353 
 1354 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
 1355 # Help Project output. For more information please see Qt Help Project / Virtual
 1356 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
 1357 # folders).
 1358 # The default value is: doc.
 1359 # This tag requires that the tag GENERATE_QHP is set to YES.
 1360 
 1361 QHP_VIRTUAL_FOLDER     = doc
 1362 
 1363 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
 1364 # filter to add. For more information please see Qt Help Project / Custom
 1365 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
 1366 # filters).
 1367 # This tag requires that the tag GENERATE_QHP is set to YES.
 1368 
 1369 QHP_CUST_FILTER_NAME   =
 1370 
 1371 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
 1372 # custom filter to add. For more information please see Qt Help Project / Custom
 1373 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
 1374 # filters).
 1375 # This tag requires that the tag GENERATE_QHP is set to YES.
 1376 
 1377 QHP_CUST_FILTER_ATTRS  =
 1378 
 1379 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
 1380 # project's filter section matches. Qt Help Project / Filter Attributes (see:
 1381 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
 1382 # This tag requires that the tag GENERATE_QHP is set to YES.
 1383 
 1384 QHP_SECT_FILTER_ATTRS  =
 1385 
 1386 # The QHG_LOCATION tag can be used to specify the location of Qt's
 1387 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
 1388 # generated .qhp file.
 1389 # This tag requires that the tag GENERATE_QHP is set to YES.
 1390 
 1391 QHG_LOCATION           =
 1392 
 1393 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
 1394 # generated, together with the HTML files, they form an Eclipse help plugin. To
 1395 # install this plugin and make it available under the help contents menu in
 1396 # Eclipse, the contents of the directory containing the HTML and XML files needs
 1397 # to be copied into the plugins directory of eclipse. The name of the directory
 1398 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
 1399 # After copying Eclipse needs to be restarted before the help appears.
 1400 # The default value is: NO.
 1401 # This tag requires that the tag GENERATE_HTML is set to YES.
 1402 
 1403 GENERATE_ECLIPSEHELP   = NO
 1404 
 1405 # A unique identifier for the Eclipse help plugin. When installing the plugin
 1406 # the directory name containing the HTML and XML files should also have this
 1407 # name. Each documentation set should have its own identifier.
 1408 # The default value is: org.doxygen.Project.
 1409 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
 1410 
 1411 ECLIPSE_DOC_ID         = org.doxygen.Project
 1412 
 1413 # If you want full control over the layout of the generated HTML pages it might
 1414 # be necessary to disable the index and replace it with your own. The
 1415 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
 1416 # of each HTML page. A value of NO enables the index and the value YES disables
 1417 # it. Since the tabs in the index contain the same information as the navigation
 1418 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
 1419 # The default value is: NO.
 1420 # This tag requires that the tag GENERATE_HTML is set to YES.
 1421 
 1422 DISABLE_INDEX          = NO
 1423 
 1424 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 1425 # structure should be generated to display hierarchical information. If the tag
 1426 # value is set to YES, a side panel will be generated containing a tree-like
 1427 # index structure (just like the one that is generated for HTML Help). For this
 1428 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
 1429 # (i.e. any modern browser). Windows users are probably better off using the
 1430 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
 1431 # further fine-tune the look of the index. As an example, the default style
 1432 # sheet generated by doxygen has an example that shows how to put an image at
 1433 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
 1434 # the same information as the tab index, you could consider setting
 1435 # DISABLE_INDEX to YES when enabling this option.
 1436 # The default value is: NO.
 1437 # This tag requires that the tag GENERATE_HTML is set to YES.
 1438 
 1439 GENERATE_TREEVIEW      = YES
 1440 
 1441 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 1442 # doxygen will group on one line in the generated HTML documentation.
 1443 #
 1444 # Note that a value of 0 will completely suppress the enum values from appearing
 1445 # in the overview section.
 1446 # Minimum value: 0, maximum value: 20, default value: 4.
 1447 # This tag requires that the tag GENERATE_HTML is set to YES.
 1448 
 1449 ENUM_VALUES_PER_LINE   = 4
 1450 
 1451 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
 1452 # to set the initial width (in pixels) of the frame in which the tree is shown.
 1453 # Minimum value: 0, maximum value: 1500, default value: 250.
 1454 # This tag requires that the tag GENERATE_HTML is set to YES.
 1455 
 1456 TREEVIEW_WIDTH         = 250
 1457 
 1458 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
 1459 # external symbols imported via tag files in a separate window.
 1460 # The default value is: NO.
 1461 # This tag requires that the tag GENERATE_HTML is set to YES.
 1462 
 1463 EXT_LINKS_IN_WINDOW    = NO
 1464 
 1465 # Use this tag to change the font size of LaTeX formulas included as images in
 1466 # the HTML documentation. When you change the font size after a successful
 1467 # doxygen run you need to manually remove any form_*.png images from the HTML
 1468 # output directory to force them to be regenerated.
 1469 # Minimum value: 8, maximum value: 50, default value: 10.
 1470 # This tag requires that the tag GENERATE_HTML is set to YES.
 1471 
 1472 FORMULA_FONTSIZE       = 10
 1473 
 1474 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
 1475 # generated for formulas are transparent PNGs. Transparent PNGs are not
 1476 # supported properly for IE 6.0, but are supported on all modern browsers.
 1477 #
 1478 # Note that when changing this option you need to delete any form_*.png files in
 1479 # the HTML output directory before the changes have effect.
 1480 # The default value is: YES.
 1481 # This tag requires that the tag GENERATE_HTML is set to YES.
 1482 
 1483 FORMULA_TRANSPARENT    = YES
 1484 
 1485 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
 1486 # http://www.mathjax.org) which uses client side Javascript for the rendering
 1487 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
 1488 # installed or if you want to formulas look prettier in the HTML output. When
 1489 # enabled you may also need to install MathJax separately and configure the path
 1490 # to it using the MATHJAX_RELPATH option.
 1491 # The default value is: NO.
 1492 # This tag requires that the tag GENERATE_HTML is set to YES.
 1493 
 1494 USE_MATHJAX            = NO
 1495 
 1496 # When MathJax is enabled you can set the default output format to be used for
 1497 # the MathJax output. See the MathJax site (see:
 1498 # http://docs.mathjax.org/en/latest/output.html) for more details.
 1499 # Possible values are: HTML-CSS (which is slower, but has the best
 1500 # compatibility), NativeMML (i.e. MathML) and SVG.
 1501 # The default value is: HTML-CSS.
 1502 # This tag requires that the tag USE_MATHJAX is set to YES.
 1503 
 1504 MATHJAX_FORMAT         = HTML-CSS
 1505 
 1506 # When MathJax is enabled you need to specify the location relative to the HTML
 1507 # output directory using the MATHJAX_RELPATH option. The destination directory
 1508 # should contain the MathJax.js script. For instance, if the mathjax directory
 1509 # is located at the same level as the HTML output directory, then
 1510 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
 1511 # Content Delivery Network so you can quickly see the result without installing
 1512 # MathJax. However, it is strongly recommended to install a local copy of
 1513 # MathJax from http://www.mathjax.org before deployment.
 1514 # The default value is: http://cdn.mathjax.org/mathjax/latest.
 1515 # This tag requires that the tag USE_MATHJAX is set to YES.
 1516 
 1517 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 1518 
 1519 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
 1520 # extension names that should be enabled during MathJax rendering. For example
 1521 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
 1522 # This tag requires that the tag USE_MATHJAX is set to YES.
 1523 
 1524 MATHJAX_EXTENSIONS     =
 1525 
 1526 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
 1527 # of code that will be used on startup of the MathJax code. See the MathJax site
 1528 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
 1529 # example see the documentation.
 1530 # This tag requires that the tag USE_MATHJAX is set to YES.
 1531 
 1532 MATHJAX_CODEFILE       =
 1533 
 1534 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
 1535 # the HTML output. The underlying search engine uses javascript and DHTML and
 1536 # should work on any modern browser. Note that when using HTML help
 1537 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
 1538 # there is already a search function so this one should typically be disabled.
 1539 # For large projects the javascript based search engine can be slow, then
 1540 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
 1541 # search using the keyboard; to jump to the search box use <access key> + S
 1542 # (what the <access key> is depends on the OS and browser, but it is typically
 1543 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
 1544 # key> to jump into the search results window, the results can be navigated
 1545 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
 1546 # the search. The filter options can be selected when the cursor is inside the
 1547 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
 1548 # to select a filter and <Enter> or <escape> to activate or cancel the filter
 1549 # option.
 1550 # The default value is: YES.
 1551 # This tag requires that the tag GENERATE_HTML is set to YES.
 1552 
 1553 SEARCHENGINE           = YES
 1554 
 1555 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
 1556 # implemented using a web server instead of a web client using Javascript. There
 1557 # are two flavours of web server based searching depending on the
 1558 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
 1559 # searching and an index file used by the script. When EXTERNAL_SEARCH is
 1560 # enabled the indexing and searching needs to be provided by external tools. See
 1561 # the section "External Indexing and Searching" for details.
 1562 # The default value is: NO.
 1563 # This tag requires that the tag SEARCHENGINE is set to YES.
 1564 
 1565 SERVER_BASED_SEARCH    = NO
 1566 
 1567 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
 1568 # script for searching. Instead the search results are written to an XML file
 1569 # which needs to be processed by an external indexer. Doxygen will invoke an
 1570 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
 1571 # search results.
 1572 #
 1573 # Doxygen ships with an example indexer ( doxyindexer) and search engine
 1574 # (doxysearch.cgi) which are based on the open source search engine library
 1575 # Xapian (see: http://xapian.org/).
 1576 #
 1577 # See the section "External Indexing and Searching" for details.
 1578 # The default value is: NO.
 1579 # This tag requires that the tag SEARCHENGINE is set to YES.
 1580 
 1581 EXTERNAL_SEARCH        = NO
 1582 
 1583 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
 1584 # which will return the search results when EXTERNAL_SEARCH is enabled.
 1585 #
 1586 # Doxygen ships with an example indexer ( doxyindexer) and search engine
 1587 # (doxysearch.cgi) which are based on the open source search engine library
 1588 # Xapian (see: http://xapian.org/). See the section "External Indexing and
 1589 # Searching" for details.
 1590 # This tag requires that the tag SEARCHENGINE is set to YES.
 1591 
 1592 SEARCHENGINE_URL       =
 1593 
 1594 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
 1595 # search data is written to a file for indexing by an external tool. With the
 1596 # SEARCHDATA_FILE tag the name of this file can be specified.
 1597 # The default file is: searchdata.xml.
 1598 # This tag requires that the tag SEARCHENGINE is set to YES.
 1599 
 1600 SEARCHDATA_FILE        = searchdata.xml
 1601 
 1602 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
 1603 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
 1604 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
 1605 # projects and redirect the results back to the right project.
 1606 # This tag requires that the tag SEARCHENGINE is set to YES.
 1607 
 1608 EXTERNAL_SEARCH_ID     =
 1609 
 1610 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
 1611 # projects other than the one defined by this configuration file, but that are
 1612 # all added to the same external search index. Each project needs to have a
 1613 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
 1614 # to a relative location where the documentation can be found. The format is:
 1615 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
 1616 # This tag requires that the tag SEARCHENGINE is set to YES.
 1617 
 1618 EXTRA_SEARCH_MAPPINGS  =
 1619 
 1620 #---------------------------------------------------------------------------
 1621 # Configuration options related to the LaTeX output
 1622 #---------------------------------------------------------------------------
 1623 
 1624 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
 1625 # The default value is: YES.
 1626 
 1627 GENERATE_LATEX         = NO
 1628 
 1629 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 1630 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 1631 # it.
 1632 # The default directory is: latex.
 1633 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1634 
 1635 LATEX_OUTPUT           = latex
 1636 
 1637 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
 1638 # invoked.
 1639 #
 1640 # Note that when enabling USE_PDFLATEX this option is only used for generating
 1641 # bitmaps for formulas in the HTML output, but not in the Makefile that is
 1642 # written to the output directory.
 1643 # The default file is: latex.
 1644 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1645 
 1646 LATEX_CMD_NAME         = latex
 1647 
 1648 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
 1649 # index for LaTeX.
 1650 # The default file is: makeindex.
 1651 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1652 
 1653 MAKEINDEX_CMD_NAME     = makeindex
 1654 
 1655 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
 1656 # documents. This may be useful for small projects and may help to save some
 1657 # trees in general.
 1658 # The default value is: NO.
 1659 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1660 
 1661 COMPACT_LATEX          = NO
 1662 
 1663 # The PAPER_TYPE tag can be used to set the paper type that is used by the
 1664 # printer.
 1665 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
 1666 # 14 inches) and executive (7.25 x 10.5 inches).
 1667 # The default value is: a4.
 1668 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1669 
 1670 PAPER_TYPE             = a4
 1671 
 1672 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
 1673 # that should be included in the LaTeX output. To get the times font for
 1674 # instance you can specify
 1675 # EXTRA_PACKAGES=times
 1676 # If left blank no extra packages will be included.
 1677 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1678 
 1679 EXTRA_PACKAGES         =
 1680 
 1681 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
 1682 # generated LaTeX document. The header should contain everything until the first
 1683 # chapter. If it is left blank doxygen will generate a standard header. See
 1684 # section "Doxygen usage" for information on how to let doxygen write the
 1685 # default header to a separate file.
 1686 #
 1687 # Note: Only use a user-defined header if you know what you are doing! The
 1688 # following commands have a special meaning inside the header: $title,
 1689 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
 1690 # replace them by respectively the title of the page, the current date and time,
 1691 # only the current date, the version number of doxygen, the project name (see
 1692 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
 1693 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1694 
 1695 LATEX_HEADER           =
 1696 
 1697 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
 1698 # generated LaTeX document. The footer should contain everything after the last
 1699 # chapter. If it is left blank doxygen will generate a standard footer.
 1700 #
 1701 # Note: Only use a user-defined footer if you know what you are doing!
 1702 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1703 
 1704 LATEX_FOOTER           =
 1705 
 1706 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
 1707 # other source files which should be copied to the LATEX_OUTPUT output
 1708 # directory. Note that the files will be copied as-is; there are no commands or
 1709 # markers available.
 1710 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1711 
 1712 LATEX_EXTRA_FILES      =
 1713 
 1714 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
 1715 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
 1716 # contain links (just like the HTML output) instead of page references. This
 1717 # makes the output suitable for online browsing using a PDF viewer.
 1718 # The default value is: YES.
 1719 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1720 
 1721 PDF_HYPERLINKS         = YES
 1722 
 1723 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
 1724 # the PDF file directly from the LaTeX files. Set this option to YES to get a
 1725 # higher quality PDF documentation.
 1726 # The default value is: YES.
 1727 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1728 
 1729 USE_PDFLATEX           = YES
 1730 
 1731 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
 1732 # command to the generated LaTeX files. This will instruct LaTeX to keep running
 1733 # if errors occur, instead of asking the user for help. This option is also used
 1734 # when generating formulas in HTML.
 1735 # The default value is: NO.
 1736 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1737 
 1738 LATEX_BATCHMODE        = NO
 1739 
 1740 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
 1741 # index chapters (such as File Index, Compound Index, etc.) in the output.
 1742 # The default value is: NO.
 1743 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1744 
 1745 LATEX_HIDE_INDICES     = NO
 1746 
 1747 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
 1748 # code with syntax highlighting in the LaTeX output.
 1749 #
 1750 # Note that which sources are shown also depends on other settings such as
 1751 # SOURCE_BROWSER.
 1752 # The default value is: NO.
 1753 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1754 
 1755 LATEX_SOURCE_CODE      = NO
 1756 
 1757 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
 1758 # bibliography, e.g. plainnat, or ieeetr. See
 1759 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
 1760 # The default value is: plain.
 1761 # This tag requires that the tag GENERATE_LATEX is set to YES.
 1762 
 1763 LATEX_BIB_STYLE        = plain
 1764 
 1765 #---------------------------------------------------------------------------
 1766 # Configuration options related to the RTF output
 1767 #---------------------------------------------------------------------------
 1768 
 1769 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
 1770 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
 1771 # readers/editors.
 1772 # The default value is: NO.
 1773 
 1774 GENERATE_RTF           = NO
 1775 
 1776 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
 1777 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 1778 # it.
 1779 # The default directory is: rtf.
 1780 # This tag requires that the tag GENERATE_RTF is set to YES.
 1781 
 1782 RTF_OUTPUT             = rtf
 1783 
 1784 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
 1785 # documents. This may be useful for small projects and may help to save some
 1786 # trees in general.
 1787 # The default value is: NO.
 1788 # This tag requires that the tag GENERATE_RTF is set to YES.
 1789 
 1790 COMPACT_RTF            = NO
 1791 
 1792 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
 1793 # contain hyperlink fields. The RTF file will contain links (just like the HTML
 1794 # output) instead of page references. This makes the output suitable for online
 1795 # browsing using Word or some other Word compatible readers that support those
 1796 # fields.
 1797 #
 1798 # Note: WordPad (write) and others do not support links.
 1799 # The default value is: NO.
 1800 # This tag requires that the tag GENERATE_RTF is set to YES.
 1801 
 1802 RTF_HYPERLINKS         = NO
 1803 
 1804 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
 1805 # file, i.e. a series of assignments. You only have to provide replacements,
 1806 # missing definitions are set to their default value.
 1807 #
 1808 # See also section "Doxygen usage" for information on how to generate the
 1809 # default style sheet that doxygen normally uses.
 1810 # This tag requires that the tag GENERATE_RTF is set to YES.
 1811 
 1812 RTF_STYLESHEET_FILE    =
 1813 
 1814 # Set optional variables used in the generation of an RTF document. Syntax is
 1815 # similar to doxygen's config file. A template extensions file can be generated
 1816 # using doxygen -e rtf extensionFile.
 1817 # This tag requires that the tag GENERATE_RTF is set to YES.
 1818 
 1819 RTF_EXTENSIONS_FILE    =
 1820 
 1821 #---------------------------------------------------------------------------
 1822 # Configuration options related to the man page output
 1823 #---------------------------------------------------------------------------
 1824 
 1825 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
 1826 # classes and files.
 1827 # The default value is: NO.
 1828 
 1829 GENERATE_MAN           = NO
 1830 
 1831 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
 1832 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 1833 # it. A directory man3 will be created inside the directory specified by
 1834 # MAN_OUTPUT.
 1835 # The default directory is: man.
 1836 # This tag requires that the tag GENERATE_MAN is set to YES.
 1837 
 1838 MAN_OUTPUT             = man
 1839 
 1840 # The MAN_EXTENSION tag determines the extension that is added to the generated
 1841 # man pages. In case the manual section does not start with a number, the number
 1842 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
 1843 # optional.
 1844 # The default value is: .3.
 1845 # This tag requires that the tag GENERATE_MAN is set to YES.
 1846 
 1847 MAN_EXTENSION          = .3
 1848 
 1849 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
 1850 # will generate one additional man file for each entity documented in the real
 1851 # man page(s). These additional files only source the real man page, but without
 1852 # them the man command would be unable to find the correct page.
 1853 # The default value is: NO.
 1854 # This tag requires that the tag GENERATE_MAN is set to YES.
 1855 
 1856 MAN_LINKS              = NO
 1857 
 1858 #---------------------------------------------------------------------------
 1859 # Configuration options related to the XML output
 1860 #---------------------------------------------------------------------------
 1861 
 1862 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
 1863 # captures the structure of the code including all documentation.
 1864 # The default value is: NO.
 1865 
 1866 GENERATE_XML           = NO
 1867 
 1868 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 1869 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 1870 # it.
 1871 # The default directory is: xml.
 1872 # This tag requires that the tag GENERATE_XML is set to YES.
 1873 
 1874 XML_OUTPUT             = xml
 1875 
 1876 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
 1877 # validating XML parser to check the syntax of the XML files.
 1878 # This tag requires that the tag GENERATE_XML is set to YES.
 1879 
 1880 XML_SCHEMA             =
 1881 
 1882 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
 1883 # validating XML parser to check the syntax of the XML files.
 1884 # This tag requires that the tag GENERATE_XML is set to YES.
 1885 
 1886 XML_DTD                =
 1887 
 1888 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
 1889 # listings (including syntax highlighting and cross-referencing information) to
 1890 # the XML output. Note that enabling this will significantly increase the size
 1891 # of the XML output.
 1892 # The default value is: YES.
 1893 # This tag requires that the tag GENERATE_XML is set to YES.
 1894 
 1895 XML_PROGRAMLISTING     = YES
 1896 
 1897 #---------------------------------------------------------------------------
 1898 # Configuration options related to the DOCBOOK output
 1899 #---------------------------------------------------------------------------
 1900 
 1901 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
 1902 # that can be used to generate PDF.
 1903 # The default value is: NO.
 1904 
 1905 GENERATE_DOCBOOK       = NO
 1906 
 1907 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
 1908 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
 1909 # front of it.
 1910 # The default directory is: docbook.
 1911 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
 1912 
 1913 DOCBOOK_OUTPUT         = docbook
 1914 
 1915 #---------------------------------------------------------------------------
 1916 # Configuration options for the AutoGen Definitions output
 1917 #---------------------------------------------------------------------------
 1918 
 1919 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
 1920 # Definitions (see http://autogen.sf.net) file that captures the structure of
 1921 # the code including all documentation. Note that this feature is still
 1922 # experimental and incomplete at the moment.
 1923 # The default value is: NO.
 1924 
 1925 GENERATE_AUTOGEN_DEF   = NO
 1926 
 1927 #---------------------------------------------------------------------------
 1928 # Configuration options related to the Perl module output
 1929 #---------------------------------------------------------------------------
 1930 
 1931 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
 1932 # file that captures the structure of the code including all documentation.
 1933 #
 1934 # Note that this feature is still experimental and incomplete at the moment.
 1935 # The default value is: NO.
 1936 
 1937 GENERATE_PERLMOD       = NO
 1938 
 1939 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
 1940 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
 1941 # output from the Perl module output.
 1942 # The default value is: NO.
 1943 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
 1944 
 1945 PERLMOD_LATEX          = NO
 1946 
 1947 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
 1948 # formatted so it can be parsed by a human reader. This is useful if you want to
 1949 # understand what is going on. On the other hand, if this tag is set to NO the
 1950 # size of the Perl module output will be much smaller and Perl will parse it
 1951 # just the same.
 1952 # The default value is: YES.
 1953 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
 1954 
 1955 PERLMOD_PRETTY         = YES
 1956 
 1957 # The names of the make variables in the generated doxyrules.make file are
 1958 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
 1959 # so different doxyrules.make files included by the same Makefile don't
 1960 # overwrite each other's variables.
 1961 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
 1962 
 1963 PERLMOD_MAKEVAR_PREFIX =
 1964 
 1965 #---------------------------------------------------------------------------
 1966 # Configuration options related to the preprocessor
 1967 #---------------------------------------------------------------------------
 1968 
 1969 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
 1970 # C-preprocessor directives found in the sources and include files.
 1971 # The default value is: YES.
 1972 
 1973 ENABLE_PREPROCESSING   = NO
 1974 
 1975 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
 1976 # in the source code. If set to NO only conditional compilation will be
 1977 # performed. Macro expansion can be done in a controlled way by setting
 1978 # EXPAND_ONLY_PREDEF to YES.
 1979 # The default value is: NO.
 1980 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 1981 
 1982 MACRO_EXPANSION        = NO
 1983 
 1984 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 1985 # the macro expansion is limited to the macros specified with the PREDEFINED and
 1986 # EXPAND_AS_DEFINED tags.
 1987 # The default value is: NO.
 1988 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 1989 
 1990 EXPAND_ONLY_PREDEF     = NO
 1991 
 1992 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
 1993 # INCLUDE_PATH will be searched if a #include is found.
 1994 # The default value is: YES.
 1995 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 1996 
 1997 SEARCH_INCLUDES        = YES
 1998 
 1999 # The INCLUDE_PATH tag can be used to specify one or more directories that
 2000 # contain include files that are not input files but should be processed by the
 2001 # preprocessor.
 2002 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
 2003 
 2004 INCLUDE_PATH           =
 2005 
 2006 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 2007 # patterns (like *.h and *.hpp) to filter out the header-files in the
 2008 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
 2009 # used.
 2010 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 2011 
 2012 INCLUDE_FILE_PATTERNS  =
 2013 
 2014 # The PREDEFINED tag can be used to specify one or more macro names that are
 2015 # defined before the preprocessor is started (similar to the -D option of e.g.
 2016 # gcc). The argument of the tag is a list of macros of the form: name or
 2017 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
 2018 # is assumed. To prevent a macro definition from being undefined via #undef or
 2019 # recursively expanded use the := operator instead of the = operator.
 2020 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 2021 
 2022 PREDEFINED             =
 2023 
 2024 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 2025 # tag can be used to specify a list of macro names that should be expanded. The
 2026 # macro definition that is found in the sources will be used. Use the PREDEFINED
 2027 # tag if you want to use a different macro definition that overrules the
 2028 # definition found in the source code.
 2029 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 2030 
 2031 EXPAND_AS_DEFINED      =
 2032 
 2033 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
 2034 # remove all refrences to function-like macros that are alone on a line, have an
 2035 # all uppercase name, and do not end with a semicolon. Such function macros are
 2036 # typically used for boiler-plate code, and will confuse the parser if not
 2037 # removed.
 2038 # The default value is: YES.
 2039 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 2040 
 2041 SKIP_FUNCTION_MACROS   = YES
 2042 
 2043 #---------------------------------------------------------------------------
 2044 # Configuration options related to external references
 2045 #---------------------------------------------------------------------------
 2046 
 2047 # The TAGFILES tag can be used to specify one or more tag files. For each tag
 2048 # file the location of the external documentation should be added. The format of
 2049 # a tag file without this location is as follows:
 2050 # TAGFILES = file1 file2 ...
 2051 # Adding location for the tag files is done as follows:
 2052 # TAGFILES = file1=loc1 "file2 = loc2" ...
 2053 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
 2054 # section "Linking to external documentation" for more information about the use
 2055 # of tag files.
 2056 # Note: Each tag file must have an unique name (where the name does NOT include
 2057 # the path). If a tag file is not located in the directory in which doxygen is
 2058 # run, you must also specify the path to the tagfile here.
 2059 
 2060 TAGFILES               =
 2061 
 2062 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
 2063 # tag file that is based on the input files it reads. See section "Linking to
 2064 # external documentation" for more information about the usage of tag files.
 2065 
 2066 GENERATE_TAGFILE       =
 2067 
 2068 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
 2069 # class index. If set to NO only the inherited external classes will be listed.
 2070 # The default value is: NO.
 2071 
 2072 ALLEXTERNALS           = NO
 2073 
 2074 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
 2075 # the modules index. If set to NO, only the current project's groups will be
 2076 # listed.
 2077 # The default value is: YES.
 2078 
 2079 EXTERNAL_GROUPS        = NO
 2080 
 2081 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
 2082 # the related pages index. If set to NO, only the current project's pages will
 2083 # be listed.
 2084 # The default value is: YES.
 2085 
 2086 EXTERNAL_PAGES         = YES
 2087 
 2088 # The PERL_PATH should be the absolute path and name of the perl script
 2089 # interpreter (i.e. the result of 'which perl').
 2090 # The default file (with absolute path) is: /usr/bin/perl.
 2091 
 2092 PERL_PATH              = /usr/bin/perl
 2093 
 2094 #---------------------------------------------------------------------------
 2095 # Configuration options related to the dot tool
 2096 #---------------------------------------------------------------------------
 2097 
 2098 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
 2099 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
 2100 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
 2101 # disabled, but it is recommended to install and use dot, since it yields more
 2102 # powerful graphs.
 2103 # The default value is: YES.
 2104 
 2105 CLASS_DIAGRAMS         = YES
 2106 
 2107 # You can define message sequence charts within doxygen comments using the \msc
 2108 # command. Doxygen will then run the mscgen tool (see:
 2109 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
 2110 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
 2111 # the mscgen tool resides. If left empty the tool is assumed to be found in the
 2112 # default search path.
 2113 
 2114 MSCGEN_PATH            =
 2115 
 2116 # If set to YES, the inheritance and collaboration graphs will hide inheritance
 2117 # and usage relations if the target is undocumented or is not a class.
 2118 # The default value is: YES.
 2119 
 2120 HIDE_UNDOC_RELATIONS   = YES
 2121 
 2122 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
 2123 # available from the path. This tool is part of Graphviz (see:
 2124 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
 2125 # Bell Labs. The other options in this section have no effect if this option is
 2126 # set to NO
 2127 # The default value is: NO.
 2128 
 2129 HAVE_DOT               = NO
 2130 
 2131 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
 2132 # to run in parallel. When set to 0 doxygen will base this on the number of
 2133 # processors available in the system. You can set it explicitly to a value
 2134 # larger than 0 to get control over the balance between CPU load and processing
 2135 # speed.
 2136 # Minimum value: 0, maximum value: 32, default value: 0.
 2137 # This tag requires that the tag HAVE_DOT is set to YES.
 2138 
 2139 DOT_NUM_THREADS        = 0
 2140 
 2141 # When you want a differently looking font n the dot files that doxygen
 2142 # generates you can specify the font name using DOT_FONTNAME. You need to make
 2143 # sure dot is able to find the font, which can be done by putting it in a
 2144 # standard location or by setting the DOTFONTPATH environment variable or by
 2145 # setting DOT_FONTPATH to the directory containing the font.
 2146 # The default value is: Helvetica.
 2147 # This tag requires that the tag HAVE_DOT is set to YES.
 2148 
 2149 DOT_FONTNAME           = Helvetica
 2150 
 2151 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
 2152 # dot graphs.
 2153 # Minimum value: 4, maximum value: 24, default value: 10.
 2154 # This tag requires that the tag HAVE_DOT is set to YES.
 2155 
 2156 DOT_FONTSIZE           = 10
 2157 
 2158 # By default doxygen will tell dot to use the default font as specified with
 2159 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
 2160 # the path where dot can find it using this tag.
 2161 # This tag requires that the tag HAVE_DOT is set to YES.
 2162 
 2163 DOT_FONTPATH           =
 2164 
 2165 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
 2166 # each documented class showing the direct and indirect inheritance relations.
 2167 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
 2168 # The default value is: YES.
 2169 # This tag requires that the tag HAVE_DOT is set to YES.
 2170 
 2171 CLASS_GRAPH            = YES
 2172 
 2173 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
 2174 # graph for each documented class showing the direct and indirect implementation
 2175 # dependencies (inheritance, containment, and class references variables) of the
 2176 # class with other documented classes.
 2177 # The default value is: YES.
 2178 # This tag requires that the tag HAVE_DOT is set to YES.
 2179 
 2180 COLLABORATION_GRAPH    = YES
 2181 
 2182 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
 2183 # groups, showing the direct groups dependencies.
 2184 # The default value is: YES.
 2185 # This tag requires that the tag HAVE_DOT is set to YES.
 2186 
 2187 GROUP_GRAPHS           = YES
 2188 
 2189 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
 2190 # collaboration diagrams in a style similar to the OMG's Unified Modeling
 2191 # Language.
 2192 # The default value is: NO.
 2193 # This tag requires that the tag HAVE_DOT is set to YES.
 2194 
 2195 UML_LOOK               = NO
 2196 
 2197 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
 2198 # class node. If there are many fields or methods and many nodes the graph may
 2199 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
 2200 # number of items for each type to make the size more manageable. Set this to 0
 2201 # for no limit. Note that the threshold may be exceeded by 50% before the limit
 2202 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
 2203 # but if the number exceeds 15, the total amount of fields shown is limited to
 2204 # 10.
 2205 # Minimum value: 0, maximum value: 100, default value: 10.
 2206 # This tag requires that the tag HAVE_DOT is set to YES.
 2207 
 2208 UML_LIMIT_NUM_FIELDS   = 10
 2209 
 2210 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
 2211 # collaboration graphs will show the relations between templates and their
 2212 # instances.
 2213 # The default value is: NO.
 2214 # This tag requires that the tag HAVE_DOT is set to YES.
 2215 
 2216 TEMPLATE_RELATIONS     = NO
 2217 
 2218 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
 2219 # YES then doxygen will generate a graph for each documented file showing the
 2220 # direct and indirect include dependencies of the file with other documented
 2221 # files.
 2222 # The default value is: YES.
 2223 # This tag requires that the tag HAVE_DOT is set to YES.
 2224 
 2225 INCLUDE_GRAPH          = YES
 2226 
 2227 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
 2228 # set to YES then doxygen will generate a graph for each documented file showing
 2229 # the direct and indirect include dependencies of the file with other documented
 2230 # files.
 2231 # The default value is: YES.
 2232 # This tag requires that the tag HAVE_DOT is set to YES.
 2233 
 2234 INCLUDED_BY_GRAPH      = YES
 2235 
 2236 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
 2237 # dependency graph for every global function or class method.
 2238 #
 2239 # Note that enabling this option will significantly increase the time of a run.
 2240 # So in most cases it will be better to enable call graphs for selected
 2241 # functions only using the \callgraph command.
 2242 # The default value is: NO.
 2243 # This tag requires that the tag HAVE_DOT is set to YES.
 2244 
 2245 CALL_GRAPH             = NO
 2246 
 2247 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
 2248 # dependency graph for every global function or class method.
 2249 #
 2250 # Note that enabling this option will significantly increase the time of a run.
 2251 # So in most cases it will be better to enable caller graphs for selected
 2252 # functions only using the \callergraph command.
 2253 # The default value is: NO.
 2254 # This tag requires that the tag HAVE_DOT is set to YES.
 2255 
 2256 CALLER_GRAPH           = NO
 2257 
 2258 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
 2259 # hierarchy of all classes instead of a textual one.
 2260 # The default value is: YES.
 2261 # This tag requires that the tag HAVE_DOT is set to YES.
 2262 
 2263 GRAPHICAL_HIERARCHY    = YES
 2264 
 2265 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
 2266 # dependencies a directory has on other directories in a graphical way. The
 2267 # dependency relations are determined by the #include relations between the
 2268 # files in the directories.
 2269 # The default value is: YES.
 2270 # This tag requires that the tag HAVE_DOT is set to YES.
 2271 
 2272 DIRECTORY_GRAPH        = YES
 2273 
 2274 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
 2275 # generated by dot.
 2276 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
 2277 # to make the SVG files visible in IE 9+ (other browsers do not have this
 2278 # requirement).
 2279 # Possible values are: png, jpg, gif and svg.
 2280 # The default value is: png.
 2281 # This tag requires that the tag HAVE_DOT is set to YES.
 2282 
 2283 DOT_IMAGE_FORMAT       = png
 2284 
 2285 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
 2286 # enable generation of interactive SVG images that allow zooming and panning.
 2287 #
 2288 # Note that this requires a modern browser other than Internet Explorer. Tested
 2289 # and working are Firefox, Chrome, Safari, and Opera.
 2290 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
 2291 # the SVG files visible. Older versions of IE do not have SVG support.
 2292 # The default value is: NO.
 2293 # This tag requires that the tag HAVE_DOT is set to YES.
 2294 
 2295 INTERACTIVE_SVG        = NO
 2296 
 2297 # The DOT_PATH tag can be used to specify the path where the dot tool can be
 2298 # found. If left blank, it is assumed the dot tool can be found in the path.
 2299 # This tag requires that the tag HAVE_DOT is set to YES.
 2300 
 2301 DOT_PATH               =
 2302 
 2303 # The DOTFILE_DIRS tag can be used to specify one or more directories that
 2304 # contain dot files that are included in the documentation (see the \dotfile
 2305 # command).
 2306 # This tag requires that the tag HAVE_DOT is set to YES.
 2307 
 2308 DOTFILE_DIRS           =
 2309 
 2310 # The MSCFILE_DIRS tag can be used to specify one or more directories that
 2311 # contain msc files that are included in the documentation (see the \mscfile
 2312 # command).
 2313 
 2314 MSCFILE_DIRS           =
 2315 
 2316 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
 2317 # that will be shown in the graph. If the number of nodes in a graph becomes
 2318 # larger than this value, doxygen will truncate the graph, which is visualized
 2319 # by representing a node as a red box. Note that doxygen if the number of direct
 2320 # children of the root node in a graph is already larger than
 2321 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
 2322 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
 2323 # Minimum value: 0, maximum value: 10000, default value: 50.
 2324 # This tag requires that the tag HAVE_DOT is set to YES.
 2325 
 2326 DOT_GRAPH_MAX_NODES    = 50
 2327 
 2328 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
 2329 # generated by dot. A depth value of 3 means that only nodes reachable from the
 2330 # root by following a path via at most 3 edges will be shown. Nodes that lay
 2331 # further from the root node will be omitted. Note that setting this option to 1
 2332 # or 2 may greatly reduce the computation time needed for large code bases. Also
 2333 # note that the size of a graph can be further restricted by
 2334 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
 2335 # Minimum value: 0, maximum value: 1000, default value: 0.
 2336 # This tag requires that the tag HAVE_DOT is set to YES.
 2337 
 2338 MAX_DOT_GRAPH_DEPTH    = 0
 2339 
 2340 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
 2341 # background. This is disabled by default, because dot on Windows does not seem
 2342 # to support this out of the box.
 2343 #
 2344 # Warning: Depending on the platform used, enabling this option may lead to
 2345 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
 2346 # read).
 2347 # The default value is: NO.
 2348 # This tag requires that the tag HAVE_DOT is set to YES.
 2349 
 2350 DOT_TRANSPARENT        = NO
 2351 
 2352 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
 2353 # files in one run (i.e. multiple -o and -T options on the command line). This
 2354 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
 2355 # this, this feature is disabled by default.
 2356 # The default value is: NO.
 2357 # This tag requires that the tag HAVE_DOT is set to YES.
 2358 
 2359 DOT_MULTI_TARGETS      = NO
 2360 
 2361 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
 2362 # explaining the meaning of the various boxes and arrows in the dot generated
 2363 # graphs.
 2364 # The default value is: YES.
 2365 # This tag requires that the tag HAVE_DOT is set to YES.
 2366 
 2367 GENERATE_LEGEND        = YES
 2368 
 2369 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
 2370 # files that are used to generate the various graphs.
 2371 # The default value is: YES.
 2372 # This tag requires that the tag HAVE_DOT is set to YES.
 2373 
 2374 DOT_CLEANUP            = YES