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