"Fossies" - the Fresh Open Source Software Archive

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