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