Doxyfile

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