00001 # Doxyfile 1.3.6 00002 00003 # This file describes the settings to be used by the documentation system 00004 # doxygen (www.doxygen.org) for a project 00005 # 00006 # All text after a hash (#) is considered a comment and will be ignored 00007 # The format is: 00008 # TAG = value [value, ...] 00009 # For lists items can also be appended using: 00010 # TAG += value [value, ...] 00011 # Values that contain spaces should be placed between quotes (" ") 00012 00013 #--------------------------------------------------------------------------- 00014 # Project related configuration options 00015 #--------------------------------------------------------------------------- 00016 00017 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 00018 # by quotes) that should identify the project. 00019 00020 PROJECT_NAME = "GNU C++ STL" 00021 00022 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 00023 # This could be handy for archiving the generated documentation or 00024 # if some version control system is used. 00025 00026 PROJECT_NUMBER = 3.4.6 00027 00028 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 00029 # base path where the generated documentation will be put. 00030 # If a relative path is entered, it will be relative to the location 00031 # where doxygen was started. If left blank the current directory will be used. 00032 00033 OUTPUT_DIRECTORY = . 00034 00035 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 00036 # documentation generated by doxygen is written. Doxygen will use this 00037 # information to generate all constant output in the proper language. 00038 # The default language is English, other supported languages are: 00039 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 00040 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 00041 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, 00042 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 00043 00044 OUTPUT_LANGUAGE = English 00045 00046 # This tag can be used to specify the encoding used in the generated output. 00047 # The encoding is not always determined by the language that is chosen, 00048 # but also whether or not the output is meant for Windows or non-Windows users. 00049 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 00050 # forces the Windows encoding (this is the default for the Windows binary), 00051 # whereas setting the tag to NO uses a Unix-style encoding (the default for 00052 # all platforms other than Windows). 00053 00054 USE_WINDOWS_ENCODING = NO 00055 00056 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 00057 # include brief member descriptions after the members that are listed in 00058 # the file and class documentation (similar to JavaDoc). 00059 # Set to NO to disable this. 00060 00061 BRIEF_MEMBER_DESC = YES 00062 00063 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 00064 # the brief description of a member or function before the detailed description. 00065 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 00066 # brief descriptions will be completely suppressed. 00067 00068 REPEAT_BRIEF = YES 00069 00070 # This tag implements a quasi-intelligent brief description abbreviator 00071 # that is used to form the text in various listings. Each string 00072 # in this list, if found as the leading text of the brief description, will be 00073 # stripped from the text and the result after processing the whole list, is used 00074 # as the annotated text. Otherwise, the brief description is used as-is. If left 00075 # blank, the following values are used ("$name" is automatically replaced with the 00076 # name of the entity): "The $name class" "The $name widget" "The $name file" 00077 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" 00078 00079 ABBREVIATE_BRIEF = 00080 00081 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 00082 # Doxygen will generate a detailed section even if there is only a brief 00083 # description. 00084 00085 ALWAYS_DETAILED_SEC = YES 00086 00087 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 00088 # members of a class in the documentation of that class as if those members were 00089 # ordinary class members. Constructors, destructors and assignment operators of 00090 # the base classes will not be shown. 00091 00092 INLINE_INHERITED_MEMB = NO 00093 00094 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 00095 # path before files name in the file list and in the header files. If set 00096 # to NO the shortest path that makes the file name unique will be used. 00097 00098 FULL_PATH_NAMES = NO 00099 00100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 00101 # can be used to strip a user-defined part of the path. Stripping is 00102 # only done if one of the specified strings matches the left-hand part of 00103 # the path. It is allowed to use relative paths in the argument list. 00104 # If left blank the directory from which doxygen is run is used as the 00105 # path to strip. 00106 00107 STRIP_FROM_PATH = 00108 00109 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 00110 # (but less readable) file names. This can be useful is your file systems 00111 # doesn't support long names like on DOS, Mac, or CD-ROM. 00112 00113 SHORT_NAMES = NO 00114 00115 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 00116 # will interpret the first line (until the first dot) of a JavaDoc-style 00117 # comment as the brief description. If set to NO, the JavaDoc 00118 # comments will behave just like the Qt-style comments (thus requiring an 00119 # explicit @brief command for a brief description. 00120 00121 JAVADOC_AUTOBRIEF = NO 00122 00123 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 00124 # treat a multi-line C++ special comment block (i.e. a block of 00125 # comments) as a brief description. This used to be the default behaviour. 00126 # The new default is to treat a multi-line C++ comment block as a detailed 00127 # description. Set this tag to YES if you prefer the old behaviour instead. 00128 00129 MULTILINE_CPP_IS_BRIEF = NO 00130 00131 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 00132 # will output the detailed description near the top, like JavaDoc. 00133 # If set to NO, the detailed description appears after the member 00134 # documentation. 00135 00136 DETAILS_AT_TOP = NO 00137 00138 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 00139 # member inherits the documentation from any documented member that it 00140 # re-implements. 00141 00142 INHERIT_DOCS = YES 00143 00144 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 00145 # tag is set to YES, then doxygen will reuse the documentation of the first 00146 # member in the group (if any) for the other members of the group. By default 00147 # all members of a group must be documented explicitly. 00148 00149 DISTRIBUTE_GROUP_DOC = NO 00150 00151 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 00152 # Doxygen uses this value to replace tabs by spaces in code fragments. 00153 00154 TAB_SIZE = 4 00155 00156 # This tag can be used to specify a number of aliases that acts 00157 # as commands in the documentation. An alias has the form "name=value". 00158 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 00159 # put the command \sideeffect (or @sideeffect) in the documentation, which 00160 # will result in a user-defined paragraph with heading "Side Effects:". 00161 # You can put \n's in the value part of an alias to insert newlines. 00162 00163 ALIASES = 00164 00165 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 00166 # only. Doxygen will then generate output that is more tailored for C. 00167 # For instance, some of the names that are used will be different. The list 00168 # of all members will be omitted, etc. 00169 00170 OPTIMIZE_OUTPUT_FOR_C = NO 00171 00172 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 00173 # only. Doxygen will then generate output that is more tailored for Java. 00174 # For instance, namespaces will be presented as packages, qualified scopes 00175 # will look different, etc. 00176 00177 OPTIMIZE_OUTPUT_JAVA = NO 00178 00179 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 00180 # the same type (for instance a group of public functions) to be put as a 00181 # subgroup of that type (e.g. under the Public Functions section). Set it to 00182 # NO to prevent subgrouping. Alternatively, this can be done per class using 00183 # the \nosubgrouping command. 00184 00185 SUBGROUPING = YES 00186 00187 #--------------------------------------------------------------------------- 00188 # Build related configuration options 00189 #--------------------------------------------------------------------------- 00190 00191 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 00192 # documentation are documented, even if no documentation was available. 00193 # Private class members and static file members will be hidden unless 00194 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 00195 00196 EXTRACT_ALL = YES 00197 00198 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 00199 # will be included in the documentation. 00200 00201 EXTRACT_PRIVATE = YES 00202 00203 # If the EXTRACT_STATIC tag is set to YES all static members of a file 00204 # will be included in the documentation. 00205 00206 EXTRACT_STATIC = YES 00207 00208 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 00209 # defined locally in source files will be included in the documentation. 00210 # If set to NO only classes defined in header files are included. 00211 00212 EXTRACT_LOCAL_CLASSES = YES 00213 00214 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 00215 # undocumented members of documented classes, files or namespaces. 00216 # If set to NO (the default) these members will be included in the 00217 # various overviews, but no documentation section is generated. 00218 # This option has no effect if EXTRACT_ALL is enabled. 00219 00220 HIDE_UNDOC_MEMBERS = NO 00221 00222 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 00223 # undocumented classes that are normally visible in the class hierarchy. 00224 # If set to NO (the default) these classes will be included in the various 00225 # overviews. This option has no effect if EXTRACT_ALL is enabled. 00226 00227 HIDE_UNDOC_CLASSES = NO 00228 00229 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 00230 # friend (class|struct|union) declarations. 00231 # If set to NO (the default) these declarations will be included in the 00232 # documentation. 00233 00234 HIDE_FRIEND_COMPOUNDS = NO 00235 00236 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 00237 # documentation blocks found inside the body of a function. 00238 # If set to NO (the default) these blocks will be appended to the 00239 # function's detailed documentation block. 00240 00241 HIDE_IN_BODY_DOCS = NO 00242 00243 # The INTERNAL_DOCS tag determines if documentation 00244 # that is typed after a \internal command is included. If the tag is set 00245 # to NO (the default) then the documentation will be excluded. 00246 # Set it to YES to include the internal documentation. 00247 00248 INTERNAL_DOCS = NO 00249 00250 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 00251 # file names in lower-case letters. If set to YES upper-case letters are also 00252 # allowed. This is useful if you have classes or files whose names only differ 00253 # in case and if your file system supports case sensitive file names. Windows 00254 # users are advised to set this option to NO. 00255 00256 CASE_SENSE_NAMES = YES 00257 00258 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 00259 # will show members with their full class and namespace scopes in the 00260 # documentation. If set to YES the scope will be hidden. 00261 00262 HIDE_SCOPE_NAMES = NO 00263 00264 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 00265 # will put a list of the files that are included by a file in the documentation 00266 # of that file. 00267 00268 SHOW_INCLUDE_FILES = YES 00269 00270 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 00271 # is inserted in the documentation for inline members. 00272 00273 INLINE_INFO = YES 00274 00275 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 00276 # will sort the (detailed) documentation of file and class members 00277 # alphabetically by member name. If set to NO the members will appear in 00278 # declaration order. 00279 00280 SORT_MEMBER_DOCS = YES 00281 00282 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 00283 # brief documentation of file, namespace and class members alphabetically 00284 # by member name. If set to NO (the default) the members will appear in 00285 # declaration order. 00286 00287 SORT_BRIEF_DOCS = NO 00288 00289 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 00290 # sorted by fully-qualified names, including namespaces. If set to 00291 # NO (the default), the class list will be sorted only by class name, 00292 # not including the namespace part. 00293 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 00294 # Note: This option applies only to the class list, not to the 00295 # alphabetical list. 00296 00297 SORT_BY_SCOPE_NAME = NO 00298 00299 # The GENERATE_TODOLIST tag can be used to enable (YES) or 00300 # disable (NO) the todo list. This list is created by putting \todo 00301 # commands in the documentation. 00302 00303 GENERATE_TODOLIST = YES 00304 00305 # The GENERATE_TESTLIST tag can be used to enable (YES) or 00306 # disable (NO) the test list. This list is created by putting \test 00307 # commands in the documentation. 00308 00309 GENERATE_TESTLIST = YES 00310 00311 # The GENERATE_BUGLIST tag can be used to enable (YES) or 00312 # disable (NO) the bug list. This list is created by putting \bug 00313 # commands in the documentation. 00314 00315 GENERATE_BUGLIST = YES 00316 00317 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 00318 # disable (NO) the deprecated list. This list is created by putting 00319 # \deprecated commands in the documentation. 00320 00321 GENERATE_DEPRECATEDLIST= YES 00322 00323 # The ENABLED_SECTIONS tag can be used to enable conditional 00324 # documentation sections, marked by \if sectionname ... \endif. 00325 00326 ENABLED_SECTIONS = 00327 00328 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 00329 # the initial value of a variable or define consists of for it to appear in 00330 # the documentation. If the initializer consists of more lines than specified 00331 # here it will be hidden. Use a value of 0 to hide initializers completely. 00332 # The appearance of the initializer of individual variables and defines in the 00333 # documentation can be controlled using \showinitializer or \hideinitializer 00334 # command in the documentation regardless of this setting. 00335 00336 MAX_INITIALIZER_LINES = 30 00337 00338 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 00339 # at the bottom of the documentation of classes and structs. If set to YES the 00340 # list will mention the files that were used to generate the documentation. 00341 00342 SHOW_USED_FILES = YES 00343 00344 #--------------------------------------------------------------------------- 00345 # configuration options related to warning and progress messages 00346 #--------------------------------------------------------------------------- 00347 00348 # The QUIET tag can be used to turn on/off the messages that are generated 00349 # by doxygen. Possible values are YES and NO. If left blank NO is used. 00350 00351 QUIET = NO 00352 00353 # The WARNINGS tag can be used to turn on/off the warning messages that are 00354 # generated by doxygen. Possible values are YES and NO. If left blank 00355 # NO is used. 00356 00357 WARNINGS = YES 00358 00359 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 00360 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 00361 # automatically be disabled. 00362 00363 WARN_IF_UNDOCUMENTED = YES 00364 00365 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 00366 # potential errors in the documentation, such as not documenting some 00367 # parameters in a documented function, or documenting parameters that 00368 # don't exist or using markup commands wrongly. 00369 00370 WARN_IF_DOC_ERROR = YES 00371 00372 # The WARN_FORMAT tag determines the format of the warning messages that 00373 # doxygen can produce. The string should contain the $file, $line, and $text 00374 # tags, which will be replaced by the file and line number from which the 00375 # warning originated and the warning text. 00376 00377 WARN_FORMAT = "$file:$line: $text" 00378 00379 # The WARN_LOGFILE tag can be used to specify a file to which warning 00380 # and error messages should be written. If left blank the output is written 00381 # to stderr. 00382 00383 WARN_LOGFILE = 00384 00385 #--------------------------------------------------------------------------- 00386 # configuration options related to the input files 00387 #--------------------------------------------------------------------------- 00388 00389 # The INPUT tag can be used to specify the files and/or directories that contain 00390 # documented source files. You may enter file names like "myfile.cpp" or 00391 # directories like "/usr/src/myproject". Separate the files or directories 00392 # with spaces. 00393 00394 INPUT = . 00395 00396 # If the value of the INPUT tag contains directories, you can use the 00397 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 00398 # and *.h) to filter out the source-files in the directories. If left 00399 # blank the following patterns are tested: 00400 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 00401 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc 00402 00403 FILE_PATTERNS = * 00404 00405 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 00406 # should be searched for input files as well. Possible values are YES and NO. 00407 # If left blank NO is used. 00408 00409 RECURSIVE = YES 00410 00411 # The EXCLUDE tag can be used to specify files and/or directories that should 00412 # excluded from the INPUT source files. This way you can easily exclude a 00413 # subdirectory from a directory tree whose root is specified with the INPUT tag. 00414 00415 EXCLUDE = html i386-redhat-linux/bits/stdc++.h.gch 00416 00417 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 00418 # that are symbolic links (a Unix filesystem feature) are excluded from the input. 00419 00420 EXCLUDE_SYMLINKS = NO 00421 00422 # If the value of the INPUT tag contains directories, you can use the 00423 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 00424 # certain files from those directories. 00425 00426 EXCLUDE_PATTERNS = 00427 00428 # The EXAMPLE_PATH tag can be used to specify one or more files or 00429 # directories that contain example code fragments that are included (see 00430 # the \include command). 00431 00432 EXAMPLE_PATH = 00433 00434 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 00435 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 00436 # and *.h) to filter out the source-files in the directories. If left 00437 # blank all files are included. 00438 00439 EXAMPLE_PATTERNS = 00440 00441 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 00442 # searched for input files to be used with the \include or \dontinclude 00443 # commands irrespective of the value of the RECURSIVE tag. 00444 # Possible values are YES and NO. If left blank NO is used. 00445 00446 EXAMPLE_RECURSIVE = NO 00447 00448 # The IMAGE_PATH tag can be used to specify one or more files or 00449 # directories that contain image that are included in the documentation (see 00450 # the \image command). 00451 00452 IMAGE_PATH = 00453 00454 # The INPUT_FILTER tag can be used to specify a program that doxygen should 00455 # invoke to filter for each input file. Doxygen will invoke the filter program 00456 # by executing (via popen()) the command <filter> <input-file>, where <filter> 00457 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 00458 # input file. Doxygen will then use the output that the filter program writes 00459 # to standard output. 00460 00461 INPUT_FILTER = 00462 00463 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 00464 # INPUT_FILTER) will be used to filter the input files when producing source 00465 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 00466 00467 FILTER_SOURCE_FILES = NO 00468 00469 #--------------------------------------------------------------------------- 00470 # configuration options related to source browsing 00471 #--------------------------------------------------------------------------- 00472 00473 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 00474 # be generated. Documented entities will be cross-referenced with these sources. 00475 # Note: To get rid of all source code in the generated output, make sure also 00476 # VERBATIM_HEADERS is set to NO. 00477 00478 SOURCE_BROWSER = YES 00479 00480 # Setting the INLINE_SOURCES tag to YES will include the body 00481 # of functions and classes directly in the documentation. 00482 00483 INLINE_SOURCES = NO 00484 00485 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 00486 # doxygen to hide any special comment blocks from generated source code 00487 # fragments. Normal C and C++ comments will always remain visible. 00488 00489 STRIP_CODE_COMMENTS = YES 00490 00491 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 00492 # then for each documented function all documented 00493 # functions referencing it will be listed. 00494 00495 REFERENCED_BY_RELATION = YES 00496 00497 # If the REFERENCES_RELATION tag is set to YES (the default) 00498 # then for each documented function all documented entities 00499 # called/used by that function will be listed. 00500 00501 REFERENCES_RELATION = YES 00502 00503 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 00504 # will generate a verbatim copy of the header file for each class for 00505 # which an include is specified. Set to NO to disable this. 00506 00507 VERBATIM_HEADERS = YES 00508 00509 #--------------------------------------------------------------------------- 00510 # configuration options related to the alphabetical class index 00511 #--------------------------------------------------------------------------- 00512 00513 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 00514 # of all compounds will be generated. Enable this if the project 00515 # contains a lot of classes, structs, unions or interfaces. 00516 00517 ALPHABETICAL_INDEX = YES 00518 00519 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 00520 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 00521 # in which this list will be split (can be a number in the range [1..20]) 00522 00523 COLS_IN_ALPHA_INDEX = 5 00524 00525 # In case all classes in a project start with a common prefix, all 00526 # classes will be put under the same header in the alphabetical index. 00527 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 00528 # should be ignored while generating the index headers. 00529 00530 IGNORE_PREFIX = 00531 00532 #--------------------------------------------------------------------------- 00533 # configuration options related to the HTML output 00534 #--------------------------------------------------------------------------- 00535 00536 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 00537 # generate HTML output. 00538 00539 GENERATE_HTML = YES 00540 00541 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 00542 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 00543 # put in front of it. If left blank `html' will be used as the default path. 00544 00545 HTML_OUTPUT = html 00546 00547 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 00548 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 00549 # doxygen will generate files with .html extension. 00550 00551 HTML_FILE_EXTENSION = .html 00552 00553 # The HTML_HEADER tag can be used to specify a personal HTML header for 00554 # each generated HTML page. If it is left blank doxygen will generate a 00555 # standard header. 00556 00557 HTML_HEADER = 00558 00559 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 00560 # each generated HTML page. If it is left blank doxygen will generate a 00561 # standard footer. 00562 00563 HTML_FOOTER = 00564 00565 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 00566 # style sheet that is used by each HTML page. It can be used to 00567 # fine-tune the look of the HTML output. If the tag is left blank doxygen 00568 # will generate a default style sheet. Note that doxygen will try to copy 00569 # the style sheet file to the HTML output directory, so don't put your own 00570 # stylesheet in the HTML output directory as well, or it will be erased! 00571 00572 HTML_STYLESHEET = 00573 00574 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 00575 # files or namespaces will be aligned in HTML using tables. If set to 00576 # NO a bullet list will be used. 00577 00578 HTML_ALIGN_MEMBERS = YES 00579 00580 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 00581 # will be generated that can be used as input for tools like the 00582 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 00583 # of the generated HTML documentation. 00584 00585 GENERATE_HTMLHELP = NO 00586 00587 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 00588 # be used to specify the file name of the resulting .chm file. You 00589 # can add a path in front of the file if the result should not be 00590 # written to the html output directory. 00591 00592 CHM_FILE = 00593 00594 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 00595 # be used to specify the location (absolute path including file name) of 00596 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 00597 # the HTML help compiler on the generated index.hhp. 00598 00599 HHC_LOCATION = 00600 00601 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 00602 # controls if a separate .chi index file is generated (YES) or that 00603 # it should be included in the master .chm file (NO). 00604 00605 GENERATE_CHI = NO 00606 00607 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 00608 # controls whether a binary table of contents is generated (YES) or a 00609 # normal table of contents (NO) in the .chm file. 00610 00611 BINARY_TOC = NO 00612 00613 # The TOC_EXPAND flag can be set to YES to add extra items for group members 00614 # to the contents of the HTML help documentation and to the tree view. 00615 00616 TOC_EXPAND = NO 00617 00618 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 00619 # top of each HTML page. The value NO (the default) enables the index and 00620 # the value YES disables it. 00621 00622 DISABLE_INDEX = NO 00623 00624 # This tag can be used to set the number of enum values (range [1..20]) 00625 # that doxygen will group on one line in the generated HTML documentation. 00626 00627 ENUM_VALUES_PER_LINE = 4 00628 00629 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 00630 # generated containing a tree-like index structure (just like the one that 00631 # is generated for HTML Help). For this to work a browser that supports 00632 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 00633 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 00634 # probably better off using the HTML help feature. 00635 00636 GENERATE_TREEVIEW = YES 00637 00638 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 00639 # used to set the initial width (in pixels) of the frame in which the tree 00640 # is shown. 00641 00642 TREEVIEW_WIDTH = 250 00643 00644 #--------------------------------------------------------------------------- 00645 # configuration options related to the LaTeX output 00646 #--------------------------------------------------------------------------- 00647 00648 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 00649 # generate Latex output. 00650 00651 GENERATE_LATEX = NO 00652 00653 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 00654 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 00655 # put in front of it. If left blank `latex' will be used as the default path. 00656 00657 LATEX_OUTPUT = latex 00658 00659 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 00660 # invoked. If left blank `latex' will be used as the default command name. 00661 00662 LATEX_CMD_NAME = latex 00663 00664 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 00665 # generate index for LaTeX. If left blank `makeindex' will be used as the 00666 # default command name. 00667 00668 MAKEINDEX_CMD_NAME = makeindex 00669 00670 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 00671 # LaTeX documents. This may be useful for small projects and may help to 00672 # save some trees in general. 00673 00674 COMPACT_LATEX = NO 00675 00676 # The PAPER_TYPE tag can be used to set the paper type that is used 00677 # by the printer. Possible values are: a4, a4wide, letter, legal and 00678 # executive. If left blank a4wide will be used. 00679 00680 PAPER_TYPE = a4wide 00681 00682 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 00683 # packages that should be included in the LaTeX output. 00684 00685 EXTRA_PACKAGES = 00686 00687 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 00688 # the generated latex document. The header should contain everything until 00689 # the first chapter. If it is left blank doxygen will generate a 00690 # standard header. Notice: only use this tag if you know what you are doing! 00691 00692 LATEX_HEADER = 00693 00694 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 00695 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 00696 # contain links (just like the HTML output) instead of page references 00697 # This makes the output suitable for online browsing using a pdf viewer. 00698 00699 PDF_HYPERLINKS = NO 00700 00701 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 00702 # plain latex in the generated Makefile. Set this option to YES to get a 00703 # higher quality PDF documentation. 00704 00705 USE_PDFLATEX = NO 00706 00707 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 00708 # command to the generated LaTeX files. This will instruct LaTeX to keep 00709 # running if errors occur, instead of asking the user for help. 00710 # This option is also used when generating formulas in HTML. 00711 00712 LATEX_BATCHMODE = NO 00713 00714 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 00715 # include the index chapters (such as File Index, Compound Index, etc.) 00716 # in the output. 00717 00718 LATEX_HIDE_INDICES = NO 00719 00720 #--------------------------------------------------------------------------- 00721 # configuration options related to the RTF output 00722 #--------------------------------------------------------------------------- 00723 00724 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 00725 # The RTF output is optimized for Word 97 and may not look very pretty with 00726 # other RTF readers or editors. 00727 00728 GENERATE_RTF = NO 00729 00730 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 00731 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 00732 # put in front of it. If left blank `rtf' will be used as the default path. 00733 00734 RTF_OUTPUT = rtf 00735 00736 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 00737 # RTF documents. This may be useful for small projects and may help to 00738 # save some trees in general. 00739 00740 COMPACT_RTF = NO 00741 00742 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 00743 # will contain hyperlink fields. The RTF file will 00744 # contain links (just like the HTML output) instead of page references. 00745 # This makes the output suitable for online browsing using WORD or other 00746 # programs which support those fields. 00747 # Note: wordpad (write) and others do not support links. 00748 00749 RTF_HYPERLINKS = NO 00750 00751 # Load stylesheet definitions from file. Syntax is similar to doxygen's 00752 # config file, i.e. a series of assignments. You only have to provide 00753 # replacements, missing definitions are set to their default value. 00754 00755 RTF_STYLESHEET_FILE = 00756 00757 # Set optional variables used in the generation of an rtf document. 00758 # Syntax is similar to doxygen's config file. 00759 00760 RTF_EXTENSIONS_FILE = 00761 00762 #--------------------------------------------------------------------------- 00763 # configuration options related to the man page output 00764 #--------------------------------------------------------------------------- 00765 00766 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 00767 # generate man pages 00768 00769 GENERATE_MAN = NO 00770 00771 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 00772 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 00773 # put in front of it. If left blank `man' will be used as the default path. 00774 00775 MAN_OUTPUT = man 00776 00777 # The MAN_EXTENSION tag determines the extension that is added to 00778 # the generated man pages (default is the subroutine's section .3) 00779 00780 MAN_EXTENSION = .3 00781 00782 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 00783 # then it will generate one additional man file for each entity 00784 # documented in the real man page(s). These additional files 00785 # only source the real man page, but without them the man command 00786 # would be unable to find the correct page. The default is NO. 00787 00788 MAN_LINKS = NO 00789 00790 #--------------------------------------------------------------------------- 00791 # configuration options related to the XML output 00792 #--------------------------------------------------------------------------- 00793 00794 # If the GENERATE_XML tag is set to YES Doxygen will 00795 # generate an XML file that captures the structure of 00796 # the code including all documentation. 00797 00798 GENERATE_XML = NO 00799 00800 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 00801 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 00802 # put in front of it. If left blank `xml' will be used as the default path. 00803 00804 XML_OUTPUT = xml 00805 00806 # The XML_SCHEMA tag can be used to specify an XML schema, 00807 # which can be used by a validating XML parser to check the 00808 # syntax of the XML files. 00809 00810 XML_SCHEMA = 00811 00812 # The XML_DTD tag can be used to specify an XML DTD, 00813 # which can be used by a validating XML parser to check the 00814 # syntax of the XML files. 00815 00816 XML_DTD = 00817 00818 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 00819 # dump the program listings (including syntax highlighting 00820 # and cross-referencing information) to the XML output. Note that 00821 # enabling this will significantly increase the size of the XML output. 00822 00823 XML_PROGRAMLISTING = YES 00824 00825 #--------------------------------------------------------------------------- 00826 # configuration options for the AutoGen Definitions output 00827 #--------------------------------------------------------------------------- 00828 00829 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 00830 # generate an AutoGen Definitions (see autogen.sf.net) file 00831 # that captures the structure of the code including all 00832 # documentation. Note that this feature is still experimental 00833 # and incomplete at the moment. 00834 00835 GENERATE_AUTOGEN_DEF = NO 00836 00837 #--------------------------------------------------------------------------- 00838 # configuration options related to the Perl module output 00839 #--------------------------------------------------------------------------- 00840 00841 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 00842 # generate a Perl module file that captures the structure of 00843 # the code including all documentation. Note that this 00844 # feature is still experimental and incomplete at the 00845 # moment. 00846 00847 GENERATE_PERLMOD = NO 00848 00849 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 00850 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 00851 # to generate PDF and DVI output from the Perl module output. 00852 00853 PERLMOD_LATEX = NO 00854 00855 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 00856 # nicely formatted so it can be parsed by a human reader. This is useful 00857 # if you want to understand what is going on. On the other hand, if this 00858 # tag is set to NO the size of the Perl module output will be much smaller 00859 # and Perl will parse it just the same. 00860 00861 PERLMOD_PRETTY = YES 00862 00863 # The names of the make variables in the generated doxyrules.make file 00864 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 00865 # This is useful so different doxyrules.make files included by the same 00866 # Makefile don't overwrite each other's variables. 00867 00868 PERLMOD_MAKEVAR_PREFIX = 00869 00870 #--------------------------------------------------------------------------- 00871 # Configuration options related to the preprocessor 00872 #--------------------------------------------------------------------------- 00873 00874 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 00875 # evaluate all C-preprocessor directives found in the sources and include 00876 # files. 00877 00878 ENABLE_PREPROCESSING = YES 00879 00880 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 00881 # names in the source code. If set to NO (the default) only conditional 00882 # compilation will be performed. Macro expansion can be done in a controlled 00883 # way by setting EXPAND_ONLY_PREDEF to YES. 00884 00885 MACRO_EXPANSION = NO 00886 00887 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 00888 # then the macro expansion is limited to the macros specified with the 00889 # PREDEFINED and EXPAND_AS_PREDEFINED tags. 00890 00891 EXPAND_ONLY_PREDEF = NO 00892 00893 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 00894 # in the INCLUDE_PATH (see below) will be search if a #include is found. 00895 00896 SEARCH_INCLUDES = YES 00897 00898 # The INCLUDE_PATH tag can be used to specify one or more directories that 00899 # contain include files that are not input files but should be processed by 00900 # the preprocessor. 00901 00902 INCLUDE_PATH = 00903 00904 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 00905 # patterns (like *.h and *.hpp) to filter out the header-files in the 00906 # directories. If left blank, the patterns specified with FILE_PATTERNS will 00907 # be used. 00908 00909 INCLUDE_FILE_PATTERNS = 00910 00911 # The PREDEFINED tag can be used to specify one or more macro names that 00912 # are defined before the preprocessor is started (similar to the -D option of 00913 # gcc). The argument of the tag is a list of macros of the form: name 00914 # or name=definition (no spaces). If the definition and the = are 00915 # omitted =1 is assumed. 00916 00917 PREDEFINED = 00918 00919 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 00920 # this tag can be used to specify a list of macro names that should be expanded. 00921 # The macro definition that is found in the sources will be used. 00922 # Use the PREDEFINED tag if you want to use a different macro definition. 00923 00924 EXPAND_AS_DEFINED = 00925 00926 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 00927 # doxygen's preprocessor will remove all function-like macros that are alone 00928 # on a line, have an all uppercase name, and do not end with a semicolon. Such 00929 # function macros are typically used for boiler-plate code, and will confuse the 00930 # parser if not removed. 00931 00932 SKIP_FUNCTION_MACROS = YES 00933 00934 #--------------------------------------------------------------------------- 00935 # Configuration::additions related to external references 00936 #--------------------------------------------------------------------------- 00937 00938 # The TAGFILES option can be used to specify one or more tagfiles. 00939 # Optionally an initial location of the external documentation 00940 # can be added for each tagfile. The format of a tag file without 00941 # this location is as follows: 00942 # TAGFILES = file1 file2 ... 00943 # Adding location for the tag files is done as follows: 00944 # TAGFILES = file1=loc1 "file2 = loc2" ... 00945 # where "loc1" and "loc2" can be relative or absolute paths or 00946 # URLs. If a location is present for each tag, the installdox tool 00947 # does not have to be run to correct the links. 00948 # Note that each tag file must have a unique name 00949 # (where the name does NOT include the path) 00950 # If a tag file is not located in the directory in which doxygen 00951 # is run, you must also specify the path to the tagfile here. 00952 00953 TAGFILES = 00954 00955 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 00956 # a tag file that is based on the input files it reads. 00957 00958 GENERATE_TAGFILE = 00959 00960 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 00961 # in the class index. If set to NO only the inherited external classes 00962 # will be listed. 00963 00964 ALLEXTERNALS = NO 00965 00966 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 00967 # in the modules index. If set to NO, only the current project's groups will 00968 # be listed. 00969 00970 EXTERNAL_GROUPS = YES 00971 00972 # The PERL_PATH should be the absolute path and name of the perl script 00973 # interpreter (i.e. the result of `which perl'). 00974 00975 PERL_PATH = /usr/bin/perl 00976 00977 #--------------------------------------------------------------------------- 00978 # Configuration options related to the dot tool 00979 #--------------------------------------------------------------------------- 00980 00981 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 00982 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 00983 # super classes. Setting the tag to NO turns the diagrams off. Note that this 00984 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is 00985 # recommended to install and use dot, since it yields more powerful graphs. 00986 00987 CLASS_DIAGRAMS = YES 00988 00989 # If set to YES, the inheritance and collaboration graphs will hide 00990 # inheritance and usage relations if the target is undocumented 00991 # or is not a class. 00992 00993 HIDE_UNDOC_RELATIONS = YES 00994 00995 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 00996 # available from the path. This tool is part of Graphviz, a graph visualization 00997 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 00998 # have no effect if this option is set to NO (the default) 00999 01000 HAVE_DOT = NO 01001 01002 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 01003 # will generate a graph for each documented class showing the direct and 01004 # indirect inheritance relations. Setting this tag to YES will force the 01005 # the CLASS_DIAGRAMS tag to NO. 01006 01007 CLASS_GRAPH = YES 01008 01009 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 01010 # will generate a graph for each documented class showing the direct and 01011 # indirect implementation dependencies (inheritance, containment, and 01012 # class references variables) of the class with other documented classes. 01013 01014 COLLABORATION_GRAPH = YES 01015 01016 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 01017 # collaboration diagrams in a style similar to the OMG's Unified Modeling 01018 # Language. 01019 01020 UML_LOOK = YES 01021 01022 # If set to YES, the inheritance and collaboration graphs will show the 01023 # relations between templates and their instances. 01024 01025 TEMPLATE_RELATIONS = YES 01026 01027 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 01028 # tags are set to YES then doxygen will generate a graph for each documented 01029 # file showing the direct and indirect include dependencies of the file with 01030 # other documented files. 01031 01032 INCLUDE_GRAPH = YES 01033 01034 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 01035 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 01036 # documented header file showing the documented files that directly or 01037 # indirectly include this file. 01038 01039 INCLUDED_BY_GRAPH = YES 01040 01041 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 01042 # generate a call dependency graph for every global function or class method. 01043 # Note that enabling this option will significantly increase the time of a run. 01044 # So in most cases it will be better to enable call graphs for selected 01045 # functions only using the \callgraph command. 01046 01047 CALL_GRAPH = NO 01048 01049 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 01050 # will graphical hierarchy of all classes instead of a textual one. 01051 01052 GRAPHICAL_HIERARCHY = YES 01053 01054 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 01055 # generated by dot. Possible values are png, jpg, or gif 01056 # If left blank png will be used. 01057 01058 DOT_IMAGE_FORMAT = png 01059 01060 # The tag DOT_PATH can be used to specify the path where the dot tool can be 01061 # found. If left blank, it is assumed the dot tool can be found on the path. 01062 01063 DOT_PATH = 01064 01065 # The DOTFILE_DIRS tag can be used to specify one or more directories that 01066 # contain dot files that are included in the documentation (see the 01067 # \dotfile command). 01068 01069 DOTFILE_DIRS = 01070 01071 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 01072 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 01073 # this value, doxygen will try to truncate the graph, so that it fits within 01074 # the specified constraint. Beware that most browsers cannot cope with very 01075 # large images. 01076 01077 MAX_DOT_GRAPH_WIDTH = 1024 01078 01079 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 01080 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 01081 # this value, doxygen will try to truncate the graph, so that it fits within 01082 # the specified constraint. Beware that most browsers cannot cope with very 01083 # large images. 01084 01085 MAX_DOT_GRAPH_HEIGHT = 1024 01086 01087 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 01088 # graphs generated by dot. A depth value of 3 means that only nodes reachable 01089 # from the root by following a path via at most 3 edges will be shown. Nodes that 01090 # lay further from the root node will be omitted. Note that setting this option to 01091 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 01092 # note that a graph may be further truncated if the graph's image dimensions are 01093 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 01094 # If 0 is used for the depth value (the default), the graph is not depth-constrained. 01095 01096 MAX_DOT_GRAPH_DEPTH = 0 01097 01098 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 01099 # generate a legend page explaining the meaning of the various boxes and 01100 # arrows in the dot generated graphs. 01101 01102 GENERATE_LEGEND = YES 01103 01104 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 01105 # remove the intermediate dot files that are used to generate 01106 # the various graphs. 01107 01108 DOT_CLEANUP = YES 01109 01110 #--------------------------------------------------------------------------- 01111 # Configuration::additions related to the search engine 01112 #--------------------------------------------------------------------------- 01113 01114 # The SEARCHENGINE tag specifies whether or not a search engine should be 01115 # used. If set to NO the values of all tags below this one will be ignored. 01116 01117 SEARCHENGINE = YES