Panda3D
|
00001 # Doxyfile 1.7.3 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 # This tag specifies the encoding used for all characters in the config file 00018 # that follow. The default is UTF-8 which is also the encoding used for all 00019 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 00020 # iconv built into libc) for the transcoding. See 00021 # http://www.gnu.org/software/libiconv for the list of possible encodings. 00022 00023 DOXYFILE_ENCODING = UTF-8 00024 00025 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 00026 # by quotes) that should identify the project. 00027 00028 PROJECT_NAME = Panda3D 00029 00030 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 00031 # This could be handy for archiving the generated documentation or 00032 # if some version control system is used. 00033 00034 PROJECT_NUMBER = $(PANDA3D_VERSION) 00035 00036 # Using the PROJECT_BRIEF tag one can provide an optional one line description 00037 # for a project that appears at the top of each page and should give viewer 00038 # a quick idea about the purpose of the project. Keep the description short. 00039 00040 PROJECT_BRIEF = 00041 00042 # With the PROJECT_LOGO tag one can specify an logo or icon that is 00043 # included in the documentation. The maximum height of the logo should not 00044 # exceed 55 pixels and the maximum width should not exceed 200 pixels. 00045 # Doxygen will copy the logo to the output directory. 00046 00047 PROJECT_LOGO = 00048 00049 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 00050 # base path where the generated documentation will be put. 00051 # If a relative path is entered, it will be relative to the location 00052 # where doxygen was started. If left blank the current directory will be used. 00053 00054 OUTPUT_DIRECTORY = reference-cxx 00055 00056 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 00057 # 4096 sub-directories (in 2 levels) under the output directory of each output 00058 # format and will distribute the generated files over these directories. 00059 # Enabling this option can be useful when feeding doxygen a huge amount of 00060 # source files, where putting all generated files in the same directory would 00061 # otherwise cause performance problems for the file system. 00062 00063 CREATE_SUBDIRS = NO 00064 00065 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 00066 # documentation generated by doxygen is written. Doxygen will use this 00067 # information to generate all constant output in the proper language. 00068 # The default language is English, other supported languages are: 00069 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 00070 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 00071 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 00072 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 00073 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 00074 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 00075 00076 OUTPUT_LANGUAGE = English 00077 00078 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 00079 # include brief member descriptions after the members that are listed in 00080 # the file and class documentation (similar to JavaDoc). 00081 # Set to NO to disable this. 00082 00083 BRIEF_MEMBER_DESC = YES 00084 00085 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 00086 # the brief description of a member or function before the detailed description. 00087 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 00088 # brief descriptions will be completely suppressed. 00089 00090 REPEAT_BRIEF = YES 00091 00092 # This tag implements a quasi-intelligent brief description abbreviator 00093 # that is used to form the text in various listings. Each string 00094 # in this list, if found as the leading text of the brief description, will be 00095 # stripped from the text and the result after processing the whole list, is 00096 # used as the annotated text. Otherwise, the brief description is used as-is. 00097 # If left blank, the following values are used ("$name" is automatically 00098 # replaced with the name of the entity): "The $name class" "The $name widget" 00099 # "The $name file" "is" "provides" "specifies" "contains" 00100 # "represents" "a" "an" "the" 00101 00102 ABBREVIATE_BRIEF = "The $name class" \ 00103 "The $name widget" \ 00104 "The $name file" \ 00105 is \ 00106 provides \ 00107 specifies \ 00108 contains \ 00109 represents \ 00110 a \ 00111 an \ 00112 the 00113 00114 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 00115 # Doxygen will generate a detailed section even if there is only a brief 00116 # description. 00117 00118 ALWAYS_DETAILED_SEC = YES 00119 00120 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 00121 # inherited members of a class in the documentation of that class as if those 00122 # members were ordinary class members. Constructors, destructors and assignment 00123 # operators of the base classes will not be shown. 00124 00125 INLINE_INHERITED_MEMB = NO 00126 00127 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 00128 # path before files name in the file list and in the header files. If set 00129 # to NO the shortest path that makes the file name unique will be used. 00130 00131 FULL_PATH_NAMES = YES 00132 00133 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 00134 # can be used to strip a user-defined part of the path. Stripping is 00135 # only done if one of the specified strings matches the left-hand part of 00136 # the path. The tag can be used to show relative paths in the file list. 00137 # If left blank the directory from which doxygen is run is used as the 00138 # path to strip. 00139 00140 STRIP_FROM_PATH = 00141 00142 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 00143 # the path mentioned in the documentation of a class, which tells 00144 # the reader which header file to include in order to use a class. 00145 # If left blank only the name of the header file containing the class 00146 # definition is used. Otherwise one should specify the include paths that 00147 # are normally passed to the compiler using the -I flag. 00148 00149 STRIP_FROM_INC_PATH = 00150 00151 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 00152 # (but less readable) file names. This can be useful if your file system 00153 # doesn't support long names like on DOS, Mac, or CD-ROM. 00154 00155 SHORT_NAMES = NO 00156 00157 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 00158 # will interpret the first line (until the first dot) of a JavaDoc-style 00159 # comment as the brief description. If set to NO, the JavaDoc 00160 # comments will behave just like regular Qt-style comments 00161 # (thus requiring an explicit @brief command for a brief description.) 00162 00163 JAVADOC_AUTOBRIEF = YES 00164 00165 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 00166 # interpret the first line (until the first dot) of a Qt-style 00167 # comment as the brief description. If set to NO, the comments 00168 # will behave just like regular Qt-style comments (thus requiring 00169 # an explicit \brief command for a brief description.) 00170 00171 QT_AUTOBRIEF = YES 00172 00173 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 00174 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 00175 # comments) as a brief description. This used to be the default behaviour. 00176 # The new default is to treat a multi-line C++ comment block as a detailed 00177 # description. Set this tag to YES if you prefer the old behaviour instead. 00178 00179 MULTILINE_CPP_IS_BRIEF = NO 00180 00181 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 00182 # member inherits the documentation from any documented member that it 00183 # re-implements. 00184 00185 INHERIT_DOCS = YES 00186 00187 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 00188 # a new page for each member. If set to NO, the documentation of a member will 00189 # be part of the file/class/namespace that contains it. 00190 00191 SEPARATE_MEMBER_PAGES = NO 00192 00193 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 00194 # Doxygen uses this value to replace tabs by spaces in code fragments. 00195 00196 TAB_SIZE = 2 00197 00198 # This tag can be used to specify a number of aliases that acts 00199 # as commands in the documentation. An alias has the form "name=value". 00200 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 00201 # put the command \sideeffect (or @sideeffect) in the documentation, which 00202 # will result in a user-defined paragraph with heading "Side Effects:". 00203 # You can put \n's in the value part of an alias to insert newlines. 00204 00205 ALIASES = 00206 00207 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 00208 # sources only. Doxygen will then generate output that is more tailored for C. 00209 # For instance, some of the names that are used will be different. The list 00210 # of all members will be omitted, etc. 00211 00212 OPTIMIZE_OUTPUT_FOR_C = NO 00213 00214 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 00215 # sources only. Doxygen will then generate output that is more tailored for 00216 # Java. For instance, namespaces will be presented as packages, qualified 00217 # scopes will look different, etc. 00218 00219 OPTIMIZE_OUTPUT_JAVA = NO 00220 00221 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 00222 # sources only. Doxygen will then generate output that is more tailored for 00223 # Fortran. 00224 00225 OPTIMIZE_FOR_FORTRAN = NO 00226 00227 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 00228 # sources. Doxygen will then generate output that is tailored for 00229 # VHDL. 00230 00231 OPTIMIZE_OUTPUT_VHDL = NO 00232 00233 # Doxygen selects the parser to use depending on the extension of the files it 00234 # parses. With this tag you can assign which parser to use for a given extension. 00235 # Doxygen has a built-in mapping, but you can override or extend it using this 00236 # tag. The format is ext=language, where ext is a file extension, and language 00237 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 00238 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 00239 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 00240 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 00241 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 00242 00243 EXTENSION_MAPPING = I=C++ 00244 00245 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 00246 # to include (a tag file for) the STL sources as input, then you should 00247 # set this tag to YES in order to let doxygen match functions declarations and 00248 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 00249 # func(std::string) {}). This also makes the inheritance and collaboration 00250 # diagrams that involve STL classes more complete and accurate. 00251 00252 BUILTIN_STL_SUPPORT = YES 00253 00254 # If you use Microsoft's C++/CLI language, you should set this option to YES to 00255 # enable parsing support. 00256 00257 CPP_CLI_SUPPORT = NO 00258 00259 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 00260 # Doxygen will parse them like normal C++ but will assume all classes use public 00261 # instead of private inheritance when no explicit protection keyword is present. 00262 00263 SIP_SUPPORT = NO 00264 00265 # For Microsoft's IDL there are propget and propput attributes to indicate getter 00266 # and setter methods for a property. Setting this option to YES (the default) 00267 # will make doxygen replace the get and set methods by a property in the 00268 # documentation. This will only work if the methods are indeed getting or 00269 # setting a simple type. If this is not the case, or you want to show the 00270 # methods anyway, you should set this option to NO. 00271 00272 IDL_PROPERTY_SUPPORT = YES 00273 00274 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 00275 # tag is set to YES, then doxygen will reuse the documentation of the first 00276 # member in the group (if any) for the other members of the group. By default 00277 # all members of a group must be documented explicitly. 00278 00279 DISTRIBUTE_GROUP_DOC = NO 00280 00281 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 00282 # the same type (for instance a group of public functions) to be put as a 00283 # subgroup of that type (e.g. under the Public Functions section). Set it to 00284 # NO to prevent subgrouping. Alternatively, this can be done per class using 00285 # the \nosubgrouping command. 00286 00287 SUBGROUPING = YES 00288 00289 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 00290 # is documented as struct, union, or enum with the name of the typedef. So 00291 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 00292 # with name TypeT. When disabled the typedef will appear as a member of a file, 00293 # namespace, or class. And the struct will be named TypeS. This can typically 00294 # be useful for C code in case the coding convention dictates that all compound 00295 # types are typedef'ed and only the typedef is referenced, never the tag name. 00296 00297 TYPEDEF_HIDES_STRUCT = NO 00298 00299 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 00300 # determine which symbols to keep in memory and which to flush to disk. 00301 # When the cache is full, less often used symbols will be written to disk. 00302 # For small to medium size projects (<1000 input files) the default value is 00303 # probably good enough. For larger projects a too small cache size can cause 00304 # doxygen to be busy swapping symbols to and from disk most of the time 00305 # causing a significant performance penalty. 00306 # If the system has enough physical memory increasing the cache will improve the 00307 # performance by keeping more symbols in memory. Note that the value works on 00308 # a logarithmic scale so increasing the size by one will roughly double the 00309 # memory usage. The cache size is given by this formula: 00310 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 00311 # corresponding to a cache size of 2^16 = 65536 symbols 00312 00313 SYMBOL_CACHE_SIZE = 0 00314 00315 #--------------------------------------------------------------------------- 00316 # Build related configuration options 00317 #--------------------------------------------------------------------------- 00318 00319 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 00320 # documentation are documented, even if no documentation was available. 00321 # Private class members and static file members will be hidden unless 00322 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 00323 00324 EXTRACT_ALL = NO 00325 00326 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 00327 # will be included in the documentation. 00328 00329 EXTRACT_PRIVATE = NO 00330 00331 # If the EXTRACT_STATIC tag is set to YES all static members of a file 00332 # will be included in the documentation. 00333 00334 EXTRACT_STATIC = NO 00335 00336 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 00337 # defined locally in source files will be included in the documentation. 00338 # If set to NO only classes defined in header files are included. 00339 00340 EXTRACT_LOCAL_CLASSES = YES 00341 00342 # This flag is only useful for Objective-C code. When set to YES local 00343 # methods, which are defined in the implementation section but not in 00344 # the interface are included in the documentation. 00345 # If set to NO (the default) only methods in the interface are included. 00346 00347 EXTRACT_LOCAL_METHODS = NO 00348 00349 # If this flag is set to YES, the members of anonymous namespaces will be 00350 # extracted and appear in the documentation as a namespace called 00351 # 'anonymous_namespace{file}', where file will be replaced with the base 00352 # name of the file that contains the anonymous namespace. By default 00353 # anonymous namespaces are hidden. 00354 00355 EXTRACT_ANON_NSPACES = NO 00356 00357 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 00358 # undocumented members of documented classes, files or namespaces. 00359 # If set to NO (the default) these members will be included in the 00360 # various overviews, but no documentation section is generated. 00361 # This option has no effect if EXTRACT_ALL is enabled. 00362 00363 HIDE_UNDOC_MEMBERS = NO 00364 00365 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 00366 # undocumented classes that are normally visible in the class hierarchy. 00367 # If set to NO (the default) these classes will be included in the various 00368 # overviews. This option has no effect if EXTRACT_ALL is enabled. 00369 00370 HIDE_UNDOC_CLASSES = NO 00371 00372 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 00373 # friend (class|struct|union) declarations. 00374 # If set to NO (the default) these declarations will be included in the 00375 # documentation. 00376 00377 HIDE_FRIEND_COMPOUNDS = NO 00378 00379 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 00380 # documentation blocks found inside the body of a function. 00381 # If set to NO (the default) these blocks will be appended to the 00382 # function's detailed documentation block. 00383 00384 HIDE_IN_BODY_DOCS = YES 00385 00386 # The INTERNAL_DOCS tag determines if documentation 00387 # that is typed after a \internal command is included. If the tag is set 00388 # to NO (the default) then the documentation will be excluded. 00389 # Set it to YES to include the internal documentation. 00390 00391 INTERNAL_DOCS = NO 00392 00393 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 00394 # file names in lower-case letters. If set to YES upper-case letters are also 00395 # allowed. This is useful if you have classes or files whose names only differ 00396 # in case and if your file system supports case sensitive file names. Windows 00397 # and Mac users are advised to set this option to NO. 00398 00399 CASE_SENSE_NAMES = YES 00400 00401 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 00402 # will show members with their full class and namespace scopes in the 00403 # documentation. If set to YES the scope will be hidden. 00404 00405 HIDE_SCOPE_NAMES = NO 00406 00407 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 00408 # will put a list of the files that are included by a file in the documentation 00409 # of that file. 00410 00411 SHOW_INCLUDE_FILES = YES 00412 00413 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 00414 # will list include files with double quotes in the documentation 00415 # rather than with sharp brackets. 00416 00417 FORCE_LOCAL_INCLUDES = YES 00418 00419 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 00420 # is inserted in the documentation for inline members. 00421 00422 INLINE_INFO = YES 00423 00424 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 00425 # will sort the (detailed) documentation of file and class members 00426 # alphabetically by member name. If set to NO the members will appear in 00427 # declaration order. 00428 00429 SORT_MEMBER_DOCS = YES 00430 00431 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 00432 # brief documentation of file, namespace and class members alphabetically 00433 # by member name. If set to NO (the default) the members will appear in 00434 # declaration order. 00435 00436 SORT_BRIEF_DOCS = YES 00437 00438 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 00439 # will sort the (brief and detailed) documentation of class members so that 00440 # constructors and destructors are listed first. If set to NO (the default) 00441 # the constructors will appear in the respective orders defined by 00442 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 00443 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 00444 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 00445 00446 SORT_MEMBERS_CTORS_1ST = YES 00447 00448 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 00449 # hierarchy of group names into alphabetical order. If set to NO (the default) 00450 # the group names will appear in their defined order. 00451 00452 SORT_GROUP_NAMES = NO 00453 00454 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 00455 # sorted by fully-qualified names, including namespaces. If set to 00456 # NO (the default), the class list will be sorted only by class name, 00457 # not including the namespace part. 00458 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 00459 # Note: This option applies only to the class list, not to the 00460 # alphabetical list. 00461 00462 SORT_BY_SCOPE_NAME = NO 00463 00464 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 00465 # do proper type resolution of all parameters of a function it will reject a 00466 # match between the prototype and the implementation of a member function even 00467 # if there is only one candidate or it is obvious which candidate to choose 00468 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 00469 # will still accept a match between prototype and implementation in such cases. 00470 00471 STRICT_PROTO_MATCHING = NO 00472 00473 # The GENERATE_TODOLIST tag can be used to enable (YES) or 00474 # disable (NO) the todo list. This list is created by putting \todo 00475 # commands in the documentation. 00476 00477 GENERATE_TODOLIST = NO 00478 00479 # The GENERATE_TESTLIST tag can be used to enable (YES) or 00480 # disable (NO) the test list. This list is created by putting \test 00481 # commands in the documentation. 00482 00483 GENERATE_TESTLIST = NO 00484 00485 # The GENERATE_BUGLIST tag can be used to enable (YES) or 00486 # disable (NO) the bug list. This list is created by putting \bug 00487 # commands in the documentation. 00488 00489 GENERATE_BUGLIST = NO 00490 00491 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 00492 # disable (NO) the deprecated list. This list is created by putting 00493 # \deprecated commands in the documentation. 00494 00495 GENERATE_DEPRECATEDLIST= NO 00496 00497 # The ENABLED_SECTIONS tag can be used to enable conditional 00498 # documentation sections, marked by \if sectionname ... \endif. 00499 00500 ENABLED_SECTIONS = 00501 00502 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 00503 # the initial value of a variable or macro consists of for it to appear in 00504 # the documentation. If the initializer consists of more lines than specified 00505 # here it will be hidden. Use a value of 0 to hide initializers completely. 00506 # The appearance of the initializer of individual variables and macros in the 00507 # documentation can be controlled using \showinitializer or \hideinitializer 00508 # command in the documentation regardless of this setting. 00509 00510 MAX_INITIALIZER_LINES = 30 00511 00512 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 00513 # at the bottom of the documentation of classes and structs. If set to YES the 00514 # list will mention the files that were used to generate the documentation. 00515 00516 SHOW_USED_FILES = YES 00517 00518 # If the sources in your project are distributed over multiple directories 00519 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 00520 # in the documentation. The default is NO. 00521 00522 SHOW_DIRECTORIES = YES 00523 00524 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 00525 # This will remove the Files entry from the Quick Index and from the 00526 # Folder Tree View (if specified). The default is YES. 00527 00528 SHOW_FILES = YES 00529 00530 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 00531 # Namespaces page. This will remove the Namespaces entry from the Quick Index 00532 # and from the Folder Tree View (if specified). The default is YES. 00533 00534 SHOW_NAMESPACES = YES 00535 00536 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 00537 # doxygen should invoke to get the current version for each file (typically from 00538 # the version control system). Doxygen will invoke the program by executing (via 00539 # popen()) the command <command> <input-file>, where <command> is the value of 00540 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 00541 # provided by doxygen. Whatever the program writes to standard output 00542 # is used as the file version. See the manual for examples. 00543 00544 FILE_VERSION_FILTER = 00545 00546 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 00547 # by doxygen. The layout file controls the global structure of the generated 00548 # output files in an output format independent way. The create the layout file 00549 # that represents doxygen's defaults, run doxygen with the -l option. 00550 # You can optionally specify a file name after the option, if omitted 00551 # DoxygenLayout.xml will be used as the name of the layout file. 00552 00553 LAYOUT_FILE = 00554 00555 #--------------------------------------------------------------------------- 00556 # configuration options related to warning and progress messages 00557 #--------------------------------------------------------------------------- 00558 00559 # The QUIET tag can be used to turn on/off the messages that are generated 00560 # by doxygen. Possible values are YES and NO. If left blank NO is used. 00561 00562 QUIET = NO 00563 00564 # The WARNINGS tag can be used to turn on/off the warning messages that are 00565 # generated by doxygen. Possible values are YES and NO. If left blank 00566 # NO is used. 00567 00568 WARNINGS = YES 00569 00570 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 00571 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 00572 # automatically be disabled. 00573 00574 WARN_IF_UNDOCUMENTED = NO 00575 00576 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 00577 # potential errors in the documentation, such as not documenting some 00578 # parameters in a documented function, or documenting parameters that 00579 # don't exist or using markup commands wrongly. 00580 00581 WARN_IF_DOC_ERROR = YES 00582 00583 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 00584 # functions that are documented, but have no documentation for their parameters 00585 # or return value. If set to NO (the default) doxygen will only warn about 00586 # wrong or incomplete parameter documentation, but not about the absence of 00587 # documentation. 00588 00589 WARN_NO_PARAMDOC = NO 00590 00591 # The WARN_FORMAT tag determines the format of the warning messages that 00592 # doxygen can produce. The string should contain the $file, $line, and $text 00593 # tags, which will be replaced by the file and line number from which the 00594 # warning originated and the warning text. Optionally the format may contain 00595 # $version, which will be replaced by the version of the file (if it could 00596 # be obtained via FILE_VERSION_FILTER) 00597 00598 WARN_FORMAT = "$file:$line: $text" 00599 00600 # The WARN_LOGFILE tag can be used to specify a file to which warning 00601 # and error messages should be written. If left blank the output is written 00602 # to stderr. 00603 00604 WARN_LOGFILE = 00605 00606 #--------------------------------------------------------------------------- 00607 # configuration options related to the input files 00608 #--------------------------------------------------------------------------- 00609 00610 # The INPUT tag can be used to specify the files and/or directories that contain 00611 # documented source files. You may enter file names like "myfile.cpp" or 00612 # directories like "/usr/src/myproject". Separate the files or directories 00613 # with spaces. 00614 00615 INPUT = dtool \ 00616 panda \ 00617 direct \ 00618 pandatool \ 00619 contrib 00620 00621 # This tag can be used to specify the character encoding of the source files 00622 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 00623 # also the default input encoding. Doxygen uses libiconv (or the iconv built 00624 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 00625 # the list of possible encodings. 00626 00627 INPUT_ENCODING = UTF-8 00628 00629 # If the value of the INPUT tag contains directories, you can use the 00630 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 00631 # and *.h) to filter out the source-files in the directories. If left 00632 # blank the following patterns are tested: 00633 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 00634 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 00635 # *.f90 *.f *.for *.vhd *.vhdl 00636 00637 FILE_PATTERNS = *.cxx \ 00638 *.h \ 00639 *.c \ 00640 *.I \ 00641 *.cpp 00642 00643 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 00644 # should be searched for input files as well. Possible values are YES and NO. 00645 # If left blank NO is used. 00646 00647 RECURSIVE = YES 00648 00649 # The EXCLUDE tag can be used to specify files and/or directories that should 00650 # excluded from the INPUT source files. This way you can easily exclude a 00651 # subdirectory from a directory tree whose root is specified with the INPUT tag. 00652 00653 EXCLUDE = dtool/src/parser-inc \ 00654 dtool/src/cppparser \ 00655 dtool/src/interrogate \ 00656 direct/src/plugin \ 00657 direct/src/plugin_standalone \ 00658 direct/src/plugin_npapi \ 00659 direct/src/plugin_activex \ 00660 dtool/src/test_interrogate \ 00661 panda/src/linmath/fltnames.h \ 00662 panda/src/linmath/dblnames.h \ 00663 panda/src/linmath/dbl2fltnames.h \ 00664 panda/src/linmath/flt2dblnames.h 00665 00666 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 00667 # directories that are symbolic links (a Unix file system feature) are excluded 00668 # from the input. 00669 00670 EXCLUDE_SYMLINKS = NO 00671 00672 # If the value of the INPUT tag contains directories, you can use the 00673 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 00674 # certain files from those directories. Note that the wildcards are matched 00675 # against the file with absolute path, so to exclude all test directories 00676 # for example use the pattern */test/* 00677 00678 EXCLUDE_PATTERNS = */Opt*-*/* \ 00679 */CVS/* \ 00680 *_composite*.cxx \ 00681 *_ext.* \ 00682 */test/* \ 00683 */test_* \ 00684 *_src.* \ 00685 *_src_ext.* \ 00686 *_ext_src.* 00687 00688 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 00689 # (namespaces, classes, functions, etc.) that should be excluded from the 00690 # output. The symbol name can be a fully qualified name, a word, or if the 00691 # wildcard * is used, a substring. Examples: ANamespace, AClass, 00692 # AClass::ANamespace, ANamespace::*Test 00693 00694 EXCLUDE_SYMBOLS = 00695 00696 # The EXAMPLE_PATH tag can be used to specify one or more files or 00697 # directories that contain example code fragments that are included (see 00698 # the \include command). 00699 00700 EXAMPLE_PATH = 00701 00702 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 00703 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 00704 # and *.h) to filter out the source-files in the directories. If left 00705 # blank all files are included. 00706 00707 EXAMPLE_PATTERNS = * 00708 00709 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 00710 # searched for input files to be used with the \include or \dontinclude 00711 # commands irrespective of the value of the RECURSIVE tag. 00712 # Possible values are YES and NO. If left blank NO is used. 00713 00714 EXAMPLE_RECURSIVE = NO 00715 00716 # The IMAGE_PATH tag can be used to specify one or more files or 00717 # directories that contain image that are included in the documentation (see 00718 # the \image command). 00719 00720 IMAGE_PATH = 00721 00722 # The INPUT_FILTER tag can be used to specify a program that doxygen should 00723 # invoke to filter for each input file. Doxygen will invoke the filter program 00724 # by executing (via popen()) the command <filter> <input-file>, where <filter> 00725 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 00726 # input file. Doxygen will then use the output that the filter program writes 00727 # to standard output. If FILTER_PATTERNS is specified, this tag will be 00728 # ignored. 00729 00730 INPUT_FILTER = "python direct/src/directscripts/doxygen_filter.py" 00731 00732 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 00733 # basis. Doxygen will compare the file name with each pattern and apply the 00734 # filter if there is a match. The filters are a list of the form: 00735 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 00736 # info on how filters are used. If FILTER_PATTERNS is empty or if 00737 # non of the patterns match the file name, INPUT_FILTER is applied. 00738 00739 FILTER_PATTERNS = 00740 00741 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 00742 # INPUT_FILTER) will be used to filter the input files when producing source 00743 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 00744 00745 FILTER_SOURCE_FILES = NO 00746 00747 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 00748 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 00749 # and it is also possible to disable source filtering for a specific pattern 00750 # using *.ext= (so without naming a filter). This option only has effect when 00751 # FILTER_SOURCE_FILES is enabled. 00752 00753 FILTER_SOURCE_PATTERNS = 00754 00755 #--------------------------------------------------------------------------- 00756 # configuration options related to source browsing 00757 #--------------------------------------------------------------------------- 00758 00759 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 00760 # be generated. Documented entities will be cross-referenced with these sources. 00761 # Note: To get rid of all source code in the generated output, make sure also 00762 # VERBATIM_HEADERS is set to NO. 00763 00764 SOURCE_BROWSER = YES 00765 00766 # Setting the INLINE_SOURCES tag to YES will include the body 00767 # of functions and classes directly in the documentation. 00768 00769 INLINE_SOURCES = NO 00770 00771 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 00772 # doxygen to hide any special comment blocks from generated source code 00773 # fragments. Normal C and C++ comments will always remain visible. 00774 00775 STRIP_CODE_COMMENTS = NO 00776 00777 # If the REFERENCED_BY_RELATION tag is set to YES 00778 # then for each documented function all documented 00779 # functions referencing it will be listed. 00780 00781 REFERENCED_BY_RELATION = YES 00782 00783 # If the REFERENCES_RELATION tag is set to YES 00784 # then for each documented function all documented entities 00785 # called/used by that function will be listed. 00786 00787 REFERENCES_RELATION = YES 00788 00789 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 00790 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 00791 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 00792 # link to the source code. Otherwise they will link to the documentation. 00793 00794 REFERENCES_LINK_SOURCE = YES 00795 00796 # If the USE_HTAGS tag is set to YES then the references to source code 00797 # will point to the HTML generated by the htags(1) tool instead of doxygen 00798 # built-in source browser. The htags tool is part of GNU's global source 00799 # tagging system (see http://www.gnu.org/software/global/global.html). You 00800 # will need version 4.8.6 or higher. 00801 00802 USE_HTAGS = NO 00803 00804 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 00805 # will generate a verbatim copy of the header file for each class for 00806 # which an include is specified. Set to NO to disable this. 00807 00808 VERBATIM_HEADERS = YES 00809 00810 #--------------------------------------------------------------------------- 00811 # configuration options related to the alphabetical class index 00812 #--------------------------------------------------------------------------- 00813 00814 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 00815 # of all compounds will be generated. Enable this if the project 00816 # contains a lot of classes, structs, unions or interfaces. 00817 00818 ALPHABETICAL_INDEX = YES 00819 00820 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 00821 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 00822 # in which this list will be split (can be a number in the range [1..20]) 00823 00824 COLS_IN_ALPHA_INDEX = 5 00825 00826 # In case all classes in a project start with a common prefix, all 00827 # classes will be put under the same header in the alphabetical index. 00828 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 00829 # should be ignored while generating the index headers. 00830 00831 IGNORE_PREFIX = 00832 00833 #--------------------------------------------------------------------------- 00834 # configuration options related to the HTML output 00835 #--------------------------------------------------------------------------- 00836 00837 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 00838 # generate HTML output. 00839 00840 GENERATE_HTML = YES 00841 00842 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 00843 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 00844 # put in front of it. If left blank `html' will be used as the default path. 00845 00846 HTML_OUTPUT = html 00847 00848 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 00849 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 00850 # doxygen will generate files with .html extension. 00851 00852 HTML_FILE_EXTENSION = $(DOXYGEN_HTML_FILE_EXTENSION) 00853 00854 # The HTML_HEADER tag can be used to specify a personal HTML header for 00855 # each generated HTML page. If it is left blank doxygen will generate a 00856 # standard header. 00857 00858 HTML_HEADER = $(DOXYGEN_HTML_HEADER) 00859 00860 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 00861 # each generated HTML page. If it is left blank doxygen will generate a 00862 # standard footer. 00863 00864 HTML_FOOTER = $(DOXYGEN_HTML_FOOTER) 00865 00866 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 00867 # style sheet that is used by each HTML page. It can be used to 00868 # fine-tune the look of the HTML output. If the tag is left blank doxygen 00869 # will generate a default style sheet. Note that doxygen will try to copy 00870 # the style sheet file to the HTML output directory, so don't put your own 00871 # stylesheet in the HTML output directory as well, or it will be erased! 00872 00873 HTML_STYLESHEET = $(DOXYGEN_HTML_STYLESHEET) 00874 00875 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 00876 # Doxygen will adjust the colors in the stylesheet and background images 00877 # according to this color. Hue is specified as an angle on a colorwheel, 00878 # see http://en.wikipedia.org/wiki/Hue for more information. 00879 # For instance the value 0 represents red, 60 is yellow, 120 is green, 00880 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 00881 # The allowed range is 0 to 359. 00882 00883 HTML_COLORSTYLE_HUE = 220 00884 00885 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 00886 # the colors in the HTML output. For a value of 0 the output will use 00887 # grayscales only. A value of 255 will produce the most vivid colors. 00888 00889 HTML_COLORSTYLE_SAT = 100 00890 00891 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 00892 # the luminance component of the colors in the HTML output. Values below 00893 # 100 gradually make the output lighter, whereas values above 100 make 00894 # the output darker. The value divided by 100 is the actual gamma applied, 00895 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 00896 # and 100 does not change the gamma. 00897 00898 HTML_COLORSTYLE_GAMMA = 80 00899 00900 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 00901 # page will contain the date and time when the page was generated. Setting 00902 # this to NO can help when comparing the output of multiple runs. 00903 00904 HTML_TIMESTAMP = YES 00905 00906 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 00907 # files or namespaces will be aligned in HTML using tables. If set to 00908 # NO a bullet list will be used. 00909 00910 HTML_ALIGN_MEMBERS = YES 00911 00912 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 00913 # documentation will contain sections that can be hidden and shown after the 00914 # page has loaded. For this to work a browser that supports 00915 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 00916 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 00917 00918 HTML_DYNAMIC_SECTIONS = NO 00919 00920 # If the GENERATE_DOCSET tag is set to YES, additional index files 00921 # will be generated that can be used as input for Apple's Xcode 3 00922 # integrated development environment, introduced with OSX 10.5 (Leopard). 00923 # To create a documentation set, doxygen will generate a Makefile in the 00924 # HTML output directory. Running make will produce the docset in that 00925 # directory and running "make install" will install the docset in 00926 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 00927 # it at startup. 00928 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 00929 # for more information. 00930 00931 GENERATE_DOCSET = NO 00932 00933 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 00934 # feed. A documentation feed provides an umbrella under which multiple 00935 # documentation sets from a single provider (such as a company or product suite) 00936 # can be grouped. 00937 00938 DOCSET_FEEDNAME = "Doxygen generated docs" 00939 00940 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 00941 # should uniquely identify the documentation set bundle. This should be a 00942 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 00943 # will append .docset to the name. 00944 00945 DOCSET_BUNDLE_ID = org.doxygen.Project 00946 00947 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 00948 # the documentation publisher. This should be a reverse domain-name style 00949 # string, e.g. com.mycompany.MyDocSet.documentation. 00950 00951 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 00952 00953 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 00954 00955 DOCSET_PUBLISHER_NAME = Publisher 00956 00957 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 00958 # will be generated that can be used as input for tools like the 00959 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 00960 # of the generated HTML documentation. 00961 00962 GENERATE_HTMLHELP = NO 00963 00964 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 00965 # be used to specify the file name of the resulting .chm file. You 00966 # can add a path in front of the file if the result should not be 00967 # written to the html output directory. 00968 00969 CHM_FILE = 00970 00971 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 00972 # be used to specify the location (absolute path including file name) of 00973 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 00974 # the HTML help compiler on the generated index.hhp. 00975 00976 HHC_LOCATION = 00977 00978 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 00979 # controls if a separate .chi index file is generated (YES) or that 00980 # it should be included in the master .chm file (NO). 00981 00982 GENERATE_CHI = NO 00983 00984 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 00985 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 00986 # content. 00987 00988 CHM_INDEX_ENCODING = 00989 00990 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 00991 # controls whether a binary table of contents is generated (YES) or a 00992 # normal table of contents (NO) in the .chm file. 00993 00994 BINARY_TOC = NO 00995 00996 # The TOC_EXPAND flag can be set to YES to add extra items for group members 00997 # to the contents of the HTML help documentation and to the tree view. 00998 00999 TOC_EXPAND = NO 01000 01001 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 01002 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 01003 # that can be used as input for Qt's qhelpgenerator to generate a 01004 # Qt Compressed Help (.qch) of the generated HTML documentation. 01005 01006 GENERATE_QHP = NO 01007 01008 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 01009 # be used to specify the file name of the resulting .qch file. 01010 # The path specified is relative to the HTML output folder. 01011 01012 QCH_FILE = 01013 01014 # The QHP_NAMESPACE tag specifies the namespace to use when generating 01015 # Qt Help Project output. For more information please see 01016 # http://doc.trolltech.com/qthelpproject.html#namespace 01017 01018 QHP_NAMESPACE = org.doxygen.Project 01019 01020 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 01021 # Qt Help Project output. For more information please see 01022 # http://doc.trolltech.com/qthelpproject.html#virtual-folders 01023 01024 QHP_VIRTUAL_FOLDER = doc 01025 01026 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 01027 # add. For more information please see 01028 # http://doc.trolltech.com/qthelpproject.html#custom-filters 01029 01030 QHP_CUST_FILTER_NAME = 01031 01032 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 01033 # custom filter to add. For more information please see 01034 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 01035 # Qt Help Project / Custom Filters</a>. 01036 01037 QHP_CUST_FILTER_ATTRS = 01038 01039 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 01040 # project's 01041 # filter section matches. 01042 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 01043 # Qt Help Project / Filter Attributes</a>. 01044 01045 QHP_SECT_FILTER_ATTRS = 01046 01047 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 01048 # be used to specify the location of Qt's qhelpgenerator. 01049 # If non-empty doxygen will try to run qhelpgenerator on the generated 01050 # .qhp file. 01051 01052 QHG_LOCATION = 01053 01054 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 01055 # will be generated, which together with the HTML files, form an Eclipse help 01056 # plugin. To install this plugin and make it available under the help contents 01057 # menu in Eclipse, the contents of the directory containing the HTML and XML 01058 # files needs to be copied into the plugins directory of eclipse. The name of 01059 # the directory within the plugins directory should be the same as 01060 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 01061 # the help appears. 01062 01063 GENERATE_ECLIPSEHELP = NO 01064 01065 # A unique identifier for the eclipse help plugin. When installing the plugin 01066 # the directory name containing the HTML and XML files should also have 01067 # this name. 01068 01069 ECLIPSE_DOC_ID = org.doxygen.Project 01070 01071 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 01072 # top of each HTML page. The value NO (the default) enables the index and 01073 # the value YES disables it. 01074 01075 DISABLE_INDEX = NO 01076 01077 # This tag can be used to set the number of enum values (range [0,1..20]) 01078 # that doxygen will group on one line in the generated HTML documentation. 01079 # Note that a value of 0 will completely suppress the enum values from 01080 # appearing in the overview section. 01081 01082 ENUM_VALUES_PER_LINE = 4 01083 01084 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 01085 # structure should be generated to display hierarchical information. 01086 # If the tag value is set to YES, a side panel will be generated 01087 # containing a tree-like index structure (just like the one that 01088 # is generated for HTML Help). For this to work a browser that supports 01089 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 01090 # Windows users are probably better off using the HTML help feature. 01091 01092 GENERATE_TREEVIEW = NO 01093 01094 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 01095 # and Class Hierarchy pages using a tree view instead of an ordered list. 01096 01097 USE_INLINE_TREES = NO 01098 01099 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 01100 # used to set the initial width (in pixels) of the frame in which the tree 01101 # is shown. 01102 01103 TREEVIEW_WIDTH = 250 01104 01105 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 01106 # links to external symbols imported via tag files in a separate window. 01107 01108 EXT_LINKS_IN_WINDOW = NO 01109 01110 # Use this tag to change the font size of Latex formulas included 01111 # as images in the HTML documentation. The default is 10. Note that 01112 # when you change the font size after a successful doxygen run you need 01113 # to manually remove any form_*.png images from the HTML output directory 01114 # to force them to be regenerated. 01115 01116 FORMULA_FONTSIZE = 10 01117 01118 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 01119 # generated for formulas are transparent PNGs. Transparent PNGs are 01120 # not supported properly for IE 6.0, but are supported on all modern browsers. 01121 # Note that when changing this option you need to delete any form_*.png files 01122 # in the HTML output before the changes have effect. 01123 01124 FORMULA_TRANSPARENT = YES 01125 01126 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 01127 # (see http://www.mathjax.org) which uses client side Javascript for the 01128 # rendering instead of using prerendered bitmaps. Use this if you do not 01129 # have LaTeX installed or if you want to formulas look prettier in the HTML 01130 # output. When enabled you also need to install MathJax separately and 01131 # configure the path to it using the MATHJAX_RELPATH option. 01132 01133 USE_MATHJAX = NO 01134 01135 # When MathJax is enabled you need to specify the location relative to the 01136 # HTML output directory using the MATHJAX_RELPATH option. The destination 01137 # directory should contain the MathJax.js script. For instance, if the mathjax 01138 # directory is located at the same level as the HTML output directory, then 01139 # MATHJAX_RELPATH should be ../mathjax. The default value points to the 01140 # mathjax.org site, so you can quickly see the result without installing 01141 # MathJax, but it is strongly recommended to install a local copy of MathJax 01142 # before deployment. 01143 01144 MATHJAX_RELPATH = http://www.mathjax.org/mathjax 01145 01146 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 01147 # for the HTML output. The underlying search engine uses javascript 01148 # and DHTML and should work on any modern browser. Note that when using 01149 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 01150 # (GENERATE_DOCSET) there is already a search function so this one should 01151 # typically be disabled. For large projects the javascript based search engine 01152 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 01153 01154 SEARCHENGINE = YES 01155 01156 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 01157 # implemented using a PHP enabled web server instead of at the web client 01158 # using Javascript. Doxygen will generate the search PHP script and index 01159 # file to put on the web server. The advantage of the server 01160 # based approach is that it scales better to large projects and allows 01161 # full text search. The disadvantages are that it is more difficult to setup 01162 # and does not have live searching capabilities. 01163 01164 SERVER_BASED_SEARCH = NO 01165 01166 #--------------------------------------------------------------------------- 01167 # configuration options related to the LaTeX output 01168 #--------------------------------------------------------------------------- 01169 01170 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 01171 # generate Latex output. 01172 01173 GENERATE_LATEX = NO 01174 01175 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 01176 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 01177 # put in front of it. If left blank `latex' will be used as the default path. 01178 01179 LATEX_OUTPUT = latex 01180 01181 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 01182 # invoked. If left blank `latex' will be used as the default command name. 01183 # Note that when enabling USE_PDFLATEX this option is only used for 01184 # generating bitmaps for formulas in the HTML output, but not in the 01185 # Makefile that is written to the output directory. 01186 01187 LATEX_CMD_NAME = latex 01188 01189 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 01190 # generate index for LaTeX. If left blank `makeindex' will be used as the 01191 # default command name. 01192 01193 MAKEINDEX_CMD_NAME = makeindex 01194 01195 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 01196 # LaTeX documents. This may be useful for small projects and may help to 01197 # save some trees in general. 01198 01199 COMPACT_LATEX = NO 01200 01201 # The PAPER_TYPE tag can be used to set the paper type that is used 01202 # by the printer. Possible values are: a4, letter, legal and 01203 # executive. If left blank a4wide will be used. 01204 01205 PAPER_TYPE = a4wide 01206 01207 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 01208 # packages that should be included in the LaTeX output. 01209 01210 EXTRA_PACKAGES = 01211 01212 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 01213 # the generated latex document. The header should contain everything until 01214 # the first chapter. If it is left blank doxygen will generate a 01215 # standard header. Notice: only use this tag if you know what you are doing! 01216 01217 LATEX_HEADER = 01218 01219 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 01220 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 01221 # contain links (just like the HTML output) instead of page references 01222 # This makes the output suitable for online browsing using a pdf viewer. 01223 01224 PDF_HYPERLINKS = YES 01225 01226 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 01227 # plain latex in the generated Makefile. Set this option to YES to get a 01228 # higher quality PDF documentation. 01229 01230 USE_PDFLATEX = YES 01231 01232 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 01233 # command to the generated LaTeX files. This will instruct LaTeX to keep 01234 # running if errors occur, instead of asking the user for help. 01235 # This option is also used when generating formulas in HTML. 01236 01237 LATEX_BATCHMODE = NO 01238 01239 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 01240 # include the index chapters (such as File Index, Compound Index, etc.) 01241 # in the output. 01242 01243 LATEX_HIDE_INDICES = NO 01244 01245 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 01246 # source code with syntax highlighting in the LaTeX output. 01247 # Note that which sources are shown also depends on other settings 01248 # such as SOURCE_BROWSER. 01249 01250 LATEX_SOURCE_CODE = NO 01251 01252 #--------------------------------------------------------------------------- 01253 # configuration options related to the RTF output 01254 #--------------------------------------------------------------------------- 01255 01256 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 01257 # The RTF output is optimized for Word 97 and may not look very pretty with 01258 # other RTF readers or editors. 01259 01260 GENERATE_RTF = NO 01261 01262 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 01263 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 01264 # put in front of it. If left blank `rtf' will be used as the default path. 01265 01266 RTF_OUTPUT = rtf 01267 01268 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 01269 # RTF documents. This may be useful for small projects and may help to 01270 # save some trees in general. 01271 01272 COMPACT_RTF = NO 01273 01274 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 01275 # will contain hyperlink fields. The RTF file will 01276 # contain links (just like the HTML output) instead of page references. 01277 # This makes the output suitable for online browsing using WORD or other 01278 # programs which support those fields. 01279 # Note: wordpad (write) and others do not support links. 01280 01281 RTF_HYPERLINKS = NO 01282 01283 # Load stylesheet definitions from file. Syntax is similar to doxygen's 01284 # config file, i.e. a series of assignments. You only have to provide 01285 # replacements, missing definitions are set to their default value. 01286 01287 RTF_STYLESHEET_FILE = 01288 01289 # Set optional variables used in the generation of an rtf document. 01290 # Syntax is similar to doxygen's config file. 01291 01292 RTF_EXTENSIONS_FILE = 01293 01294 #--------------------------------------------------------------------------- 01295 # configuration options related to the man page output 01296 #--------------------------------------------------------------------------- 01297 01298 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 01299 # generate man pages 01300 01301 GENERATE_MAN = NO 01302 01303 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 01304 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 01305 # put in front of it. If left blank `man' will be used as the default path. 01306 01307 MAN_OUTPUT = man 01308 01309 # The MAN_EXTENSION tag determines the extension that is added to 01310 # the generated man pages (default is the subroutine's section .3) 01311 01312 MAN_EXTENSION = .3 01313 01314 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 01315 # then it will generate one additional man file for each entity 01316 # documented in the real man page(s). These additional files 01317 # only source the real man page, but without them the man command 01318 # would be unable to find the correct page. The default is NO. 01319 01320 MAN_LINKS = NO 01321 01322 #--------------------------------------------------------------------------- 01323 # configuration options related to the XML output 01324 #--------------------------------------------------------------------------- 01325 01326 # If the GENERATE_XML tag is set to YES Doxygen will 01327 # generate an XML file that captures the structure of 01328 # the code including all documentation. 01329 01330 GENERATE_XML = NO 01331 01332 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 01333 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 01334 # put in front of it. If left blank `xml' will be used as the default path. 01335 01336 XML_OUTPUT = xml 01337 01338 # The XML_SCHEMA tag can be used to specify an XML schema, 01339 # which can be used by a validating XML parser to check the 01340 # syntax of the XML files. 01341 01342 XML_SCHEMA = 01343 01344 # The XML_DTD tag can be used to specify an XML DTD, 01345 # which can be used by a validating XML parser to check the 01346 # syntax of the XML files. 01347 01348 XML_DTD = 01349 01350 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 01351 # dump the program listings (including syntax highlighting 01352 # and cross-referencing information) to the XML output. Note that 01353 # enabling this will significantly increase the size of the XML output. 01354 01355 XML_PROGRAMLISTING = YES 01356 01357 #--------------------------------------------------------------------------- 01358 # configuration options for the AutoGen Definitions output 01359 #--------------------------------------------------------------------------- 01360 01361 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 01362 # generate an AutoGen Definitions (see autogen.sf.net) file 01363 # that captures the structure of the code including all 01364 # documentation. Note that this feature is still experimental 01365 # and incomplete at the moment. 01366 01367 GENERATE_AUTOGEN_DEF = NO 01368 01369 #--------------------------------------------------------------------------- 01370 # configuration options related to the Perl module output 01371 #--------------------------------------------------------------------------- 01372 01373 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 01374 # generate a Perl module file that captures the structure of 01375 # the code including all documentation. Note that this 01376 # feature is still experimental and incomplete at the 01377 # moment. 01378 01379 GENERATE_PERLMOD = NO 01380 01381 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 01382 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 01383 # to generate PDF and DVI output from the Perl module output. 01384 01385 PERLMOD_LATEX = NO 01386 01387 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 01388 # nicely formatted so it can be parsed by a human reader. This is useful 01389 # if you want to understand what is going on. On the other hand, if this 01390 # tag is set to NO the size of the Perl module output will be much smaller 01391 # and Perl will parse it just the same. 01392 01393 PERLMOD_PRETTY = YES 01394 01395 # The names of the make variables in the generated doxyrules.make file 01396 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 01397 # This is useful so different doxyrules.make files included by the same 01398 # Makefile don't overwrite each other's variables. 01399 01400 PERLMOD_MAKEVAR_PREFIX = 01401 01402 #--------------------------------------------------------------------------- 01403 # Configuration options related to the preprocessor 01404 #--------------------------------------------------------------------------- 01405 01406 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 01407 # evaluate all C-preprocessor directives found in the sources and include 01408 # files. 01409 01410 ENABLE_PREPROCESSING = YES 01411 01412 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 01413 # names in the source code. If set to NO (the default) only conditional 01414 # compilation will be performed. Macro expansion can be done in a controlled 01415 # way by setting EXPAND_ONLY_PREDEF to YES. 01416 01417 MACRO_EXPANSION = YES 01418 01419 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 01420 # then the macro expansion is limited to the macros specified with the 01421 # PREDEFINED and EXPAND_AS_DEFINED tags. 01422 01423 EXPAND_ONLY_PREDEF = NO 01424 01425 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 01426 # in the INCLUDE_PATH (see below) will be search if a #include is found. 01427 01428 SEARCH_INCLUDES = NO 01429 01430 # The INCLUDE_PATH tag can be used to specify one or more directories that 01431 # contain include files that are not input files but should be processed by 01432 # the preprocessor. 01433 01434 INCLUDE_PATH = 01435 01436 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 01437 # patterns (like *.h and *.hpp) to filter out the header-files in the 01438 # directories. If left blank, the patterns specified with FILE_PATTERNS will 01439 # be used. 01440 01441 INCLUDE_FILE_PATTERNS = 01442 01443 # The PREDEFINED tag can be used to specify one or more macro names that 01444 # are defined before the preprocessor is started (similar to the -D option of 01445 # gcc). The argument of the tag is a list of macros of the form: name 01446 # or name=definition (no spaces). If the definition and the = are 01447 # omitted =1 is assumed. To prevent a macro definition from being 01448 # undefined via #undef or recursively expanded use the := operator 01449 # instead of the = operator. 01450 01451 PREDEFINED = TVOLATILE= \ 01452 INLINE=inline \ 01453 PUBLISHED=public \ 01454 INLINE_LINMATH=inline \ 01455 INLINE_MATHUTIL=inline \ 01456 EXTENSION(x)= \ 01457 EXTEND= \ 01458 ALLOC_DELETED_CHAIN(x)= \ 01459 BLOCKING= \ 01460 TYPENAME=typename 01461 01462 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 01463 # this tag can be used to specify a list of macro names that should be expanded. 01464 # The macro definition that is found in the sources will be used. 01465 # Use the PREDEFINED tag if you want to use a different macro definition that 01466 # overrules the definition found in the source code. 01467 01468 EXPAND_AS_DEFINED = FLOATNAME \ 01469 FLOATTYPE \ 01470 FLOATTOKEN \ 01471 FLOATCONST \ 01472 FLOATTYPE2 \ 01473 FLOATNAME2 \ 01474 FLOATTOKEN2 01475 01476 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 01477 # doxygen's preprocessor will remove all references to function-like macros 01478 # that are alone on a line, have an all uppercase name, and do not end with a 01479 # semicolon, because these will confuse the parser if not removed. 01480 01481 SKIP_FUNCTION_MACROS = NO 01482 01483 #--------------------------------------------------------------------------- 01484 # Configuration::additions related to external references 01485 #--------------------------------------------------------------------------- 01486 01487 # The TAGFILES option can be used to specify one or more tagfiles. 01488 # Optionally an initial location of the external documentation 01489 # can be added for each tagfile. The format of a tag file without 01490 # this location is as follows: 01491 # TAGFILES = file1 file2 ... 01492 # Adding location for the tag files is done as follows: 01493 # TAGFILES = file1=loc1 "file2 = loc2" ... 01494 # where "loc1" and "loc2" can be relative or absolute paths or 01495 # URLs. If a location is present for each tag, the installdox tool 01496 # does not have to be run to correct the links. 01497 # Note that each tag file must have a unique name 01498 # (where the name does NOT include the path) 01499 # If a tag file is not located in the directory in which doxygen 01500 # is run, you must also specify the path to the tagfile here. 01501 01502 TAGFILES = 01503 01504 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 01505 # a tag file that is based on the input files it reads. 01506 01507 GENERATE_TAGFILE = 01508 01509 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 01510 # in the class index. If set to NO only the inherited external classes 01511 # will be listed. 01512 01513 ALLEXTERNALS = NO 01514 01515 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 01516 # in the modules index. If set to NO, only the current project's groups will 01517 # be listed. 01518 01519 EXTERNAL_GROUPS = YES 01520 01521 # The PERL_PATH should be the absolute path and name of the perl script 01522 # interpreter (i.e. the result of `which perl'). 01523 01524 PERL_PATH = /usr/bin/perl 01525 01526 #--------------------------------------------------------------------------- 01527 # Configuration options related to the dot tool 01528 #--------------------------------------------------------------------------- 01529 01530 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 01531 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 01532 # or super classes. Setting the tag to NO turns the diagrams off. Note that 01533 # this option also works with HAVE_DOT disabled, but it is recommended to 01534 # install and use dot, since it yields more powerful graphs. 01535 01536 CLASS_DIAGRAMS = YES 01537 01538 # You can define message sequence charts within doxygen comments using the \msc 01539 # command. Doxygen will then run the mscgen tool (see 01540 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 01541 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 01542 # the mscgen tool resides. If left empty the tool is assumed to be found in the 01543 # default search path. 01544 01545 MSCGEN_PATH = 01546 01547 # If set to YES, the inheritance and collaboration graphs will hide 01548 # inheritance and usage relations if the target is undocumented 01549 # or is not a class. 01550 01551 HIDE_UNDOC_RELATIONS = YES 01552 01553 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 01554 # available from the path. This tool is part of Graphviz, a graph visualization 01555 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 01556 # have no effect if this option is set to NO (the default) 01557 01558 HAVE_DOT = NO 01559 01560 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 01561 # allowed to run in parallel. When set to 0 (the default) doxygen will 01562 # base this on the number of processors available in the system. You can set it 01563 # explicitly to a value larger than 0 to get control over the balance 01564 # between CPU load and processing speed. 01565 01566 DOT_NUM_THREADS = 0 01567 01568 # By default doxygen will write a font called Helvetica to the output 01569 # directory and reference it in all dot files that doxygen generates. 01570 # When you want a differently looking font you can specify the font name 01571 # using DOT_FONTNAME. You need to make sure dot is able to find the font, 01572 # which can be done by putting it in a standard location or by setting the 01573 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 01574 # containing the font. 01575 01576 DOT_FONTNAME = FreeSans.ttf 01577 01578 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 01579 # The default size is 10pt. 01580 01581 DOT_FONTSIZE = 10 01582 01583 # By default doxygen will tell dot to use the output directory to look for the 01584 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 01585 # different font using DOT_FONTNAME you can set the path where dot 01586 # can find it using this tag. 01587 01588 DOT_FONTPATH = 01589 01590 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 01591 # will generate a graph for each documented class showing the direct and 01592 # indirect inheritance relations. Setting this tag to YES will force the 01593 # the CLASS_DIAGRAMS tag to NO. 01594 01595 CLASS_GRAPH = YES 01596 01597 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 01598 # will generate a graph for each documented class showing the direct and 01599 # indirect implementation dependencies (inheritance, containment, and 01600 # class references variables) of the class with other documented classes. 01601 01602 COLLABORATION_GRAPH = YES 01603 01604 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 01605 # will generate a graph for groups, showing the direct groups dependencies 01606 01607 GROUP_GRAPHS = YES 01608 01609 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 01610 # collaboration diagrams in a style similar to the OMG's Unified Modeling 01611 # Language. 01612 01613 UML_LOOK = NO 01614 01615 # If set to YES, the inheritance and collaboration graphs will show the 01616 # relations between templates and their instances. 01617 01618 TEMPLATE_RELATIONS = NO 01619 01620 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 01621 # tags are set to YES then doxygen will generate a graph for each documented 01622 # file showing the direct and indirect include dependencies of the file with 01623 # other documented files. 01624 01625 INCLUDE_GRAPH = YES 01626 01627 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 01628 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 01629 # documented header file showing the documented files that directly or 01630 # indirectly include this file. 01631 01632 INCLUDED_BY_GRAPH = YES 01633 01634 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 01635 # doxygen will generate a call dependency graph for every global function 01636 # or class method. Note that enabling this option will significantly increase 01637 # the time of a run. So in most cases it will be better to enable call graphs 01638 # for selected functions only using the \callgraph command. 01639 01640 CALL_GRAPH = NO 01641 01642 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 01643 # doxygen will generate a caller dependency graph for every global function 01644 # or class method. Note that enabling this option will significantly increase 01645 # the time of a run. So in most cases it will be better to enable caller 01646 # graphs for selected functions only using the \callergraph command. 01647 01648 CALLER_GRAPH = NO 01649 01650 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 01651 # will generate a graphical hierarchy of all classes instead of a textual one. 01652 01653 GRAPHICAL_HIERARCHY = YES 01654 01655 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 01656 # then doxygen will show the dependencies a directory has on other directories 01657 # in a graphical way. The dependency relations are determined by the #include 01658 # relations between the files in the directories. 01659 01660 DIRECTORY_GRAPH = YES 01661 01662 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 01663 # generated by dot. Possible values are png, svg, gif or svg. 01664 # If left blank png will be used. 01665 01666 DOT_IMAGE_FORMAT = png 01667 01668 # The tag DOT_PATH can be used to specify the path where the dot tool can be 01669 # found. If left blank, it is assumed the dot tool can be found in the path. 01670 01671 DOT_PATH = 01672 01673 # The DOTFILE_DIRS tag can be used to specify one or more directories that 01674 # contain dot files that are included in the documentation (see the 01675 # \dotfile command). 01676 01677 DOTFILE_DIRS = 01678 01679 # The MSCFILE_DIRS tag can be used to specify one or more directories that 01680 # contain msc files that are included in the documentation (see the 01681 # \mscfile command). 01682 01683 MSCFILE_DIRS = 01684 01685 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 01686 # nodes that will be shown in the graph. If the number of nodes in a graph 01687 # becomes larger than this value, doxygen will truncate the graph, which is 01688 # visualized by representing a node as a red box. Note that doxygen if the 01689 # number of direct children of the root node in a graph is already larger than 01690 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 01691 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 01692 01693 DOT_GRAPH_MAX_NODES = 50 01694 01695 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 01696 # graphs generated by dot. A depth value of 3 means that only nodes reachable 01697 # from the root by following a path via at most 3 edges will be shown. Nodes 01698 # that lay further from the root node will be omitted. Note that setting this 01699 # option to 1 or 2 may greatly reduce the computation time needed for large 01700 # code bases. Also note that the size of a graph can be further restricted by 01701 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 01702 01703 MAX_DOT_GRAPH_DEPTH = 0 01704 01705 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 01706 # background. This is disabled by default, because dot on Windows does not 01707 # seem to support this out of the box. Warning: Depending on the platform used, 01708 # enabling this option may lead to badly anti-aliased labels on the edges of 01709 # a graph (i.e. they become hard to read). 01710 01711 DOT_TRANSPARENT = NO 01712 01713 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 01714 # files in one run (i.e. multiple -o and -T options on the command line). This 01715 # makes dot run faster, but since only newer versions of dot (>1.8.10) 01716 # support this, this feature is disabled by default. 01717 01718 DOT_MULTI_TARGETS = NO 01719 01720 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 01721 # generate a legend page explaining the meaning of the various boxes and 01722 # arrows in the dot generated graphs. 01723 01724 GENERATE_LEGEND = YES 01725 01726 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 01727 # remove the intermediate dot files that are used to generate 01728 # the various graphs. 01729 01730 DOT_CLEANUP = YES