comparison: Doxyfile.in
Doxyfile.in
- changeset 6317
- b40515160b51
- parent 4554
- 09f005a2628b
- child 6487
- b540738b5cf8
equal
deleted
inserted
replaced
| 6316:739562f5bdb0 | 6317:b40515160b51 |
|---|---|
| 1 # Doxyfile 1.2.18-20021020 | 1 # Doxyfile 1.3.3 |
| 2 | 2 |
| 3 # This file describes the settings to be used by the documentation system | 3 # This file describes the settings to be used by the documentation system |
| 4 # doxygen (www.doxygen.org) for a project | 4 # doxygen (www.doxygen.org) for a project |
| 5 # | 5 # |
| 6 # All text after a hash (#) is considered a comment and will be ignored | 6 # All text after a hash (#) is considered a comment and will be ignored |
| 36 # documentation generated by doxygen is written. Doxygen will use this | 36 # documentation generated by doxygen is written. Doxygen will use this |
| 37 # information to generate all constant output in the proper language. | 37 # information to generate all constant output in the proper language. |
| 38 # The default language is English, other supported languages are: | 38 # The default language is English, other supported languages are: |
| 39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, | 39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, |
| 40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en | 40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en |
| 41 # (Japanese with english messages), Korean, Norwegian, Polish, Portuguese, | 41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, |
| 42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian. | 42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
| 43 | 43 |
| 44 OUTPUT_LANGUAGE = English | 44 OUTPUT_LANGUAGE = English |
| 45 | |
| 46 # This tag can be used to specify the encoding used in the generated output. | |
| 47 # The encoding is not always determined by the language that is chosen, | |
| 48 # but also whether or not the output is meant for Windows or non-Windows users. | |
| 49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES | |
| 50 # forces the Windows encoding (this is the default for the Windows binary), | |
| 51 # whereas setting the tag to NO uses a Unix-style encoding (the default for | |
| 52 # all platforms other than Windows). | |
| 53 | |
| 54 USE_WINDOWS_ENCODING = NO | |
| 45 | 55 |
| 46 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | 56 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
| 47 # documentation are documented, even if no documentation was available. | 57 # documentation are documented, even if no documentation was available. |
| 48 # Private class members and static file members will be hidden unless | 58 # Private class members and static file members will be hidden unless |
| 49 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | 59 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
| 74 | 84 |
| 75 HIDE_UNDOC_MEMBERS = NO | 85 HIDE_UNDOC_MEMBERS = NO |
| 76 | 86 |
| 77 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | 87 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
| 78 # undocumented classes that are normally visible in the class hierarchy. | 88 # undocumented classes that are normally visible in the class hierarchy. |
| 79 # If set to NO (the default) these class will be included in the various | 89 # If set to NO (the default) these classes will be included in the various |
| 80 # overviews. This option has no effect if EXTRACT_ALL is enabled. | 90 # overviews. This option has no effect if EXTRACT_ALL is enabled. |
| 81 | 91 |
| 82 HIDE_UNDOC_CLASSES = NO | 92 HIDE_UNDOC_CLASSES = NO |
| 83 | 93 |
| 84 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all | 94 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
| 86 # If set to NO (the default) these declarations will be included in the | 96 # If set to NO (the default) these declarations will be included in the |
| 87 # documentation. | 97 # documentation. |
| 88 | 98 |
| 89 HIDE_FRIEND_COMPOUNDS = NO | 99 HIDE_FRIEND_COMPOUNDS = NO |
| 90 | 100 |
| 101 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any | |
| 102 # documentation blocks found inside the body of a function. | |
| 103 # If set to NO (the default) these blocks will be appended to the | |
| 104 # function's detailed documentation block. | |
| 105 | |
| 106 HIDE_IN_BODY_DOCS = NO | |
| 107 | |
| 91 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | 108 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
| 92 # include brief member descriptions after the members that are listed in | 109 # include brief member descriptions after the members that are listed in |
| 93 # the file and class documentation (similar to JavaDoc). | 110 # the file and class documentation (similar to JavaDoc). |
| 94 # Set to NO to disable this. | 111 # Set to NO to disable this. |
| 95 | 112 |
| 120 # to NO the shortest path that makes the file name unique will be used. | 137 # to NO the shortest path that makes the file name unique will be used. |
| 121 | 138 |
| 122 FULL_PATH_NAMES = NO | 139 FULL_PATH_NAMES = NO |
| 123 | 140 |
| 124 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | 141 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
| 125 # can be used to strip a user defined part of the path. Stripping is | 142 # can be used to strip a user-defined part of the path. Stripping is |
| 126 # only done if one of the specified strings matches the left-hand part of | 143 # only done if one of the specified strings matches the left-hand part of |
| 127 # the path. It is allowed to use relative paths in the argument list. | 144 # the path. It is allowed to use relative paths in the argument list. |
| 128 | 145 |
| 129 STRIP_FROM_PATH = | 146 STRIP_FROM_PATH = |
| 130 | 147 |
| 134 # Set it to YES to include the internal documentation. | 151 # Set it to YES to include the internal documentation. |
| 135 | 152 |
| 136 INTERNAL_DOCS = NO | 153 INTERNAL_DOCS = NO |
| 137 | 154 |
| 138 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | 155 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
| 139 # file names in lower case letters. If set to YES upper case letters are also | 156 # file names in lower-case letters. If set to YES upper-case letters are also |
| 140 # allowed. This is useful if you have classes or files whose names only differ | 157 # allowed. This is useful if you have classes or files whose names only differ |
| 141 # in case and if your file system supports case sensitive file names. Windows | 158 # in case and if your file system supports case sensitive file names. Windows |
| 142 # users are adviced to set this option to NO. | 159 # users are advised to set this option to NO. |
| 143 | 160 |
| 144 CASE_SENSE_NAMES = YES | 161 CASE_SENSE_NAMES = YES |
| 145 | 162 |
| 146 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | 163 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
| 147 # (but less readable) file names. This can be useful is your file systems | 164 # (but less readable) file names. This can be useful is your file systems |
| 153 # will show members with their full class and namespace scopes in the | 170 # will show members with their full class and namespace scopes in the |
| 154 # documentation. If set to YES the scope will be hidden. | 171 # documentation. If set to YES the scope will be hidden. |
| 155 | 172 |
| 156 HIDE_SCOPE_NAMES = NO | 173 HIDE_SCOPE_NAMES = NO |
| 157 | 174 |
| 158 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | |
| 159 # will generate a verbatim copy of the header file for each class for | |
| 160 # which an include is specified. Set to NO to disable this. | |
| 161 | |
| 162 VERBATIM_HEADERS = YES | |
| 163 | |
| 164 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | 175 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
| 165 # will put list of the files that are included by a file in the documentation | 176 # will put a list of the files that are included by a file in the documentation |
| 166 # of that file. | 177 # of that file. |
| 167 | 178 |
| 168 SHOW_INCLUDE_FILES = YES | 179 SHOW_INCLUDE_FILES = YES |
| 169 | 180 |
| 170 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | 181 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
| 171 # will interpret the first line (until the first dot) of a JavaDoc-style | 182 # will interpret the first line (until the first dot) of a JavaDoc-style |
| 172 # comment as the brief description. If set to NO, the JavaDoc | 183 # comment as the brief description. If set to NO, the JavaDoc |
| 173 # comments will behave just like the Qt-style comments (thus requiring an | 184 # comments will behave just like the Qt-style comments (thus requiring an |
| 174 # explict @brief command for a brief description. | 185 # explict @brief command for a brief description. |
| 175 | 186 |
| 176 JAVADOC_AUTOBRIEF = YES | 187 JAVADOC_AUTOBRIEF = YES |
| 177 | 188 |
| 178 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | 189 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
| 237 # commands in the documentation. | 248 # commands in the documentation. |
| 238 | 249 |
| 239 GENERATE_BUGLIST = YES | 250 GENERATE_BUGLIST = YES |
| 240 | 251 |
| 241 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or | 252 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
| 242 # disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation. | 253 # disable (NO) the deprecated list. This list is created by putting |
| 254 # \deprecated commands in the documentation. | |
| 243 | 255 |
| 244 GENERATE_DEPRECATEDLIST= YES | 256 GENERATE_DEPRECATEDLIST= YES |
| 245 | 257 |
| 246 # This tag can be used to specify a number of aliases that acts | 258 # This tag can be used to specify a number of aliases that acts |
| 247 # as commands in the documentation. An alias has the form "name=value". | 259 # as commands in the documentation. An alias has the form "name=value". |
| 248 # For example adding "sideeffect=\par Side Effects:\n" will allow you to | 260 # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
| 249 # put the command \sideeffect (or @sideeffect) in the documentation, which | 261 # put the command \sideeffect (or @sideeffect) in the documentation, which |
| 250 # will result in a user defined paragraph with heading "Side Effects:". | 262 # will result in a user-defined paragraph with heading "Side Effects:". |
| 251 # You can put \n's in the value part of an alias to insert newlines. | 263 # You can put \n's in the value part of an alias to insert newlines. |
| 252 | 264 |
| 253 ALIASES = | 265 ALIASES = |
| 254 | 266 |
| 255 # The ENABLED_SECTIONS tag can be used to enable conditional | 267 # The ENABLED_SECTIONS tag can be used to enable conditional |
| 256 # documentation sections, marked by \if sectionname ... \endif. | 268 # documentation sections, marked by \if sectionname ... \endif. |
| 257 | 269 |
| 258 ENABLED_SECTIONS = | 270 ENABLED_SECTIONS = |
| 259 | 271 |
| 260 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | 272 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
| 261 # the initial value of a variable or define consist of for it to appear in | 273 # the initial value of a variable or define consists of for it to appear in |
| 262 # the documentation. If the initializer consists of more lines than specified | 274 # the documentation. If the initializer consists of more lines than specified |
| 263 # here it will be hidden. Use a value of 0 to hide initializers completely. | 275 # here it will be hidden. Use a value of 0 to hide initializers completely. |
| 264 # The appearance of the initializer of individual variables and defines in the | 276 # The appearance of the initializer of individual variables and defines in the |
| 265 # documentation can be controlled using \showinitializer or \hideinitializer | 277 # documentation can be controlled using \showinitializer or \hideinitializer |
| 266 # command in the documentation regardless of this setting. | 278 # command in the documentation regardless of this setting. |
| 267 | 279 |
| 268 MAX_INITIALIZER_LINES = 30 | 280 MAX_INITIALIZER_LINES = 30 |
| 269 | 281 |
| 270 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | 282 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
| 271 # only. Doxygen will then generate output that is more tailored for C. | 283 # only. Doxygen will then generate output that is more tailored for C. |
| 272 # For instance some of the names that are used will be different. The list | 284 # For instance, some of the names that are used will be different. The list |
| 273 # of all members will be omitted, etc. | 285 # of all members will be omitted, etc. |
| 274 | 286 |
| 275 OPTIMIZE_OUTPUT_FOR_C = YES | 287 OPTIMIZE_OUTPUT_FOR_C = YES |
| 276 | 288 |
| 277 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | 289 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources |
| 278 # only. Doxygen will then generate output that is more tailored for Java. | 290 # only. Doxygen will then generate output that is more tailored for Java. |
| 279 # For instance namespaces will be presented as packages, qualified scopes | 291 # For instance, namespaces will be presented as packages, qualified scopes |
| 280 # will look different, etc. | 292 # will look different, etc. |
| 281 | 293 |
| 282 OPTIMIZE_OUTPUT_JAVA = NO | 294 OPTIMIZE_OUTPUT_JAVA = NO |
| 283 | 295 |
| 284 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | 296 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
| 285 # at the bottom of the documentation of classes and structs. If set to YES the | 297 # at the bottom of the documentation of classes and structs. If set to YES the |
| 286 # list will mention the files that were used to generate the documentation. | 298 # list will mention the files that were used to generate the documentation. |
| 287 | 299 |
| 288 SHOW_USED_FILES = YES | 300 SHOW_USED_FILES = YES |
| 289 | 301 |
| 302 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | |
| 303 # the same type (for instance a group of public functions) to be put as a | |
| 304 # subgroup of that type (e.g. under the Public Functions section). Set it to | |
| 305 # NO to prevent subgrouping. Alternatively, this can be done per class using | |
| 306 # the \nosubgrouping command. | |
| 307 | |
| 308 SUBGROUPING = YES | |
| 309 | |
| 290 #--------------------------------------------------------------------------- | 310 #--------------------------------------------------------------------------- |
| 291 # configuration options related to warning and progress messages | 311 # configuration options related to warning and progress messages |
| 292 #--------------------------------------------------------------------------- | 312 #--------------------------------------------------------------------------- |
| 293 | 313 |
| 294 # The QUIET tag can be used to turn on/off the messages that are generated | 314 # The QUIET tag can be used to turn on/off the messages that are generated |
| 305 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | 325 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
| 306 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | 326 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
| 307 # automatically be disabled. | 327 # automatically be disabled. |
| 308 | 328 |
| 309 WARN_IF_UNDOCUMENTED = NO | 329 WARN_IF_UNDOCUMENTED = NO |
| 330 | |
| 331 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for | |
| 332 # potential errors in the documentation, such as not documenting some | |
| 333 # parameters in a documented function, or documenting parameters that | |
| 334 # don't exist or using markup commands wrongly. | |
| 335 | |
| 336 WARN_IF_DOC_ERROR = YES | |
| 310 | 337 |
| 311 # The WARN_FORMAT tag determines the format of the warning messages that | 338 # The WARN_FORMAT tag determines the format of the warning messages that |
| 312 # doxygen can produce. The string should contain the $file, $line, and $text | 339 # doxygen can produce. The string should contain the $file, $line, and $text |
| 313 # tags, which will be replaced by the file and line number from which the | 340 # tags, which will be replaced by the file and line number from which the |
| 314 # warning originated and the warning text. | 341 # warning originated and the warning text. |
| 335 # If the value of the INPUT tag contains directories, you can use the | 362 # If the value of the INPUT tag contains directories, you can use the |
| 336 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | 363 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
| 337 # and *.h) to filter out the source-files in the directories. If left | 364 # and *.h) to filter out the source-files in the directories. If left |
| 338 # blank the following patterns are tested: | 365 # blank the following patterns are tested: |
| 339 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp | 366 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp |
| 340 # *.h++ *.idl *.odl | 367 # *.h++ *.idl *.odl *.cs |
| 341 | 368 |
| 342 FILE_PATTERNS = *.h | 369 FILE_PATTERNS = *.h |
| 343 | 370 |
| 344 # The RECURSIVE tag can be used to turn specify whether or not subdirectories | 371 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
| 345 # should be searched for input files as well. Possible values are YES and NO. | 372 # should be searched for input files as well. Possible values are YES and NO. |
| 435 # then for each documented function all documented entities | 462 # then for each documented function all documented entities |
| 436 # called/used by that function will be listed. | 463 # called/used by that function will be listed. |
| 437 | 464 |
| 438 REFERENCES_RELATION = YES | 465 REFERENCES_RELATION = YES |
| 439 | 466 |
| 467 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | |
| 468 # will generate a verbatim copy of the header file for each class for | |
| 469 # which an include is specified. Set to NO to disable this. | |
| 470 | |
| 471 VERBATIM_HEADERS = YES | |
| 472 | |
| 440 #--------------------------------------------------------------------------- | 473 #--------------------------------------------------------------------------- |
| 441 # configuration options related to the alphabetical class index | 474 # configuration options related to the alphabetical class index |
| 442 #--------------------------------------------------------------------------- | 475 #--------------------------------------------------------------------------- |
| 443 | 476 |
| 444 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | 477 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
| 491 # each generated HTML page. If it is left blank doxygen will generate a | 524 # each generated HTML page. If it is left blank doxygen will generate a |
| 492 # standard footer. | 525 # standard footer. |
| 493 | 526 |
| 494 HTML_FOOTER = | 527 HTML_FOOTER = |
| 495 | 528 |
| 496 # The HTML_STYLESHEET tag can be used to specify a user defined cascading | 529 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
| 497 # style sheet that is used by each HTML page. It can be used to | 530 # style sheet that is used by each HTML page. It can be used to |
| 498 # fine-tune the look of the HTML output. If the tag is left blank doxygen | 531 # fine-tune the look of the HTML output. If the tag is left blank doxygen |
| 499 # will generate a default style sheet | 532 # will generate a default style sheet |
| 500 | 533 |
| 501 HTML_STYLESHEET = | 534 HTML_STYLESHEET = |
| 520 | 553 |
| 521 CHM_FILE = | 554 CHM_FILE = |
| 522 | 555 |
| 523 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | 556 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
| 524 # be used to specify the location (absolute path including file name) of | 557 # be used to specify the location (absolute path including file name) of |
| 525 # the HTML help compiler (hhc.exe). If non empty doxygen will try to run | 558 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
| 526 # the html help compiler on the generated index.hhp. | 559 # the HTML help compiler on the generated index.hhp. |
| 527 | 560 |
| 528 HHC_LOCATION = | 561 HHC_LOCATION = |
| 529 | 562 |
| 530 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | 563 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
| 531 # controls if a separate .chi index file is generated (YES) or that | 564 # controls if a separate .chi index file is generated (YES) or that |
| 538 # normal table of contents (NO) in the .chm file. | 571 # normal table of contents (NO) in the .chm file. |
| 539 | 572 |
| 540 BINARY_TOC = NO | 573 BINARY_TOC = NO |
| 541 | 574 |
| 542 # The TOC_EXPAND flag can be set to YES to add extra items for group members | 575 # The TOC_EXPAND flag can be set to YES to add extra items for group members |
| 543 # to the contents of the Html help documentation and to the tree view. | 576 # to the contents of the HTML help documentation and to the tree view. |
| 544 | 577 |
| 545 TOC_EXPAND = NO | 578 TOC_EXPAND = NO |
| 546 | 579 |
| 547 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | 580 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
| 548 # top of each HTML page. The value NO (the default) enables the index and | 581 # top of each HTML page. The value NO (the default) enables the index and |
| 556 ENUM_VALUES_PER_LINE = 4 | 589 ENUM_VALUES_PER_LINE = 4 |
| 557 | 590 |
| 558 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | 591 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
| 559 # generated containing a tree-like index structure (just like the one that | 592 # generated containing a tree-like index structure (just like the one that |
| 560 # is generated for HTML Help). For this to work a browser that supports | 593 # is generated for HTML Help). For this to work a browser that supports |
| 561 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, | 594 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
| 562 # or Internet explorer 4.0+). Note that for large projects the tree generation | 595 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
| 563 # can take a very long time. In such cases it is better to disable this feature. | 596 # probably better off using the HTML help feature. |
| 564 # Windows users are probably better off using the HTML help feature. | |
| 565 | 597 |
| 566 GENERATE_TREEVIEW = NO | 598 GENERATE_TREEVIEW = NO |
| 567 | 599 |
| 568 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | 600 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
| 569 # used to set the initial width (in pixels) of the frame in which the tree | 601 # used to set the initial width (in pixels) of the frame in which the tree |
| 570 # is shown. | 602 # is shown. |
| 571 | 603 |
| 572 TREEVIEW_WIDTH = 250 | 604 TREEVIEW_WIDTH = 250 |
| 573 | 605 |
| 606 # If the GENERATE_DEVHELP tag is set to YES, an index file for the | |
| 607 # DevHelp documentation viewer will be generated. For more information, | |
| 608 # see http://www.imendio.com/projects/devhelp/ | |
| 609 | |
| 610 GENERATE_DEVHELP = YES | |
| 611 | |
| 612 # The DEVHELP_TITLE tag is used to specify the displayed name of the | |
| 613 # generated DevHelp book file. If left blank, the project name will | |
| 614 # be used. | |
| 615 | |
| 616 DEVHELP_TITLE = Gaim | |
| 617 | |
| 574 #--------------------------------------------------------------------------- | 618 #--------------------------------------------------------------------------- |
| 575 # configuration options related to the LaTeX output | 619 # configuration options related to the LaTeX output |
| 576 #--------------------------------------------------------------------------- | 620 #--------------------------------------------------------------------------- |
| 577 | 621 |
| 578 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | 622 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
| 584 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | 628 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| 585 # put in front of it. If left blank `latex' will be used as the default path. | 629 # put in front of it. If left blank `latex' will be used as the default path. |
| 586 | 630 |
| 587 LATEX_OUTPUT = latex | 631 LATEX_OUTPUT = latex |
| 588 | 632 |
| 589 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name. | 633 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
| 634 # invoked. If left blank `latex' will be used as the default command name. | |
| 590 | 635 |
| 591 LATEX_CMD_NAME = latex | 636 LATEX_CMD_NAME = latex |
| 592 | 637 |
| 593 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | 638 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
| 594 # generate index for LaTeX. If left blank `makeindex' will be used as the | 639 # generate index for LaTeX. If left blank `makeindex' will be used as the |
| 637 # command to the generated LaTeX files. This will instruct LaTeX to keep | 682 # command to the generated LaTeX files. This will instruct LaTeX to keep |
| 638 # running if errors occur, instead of asking the user for help. | 683 # running if errors occur, instead of asking the user for help. |
| 639 # This option is also used when generating formulas in HTML. | 684 # This option is also used when generating formulas in HTML. |
| 640 | 685 |
| 641 LATEX_BATCHMODE = NO | 686 LATEX_BATCHMODE = NO |
| 687 | |
| 688 # If LATEX_HIDE_INDICES is set to YES then doxygen will not | |
| 689 # include the index chapters (such as File Index, Compound Index, etc.) | |
| 690 # in the output. | |
| 691 | |
| 692 LATEX_HIDE_INDICES = NO | |
| 642 | 693 |
| 643 #--------------------------------------------------------------------------- | 694 #--------------------------------------------------------------------------- |
| 644 # configuration options related to the RTF output | 695 # configuration options related to the RTF output |
| 645 #--------------------------------------------------------------------------- | 696 #--------------------------------------------------------------------------- |
| 646 | 697 |
| 720 # feature is still experimental and incomplete at the | 771 # feature is still experimental and incomplete at the |
| 721 # moment. | 772 # moment. |
| 722 | 773 |
| 723 GENERATE_XML = NO | 774 GENERATE_XML = NO |
| 724 | 775 |
| 776 # The XML_OUTPUT tag is used to specify where the XML pages will be put. | |
| 777 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 778 # put in front of it. If left blank `xml' will be used as the default path. | |
| 779 | |
| 780 XML_OUTPUT = xml | |
| 781 | |
| 725 # The XML_SCHEMA tag can be used to specify an XML schema, | 782 # The XML_SCHEMA tag can be used to specify an XML schema, |
| 726 # which can be used by a validating XML parser to check the | 783 # which can be used by a validating XML parser to check the |
| 727 # syntax of the XML files. | 784 # syntax of the XML files. |
| 728 | 785 |
| 729 XML_SCHEMA = | 786 XML_SCHEMA = |
| 756 # feature is still experimental and incomplete at the | 813 # feature is still experimental and incomplete at the |
| 757 # moment. | 814 # moment. |
| 758 | 815 |
| 759 GENERATE_PERLMOD = NO | 816 GENERATE_PERLMOD = NO |
| 760 | 817 |
| 818 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate | |
| 819 # the necessary Makefile rules, Perl scripts and LaTeX code to be able | |
| 820 # to generate PDF and DVI output from the Perl module output. | |
| 821 | |
| 822 PERLMOD_LATEX = NO | |
| 823 | |
| 824 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | |
| 825 # nicely formatted so it can be parsed by a human reader. This is useful | |
| 826 # if you want to understand what is going on. On the other hand, if this | |
| 827 # tag is set to NO the size of the Perl module output will be much smaller | |
| 828 # and Perl will parse it just the same. | |
| 829 | |
| 830 PERLMOD_PRETTY = YES | |
| 831 | |
| 832 # The names of the make variables in the generated doxyrules.make file | |
| 833 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | |
| 834 # This is useful so different doxyrules.make files included by the same | |
| 835 # Makefile don't overwrite each other's variables. | |
| 836 | |
| 837 PERLMOD_MAKEVAR_PREFIX = | |
| 838 | |
| 761 #--------------------------------------------------------------------------- | 839 #--------------------------------------------------------------------------- |
| 762 # Configuration options related to the preprocessor | 840 # Configuration options related to the preprocessor |
| 763 #--------------------------------------------------------------------------- | 841 #--------------------------------------------------------------------------- |
| 764 | 842 |
| 765 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | 843 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
| 805 # or name=definition (no spaces). If the definition and the = are | 883 # or name=definition (no spaces). If the definition and the = are |
| 806 # omitted =1 is assumed. | 884 # omitted =1 is assumed. |
| 807 | 885 |
| 808 PREDEFINED = | 886 PREDEFINED = |
| 809 | 887 |
| 810 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then | 888 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
| 811 # this tag can be used to specify a list of macro names that should be expanded. | 889 # this tag can be used to specify a list of macro names that should be expanded. |
| 812 # The macro definition that is found in the sources will be used. | 890 # The macro definition that is found in the sources will be used. |
| 813 # Use the PREDEFINED tag if you want to use a different macro definition. | 891 # Use the PREDEFINED tag if you want to use a different macro definition. |
| 814 | 892 |
| 815 EXPAND_AS_DEFINED = | 893 EXPAND_AS_DEFINED = |
| 824 | 902 |
| 825 #--------------------------------------------------------------------------- | 903 #--------------------------------------------------------------------------- |
| 826 # Configuration::addtions related to external references | 904 # Configuration::addtions related to external references |
| 827 #--------------------------------------------------------------------------- | 905 #--------------------------------------------------------------------------- |
| 828 | 906 |
| 829 # The TAGFILES tag can be used to specify one or more tagfiles. | 907 # The TAGFILES option can be used to specify one or more tagfiles. |
| 908 # Optionally an initial location of the external documentation | |
| 909 # can be added for each tagfile. The format of a tag file without | |
| 910 # this location is as follows: | |
| 911 # TAGFILES = file1 file2 ... | |
| 912 # Adding location for the tag files is done as follows: | |
| 913 # TAGFILES = file1=loc1 "file2 = loc2" ... | |
| 914 # where "loc1" and "loc2" can be relative or absolute paths or | |
| 915 # URLs. If a location is present for each tag, the installdox tool | |
| 916 # does not have to be run to correct the links. | |
| 917 # Note that each tag file must have a unique name | |
| 918 # (where the name does NOT include the path) | |
| 919 # If a tag file is not located in the directory in which doxygen | |
| 920 # is run, you must also specify the path to the tagfile here. | |
| 830 | 921 |
| 831 TAGFILES = | 922 TAGFILES = |
| 832 | 923 |
| 833 # When a file name is specified after GENERATE_TAGFILE, doxygen will create | 924 # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
| 834 # a tag file that is based on the input files it reads. | 925 # a tag file that is based on the input files it reads. |
| 855 #--------------------------------------------------------------------------- | 946 #--------------------------------------------------------------------------- |
| 856 # Configuration options related to the dot tool | 947 # Configuration options related to the dot tool |
| 857 #--------------------------------------------------------------------------- | 948 #--------------------------------------------------------------------------- |
| 858 | 949 |
| 859 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | 950 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
| 860 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or | 951 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or |
| 861 # super classes. Setting the tag to NO turns the diagrams off. Note that this | 952 # super classes. Setting the tag to NO turns the diagrams off. Note that this |
| 862 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is | 953 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is |
| 863 # recommended to install and use dot, since it yield more powerful graphs. | 954 # recommended to install and use dot, since it yields more powerful graphs. |
| 864 | 955 |
| 865 CLASS_DIAGRAMS = YES | 956 CLASS_DIAGRAMS = YES |
| 866 | 957 |
| 867 # If set to YES, the inheritance and collaboration graphs will hide | 958 # If set to YES, the inheritance and collaboration graphs will hide |
| 868 # inheritance and usage relations if the target is undocumented | 959 # inheritance and usage relations if the target is undocumented |
| 889 # indirect implementation dependencies (inheritance, containment, and | 980 # indirect implementation dependencies (inheritance, containment, and |
| 890 # class references variables) of the class with other documented classes. | 981 # class references variables) of the class with other documented classes. |
| 891 | 982 |
| 892 COLLABORATION_GRAPH = YES | 983 COLLABORATION_GRAPH = YES |
| 893 | 984 |
| 985 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | |
| 986 # collaboration diagrams in a style similiar to the OMG's Unified Modeling | |
| 987 # Language. | |
| 988 | |
| 989 UML_LOOK = NO | |
| 990 | |
| 894 # If set to YES, the inheritance and collaboration graphs will show the | 991 # If set to YES, the inheritance and collaboration graphs will show the |
| 895 # relations between templates and their instances. | 992 # relations between templates and their instances. |
| 896 | 993 |
| 897 TEMPLATE_RELATIONS = YES | 994 TEMPLATE_RELATIONS = YES |
| 898 | 995 |
| 907 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | 1004 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
| 908 # documented header file showing the documented files that directly or | 1005 # documented header file showing the documented files that directly or |
| 909 # indirectly include this file. | 1006 # indirectly include this file. |
| 910 | 1007 |
| 911 INCLUDED_BY_GRAPH = YES | 1008 INCLUDED_BY_GRAPH = YES |
| 1009 | |
| 1010 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will | |
| 1011 # generate a call dependency graph for every global function or class method. | |
| 1012 # Note that enabling this option will significantly increase the time of a run. | |
| 1013 # So in most cases it will be better to enable call graphs for selected | |
| 1014 # functions only using the \callgraph command. | |
| 1015 | |
| 1016 CALL_GRAPH = NO | |
| 912 | 1017 |
| 913 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | 1018 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
| 914 # will graphical hierarchy of all classes instead of a textual one. | 1019 # will graphical hierarchy of all classes instead of a textual one. |
| 915 | 1020 |
| 916 GRAPHICAL_HIERARCHY = YES | 1021 GRAPHICAL_HIERARCHY = YES |
| 946 # the specified constraint. Beware that most browsers cannot cope with very | 1051 # the specified constraint. Beware that most browsers cannot cope with very |
| 947 # large images. | 1052 # large images. |
| 948 | 1053 |
| 949 MAX_DOT_GRAPH_HEIGHT = 1024 | 1054 MAX_DOT_GRAPH_HEIGHT = 1024 |
| 950 | 1055 |
| 1056 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | |
| 1057 # graphs generated by dot. A depth value of 3 means that only nodes reachable | |
| 1058 # from the root by following a path via at most 3 edges will be shown. Nodes that | |
| 1059 # lay further from the root node will be omitted. Note that setting this option to | |
| 1060 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also | |
| 1061 # note that a graph may be further truncated if the graph's image dimensions are | |
| 1062 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). | |
| 1063 # If 0 is used for the depth value (the default), the graph is not depth-constrained. | |
| 1064 | |
| 1065 MAX_DOT_GRAPH_DEPTH = 0 | |
| 1066 | |
| 951 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | 1067 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
| 952 # generate a legend page explaining the meaning of the various boxes and | 1068 # generate a legend page explaining the meaning of the various boxes and |
| 953 # arrows in the dot generated graphs. | 1069 # arrows in the dot generated graphs. |
| 954 | 1070 |
| 955 GENERATE_LEGEND = YES | 1071 GENERATE_LEGEND = YES |
| 956 | 1072 |
| 957 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | 1073 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
| 958 # remove the intermedate dot files that are used to generate | 1074 # remove the intermediate dot files that are used to generate |
| 959 # the various graphs. | 1075 # the various graphs. |
| 960 | 1076 |
| 961 DOT_CLEANUP = YES | 1077 DOT_CLEANUP = YES |
| 962 | 1078 |
| 963 #--------------------------------------------------------------------------- | 1079 #--------------------------------------------------------------------------- |
| 1001 # The EXT_DOC_PATHS tag can be used to specify one or more paths to | 1117 # The EXT_DOC_PATHS tag can be used to specify one or more paths to |
| 1002 # documentation generated for other projects. This allows doxysearch to search | 1118 # documentation generated for other projects. This allows doxysearch to search |
| 1003 # the documentation for these projects as well. | 1119 # the documentation for these projects as well. |
| 1004 | 1120 |
| 1005 EXT_DOC_PATHS = | 1121 EXT_DOC_PATHS = |
| 1006 |
