Utrac: Doxyfile

"Fossies" - the Fresh Open Source Software Archive

Member "utrac-0.3.2/Doxyfile" (4 Jan 2009, 47777 Bytes) of package /linux/privat/old/utrac-0.3.2.tgz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

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