man.doxy
1 # Doxyfile 1.8.2
2
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
5 #
6 # All text after a hash (#) is considered a comment and will be ignored
7 # The format is:
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
26 # identify the project. Note that if you do not use Doxywizard you need
27 # to put quotes around the project name if it contains spaces.
28
29 PROJECT_NAME =
30
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32 # This could be handy for archiving the generated documentation or
33 # if some version control system is used.
34
35 PROJECT_NUMBER = 0.9.4
36
37 # Using the PROJECT_BRIEF tag one can provide an optional one line description
38 # for a project that appears at the top of each page and should give viewer
39 # a quick idea about the purpose of the project. Keep the description short.
40
41 PROJECT_BRIEF =
42
43 # With the PROJECT_LOGO tag one can specify an logo or icon that is
44 # included in the documentation. The maximum height of the logo should not
45 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
46 # Doxygen will copy the logo to the output directory.
47
48 PROJECT_LOGO = G:/Repository/glm/doc/logo.png
49
50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51 # base path where the generated documentation will be put.
52 # If a relative path is entered, it will be relative to the location
53 # where doxygen was started. If left blank the current directory will be used.
54
55 OUTPUT_DIRECTORY = .
56
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58 # 4096 sub-directories (in 2 levels) under the output directory of each output
59 # format and will distribute the generated files over these directories.
60 # Enabling this option can be useful when feeding doxygen a huge amount of
61 # source files, where putting all generated files in the same directory would
62 # otherwise cause performance problems for the file system.
63
64 CREATE_SUBDIRS = NO
65
66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
67 # documentation generated by doxygen is written. Doxygen will use this
68 # information to generate all constant output in the proper language.
69 # The default language is English, other supported languages are:
70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
77 OUTPUT_LANGUAGE = English
78
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80 # include brief member descriptions after the members that are listed in
81 # the file and class documentation (similar to JavaDoc).
82 # Set to NO to disable this.
83
84 BRIEF_MEMBER_DESC = NO
85
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87 # the brief description of a member or function before the detailed description.
88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89 # brief descriptions will be completely suppressed.
90
91 REPEAT_BRIEF = YES
92
93 # This tag implements a quasi-intelligent brief description abbreviator
94 # that is used to form the text in various listings. Each string
95 # in this list, if found as the leading text of the brief description, will be
96 # stripped from the text and the result after processing the whole list, is
97 # used as the annotated text. Otherwise, the brief description is used as-is.
98 # If left blank, the following values are used ("$name" is automatically 99 # replaced with the name of the entity): "The$name class" "The $name widget" 100 # "The$name file" "is" "provides" "specifies" "contains"
101 # "represents" "a" "an" "the"
102
103 ABBREVIATE_BRIEF = "The $name class " \ 104 "The$name widget " \
105  "The $name file " \ 106 is \ 107 provides \ 108 specifies \ 109 contains \ 110 represents \ 111 a \ 112 an \ 113 the 114 115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 116 # Doxygen will generate a detailed section even if there is only a brief 117 # description. 118 119 ALWAYS_DETAILED_SEC = NO 120 121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 122 # inherited members of a class in the documentation of that class as if those 123 # members were ordinary class members. Constructors, destructors and assignment 124 # operators of the base classes will not be shown. 125 126 INLINE_INHERITED_MEMB = NO 127 128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 129 # path before files name in the file list and in the header files. If set 130 # to NO the shortest path that makes the file name unique will be used. 131 132 FULL_PATH_NAMES = NO 133 134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 135 # can be used to strip a user-defined part of the path. Stripping is 136 # only done if one of the specified strings matches the left-hand part of 137 # the path. The tag can be used to show relative paths in the file list. 138 # If left blank the directory from which doxygen is run is used as the 139 # path to strip. Note that you specify absolute paths here, but also 140 # relative paths, which will be relative from the directory where doxygen is 141 # started. 142 143 STRIP_FROM_PATH = "C:/Documents and Settings/Groove/ " 144 145 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 146 # the path mentioned in the documentation of a class, which tells 147 # the reader which header file to include in order to use a class. 148 # If left blank only the name of the header file containing the class 149 # definition is used. Otherwise one should specify the include paths that 150 # are normally passed to the compiler using the -I flag. 151 152 STRIP_FROM_INC_PATH = 153 154 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 155 # (but less readable) file names. This can be useful if your file system 156 # doesn't support long names like on DOS, Mac, or CD-ROM. 157 158 SHORT_NAMES = YES 159 160 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 161 # will interpret the first line (until the first dot) of a JavaDoc-style 162 # comment as the brief description. If set to NO, the JavaDoc 163 # comments will behave just like regular Qt-style comments 164 # (thus requiring an explicit @brief command for a brief description.) 165 166 JAVADOC_AUTOBRIEF = YES 167 168 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 169 # interpret the first line (until the first dot) of a Qt-style 170 # comment as the brief description. If set to NO, the comments 171 # will behave just like regular Qt-style comments (thus requiring 172 # an explicit \brief command for a brief description.) 173 174 QT_AUTOBRIEF = NO 175 176 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 177 # treat a multi-line C++ special comment block (i.e. a block of 178 # comments) as a brief description. This used to be the default behaviour. 179 # The new default is to treat a multi-line C++ comment block as a detailed 180 # description. Set this tag to YES if you prefer the old behaviour instead. 181 182 MULTILINE_CPP_IS_BRIEF = NO 183 184 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 185 # member inherits the documentation from any documented member that it 186 # re-implements. 187 188 INHERIT_DOCS = YES 189 190 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 191 # a new page for each member. If set to NO, the documentation of a member will 192 # be part of the file/class/namespace that contains it. 193 194 SEPARATE_MEMBER_PAGES = NO 195 196 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 197 # Doxygen uses this value to replace tabs by spaces in code fragments. 198 199 TAB_SIZE = 8 200 201 # This tag can be used to specify a number of aliases that acts 202 # as commands in the documentation. An alias has the form "name=value". 203 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 204 # put the command \sideeffect (or @sideeffect) in the documentation, which 205 # will result in a user-defined paragraph with heading "Side Effects:". 206 # You can put \n's in the value part of an alias to insert newlines. 207 208 ALIASES = 209 210 # This tag can be used to specify a number of word-keyword mappings (TCL only). 211 # A mapping has the form "name=value". For example adding 212 # "class=itcl::class" will allow you to use the command class in the 213 # itcl::class meaning. 214 215 TCL_SUBST = 216 217 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 218 # sources only. Doxygen will then generate output that is more tailored for C. 219 # For instance, some of the names that are used will be different. The list 220 # of all members will be omitted, etc. 221 222 OPTIMIZE_OUTPUT_FOR_C = NO 223 224 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 225 # sources only. Doxygen will then generate output that is more tailored for 226 # Java. For instance, namespaces will be presented as packages, qualified 227 # scopes will look different, etc. 228 229 OPTIMIZE_OUTPUT_JAVA = NO 230 231 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 232 # sources only. Doxygen will then generate output that is more tailored for 233 # Fortran. 234 235 OPTIMIZE_FOR_FORTRAN = NO 236 237 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 238 # sources. Doxygen will then generate output that is tailored for 239 # VHDL. 240 241 OPTIMIZE_OUTPUT_VHDL = NO 242 243 # Doxygen selects the parser to use depending on the extension of the files it 244 # parses. With this tag you can assign which parser to use for a given 245 # extension. Doxygen has a built-in mapping, but you can override or extend it 246 # using this tag. The format is ext=language, where ext is a file extension, 247 # and language is one of the parsers supported by doxygen: IDL, Java, 248 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 249 # C++. For instance to make doxygen treat .inc files as Fortran files (default 250 # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 251 # that for custom extensions you also need to set FILE_PATTERNS otherwise the 252 # files are not read by doxygen. 253 254 EXTENSION_MAPPING = 255 256 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 257 # comments according to the Markdown format, which allows for more readable 258 # documentation. See http://daringfireball.net/projects/markdown/ for details. 259 # The output of markdown processing is further processed by doxygen, so you 260 # can mix doxygen, HTML, and XML commands with Markdown formatting. 261 # Disable only in case of backward compatibilities issues. 262 263 MARKDOWN_SUPPORT = YES 264 265 # When enabled doxygen tries to link words that correspond to documented classes, 266 # or namespaces to their corresponding documentation. Such a link can be 267 # prevented in individual cases by by putting a % sign in front of the word or 268 # globally by setting AUTOLINK_SUPPORT to NO. 269 270 AUTOLINK_SUPPORT = YES 271 272 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 273 # to include (a tag file for) the STL sources as input, then you should 274 # set this tag to YES in order to let doxygen match functions declarations and 275 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 276 # func(std::string) {}). This also makes the inheritance and collaboration 277 # diagrams that involve STL classes more complete and accurate. 278 279 BUILTIN_STL_SUPPORT = NO 280 281 # If you use Microsoft's C++/CLI language, you should set this option to YES to 282 # enable parsing support. 283 284 CPP_CLI_SUPPORT = NO 285 286 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 287 # Doxygen will parse them like normal C++ but will assume all classes use public 288 # instead of private inheritance when no explicit protection keyword is present. 289 290 SIP_SUPPORT = NO 291 292 # For Microsoft's IDL there are propget and propput attributes to indicate 293 # getter and setter methods for a property. Setting this option to YES (the 294 # default) will make doxygen replace the get and set methods by a property in 295 # the documentation. This will only work if the methods are indeed getting or 296 # setting a simple type. If this is not the case, or you want to show the 297 # methods anyway, you should set this option to NO. 298 299 IDL_PROPERTY_SUPPORT = YES 300 301 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 302 # tag is set to YES, then doxygen will reuse the documentation of the first 303 # member in the group (if any) for the other members of the group. By default 304 # all members of a group must be documented explicitly. 305 306 DISTRIBUTE_GROUP_DOC = NO 307 308 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 309 # the same type (for instance a group of public functions) to be put as a 310 # subgroup of that type (e.g. under the Public Functions section). Set it to 311 # NO to prevent subgrouping. Alternatively, this can be done per class using 312 # the \nosubgrouping command. 313 314 SUBGROUPING = NO 315 316 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 317 # unions are shown inside the group in which they are included (e.g. using 318 # @ingroup) instead of on a separate page (for HTML and Man pages) or 319 # section (for LaTeX and RTF). 320 321 INLINE_GROUPED_CLASSES = NO 322 323 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 324 # unions with only public data fields will be shown inline in the documentation 325 # of the scope in which they are defined (i.e. file, namespace, or group 326 # documentation), provided this scope is documented. If set to NO (the default), 327 # structs, classes, and unions are shown on a separate page (for HTML and Man 328 # pages) or section (for LaTeX and RTF). 329 330 INLINE_SIMPLE_STRUCTS = NO 331 332 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 333 # is documented as struct, union, or enum with the name of the typedef. So 334 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 335 # with name TypeT. When disabled the typedef will appear as a member of a file, 336 # namespace, or class. And the struct will be named TypeS. This can typically 337 # be useful for C code in case the coding convention dictates that all compound 338 # types are typedef'ed and only the typedef is referenced, never the tag name. 339 340 TYPEDEF_HIDES_STRUCT = NO 341 342 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 343 # determine which symbols to keep in memory and which to flush to disk. 344 # When the cache is full, less often used symbols will be written to disk. 345 # For small to medium size projects (<1000 input files) the default value is 346 # probably good enough. For larger projects a too small cache size can cause 347 # doxygen to be busy swapping symbols to and from disk most of the time 348 # causing a significant performance penalty. 349 # If the system has enough physical memory increasing the cache will improve the 350 # performance by keeping more symbols in memory. Note that the value works on 351 # a logarithmic scale so increasing the size by one will roughly double the 352 # memory usage. The cache size is given by this formula: 353 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 354 # corresponding to a cache size of 2^16 = 65536 symbols. 355 356 SYMBOL_CACHE_SIZE = 0 357 358 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 359 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 360 # their name and scope. Since this can be an expensive process and often the 361 # same symbol appear multiple times in the code, doxygen keeps a cache of 362 # pre-resolved symbols. If the cache is too small doxygen will become slower. 363 # If the cache is too large, memory is wasted. The cache size is given by this 364 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 365 # corresponding to a cache size of 2^16 = 65536 symbols. 366 367 LOOKUP_CACHE_SIZE = 0 368 369 #--------------------------------------------------------------------------- 370 # Build related configuration options 371 #--------------------------------------------------------------------------- 372 373 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 374 # documentation are documented, even if no documentation was available. 375 # Private class members and static file members will be hidden unless 376 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 377 378 EXTRACT_ALL = NO 379 380 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 381 # will be included in the documentation. 382 383 EXTRACT_PRIVATE = NO 384 385 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 386 # scope will be included in the documentation. 387 388 EXTRACT_PACKAGE = NO 389 390 # If the EXTRACT_STATIC tag is set to YES all static members of a file 391 # will be included in the documentation. 392 393 EXTRACT_STATIC = YES 394 395 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 396 # defined locally in source files will be included in the documentation. 397 # If set to NO only classes defined in header files are included. 398 399 EXTRACT_LOCAL_CLASSES = NO 400 401 # This flag is only useful for Objective-C code. When set to YES local 402 # methods, which are defined in the implementation section but not in 403 # the interface are included in the documentation. 404 # If set to NO (the default) only methods in the interface are included. 405 406 EXTRACT_LOCAL_METHODS = NO 407 408 # If this flag is set to YES, the members of anonymous namespaces will be 409 # extracted and appear in the documentation as a namespace called 410 # 'anonymous_namespace{file}', where file will be replaced with the base 411 # name of the file that contains the anonymous namespace. By default 412 # anonymous namespaces are hidden. 413 414 EXTRACT_ANON_NSPACES = NO 415 416 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 417 # undocumented members of documented classes, files or namespaces. 418 # If set to NO (the default) these members will be included in the 419 # various overviews, but no documentation section is generated. 420 # This option has no effect if EXTRACT_ALL is enabled. 421 422 HIDE_UNDOC_MEMBERS = YES 423 424 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 425 # undocumented classes that are normally visible in the class hierarchy. 426 # If set to NO (the default) these classes will be included in the various 427 # overviews. This option has no effect if EXTRACT_ALL is enabled. 428 429 HIDE_UNDOC_CLASSES = YES 430 431 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 432 # friend (class|struct|union) declarations. 433 # If set to NO (the default) these declarations will be included in the 434 # documentation. 435 436 HIDE_FRIEND_COMPOUNDS = YES 437 438 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 439 # documentation blocks found inside the body of a function. 440 # If set to NO (the default) these blocks will be appended to the 441 # function's detailed documentation block. 442 443 HIDE_IN_BODY_DOCS = YES 444 445 # The INTERNAL_DOCS tag determines if documentation 446 # that is typed after a \internal command is included. If the tag is set 447 # to NO (the default) then the documentation will be excluded. 448 # Set it to YES to include the internal documentation. 449 450 INTERNAL_DOCS = NO 451 452 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 453 # file names in lower-case letters. If set to YES upper-case letters are also 454 # allowed. This is useful if you have classes or files whose names only differ 455 # in case and if your file system supports case sensitive file names. Windows 456 # and Mac users are advised to set this option to NO. 457 458 CASE_SENSE_NAMES = YES 459 460 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 461 # will show members with their full class and namespace scopes in the 462 # documentation. If set to YES the scope will be hidden. 463 464 HIDE_SCOPE_NAMES = YES 465 466 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 467 # will put a list of the files that are included by a file in the documentation 468 # of that file. 469 470 SHOW_INCLUDE_FILES = NO 471 472 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 473 # will list include files with double quotes in the documentation 474 # rather than with sharp brackets. 475 476 FORCE_LOCAL_INCLUDES = NO 477 478 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 479 # is inserted in the documentation for inline members. 480 481 INLINE_INFO = NO 482 483 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 484 # will sort the (detailed) documentation of file and class members 485 # alphabetically by member name. If set to NO the members will appear in 486 # declaration order. 487 488 SORT_MEMBER_DOCS = YES 489 490 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 491 # brief documentation of file, namespace and class members alphabetically 492 # by member name. If set to NO (the default) the members will appear in 493 # declaration order. 494 495 SORT_BRIEF_DOCS = YES 496 497 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 498 # will sort the (brief and detailed) documentation of class members so that 499 # constructors and destructors are listed first. If set to NO (the default) 500 # the constructors will appear in the respective orders defined by 501 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 502 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 503 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 504 505 SORT_MEMBERS_CTORS_1ST = NO 506 507 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 508 # hierarchy of group names into alphabetical order. If set to NO (the default) 509 # the group names will appear in their defined order. 510 511 SORT_GROUP_NAMES = NO 512 513 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 514 # sorted by fully-qualified names, including namespaces. If set to 515 # NO (the default), the class list will be sorted only by class name, 516 # not including the namespace part. 517 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 518 # Note: This option applies only to the class list, not to the 519 # alphabetical list. 520 521 SORT_BY_SCOPE_NAME = YES 522 523 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 524 # do proper type resolution of all parameters of a function it will reject a 525 # match between the prototype and the implementation of a member function even 526 # if there is only one candidate or it is obvious which candidate to choose 527 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 528 # will still accept a match between prototype and implementation in such cases. 529 530 STRICT_PROTO_MATCHING = NO 531 532 # The GENERATE_TODOLIST tag can be used to enable (YES) or 533 # disable (NO) the todo list. This list is created by putting \todo 534 # commands in the documentation. 535 536 GENERATE_TODOLIST = YES 537 538 # The GENERATE_TESTLIST tag can be used to enable (YES) or 539 # disable (NO) the test list. This list is created by putting \test 540 # commands in the documentation. 541 542 GENERATE_TESTLIST = YES 543 544 # The GENERATE_BUGLIST tag can be used to enable (YES) or 545 # disable (NO) the bug list. This list is created by putting \bug 546 # commands in the documentation. 547 548 GENERATE_BUGLIST = YES 549 550 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 551 # disable (NO) the deprecated list. This list is created by putting 552 # \deprecated commands in the documentation. 553 554 GENERATE_DEPRECATEDLIST= YES 555 556 # The ENABLED_SECTIONS tag can be used to enable conditional 557 # documentation sections, marked by \if sectionname ... \endif. 558 559 ENABLED_SECTIONS = 560 561 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 562 # the initial value of a variable or macro consists of for it to appear in 563 # the documentation. If the initializer consists of more lines than specified 564 # here it will be hidden. Use a value of 0 to hide initializers completely. 565 # The appearance of the initializer of individual variables and macros in the 566 # documentation can be controlled using \showinitializer or \hideinitializer 567 # command in the documentation regardless of this setting. 568 569 MAX_INITIALIZER_LINES = 30 570 571 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 572 # at the bottom of the documentation of classes and structs. If set to YES the 573 # list will mention the files that were used to generate the documentation. 574 575 SHOW_USED_FILES = NO 576 577 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 578 # This will remove the Files entry from the Quick Index and from the 579 # Folder Tree View (if specified). The default is YES. 580 581 SHOW_FILES = YES 582 583 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 584 # Namespaces page. This will remove the Namespaces entry from the Quick Index 585 # and from the Folder Tree View (if specified). The default is YES. 586 587 SHOW_NAMESPACES = YES 588 589 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 590 # doxygen should invoke to get the current version for each file (typically from 591 # the version control system). Doxygen will invoke the program by executing (via 592 # popen()) the command <command> <input-file>, where <command> is the value of 593 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 594 # provided by doxygen. Whatever the program writes to standard output 595 # is used as the file version. See the manual for examples. 596 597 FILE_VERSION_FILTER = 598 599 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 600 # by doxygen. The layout file controls the global structure of the generated 601 # output files in an output format independent way. To create the layout file 602 # that represents doxygen's defaults, run doxygen with the -l option. 603 # You can optionally specify a file name after the option, if omitted 604 # DoxygenLayout.xml will be used as the name of the layout file. 605 606 LAYOUT_FILE = 607 608 # The CITE_BIB_FILES tag can be used to specify one or more bib files 609 # containing the references data. This must be a list of .bib files. The 610 # .bib extension is automatically appended if omitted. Using this command 611 # requires the bibtex tool to be installed. See also 612 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 613 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 614 # feature you need bibtex and perl available in the search path. 615 616 CITE_BIB_FILES = 617 618 #--------------------------------------------------------------------------- 619 # configuration options related to warning and progress messages 620 #--------------------------------------------------------------------------- 621 622 # The QUIET tag can be used to turn on/off the messages that are generated 623 # by doxygen. Possible values are YES and NO. If left blank NO is used. 624 625 QUIET = NO 626 627 # The WARNINGS tag can be used to turn on/off the warning messages that are 628 # generated by doxygen. Possible values are YES and NO. If left blank 629 # NO is used. 630 631 WARNINGS = YES 632 633 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 634 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 635 # automatically be disabled. 636 637 WARN_IF_UNDOCUMENTED = YES 638 639 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 640 # potential errors in the documentation, such as not documenting some 641 # parameters in a documented function, or documenting parameters that 642 # don't exist or using markup commands wrongly. 643 644 WARN_IF_DOC_ERROR = YES 645 646 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 647 # functions that are documented, but have no documentation for their parameters 648 # or return value. If set to NO (the default) doxygen will only warn about 649 # wrong or incomplete parameter documentation, but not about the absence of 650 # documentation. 651 652 WARN_NO_PARAMDOC = NO 653 654 # The WARN_FORMAT tag determines the format of the warning messages that 655 # doxygen can produce. The string should contain the$file, $line, and$text
656 # tags, which will be replaced by the file and line number from which the
657 # warning originated and the warning text. Optionally the format may contain
658 # $version, which will be replaced by the version of the file (if it could 659 # be obtained via FILE_VERSION_FILTER) 660 661 WARN_FORMAT = "$file:$line:$text"
662
663 # The WARN_LOGFILE tag can be used to specify a file to which warning
664 # and error messages should be written. If left blank the output is written
665 # to stderr.
666
667 WARN_LOGFILE =
668
669 #---------------------------------------------------------------------------
670 # configuration options related to the input files
671 #---------------------------------------------------------------------------
672
673 # The INPUT tag can be used to specify the files and/or directories that contain
674 # documented source files. You may enter file names like "myfile.cpp" or
675 # directories like "/usr/src/myproject". Separate the files or directories
676 # with spaces.
677
678 INPUT = ../glm \
679  .
680
681 # This tag can be used to specify the character encoding of the source files
682 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
683 # also the default input encoding. Doxygen uses libiconv (or the iconv built
684 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
685 # the list of possible encodings.
686
687 INPUT_ENCODING = UTF-8
688
689 # If the value of the INPUT tag contains directories, you can use the
690 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
691 # and *.h) to filter out the source-files in the directories. If left
692 # blank the following patterns are tested:
693 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
694 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
695 # *.f90 *.f *.for *.vhd *.vhdl
696
697 FILE_PATTERNS = *.hpp \
698  *.doxy
699
700 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
701 # should be searched for input files as well. Possible values are YES and NO.
702 # If left blank NO is used.
703
704 RECURSIVE = YES
705
706 # The EXCLUDE tag can be used to specify files and/or directories that should be
707 # excluded from the INPUT source files. This way you can easily exclude a
708 # subdirectory from a directory tree whose root is specified with the INPUT tag.
709 # Note that relative paths are relative to the directory from which doxygen is
710 # run.
711
712 EXCLUDE =
713
714 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
715 # directories that are symbolic links (a Unix file system feature) are excluded
716 # from the input.
717
719
720 # If the value of the INPUT tag contains directories, you can use the
721 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
722 # certain files from those directories. Note that the wildcards are matched
723 # against the file with absolute path, so to exclude all test directories
724 # for example use the pattern */test/*
725
726 EXCLUDE_PATTERNS =
727
728 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
729 # (namespaces, classes, functions, etc.) that should be excluded from the
730 # output. The symbol name can be a fully qualified name, a word, or if the
731 # wildcard * is used, a substring. Examples: ANamespace, AClass,
732 # AClass::ANamespace, ANamespace::*Test
733
734 EXCLUDE_SYMBOLS =
735
736 # The EXAMPLE_PATH tag can be used to specify one or more files or
737 # directories that contain example code fragments that are included (see
738 # the \include command).
739
740 EXAMPLE_PATH =
741
742 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
743 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
744 # and *.h) to filter out the source-files in the directories. If left
745 # blank all files are included.
746
747 EXAMPLE_PATTERNS = *
748
749 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
750 # searched for input files to be used with the \include or \dontinclude
751 # commands irrespective of the value of the RECURSIVE tag.
752 # Possible values are YES and NO. If left blank NO is used.
753
754 EXAMPLE_RECURSIVE = NO
755
756 # The IMAGE_PATH tag can be used to specify one or more files or
757 # directories that contain image that are included in the documentation (see
758 # the \image command).
759
760 IMAGE_PATH =
761
762 # The INPUT_FILTER tag can be used to specify a program that doxygen should
763 # invoke to filter for each input file. Doxygen will invoke the filter program
764 # by executing (via popen()) the command <filter> <input-file>, where <filter>
765 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
766 # input file. Doxygen will then use the output that the filter program writes
767 # to standard output. If FILTER_PATTERNS is specified, this tag will be
768 # ignored.
769
770 INPUT_FILTER =
771
772 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
773 # basis. Doxygen will compare the file name with each pattern and apply the
774 # filter if there is a match. The filters are a list of the form:
775 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
776 # info on how filters are used. If FILTER_PATTERNS is empty or if
777 # non of the patterns match the file name, INPUT_FILTER is applied.
778
779 FILTER_PATTERNS =
780
781 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
782 # INPUT_FILTER) will be used to filter the input files when producing source
783 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
784
785 FILTER_SOURCE_FILES = NO
786
787 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
788 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
789 # and it is also possible to disable source filtering for a specific pattern
790 # using *.ext= (so without naming a filter). This option only has effect when
791 # FILTER_SOURCE_FILES is enabled.
792
793 FILTER_SOURCE_PATTERNS =
794
795 #---------------------------------------------------------------------------
796 # configuration options related to source browsing
797 #---------------------------------------------------------------------------
798
799 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
800 # be generated. Documented entities will be cross-referenced with these sources.
801 # Note: To get rid of all source code in the generated output, make sure also
802 # VERBATIM_HEADERS is set to NO.
803
804 SOURCE_BROWSER = YES
805
806 # Setting the INLINE_SOURCES tag to YES will include the body
807 # of functions and classes directly in the documentation.
808
809 INLINE_SOURCES = NO
810
811 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
812 # doxygen to hide any special comment blocks from generated source code
813 # fragments. Normal C, C++ and Fortran comments will always remain visible.
814
816
817 # If the REFERENCED_BY_RELATION tag is set to YES
818 # then for each documented function all documented
819 # functions referencing it will be listed.
820
821 REFERENCED_BY_RELATION = YES
822
823 # If the REFERENCES_RELATION tag is set to YES
824 # then for each documented function all documented entities
825 # called/used by that function will be listed.
826
827 REFERENCES_RELATION = YES
828
829 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
830 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
831 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
832 # link to the source code. Otherwise they will link to the documentation.
833
835
836 # If the USE_HTAGS tag is set to YES then the references to source code
837 # will point to the HTML generated by the htags(1) tool instead of doxygen
838 # built-in source browser. The htags tool is part of GNU's global source
839 # tagging system (see http://www.gnu.org/software/global/global.html). You
840 # will need version 4.8.6 or higher.
841
842 USE_HTAGS = NO
843
844 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
845 # will generate a verbatim copy of the header file for each class for
846 # which an include is specified. Set to NO to disable this.
847
849
850 #---------------------------------------------------------------------------
851 # configuration options related to the alphabetical class index
852 #---------------------------------------------------------------------------
853
854 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
855 # of all compounds will be generated. Enable this if the project
856 # contains a lot of classes, structs, unions or interfaces.
857
858 ALPHABETICAL_INDEX = NO
859
860 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
861 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
862 # in which this list will be split (can be a number in the range [1..20])
863
864 COLS_IN_ALPHA_INDEX = 5
865
866 # In case all classes in a project start with a common prefix, all
867 # classes will be put under the same header in the alphabetical index.
868 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
869 # should be ignored while generating the index headers.
870
871 IGNORE_PREFIX =
872
873 #---------------------------------------------------------------------------
874 # configuration options related to the HTML output
875 #---------------------------------------------------------------------------
876
877 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
878 # generate HTML output.
879
880 GENERATE_HTML = YES
881
882 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
883 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
884 # put in front of it. If left blank html' will be used as the default path.
885
886 HTML_OUTPUT = html
887
888 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
889 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
890 # doxygen will generate files with .html extension.
891
892 HTML_FILE_EXTENSION = .html
893
894 # The HTML_HEADER tag can be used to specify a personal HTML header for
895 # each generated HTML page. If it is left blank doxygen will generate a
896 # standard header. Note that when using a custom header you are responsible
897 # for the proper inclusion of any scripts and style sheets that doxygen
898 # needs, which is dependent on the configuration options used.
899 # It is advised to generate a default header using "doxygen -w html
900 # header.html footer.html stylesheet.css YourConfigFile" and then modify
901 # that header. Note that the header is subject to change so you typically
902 # have to redo this when upgrading to a newer version of doxygen or when
903 # changing the value of configuration settings such as GENERATE_TREEVIEW!
904
906
907 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
908 # each generated HTML page. If it is left blank doxygen will generate a
909 # standard footer.
910
911 HTML_FOOTER =
912
913 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
914 # style sheet that is used by each HTML page. It can be used to
915 # fine-tune the look of the HTML output. If left blank doxygen will
916 # generate a default style sheet. Note that it is recommended to use
917 # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
918 # tag will in the future become obsolete.
919
920 HTML_STYLESHEET =
921
922 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
923 # user-defined cascading style sheet that is included after the standard
924 # style sheets created by doxygen. Using this option one can overrule
925 # certain style aspects. This is preferred over using HTML_STYLESHEET
926 # since it does not replace the standard style sheet and is therefor more
927 # robust against future updates. Doxygen will copy the style sheet file to
928 # the output directory.
929
930 HTML_EXTRA_STYLESHEET =
931
932 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
933 # other source files which should be copied to the HTML output directory. Note
934 # that these files will be copied to the base HTML output directory. Use the
935 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
936 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
937 # the files will be copied as-is; there are no commands or markers available.
938
939 HTML_EXTRA_FILES =
940
941 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
942 # Doxygen will adjust the colors in the style sheet and background images
943 # according to this color. Hue is specified as an angle on a colorwheel,
945 # For instance the value 0 represents red, 60 is yellow, 120 is green,
946 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
947 # The allowed range is 0 to 359.
948
949 HTML_COLORSTYLE_HUE = 220
950
951 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
952 # the colors in the HTML output. For a value of 0 the output will use
953 # grayscales only. A value of 255 will produce the most vivid colors.
954
955 HTML_COLORSTYLE_SAT = 100
956
957 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
958 # the luminance component of the colors in the HTML output. Values below
959 # 100 gradually make the output lighter, whereas values above 100 make
960 # the output darker. The value divided by 100 is the actual gamma applied,
961 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
962 # and 100 does not change the gamma.
963
964 HTML_COLORSTYLE_GAMMA = 80
965
966 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
967 # page will contain the date and time when the page was generated. Setting
968 # this to NO can help when comparing the output of multiple runs.
969
970 HTML_TIMESTAMP = NO
971
972 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
973 # documentation will contain sections that can be hidden and shown after the
975
976 HTML_DYNAMIC_SECTIONS = NO
977
978 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
979 # entries shown in the various tree structured indices initially; the user
980 # can expand and collapse entries dynamically later on. Doxygen will expand
981 # the tree to such a level that at most the specified number of entries are
982 # visible (unless a fully collapsed tree already exceeds this amount).
983 # So setting the number of entries 1 will produce a full collapsed tree by
984 # default. 0 is a special value representing an infinite number of entries
985 # and will result in a full expanded tree by default.
986
987 HTML_INDEX_NUM_ENTRIES = 100
988
989 # If the GENERATE_DOCSET tag is set to YES, additional index files
990 # will be generated that can be used as input for Apple's Xcode 3
991 # integrated development environment, introduced with OSX 10.5 (Leopard).
992 # To create a documentation set, doxygen will generate a Makefile in the
993 # HTML output directory. Running make will produce the docset in that
994 # directory and running "make install" will install the docset in
995 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
996 # it at startup.
997 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
999
1000 GENERATE_DOCSET = NO
1001
1002 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1003 # feed. A documentation feed provides an umbrella under which multiple
1004 # documentation sets from a single provider (such as a company or product suite)
1005 # can be grouped.
1006
1007 DOCSET_FEEDNAME = "Doxygen generated docs"
1008
1009 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1010 # should uniquely identify the documentation set bundle. This should be a
1011 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1012 # will append .docset to the name.
1013
1014 DOCSET_BUNDLE_ID = org.doxygen.Project
1015
1016 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1017 # identify the documentation publisher. This should be a reverse domain-name
1018 # style string, e.g. com.mycompany.MyDocSet.documentation.
1019
1020 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1021
1022 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1023
1024 DOCSET_PUBLISHER_NAME = Publisher
1025
1026 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1027 # will be generated that can be used as input for tools like the
1028 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1029 # of the generated HTML documentation.
1030
1031 GENERATE_HTMLHELP = NO
1032
1033 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1034 # be used to specify the file name of the resulting .chm file. You
1035 # can add a path in front of the file if the result should not be
1036 # written to the html output directory.
1037
1038 CHM_FILE =
1039
1040 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1041 # be used to specify the location (absolute path including file name) of
1042 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1043 # the HTML help compiler on the generated index.hhp.
1044
1045 HHC_LOCATION =
1046
1047 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1048 # controls if a separate .chi index file is generated (YES) or that
1049 # it should be included in the master .chm file (NO).
1050
1051 GENERATE_CHI = NO
1052
1053 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1054 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1055 # content.
1056
1057 CHM_INDEX_ENCODING =
1058
1059 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1062
1063 BINARY_TOC = NO
1064
1065 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1066 # to the contents of the HTML help documentation and to the tree view.
1067
1068 TOC_EXPAND = NO
1069
1070 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1071 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1072 # that can be used as input for Qt's qhelpgenerator to generate a
1073 # Qt Compressed Help (.qch) of the generated HTML documentation.
1074
1075 GENERATE_QHP = NO
1076
1077 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1078 # be used to specify the file name of the resulting .qch file.
1079 # The path specified is relative to the HTML output folder.
1080
1081 QCH_FILE =
1082
1083 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1085 # http://doc.trolltech.com/qthelpproject.html#namespace
1086
1087 QHP_NAMESPACE = org.doxygen.Project
1088
1089 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1091 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1092
1093 QHP_VIRTUAL_FOLDER = doc
1094
1095 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1097 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1098
1099 QHP_CUST_FILTER_NAME =
1100
1101 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1103 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1104 # Qt Help Project / Custom Filters</a>.
1105
1106 QHP_CUST_FILTER_ATTRS =
1107
1108 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1109 # project's
1110 # filter section matches.
1111 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1112 # Qt Help Project / Filter Attributes</a>.
1113
1114 QHP_SECT_FILTER_ATTRS =
1115
1116 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1117 # be used to specify the location of Qt's qhelpgenerator.
1118 # If non-empty doxygen will try to run qhelpgenerator on the generated
1119 # .qhp file.
1120
1121 QHG_LOCATION =
1122
1123 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1124 # will be generated, which together with the HTML files, form an Eclipse help
1125 # plugin. To install this plugin and make it available under the help contents
1126 # menu in Eclipse, the contents of the directory containing the HTML and XML
1127 # files needs to be copied into the plugins directory of eclipse. The name of
1128 # the directory within the plugins directory should be the same as
1129 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1130 # the help appears.
1131
1132 GENERATE_ECLIPSEHELP = NO
1133
1134 # A unique identifier for the eclipse help plugin. When installing the plugin
1135 # the directory name containing the HTML and XML files should also have
1136 # this name.
1137
1138 ECLIPSE_DOC_ID = org.doxygen.Project
1139
1140 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1141 # at top of each HTML page. The value NO (the default) enables the index and
1142 # the value YES disables it. Since the tabs have the same information as the
1143 # navigation tree you can set this option to NO if you already set
1144 # GENERATE_TREEVIEW to YES.
1145
1146 DISABLE_INDEX = NO
1147
1148 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1149 # structure should be generated to display hierarchical information.
1150 # If the tag value is set to YES, a side panel will be generated
1151 # containing a tree-like index structure (just like the one that
1152 # is generated for HTML Help). For this to work a browser that supports
1153 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1154 # Windows users are probably better off using the HTML help feature.
1155 # Since the tree basically has the same information as the tab index you
1156 # could consider to set DISABLE_INDEX to NO when enabling this option.
1157
1158 GENERATE_TREEVIEW = NO
1159
1160 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1161 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1162 # documentation. Note that a value of 0 will completely suppress the enum
1163 # values from appearing in the overview section.
1164
1165 ENUM_VALUES_PER_LINE = 4
1166
1167 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1168 # used to set the initial width (in pixels) of the frame in which the tree
1169 # is shown.
1170
1171 TREEVIEW_WIDTH = 250
1172
1173 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1174 # links to external symbols imported via tag files in a separate window.
1175
1177
1178 # Use this tag to change the font size of Latex formulas included
1179 # as images in the HTML documentation. The default is 10. Note that
1180 # when you change the font size after a successful doxygen run you need
1181 # to manually remove any form_*.png images from the HTML output directory
1182 # to force them to be regenerated.
1183
1184 FORMULA_FONTSIZE = 10
1185
1186 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1187 # generated for formulas are transparent PNGs. Transparent PNGs are
1188 # not supported properly for IE 6.0, but are supported on all modern browsers.
1189 # Note that when changing this option you need to delete any form_*.png files
1190 # in the HTML output before the changes have effect.
1191
1192 FORMULA_TRANSPARENT = YES
1193
1194 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1195 # (see http://www.mathjax.org) which uses client side Javascript for the
1196 # rendering instead of using prerendered bitmaps. Use this if you do not
1197 # have LaTeX installed or if you want to formulas look prettier in the HTML
1198 # output. When enabled you may also need to install MathJax separately and
1199 # configure the path to it using the MATHJAX_RELPATH option.
1200
1201 USE_MATHJAX = NO
1202
1203 # When MathJax is enabled you need to specify the location relative to the
1204 # HTML output directory using the MATHJAX_RELPATH option. The destination
1205 # directory should contain the MathJax.js script. For instance, if the mathjax
1206 # directory is located at the same level as the HTML output directory, then
1207 # MATHJAX_RELPATH should be ../mathjax. The default value points to
1208 # the MathJax Content Delivery Network so you can quickly see the result without
1209 # installing MathJax. However, it is strongly recommended to install a local
1210 # copy of MathJax from http://www.mathjax.org before deployment.
1211
1212 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1213
1214 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1215 # names that should be enabled during MathJax rendering.
1216
1217 MATHJAX_EXTENSIONS =
1218
1219 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1220 # for the HTML output. The underlying search engine uses javascript
1221 # and DHTML and should work on any modern browser. Note that when using
1222 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1223 # (GENERATE_DOCSET) there is already a search function so this one should
1224 # typically be disabled. For large projects the javascript based search engine
1225 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1226
1227 SEARCHENGINE = NO
1228
1229 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1230 # implemented using a PHP enabled web server instead of at the web client
1231 # using Javascript. Doxygen will generate the search PHP script and index
1232 # file to put on the web server. The advantage of the server
1233 # based approach is that it scales better to large projects and allows
1234 # full text search. The disadvantages are that it is more difficult to setup
1235 # and does not have live searching capabilities.
1236
1237 SERVER_BASED_SEARCH = NO
1238
1239 #---------------------------------------------------------------------------
1240 # configuration options related to the LaTeX output
1241 #---------------------------------------------------------------------------
1242
1243 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1244 # generate Latex output.
1245
1246 GENERATE_LATEX = NO
1247
1248 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1249 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1250 # put in front of it. If left blank latex' will be used as the default path.
1251
1252 LATEX_OUTPUT = latex
1253
1254 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1255 # invoked. If left blank latex' will be used as the default command name.
1256 # Note that when enabling USE_PDFLATEX this option is only used for
1257 # generating bitmaps for formulas in the HTML output, but not in the
1258 # Makefile that is written to the output directory.
1259
1260 LATEX_CMD_NAME = latex
1261
1262 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1263 # generate index for LaTeX. If left blank makeindex' will be used as the
1264 # default command name.
1265
1266 MAKEINDEX_CMD_NAME = makeindex
1267
1268 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1269 # LaTeX documents. This may be useful for small projects and may help to
1270 # save some trees in general.
1271
1272 COMPACT_LATEX = NO
1273
1274 # The PAPER_TYPE tag can be used to set the paper type that is used
1275 # by the printer. Possible values are: a4, letter, legal and
1276 # executive. If left blank a4wide will be used.
1277
1278 PAPER_TYPE = a4wide
1279
1280 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1281 # packages that should be included in the LaTeX output.
1282
1283 EXTRA_PACKAGES =
1284
1285 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1286 # the generated latex document. The header should contain everything until
1287 # the first chapter. If it is left blank doxygen will generate a
1288 # standard header. Notice: only use this tag if you know what you are doing!
1289
1291
1292 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1293 # the generated latex document. The footer should contain everything after
1294 # the last chapter. If it is left blank doxygen will generate a
1295 # standard footer. Notice: only use this tag if you know what you are doing!
1296
1297 LATEX_FOOTER =
1298
1299 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1300 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1301 # contain links (just like the HTML output) instead of page references
1302 # This makes the output suitable for online browsing using a pdf viewer.
1303
1305
1306 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1307 # plain latex in the generated Makefile. Set this option to YES to get a
1308 # higher quality PDF documentation.
1309
1310 USE_PDFLATEX = YES
1311
1312 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1313 # command to the generated LaTeX files. This will instruct LaTeX to keep
1314 # running if errors occur, instead of asking the user for help.
1315 # This option is also used when generating formulas in HTML.
1316
1317 LATEX_BATCHMODE = NO
1318
1319 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1320 # include the index chapters (such as File Index, Compound Index, etc.)
1321 # in the output.
1322
1323 LATEX_HIDE_INDICES = NO
1324
1325 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1326 # source code with syntax highlighting in the LaTeX output.
1327 # Note that which sources are shown also depends on other settings
1328 # such as SOURCE_BROWSER.
1329
1330 LATEX_SOURCE_CODE = NO
1331
1332 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1333 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1335
1336 LATEX_BIB_STYLE = plain
1337
1338 #---------------------------------------------------------------------------
1339 # configuration options related to the RTF output
1340 #---------------------------------------------------------------------------
1341
1342 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1343 # The RTF output is optimized for Word 97 and may not look very pretty with
1344 # other RTF readers or editors.
1345
1346 GENERATE_RTF = NO
1347
1348 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1349 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1350 # put in front of it. If left blank rtf' will be used as the default path.
1351
1352 RTF_OUTPUT = glm.rtf
1353
1354 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1355 # RTF documents. This may be useful for small projects and may help to
1356 # save some trees in general.
1357
1358 COMPACT_RTF = NO
1359
1360 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1361 # will contain hyperlink fields. The RTF file will
1362 # contain links (just like the HTML output) instead of page references.
1363 # This makes the output suitable for online browsing using WORD or other
1364 # programs which support those fields.
1366
1368
1369 # Load style sheet definitions from file. Syntax is similar to doxygen's
1370 # config file, i.e. a series of assignments. You only have to provide
1371 # replacements, missing definitions are set to their default value.
1372
1373 RTF_STYLESHEET_FILE =
1374
1375 # Set optional variables used in the generation of an rtf document.
1376 # Syntax is similar to doxygen's config file.
1377
1378 RTF_EXTENSIONS_FILE =
1379
1380 #---------------------------------------------------------------------------
1381 # configuration options related to the man page output
1382 #---------------------------------------------------------------------------
1383
1384 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1385 # generate man pages
1386
1387 GENERATE_MAN = NO
1388
1389 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1390 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1391 # put in front of it. If left blank man' will be used as the default path.
1392
1393 MAN_OUTPUT = man
1394
1395 # The MAN_EXTENSION tag determines the extension that is added to
1396 # the generated man pages (default is the subroutine's section .3)
1397
1398 MAN_EXTENSION = .3
1399
1400 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1401 # then it will generate one additional man file for each entity
1402 # documented in the real man page(s). These additional files
1403 # only source the real man page, but without them the man command
1404 # would be unable to find the correct page. The default is NO.
1405
1407
1408 #---------------------------------------------------------------------------
1409 # configuration options related to the XML output
1410 #---------------------------------------------------------------------------
1411
1412 # If the GENERATE_XML tag is set to YES Doxygen will
1413 # generate an XML file that captures the structure of
1414 # the code including all documentation.
1415
1416 GENERATE_XML = NO
1417
1418 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1419 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1420 # put in front of it. If left blank xml' will be used as the default path.
1421
1422 XML_OUTPUT = xml
1423
1424 # The XML_SCHEMA tag can be used to specify an XML schema,
1425 # which can be used by a validating XML parser to check the
1426 # syntax of the XML files.
1427
1428 XML_SCHEMA =
1429
1430 # The XML_DTD tag can be used to specify an XML DTD,
1431 # which can be used by a validating XML parser to check the
1432 # syntax of the XML files.
1433
1434 XML_DTD =
1435
1436 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1437 # dump the program listings (including syntax highlighting
1438 # and cross-referencing information) to the XML output. Note that
1439 # enabling this will significantly increase the size of the XML output.
1440
1441 XML_PROGRAMLISTING = YES
1442
1443 #---------------------------------------------------------------------------
1444 # configuration options for the AutoGen Definitions output
1445 #---------------------------------------------------------------------------
1446
1447 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1448 # generate an AutoGen Definitions (see autogen.sf.net) file
1449 # that captures the structure of the code including all
1450 # documentation. Note that this feature is still experimental
1451 # and incomplete at the moment.
1452
1453 GENERATE_AUTOGEN_DEF = NO
1454
1455 #---------------------------------------------------------------------------
1456 # configuration options related to the Perl module output
1457 #---------------------------------------------------------------------------
1458
1459 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1460 # generate a Perl module file that captures the structure of
1461 # the code including all documentation. Note that this
1462 # feature is still experimental and incomplete at the
1463 # moment.
1464
1465 GENERATE_PERLMOD = NO
1466
1467 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1468 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1469 # to generate PDF and DVI output from the Perl module output.
1470
1471 PERLMOD_LATEX = NO
1472
1473 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1474 # nicely formatted so it can be parsed by a human reader. This is useful
1475 # if you want to understand what is going on. On the other hand, if this
1476 # tag is set to NO the size of the Perl module output will be much smaller
1477 # and Perl will parse it just the same.
1478
1479 PERLMOD_PRETTY = YES
1480
1481 # The names of the make variables in the generated doxyrules.make file
1482 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1483 # This is useful so different doxyrules.make files included by the same
1484 # Makefile don't overwrite each other's variables.
1485
1486 PERLMOD_MAKEVAR_PREFIX =
1487
1488 #---------------------------------------------------------------------------
1489 # Configuration options related to the preprocessor
1490 #---------------------------------------------------------------------------
1491
1492 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1493 # evaluate all C-preprocessor directives found in the sources and include
1494 # files.
1495
1496 ENABLE_PREPROCESSING = YES
1497
1498 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1499 # names in the source code. If set to NO (the default) only conditional
1500 # compilation will be performed. Macro expansion can be done in a controlled
1501 # way by setting EXPAND_ONLY_PREDEF to YES.
1502
1503 MACRO_EXPANSION = NO
1504
1505 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1506 # then the macro expansion is limited to the macros specified with the
1507 # PREDEFINED and EXPAND_AS_DEFINED tags.
1508
1509 EXPAND_ONLY_PREDEF = NO
1510
1511 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1512 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1513
1514 SEARCH_INCLUDES = YES
1515
1516 # The INCLUDE_PATH tag can be used to specify one or more directories that
1517 # contain include files that are not input files but should be processed by
1518 # the preprocessor.
1519
1520 INCLUDE_PATH =
1521
1522 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1523 # patterns (like *.h and *.hpp) to filter out the header-files in the
1524 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1525 # be used.
1526
1527 INCLUDE_FILE_PATTERNS =
1528
1529 # The PREDEFINED tag can be used to specify one or more macro names that
1530 # are defined before the preprocessor is started (similar to the -D option of
1531 # gcc). The argument of the tag is a list of macros of the form: name
1532 # or name=definition (no spaces). If the definition and the = are
1533 # omitted =1 is assumed. To prevent a macro definition from being
1534 # undefined via #undef or recursively expanded use the := operator
1535 # instead of the = operator.
1536
1537 PREDEFINED =
1538
1539 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1540 # this tag can be used to specify a list of macro names that should be expanded.
1541 # The macro definition that is found in the sources will be used.
1542 # Use the PREDEFINED tag if you want to use a different macro definition that
1543 # overrules the definition found in the source code.
1544
1545 EXPAND_AS_DEFINED =
1546
1547 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1548 # doxygen's preprocessor will remove all references to function-like macros
1549 # that are alone on a line, have an all uppercase name, and do not end with a
1550 # semicolon, because these will confuse the parser if not removed.
1551
1552 SKIP_FUNCTION_MACROS = YES
1553
1554 #---------------------------------------------------------------------------
1555 # Configuration::additions related to external references
1556 #---------------------------------------------------------------------------
1557
1558 # The TAGFILES option can be used to specify one or more tagfiles. For each
1559 # tag file the location of the external documentation should be added. The
1560 # format of a tag file without this location is as follows:
1561 # TAGFILES = file1 file2 ...
1562 # Adding location for the tag files is done as follows:
1563 # TAGFILES = file1=loc1 "file2 = loc2" ...
1564 # where "loc1" and "loc2" can be relative or absolute paths
1565 # or URLs. Note that each tag file must have a unique name (where the name does
1566 # NOT include the path). If a tag file is not located in the directory in which
1567 # doxygen is run, you must also specify the path to the tagfile here.
1568
1569 TAGFILES =
1570
1571 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1572 # a tag file that is based on the input files it reads.
1573
1574 GENERATE_TAGFILE =
1575
1576 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1577 # in the class index. If set to NO only the inherited external classes
1578 # will be listed.
1579
1580 ALLEXTERNALS = NO
1581
1582 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1583 # in the modules index. If set to NO, only the current project's groups will
1584 # be listed.
1585
1586 EXTERNAL_GROUPS = YES
1587
1588 # The PERL_PATH should be the absolute path and name of the perl script
1589 # interpreter (i.e. the result of which perl').
1590
1591 PERL_PATH = /usr/bin/perl
1592
1593 #---------------------------------------------------------------------------
1594 # Configuration options related to the dot tool
1595 #---------------------------------------------------------------------------
1596
1597 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1598 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1599 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1600 # this option also works with HAVE_DOT disabled, but it is recommended to
1601 # install and use dot, since it yields more powerful graphs.
1602
1603 CLASS_DIAGRAMS = YES
1604
1605 # You can define message sequence charts within doxygen comments using the \msc
1606 # command. Doxygen will then run the mscgen tool (see
1607 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1608 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1609 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1610 # default search path.
1611
1612 MSCGEN_PATH =
1613
1614 # If set to YES, the inheritance and collaboration graphs will hide
1615 # inheritance and usage relations if the target is undocumented
1616 # or is not a class.
1617
1618 HIDE_UNDOC_RELATIONS = YES
1619
1620 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1621 # available from the path. This tool is part of Graphviz, a graph visualization
1622 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1623 # have no effect if this option is set to NO (the default)
1624
1625 HAVE_DOT = NO
1626
1627 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1628 # allowed to run in parallel. When set to 0 (the default) doxygen will
1629 # base this on the number of processors available in the system. You can set it
1630 # explicitly to a value larger than 0 to get control over the balance
1631 # between CPU load and processing speed.
1632
1634
1635 # By default doxygen will use the Helvetica font for all dot files that
1636 # doxygen generates. When you want a differently looking font you can specify
1637 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1638 # the font, which can be done by putting it in a standard location or by setting
1639 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1640 # directory containing the font.
1641
1642 DOT_FONTNAME = FreeSans
1643
1644 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1645 # The default size is 10pt.
1646
1647 DOT_FONTSIZE = 10
1648
1649 # By default doxygen will tell dot to use the Helvetica font.
1650 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1651 # set the path where dot can find it.
1652
1653 DOT_FONTPATH =
1654
1655 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1656 # will generate a graph for each documented class showing the direct and
1657 # indirect inheritance relations. Setting this tag to YES will force the
1658 # CLASS_DIAGRAMS tag to NO.
1659
1660 CLASS_GRAPH = YES
1661
1662 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1663 # will generate a graph for each documented class showing the direct and
1664 # indirect implementation dependencies (inheritance, containment, and
1665 # class references variables) of the class with other documented classes.
1666
1667 COLLABORATION_GRAPH = YES
1668
1669 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1670 # will generate a graph for groups, showing the direct groups dependencies
1671
1672 GROUP_GRAPHS = YES
1673
1674 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1675 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1676 # Language.
1677
1678 UML_LOOK = NO
1679
1680 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
1681 # the class node. If there are many fields or methods and many nodes the
1682 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1683 # threshold limits the number of items for each type to make the size more
1684 # managable. Set this to 0 for no limit. Note that the threshold may be
1685 # exceeded by 50% before the limit is enforced.
1686
1687 UML_LIMIT_NUM_FIELDS = 10
1688
1689 # If set to YES, the inheritance and collaboration graphs will show the
1690 # relations between templates and their instances.
1691
1692 TEMPLATE_RELATIONS = NO
1693
1694 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1695 # tags are set to YES then doxygen will generate a graph for each documented
1696 # file showing the direct and indirect include dependencies of the file with
1697 # other documented files.
1698
1699 INCLUDE_GRAPH = YES
1700
1701 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1702 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1703 # documented header file showing the documented files that directly or
1704 # indirectly include this file.
1705
1706 INCLUDED_BY_GRAPH = YES
1707
1708 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1709 # doxygen will generate a call dependency graph for every global function
1710 # or class method. Note that enabling this option will significantly increase
1711 # the time of a run. So in most cases it will be better to enable call graphs
1712 # for selected functions only using the \callgraph command.
1713
1714 CALL_GRAPH = YES
1715
1716 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1717 # doxygen will generate a caller dependency graph for every global function
1718 # or class method. Note that enabling this option will significantly increase
1719 # the time of a run. So in most cases it will be better to enable caller
1720 # graphs for selected functions only using the \callergraph command.
1721
1722 CALLER_GRAPH = YES
1723
1724 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1725 # will generate a graphical hierarchy of all classes instead of a textual one.
1726
1727 GRAPHICAL_HIERARCHY = YES
1728
1729 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1730 # then doxygen will show the dependencies a directory has on other directories
1731 # in a graphical way. The dependency relations are determined by the #include
1732 # relations between the files in the directories.
1733
1734 DIRECTORY_GRAPH = YES
1735
1736 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1737 # generated by dot. Possible values are svg, png, jpg, or gif.
1738 # If left blank png will be used. If you choose svg you need to set
1739 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1740 # visible in IE 9+ (other browsers do not have this requirement).
1741
1742 DOT_IMAGE_FORMAT = png
1743
1744 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1745 # enable generation of interactive SVG images that allow zooming and panning.
1746 # Note that this requires a modern browser other than Internet Explorer.
1747 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1748 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1749 # visible. Older versions of IE do not have SVG support.
1750
1751 INTERACTIVE_SVG = NO
1752
1753 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1754 # found. If left blank, it is assumed the dot tool can be found in the path.
1755
1756 DOT_PATH =
1757
1758 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1759 # contain dot files that are included in the documentation (see the
1760 # \dotfile command).
1761
1762 DOTFILE_DIRS =
1763
1764 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1765 # contain msc files that are included in the documentation (see the
1766 # \mscfile command).
1767
1768 MSCFILE_DIRS =
1769
1770 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1771 # nodes that will be shown in the graph. If the number of nodes in a graph
1772 # becomes larger than this value, doxygen will truncate the graph, which is
1773 # visualized by representing a node as a red box. Note that doxygen if the
1774 # number of direct children of the root node in a graph is already larger than
1775 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1776 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1777
1778 DOT_GRAPH_MAX_NODES = 50
1779
1780 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1781 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1782 # from the root by following a path via at most 3 edges will be shown. Nodes
1783 # that lay further from the root node will be omitted. Note that setting this
1784 # option to 1 or 2 may greatly reduce the computation time needed for large
1785 # code bases. Also note that the size of a graph can be further restricted by
1786 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1787
1788 MAX_DOT_GRAPH_DEPTH = 1000
1789
1790 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1791 # background. This is disabled by default, because dot on Windows does not
1792 # seem to support this out of the box. Warning: Depending on the platform used,
1793 # enabling this option may lead to badly anti-aliased labels on the edges of
1794 # a graph (i.e. they become hard to read).
1795
1796 DOT_TRANSPARENT = NO
1797
1798 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1799 # files in one run (i.e. multiple -o and -T options on the command line). This
1800 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1801 # support this, this feature is disabled by default.
1802
1803 DOT_MULTI_TARGETS = NO
1804
1805 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1806 # generate a legend page explaining the meaning of the various boxes and
1807 # arrows in the dot generated graphs.
1808
1809 GENERATE_LEGEND = YES
1810
1811 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1812 # remove the intermediate dot files that are used to generate
1813 # the various graphs.
1814
1815 DOT_CLEANUP = YES