diff options
Diffstat (limited to 'doxygen.cfg.in')
| -rw-r--r-- | doxygen.cfg.in | 513 |
1 files changed, 333 insertions, 180 deletions
diff --git a/doxygen.cfg.in b/doxygen.cfg.in index dfe354a..3455c3b 100644 --- a/doxygen.cfg.in +++ b/doxygen.cfg.in | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | # Doxyfile 1.8.8 | 1 | # Doxyfile 1.8.16 |
| 2 | 2 | ||
| 3 | # This file describes the settings to be used by the documentation system | 3 | # This file describes the settings to be used by the documentation system |
| 4 | # doxygen (www.doxygen.org) for a project. | 4 | # doxygen (www.doxygen.org) for a project. |
| @@ -17,11 +17,11 @@ | |||
| 17 | # Project related configuration options | 17 | # Project related configuration options |
| 18 | #--------------------------------------------------------------------------- | 18 | #--------------------------------------------------------------------------- |
| 19 | 19 | ||
| 20 | # This tag specifies the encoding used for all characters in the config file | 20 | # This tag specifies the encoding used for all characters in the configuration |
| 21 | # that follow. The default is UTF-8 which is also the encoding used for all text | 21 | # file that follow. The default is UTF-8 which is also the encoding used for all |
| 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv | 22 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the |
| 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv | 23 | # iconv built into libc) for the transcoding. See |
| 24 | # for the list of possible encodings. | 24 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. |
| 25 | # The default value is: UTF-8. | 25 | # The default value is: UTF-8. |
| 26 | 26 | ||
| 27 | DOXYFILE_ENCODING = UTF-8 | 27 | DOXYFILE_ENCODING = UTF-8 |
| @@ -44,12 +44,12 @@ PROJECT_NUMBER = @VERSION@ | |||
| 44 | # for a project that appears at the top of each page and should give viewer a | 44 | # for a project that appears at the top of each page and should give viewer a |
| 45 | # quick idea about the purpose of the project. Keep the description short. | 45 | # quick idea about the purpose of the project. Keep the description short. |
| 46 | 46 | ||
| 47 | PROJECT_BRIEF = | 47 | PROJECT_BRIEF = "API Documentation" |
| 48 | 48 | ||
| 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included |
| 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels | 50 | # in the documentation. The maximum height of the logo should not exceed 55 |
| 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo | 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
| 52 | # to the output directory. | 52 | # the logo to the output directory. |
| 53 | 53 | ||
| 54 | PROJECT_LOGO = | 54 | PROJECT_LOGO = |
| 55 | 55 | ||
| @@ -60,7 +60,7 @@ PROJECT_LOGO = | |||
| 60 | 60 | ||
| 61 | OUTPUT_DIRECTORY = docs | 61 | OUTPUT_DIRECTORY = docs |
| 62 | 62 | ||
| 63 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- |
| 64 | # directories (in 2 levels) under the output directory of each output format and | 64 | # directories (in 2 levels) under the output directory of each output format and |
| 65 | # will distribute the generated files over these directories. Enabling this | 65 | # will distribute the generated files over these directories. Enabling this |
| 66 | # option can be useful when feeding doxygen a huge amount of source files, where | 66 | # option can be useful when feeding doxygen a huge amount of source files, where |
| @@ -93,14 +93,22 @@ ALLOW_UNICODE_NAMES = NO | |||
| 93 | 93 | ||
| 94 | OUTPUT_LANGUAGE = English | 94 | OUTPUT_LANGUAGE = English |
| 95 | 95 | ||
| 96 | # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member | 96 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all |
| 97 | # documentation generated by doxygen is written. Doxygen will use this | ||
| 98 | # information to generate all generated output in the proper direction. | ||
| 99 | # Possible values are: None, LTR, RTL and Context. | ||
| 100 | # The default value is: None. | ||
| 101 | |||
| 102 | OUTPUT_TEXT_DIRECTION = None | ||
| 103 | |||
| 104 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member | ||
| 97 | # descriptions after the members that are listed in the file and class | 105 | # descriptions after the members that are listed in the file and class |
| 98 | # documentation (similar to Javadoc). Set to NO to disable this. | 106 | # documentation (similar to Javadoc). Set to NO to disable this. |
| 99 | # The default value is: YES. | 107 | # The default value is: YES. |
| 100 | 108 | ||
| 101 | BRIEF_MEMBER_DESC = YES | 109 | BRIEF_MEMBER_DESC = YES |
| 102 | 110 | ||
| 103 | # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief | 111 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief |
| 104 | # description of a member or function before the detailed description | 112 | # description of a member or function before the detailed description |
| 105 | # | 113 | # |
| 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | 114 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
| @@ -135,7 +143,7 @@ ALWAYS_DETAILED_SEC = NO | |||
| 135 | 143 | ||
| 136 | INLINE_INHERITED_MEMB = NO | 144 | INLINE_INHERITED_MEMB = NO |
| 137 | 145 | ||
| 138 | # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path | 146 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path |
| 139 | # before files name in the file list and in the header files. If set to NO the | 147 | # before files name in the file list and in the header files. If set to NO the |
| 140 | # shortest path that makes the file name unique will be used | 148 | # shortest path that makes the file name unique will be used |
| 141 | # The default value is: YES. | 149 | # The default value is: YES. |
| @@ -179,6 +187,16 @@ SHORT_NAMES = NO | |||
| 179 | 187 | ||
| 180 | JAVADOC_AUTOBRIEF = YES | 188 | JAVADOC_AUTOBRIEF = YES |
| 181 | 189 | ||
| 190 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line | ||
| 191 | # such as | ||
| 192 | # /*************** | ||
| 193 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the | ||
| 194 | # Javadoc-style will behave just like regular comments and it will not be | ||
| 195 | # interpreted by doxygen. | ||
| 196 | # The default value is: NO. | ||
| 197 | |||
| 198 | JAVADOC_BANNER = NO | ||
| 199 | |||
| 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first | 200 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
| 183 | # line (until the first dot) of a Qt-style comment as the brief description. If | 201 | # line (until the first dot) of a Qt-style comment as the brief description. If |
| 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus | 202 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
| @@ -205,12 +223,12 @@ MULTILINE_CPP_IS_BRIEF = NO | |||
| 205 | 223 | ||
| 206 | INHERIT_DOCS = YES | 224 | INHERIT_DOCS = YES |
| 207 | 225 | ||
| 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a | 226 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new |
| 209 | # new page for each member. If set to NO, the documentation of a member will be | 227 | # page for each member. If set to NO, the documentation of a member will be part |
| 210 | # part of the file/class/namespace that contains it. | 228 | # of the file/class/namespace that contains it. |
| 211 | # The default value is: NO. | 229 | # The default value is: NO. |
| 212 | 230 | ||
| 213 | SEPARATE_MEMBER_PAGES = NO | 231 | SEPARATE_MEMBER_PAGES = YES |
| 214 | 232 | ||
| 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen | 233 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen |
| 216 | # uses this value to replace tabs by spaces in code fragments. | 234 | # uses this value to replace tabs by spaces in code fragments. |
| @@ -226,7 +244,12 @@ TAB_SIZE = 8 | |||
| 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the | 244 | # will allow you to put the command \sideeffect (or @sideeffect) in the |
| 227 | # documentation, which will result in a user-defined paragraph with heading | 245 | # documentation, which will result in a user-defined paragraph with heading |
| 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert | 246 | # "Side Effects:". You can put \n's in the value part of an alias to insert |
| 229 | # newlines. | 247 | # newlines (in the resulting output). You can put ^^ in the value part of an |
| 248 | # alias to insert a newline as if a physical newline was in the original file. | ||
| 249 | # When you need a literal { or } or , in the value part of an alias you have to | ||
| 250 | # escape them by means of a backslash (\), this can lead to conflicts with the | ||
| 251 | # commands \{ and \} for these it is advised to use the version @{ and @} or use | ||
| 252 | # a double escape (\\{ and \\}) | ||
| 230 | 253 | ||
| 231 | ALIASES = | 254 | ALIASES = |
| 232 | 255 | ||
| @@ -264,19 +287,28 @@ OPTIMIZE_FOR_FORTRAN = NO | |||
| 264 | 287 | ||
| 265 | OPTIMIZE_OUTPUT_VHDL = NO | 288 | OPTIMIZE_OUTPUT_VHDL = NO |
| 266 | 289 | ||
| 290 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice | ||
| 291 | # sources only. Doxygen will then generate output that is more tailored for that | ||
| 292 | # language. For instance, namespaces will be presented as modules, types will be | ||
| 293 | # separated into more groups, etc. | ||
| 294 | # The default value is: NO. | ||
| 295 | |||
| 296 | OPTIMIZE_OUTPUT_SLICE = YES | ||
| 297 | |||
| 267 | # Doxygen selects the parser to use depending on the extension of the files it | 298 | # Doxygen selects the parser to use depending on the extension of the files it |
| 268 | # parses. With this tag you can assign which parser to use for a given | 299 | # parses. With this tag you can assign which parser to use for a given |
| 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it | 300 | # extension. Doxygen has a built-in mapping, but you can override or extend it |
| 270 | # using this tag. The format is ext=language, where ext is a file extension, and | 301 | # using this tag. The format is ext=language, where ext is a file extension, and |
| 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, | 302 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
| 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: | 303 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, |
| 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: | 304 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: |
| 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed | 305 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser |
| 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For | 306 | # tries to guess whether the code is fixed or free formatted code, this is the |
| 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), | 307 | # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat |
| 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. | 308 | # .inc files as Fortran files (default is PHP), and .f files as C (default is |
| 309 | # Fortran), use: inc=Fortran f=C. | ||
| 278 | # | 310 | # |
| 279 | # Note For files without extension you can use no_extension as a placeholder. | 311 | # Note: For files without extension you can use no_extension as a placeholder. |
| 280 | # | 312 | # |
| 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise | 313 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
| 282 | # the files are not read by doxygen. | 314 | # the files are not read by doxygen. |
| @@ -285,7 +317,7 @@ EXTENSION_MAPPING = | |||
| 285 | 317 | ||
| 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments | 318 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
| 287 | # according to the Markdown format, which allows for more readable | 319 | # according to the Markdown format, which allows for more readable |
| 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. | 320 | # documentation. See https://daringfireball.net/projects/markdown/ for details. |
| 289 | # The output of markdown processing is further processed by doxygen, so you can | 321 | # The output of markdown processing is further processed by doxygen, so you can |
| 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in | 322 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
| 291 | # case of backward compatibilities issues. | 323 | # case of backward compatibilities issues. |
| @@ -293,10 +325,19 @@ EXTENSION_MAPPING = | |||
| 293 | 325 | ||
| 294 | MARKDOWN_SUPPORT = YES | 326 | MARKDOWN_SUPPORT = YES |
| 295 | 327 | ||
| 328 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up | ||
| 329 | # to that level are automatically included in the table of contents, even if | ||
| 330 | # they do not have an id attribute. | ||
| 331 | # Note: This feature currently applies only to Markdown headings. | ||
| 332 | # Minimum value: 0, maximum value: 99, default value: 5. | ||
| 333 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. | ||
| 334 | |||
| 335 | TOC_INCLUDE_HEADINGS = 5 | ||
| 336 | |||
| 296 | # When enabled doxygen tries to link words that correspond to documented | 337 | # When enabled doxygen tries to link words that correspond to documented |
| 297 | # classes, or namespaces to their corresponding documentation. Such a link can | 338 | # classes, or namespaces to their corresponding documentation. Such a link can |
| 298 | # be prevented in individual cases by by putting a % sign in front of the word | 339 | # be prevented in individual cases by putting a % sign in front of the word or |
| 299 | # or globally by setting AUTOLINK_SUPPORT to NO. | 340 | # globally by setting AUTOLINK_SUPPORT to NO. |
| 300 | # The default value is: YES. | 341 | # The default value is: YES. |
| 301 | 342 | ||
| 302 | AUTOLINK_SUPPORT = YES | 343 | AUTOLINK_SUPPORT = YES |
| @@ -318,7 +359,7 @@ BUILTIN_STL_SUPPORT = NO | |||
| 318 | CPP_CLI_SUPPORT = NO | 359 | CPP_CLI_SUPPORT = NO |
| 319 | 360 | ||
| 320 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: | 361 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
| 321 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen | 362 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen |
| 322 | # will parse them like normal C++ but will assume all classes use public instead | 363 | # will parse them like normal C++ but will assume all classes use public instead |
| 323 | # of private inheritance when no explicit protection keyword is present. | 364 | # of private inheritance when no explicit protection keyword is present. |
| 324 | # The default value is: NO. | 365 | # The default value is: NO. |
| @@ -336,13 +377,20 @@ SIP_SUPPORT = NO | |||
| 336 | IDL_PROPERTY_SUPPORT = YES | 377 | IDL_PROPERTY_SUPPORT = YES |
| 337 | 378 | ||
| 338 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | 379 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
| 339 | # tag is set to YES, then doxygen will reuse the documentation of the first | 380 | # tag is set to YES then doxygen will reuse the documentation of the first |
| 340 | # member in the group (if any) for the other members of the group. By default | 381 | # member in the group (if any) for the other members of the group. By default |
| 341 | # all members of a group must be documented explicitly. | 382 | # all members of a group must be documented explicitly. |
| 342 | # The default value is: NO. | 383 | # The default value is: NO. |
| 343 | 384 | ||
| 344 | DISTRIBUTE_GROUP_DOC = NO | 385 | DISTRIBUTE_GROUP_DOC = NO |
| 345 | 386 | ||
| 387 | # If one adds a struct or class to a group and this option is enabled, then also | ||
| 388 | # any nested class or struct is added to the same group. By default this option | ||
| 389 | # is disabled and one has to add nested compounds explicitly via \ingroup. | ||
| 390 | # The default value is: NO. | ||
| 391 | |||
| 392 | GROUP_NESTED_COMPOUNDS = NO | ||
| 393 | |||
| 346 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type | 394 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type |
| 347 | # (for instance a group of public functions) to be put as a subgroup of that | 395 | # (for instance a group of public functions) to be put as a subgroup of that |
| 348 | # type (e.g. under the Public Functions section). Set it to NO to prevent | 396 | # type (e.g. under the Public Functions section). Set it to NO to prevent |
| @@ -401,7 +449,7 @@ LOOKUP_CACHE_SIZE = 0 | |||
| 401 | # Build related configuration options | 449 | # Build related configuration options |
| 402 | #--------------------------------------------------------------------------- | 450 | #--------------------------------------------------------------------------- |
| 403 | 451 | ||
| 404 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | 452 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in |
| 405 | # documentation are documented, even if no documentation was available. Private | 453 | # documentation are documented, even if no documentation was available. Private |
| 406 | # class members and static file members will be hidden unless the | 454 | # class members and static file members will be hidden unless the |
| 407 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. | 455 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
| @@ -411,35 +459,41 @@ LOOKUP_CACHE_SIZE = 0 | |||
| 411 | 459 | ||
| 412 | EXTRACT_ALL = NO | 460 | EXTRACT_ALL = NO |
| 413 | 461 | ||
| 414 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will | 462 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will |
| 415 | # be included in the documentation. | 463 | # be included in the documentation. |
| 416 | # The default value is: NO. | 464 | # The default value is: NO. |
| 417 | 465 | ||
| 418 | EXTRACT_PRIVATE = NO | 466 | EXTRACT_PRIVATE = NO |
| 419 | 467 | ||
| 420 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal | 468 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual |
| 469 | # methods of a class will be included in the documentation. | ||
| 470 | # The default value is: NO. | ||
| 471 | |||
| 472 | EXTRACT_PRIV_VIRTUAL = NO | ||
| 473 | |||
| 474 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal | ||
| 421 | # scope will be included in the documentation. | 475 | # scope will be included in the documentation. |
| 422 | # The default value is: NO. | 476 | # The default value is: NO. |
| 423 | 477 | ||
| 424 | EXTRACT_PACKAGE = NO | 478 | EXTRACT_PACKAGE = NO |
| 425 | 479 | ||
| 426 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be | 480 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be |
| 427 | # included in the documentation. | 481 | # included in the documentation. |
| 428 | # The default value is: NO. | 482 | # The default value is: NO. |
| 429 | 483 | ||
| 430 | EXTRACT_STATIC = NO | 484 | EXTRACT_STATIC = NO |
| 431 | 485 | ||
| 432 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined | 486 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined |
| 433 | # locally in source files will be included in the documentation. If set to NO | 487 | # locally in source files will be included in the documentation. If set to NO, |
| 434 | # only classes defined in header files are included. Does not have any effect | 488 | # only classes defined in header files are included. Does not have any effect |
| 435 | # for Java sources. | 489 | # for Java sources. |
| 436 | # The default value is: YES. | 490 | # The default value is: YES. |
| 437 | 491 | ||
| 438 | EXTRACT_LOCAL_CLASSES = NO | 492 | EXTRACT_LOCAL_CLASSES = NO |
| 439 | 493 | ||
| 440 | # This flag is only useful for Objective-C code. When set to YES local methods, | 494 | # This flag is only useful for Objective-C code. If set to YES, local methods, |
| 441 | # which are defined in the implementation section but not in the interface are | 495 | # which are defined in the implementation section but not in the interface are |
| 442 | # included in the documentation. If set to NO only methods in the interface are | 496 | # included in the documentation. If set to NO, only methods in the interface are |
| 443 | # included. | 497 | # included. |
| 444 | # The default value is: NO. | 498 | # The default value is: NO. |
| 445 | 499 | ||
| @@ -464,21 +518,21 @@ HIDE_UNDOC_MEMBERS = NO | |||
| 464 | 518 | ||
| 465 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all | 519 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
| 466 | # undocumented classes that are normally visible in the class hierarchy. If set | 520 | # undocumented classes that are normally visible in the class hierarchy. If set |
| 467 | # to NO these classes will be included in the various overviews. This option has | 521 | # to NO, these classes will be included in the various overviews. This option |
| 468 | # no effect if EXTRACT_ALL is enabled. | 522 | # has no effect if EXTRACT_ALL is enabled. |
| 469 | # The default value is: NO. | 523 | # The default value is: NO. |
| 470 | 524 | ||
| 471 | HIDE_UNDOC_CLASSES = NO | 525 | HIDE_UNDOC_CLASSES = NO |
| 472 | 526 | ||
| 473 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend | 527 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
| 474 | # (class|struct|union) declarations. If set to NO these declarations will be | 528 | # (class|struct|union) declarations. If set to NO, these declarations will be |
| 475 | # included in the documentation. | 529 | # included in the documentation. |
| 476 | # The default value is: NO. | 530 | # The default value is: NO. |
| 477 | 531 | ||
| 478 | HIDE_FRIEND_COMPOUNDS = NO | 532 | HIDE_FRIEND_COMPOUNDS = NO |
| 479 | 533 | ||
| 480 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any | 534 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any |
| 481 | # documentation blocks found inside the body of a function. If set to NO these | 535 | # documentation blocks found inside the body of a function. If set to NO, these |
| 482 | # blocks will be appended to the function's detailed documentation block. | 536 | # blocks will be appended to the function's detailed documentation block. |
| 483 | # The default value is: NO. | 537 | # The default value is: NO. |
| 484 | 538 | ||
| @@ -492,21 +546,28 @@ HIDE_IN_BODY_DOCS = NO | |||
| 492 | INTERNAL_DOCS = NO | 546 | INTERNAL_DOCS = NO |
| 493 | 547 | ||
| 494 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file | 548 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
| 495 | # names in lower-case letters. If set to YES upper-case letters are also | 549 | # names in lower-case letters. If set to YES, upper-case letters are also |
| 496 | # allowed. This is useful if you have classes or files whose names only differ | 550 | # allowed. This is useful if you have classes or files whose names only differ |
| 497 | # in case and if your file system supports case sensitive file names. Windows | 551 | # in case and if your file system supports case sensitive file names. Windows |
| 498 | # and Mac users are advised to set this option to NO. | 552 | # (including Cygwin) ands Mac users are advised to set this option to NO. |
| 499 | # The default value is: system dependent. | 553 | # The default value is: system dependent. |
| 500 | 554 | ||
| 501 | CASE_SENSE_NAMES = NO | 555 | CASE_SENSE_NAMES = NO |
| 502 | 556 | ||
| 503 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with | 557 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with |
| 504 | # their full class and namespace scopes in the documentation. If set to YES the | 558 | # their full class and namespace scopes in the documentation. If set to YES, the |
| 505 | # scope will be hidden. | 559 | # scope will be hidden. |
| 506 | # The default value is: NO. | 560 | # The default value is: NO. |
| 507 | 561 | ||
| 508 | HIDE_SCOPE_NAMES = NO | 562 | HIDE_SCOPE_NAMES = NO |
| 509 | 563 | ||
| 564 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will | ||
| 565 | # append additional text to a page's title, such as Class Reference. If set to | ||
| 566 | # YES the compound reference will be hidden. | ||
| 567 | # The default value is: NO. | ||
| 568 | |||
| 569 | HIDE_COMPOUND_REFERENCE= NO | ||
| 570 | |||
| 510 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of | 571 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
| 511 | # the files that are included by a file in the documentation of that file. | 572 | # the files that are included by a file in the documentation of that file. |
| 512 | # The default value is: YES. | 573 | # The default value is: YES. |
| @@ -534,14 +595,14 @@ INLINE_INFO = YES | |||
| 534 | 595 | ||
| 535 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the | 596 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
| 536 | # (detailed) documentation of file and class members alphabetically by member | 597 | # (detailed) documentation of file and class members alphabetically by member |
| 537 | # name. If set to NO the members will appear in declaration order. | 598 | # name. If set to NO, the members will appear in declaration order. |
| 538 | # The default value is: YES. | 599 | # The default value is: YES. |
| 539 | 600 | ||
| 540 | SORT_MEMBER_DOCS = YES | 601 | SORT_MEMBER_DOCS = YES |
| 541 | 602 | ||
| 542 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief | 603 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
| 543 | # descriptions of file, namespace and class members alphabetically by member | 604 | # descriptions of file, namespace and class members alphabetically by member |
| 544 | # name. If set to NO the members will appear in declaration order. Note that | 605 | # name. If set to NO, the members will appear in declaration order. Note that |
| 545 | # this will also influence the order of the classes in the class list. | 606 | # this will also influence the order of the classes in the class list. |
| 546 | # The default value is: NO. | 607 | # The default value is: NO. |
| 547 | 608 | ||
| @@ -586,27 +647,25 @@ SORT_BY_SCOPE_NAME = NO | |||
| 586 | 647 | ||
| 587 | STRICT_PROTO_MATCHING = NO | 648 | STRICT_PROTO_MATCHING = NO |
| 588 | 649 | ||
| 589 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the | 650 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo |
| 590 | # todo list. This list is created by putting \todo commands in the | 651 | # list. This list is created by putting \todo commands in the documentation. |
| 591 | # documentation. | ||
| 592 | # The default value is: YES. | 652 | # The default value is: YES. |
| 593 | 653 | ||
| 594 | GENERATE_TODOLIST = YES | 654 | GENERATE_TODOLIST = YES |
| 595 | 655 | ||
| 596 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the | 656 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test |
| 597 | # test list. This list is created by putting \test commands in the | 657 | # list. This list is created by putting \test commands in the documentation. |
| 598 | # documentation. | ||
| 599 | # The default value is: YES. | 658 | # The default value is: YES. |
| 600 | 659 | ||
| 601 | GENERATE_TESTLIST = YES | 660 | GENERATE_TESTLIST = YES |
| 602 | 661 | ||
| 603 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug | 662 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug |
| 604 | # list. This list is created by putting \bug commands in the documentation. | 663 | # list. This list is created by putting \bug commands in the documentation. |
| 605 | # The default value is: YES. | 664 | # The default value is: YES. |
| 606 | 665 | ||
| 607 | GENERATE_BUGLIST = YES | 666 | GENERATE_BUGLIST = YES |
| 608 | 667 | ||
| 609 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) | 668 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) |
| 610 | # the deprecated list. This list is created by putting \deprecated commands in | 669 | # the deprecated list. This list is created by putting \deprecated commands in |
| 611 | # the documentation. | 670 | # the documentation. |
| 612 | # The default value is: YES. | 671 | # The default value is: YES. |
| @@ -631,8 +690,8 @@ ENABLED_SECTIONS = | |||
| 631 | MAX_INITIALIZER_LINES = 30 | 690 | MAX_INITIALIZER_LINES = 30 |
| 632 | 691 | ||
| 633 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at | 692 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at |
| 634 | # the bottom of the documentation of classes and structs. If set to YES the list | 693 | # the bottom of the documentation of classes and structs. If set to YES, the |
| 635 | # will mention the files that were used to generate the documentation. | 694 | # list will mention the files that were used to generate the documentation. |
| 636 | # The default value is: YES. | 695 | # The default value is: YES. |
| 637 | 696 | ||
| 638 | SHOW_USED_FILES = YES | 697 | SHOW_USED_FILES = YES |
| @@ -677,7 +736,7 @@ LAYOUT_FILE = | |||
| 677 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing | 736 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
| 678 | # the reference definitions. This must be a list of .bib files. The .bib | 737 | # the reference definitions. This must be a list of .bib files. The .bib |
| 679 | # extension is automatically appended if omitted. This requires the bibtex tool | 738 | # extension is automatically appended if omitted. This requires the bibtex tool |
| 680 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. | 739 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. |
| 681 | # For LaTeX the style of the bibliography can be controlled using | 740 | # For LaTeX the style of the bibliography can be controlled using |
| 682 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the | 741 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
| 683 | # search path. See also \cite for info how to create references. | 742 | # search path. See also \cite for info how to create references. |
| @@ -696,7 +755,7 @@ CITE_BIB_FILES = | |||
| 696 | QUIET = NO | 755 | QUIET = NO |
| 697 | 756 | ||
| 698 | # The WARNINGS tag can be used to turn on/off the warning messages that are | 757 | # The WARNINGS tag can be used to turn on/off the warning messages that are |
| 699 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES | 758 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES |
| 700 | # this implies that the warnings are on. | 759 | # this implies that the warnings are on. |
| 701 | # | 760 | # |
| 702 | # Tip: Turn warnings on while writing the documentation. | 761 | # Tip: Turn warnings on while writing the documentation. |
| @@ -704,7 +763,7 @@ QUIET = NO | |||
| 704 | 763 | ||
| 705 | WARNINGS = YES | 764 | WARNINGS = YES |
| 706 | 765 | ||
| 707 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate | 766 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate |
| 708 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag | 767 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag |
| 709 | # will automatically be disabled. | 768 | # will automatically be disabled. |
| 710 | # The default value is: YES. | 769 | # The default value is: YES. |
| @@ -721,12 +780,19 @@ WARN_IF_DOC_ERROR = YES | |||
| 721 | 780 | ||
| 722 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that | 781 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
| 723 | # are documented, but have no documentation for their parameters or return | 782 | # are documented, but have no documentation for their parameters or return |
| 724 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter | 783 | # value. If set to NO, doxygen will only warn about wrong or incomplete |
| 725 | # documentation, but not about the absence of documentation. | 784 | # parameter documentation, but not about the absence of documentation. If |
| 785 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. | ||
| 726 | # The default value is: NO. | 786 | # The default value is: NO. |
| 727 | 787 | ||
| 728 | WARN_NO_PARAMDOC = NO | 788 | WARN_NO_PARAMDOC = NO |
| 729 | 789 | ||
| 790 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when | ||
| 791 | # a warning is encountered. | ||
| 792 | # The default value is: NO. | ||
| 793 | |||
| 794 | WARN_AS_ERROR = NO | ||
| 795 | |||
| 730 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen | 796 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen |
| 731 | # can produce. The string should contain the $file, $line, and $text tags, which | 797 | # can produce. The string should contain the $file, $line, and $text tags, which |
| 732 | # will be replaced by the file and line number from which the warning originated | 798 | # will be replaced by the file and line number from which the warning originated |
| @@ -750,7 +816,7 @@ WARN_LOGFILE = | |||
| 750 | # The INPUT tag is used to specify the files and/or directories that contain | 816 | # The INPUT tag is used to specify the files and/or directories that contain |
| 751 | # documented source files. You may enter file names like myfile.cpp or | 817 | # documented source files. You may enter file names like myfile.cpp or |
| 752 | # directories like /usr/src/myproject. Separate the files or directories with | 818 | # directories like /usr/src/myproject. Separate the files or directories with |
| 753 | # spaces. | 819 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING |
| 754 | # Note: If this tag is empty the current directory is searched. | 820 | # Note: If this tag is empty the current directory is searched. |
| 755 | 821 | ||
| 756 | INPUT = include/@PACKAGE@ | 822 | INPUT = include/@PACKAGE@ |
| @@ -758,7 +824,7 @@ INPUT = include/@PACKAGE@ | |||
| 758 | # This tag can be used to specify the character encoding of the source files | 824 | # This tag can be used to specify the character encoding of the source files |
| 759 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses | 825 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
| 760 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv | 826 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
| 761 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of | 827 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of |
| 762 | # possible encodings. | 828 | # possible encodings. |
| 763 | # The default value is: UTF-8. | 829 | # The default value is: UTF-8. |
| 764 | 830 | ||
| @@ -766,12 +832,17 @@ INPUT_ENCODING = UTF-8 | |||
| 766 | 832 | ||
| 767 | # If the value of the INPUT tag contains directories, you can use the | 833 | # If the value of the INPUT tag contains directories, you can use the |
| 768 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and | 834 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
| 769 | # *.h) to filter out the source-files in the directories. If left blank the | 835 | # *.h) to filter out the source-files in the directories. |
| 770 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, | 836 | # |
| 771 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, | 837 | # Note that for custom extensions or not directly supported extensions you also |
| 772 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, | 838 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
| 773 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, | 839 | # read by doxygen. |
| 774 | # *.qsf, *.as and *.js. | 840 | # |
| 841 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | ||
| 842 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | ||
| 843 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, | ||
| 844 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, | ||
| 845 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. | ||
| 775 | 846 | ||
| 776 | FILE_PATTERNS = | 847 | FILE_PATTERNS = |
| 777 | 848 | ||
| @@ -857,6 +928,10 @@ IMAGE_PATH = | |||
| 857 | # Note that the filter must not add or remove lines; it is applied before the | 928 | # Note that the filter must not add or remove lines; it is applied before the |
| 858 | # code is scanned, but not when the output code is generated. If lines are added | 929 | # code is scanned, but not when the output code is generated. If lines are added |
| 859 | # or removed, the anchors will not be placed correctly. | 930 | # or removed, the anchors will not be placed correctly. |
| 931 | # | ||
| 932 | # Note that for custom extensions or not directly supported extensions you also | ||
| 933 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||
| 934 | # properly processed by doxygen. | ||
| 860 | 935 | ||
| 861 | INPUT_FILTER = | 936 | INPUT_FILTER = |
| 862 | 937 | ||
| @@ -866,11 +941,15 @@ INPUT_FILTER = | |||
| 866 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how | 941 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how |
| 867 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the | 942 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the |
| 868 | # patterns match the file name, INPUT_FILTER is applied. | 943 | # patterns match the file name, INPUT_FILTER is applied. |
| 944 | # | ||
| 945 | # Note that for custom extensions or not directly supported extensions you also | ||
| 946 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||
| 947 | # properly processed by doxygen. | ||
| 869 | 948 | ||
| 870 | FILTER_PATTERNS = | 949 | FILTER_PATTERNS = |
| 871 | 950 | ||
| 872 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | 951 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
| 873 | # INPUT_FILTER ) will also be used to filter the input files that are used for | 952 | # INPUT_FILTER) will also be used to filter the input files that are used for |
| 874 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). | 953 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). |
| 875 | # The default value is: NO. | 954 | # The default value is: NO. |
| 876 | 955 | ||
| @@ -918,7 +997,7 @@ INLINE_SOURCES = NO | |||
| 918 | STRIP_CODE_COMMENTS = YES | 997 | STRIP_CODE_COMMENTS = YES |
| 919 | 998 | ||
| 920 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented | 999 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
| 921 | # function all documented functions referencing it will be listed. | 1000 | # entity all documented functions referencing it will be listed. |
| 922 | # The default value is: NO. | 1001 | # The default value is: NO. |
| 923 | 1002 | ||
| 924 | REFERENCED_BY_RELATION = YES | 1003 | REFERENCED_BY_RELATION = YES |
| @@ -930,7 +1009,7 @@ REFERENCED_BY_RELATION = YES | |||
| 930 | REFERENCES_RELATION = YES | 1009 | REFERENCES_RELATION = YES |
| 931 | 1010 | ||
| 932 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set | 1011 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
| 933 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and | 1012 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and |
| 934 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will | 1013 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
| 935 | # link to the documentation. | 1014 | # link to the documentation. |
| 936 | # The default value is: YES. | 1015 | # The default value is: YES. |
| @@ -950,12 +1029,12 @@ SOURCE_TOOLTIPS = YES | |||
| 950 | # If the USE_HTAGS tag is set to YES then the references to source code will | 1029 | # If the USE_HTAGS tag is set to YES then the references to source code will |
| 951 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in | 1030 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in |
| 952 | # source browser. The htags tool is part of GNU's global source tagging system | 1031 | # source browser. The htags tool is part of GNU's global source tagging system |
| 953 | # (see http://www.gnu.org/software/global/global.html). You will need version | 1032 | # (see https://www.gnu.org/software/global/global.html). You will need version |
| 954 | # 4.8.6 or higher. | 1033 | # 4.8.6 or higher. |
| 955 | # | 1034 | # |
| 956 | # To use it do the following: | 1035 | # To use it do the following: |
| 957 | # - Install the latest version of global | 1036 | # - Install the latest version of global |
| 958 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file | 1037 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file |
| 959 | # - Make sure the INPUT points to the root of the source tree | 1038 | # - Make sure the INPUT points to the root of the source tree |
| 960 | # - Run doxygen as normal | 1039 | # - Run doxygen as normal |
| 961 | # | 1040 | # |
| @@ -1007,7 +1086,7 @@ IGNORE_PREFIX = | |||
| 1007 | # Configuration options related to the HTML output | 1086 | # Configuration options related to the HTML output |
| 1008 | #--------------------------------------------------------------------------- | 1087 | #--------------------------------------------------------------------------- |
| 1009 | 1088 | ||
| 1010 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output | 1089 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output |
| 1011 | # The default value is: YES. | 1090 | # The default value is: YES. |
| 1012 | 1091 | ||
| 1013 | GENERATE_HTML = YES | 1092 | GENERATE_HTML = YES |
| @@ -1073,10 +1152,10 @@ HTML_STYLESHEET = | |||
| 1073 | # cascading style sheets that are included after the standard style sheets | 1152 | # cascading style sheets that are included after the standard style sheets |
| 1074 | # created by doxygen. Using this option one can overrule certain style aspects. | 1153 | # created by doxygen. Using this option one can overrule certain style aspects. |
| 1075 | # This is preferred over using HTML_STYLESHEET since it does not replace the | 1154 | # This is preferred over using HTML_STYLESHEET since it does not replace the |
| 1076 | # standard style sheet and is therefor more robust against future updates. | 1155 | # standard style sheet and is therefore more robust against future updates. |
| 1077 | # Doxygen will copy the style sheet files to the output directory. | 1156 | # Doxygen will copy the style sheet files to the output directory. |
| 1078 | # Note: The order of the extra stylesheet files is of importance (e.g. the last | 1157 | # Note: The order of the extra style sheet files is of importance (e.g. the last |
| 1079 | # stylesheet in the list overrules the setting of the previous ones in the | 1158 | # style sheet in the list overrules the setting of the previous ones in the |
| 1080 | # list). For an example see the documentation. | 1159 | # list). For an example see the documentation. |
| 1081 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1160 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| 1082 | 1161 | ||
| @@ -1093,9 +1172,9 @@ HTML_EXTRA_STYLESHEET = | |||
| 1093 | HTML_EXTRA_FILES = | 1172 | HTML_EXTRA_FILES = |
| 1094 | 1173 | ||
| 1095 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen | 1174 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
| 1096 | # will adjust the colors in the stylesheet and background images according to | 1175 | # will adjust the colors in the style sheet and background images according to |
| 1097 | # this color. Hue is specified as an angle on a colorwheel, see | 1176 | # this color. Hue is specified as an angle on a colorwheel, see |
| 1098 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value | 1177 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value |
| 1099 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 | 1178 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
| 1100 | # purple, and 360 is red again. | 1179 | # purple, and 360 is red again. |
| 1101 | # Minimum value: 0, maximum value: 359, default value: 220. | 1180 | # Minimum value: 0, maximum value: 359, default value: 220. |
| @@ -1124,12 +1203,24 @@ HTML_COLORSTYLE_GAMMA = 80 | |||
| 1124 | 1203 | ||
| 1125 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | 1204 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
| 1126 | # page will contain the date and time when the page was generated. Setting this | 1205 | # page will contain the date and time when the page was generated. Setting this |
| 1127 | # to NO can help when comparing the output of multiple runs. | 1206 | # to YES can help to show when doxygen was last run and thus if the |
| 1128 | # The default value is: YES. | 1207 | # documentation is up to date. |
| 1208 | # The default value is: NO. | ||
| 1129 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1209 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| 1130 | 1210 | ||
| 1131 | HTML_TIMESTAMP = YES | 1211 | HTML_TIMESTAMP = YES |
| 1132 | 1212 | ||
| 1213 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML | ||
| 1214 | # documentation will contain a main index with vertical navigation menus that | ||
| 1215 | # are dynamically created via Javascript. If disabled, the navigation index will | ||
| 1216 | # consists of multiple levels of tabs that are statically embedded in every HTML | ||
| 1217 | # page. Disable this option to support browsers that do not have Javascript, | ||
| 1218 | # like the Qt help browser. | ||
| 1219 | # The default value is: YES. | ||
| 1220 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
| 1221 | |||
| 1222 | HTML_DYNAMIC_MENUS = NO | ||
| 1223 | |||
| 1133 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | 1224 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
| 1134 | # documentation will contain sections that can be hidden and shown after the | 1225 | # documentation will contain sections that can be hidden and shown after the |
| 1135 | # page has loaded. | 1226 | # page has loaded. |
| @@ -1153,13 +1244,13 @@ HTML_INDEX_NUM_ENTRIES = 100 | |||
| 1153 | 1244 | ||
| 1154 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be | 1245 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be |
| 1155 | # generated that can be used as input for Apple's Xcode 3 integrated development | 1246 | # generated that can be used as input for Apple's Xcode 3 integrated development |
| 1156 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with | 1247 | # environment (see: https://developer.apple.com/xcode/), introduced with OSX |
| 1157 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a | 1248 | # 10.5 (Leopard). To create a documentation set, doxygen will generate a |
| 1158 | # Makefile in the HTML output directory. Running make will produce the docset in | 1249 | # Makefile in the HTML output directory. Running make will produce the docset in |
| 1159 | # that directory and running make install will install the docset in | 1250 | # that directory and running make install will install the docset in |
| 1160 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at | 1251 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
| 1161 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | 1252 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy |
| 1162 | # for more information. | 1253 | # genXcode/_index.html for more information. |
| 1163 | # The default value is: NO. | 1254 | # The default value is: NO. |
| 1164 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1255 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| 1165 | 1256 | ||
| @@ -1198,7 +1289,7 @@ DOCSET_PUBLISHER_NAME = Publisher | |||
| 1198 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three | 1289 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
| 1199 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The | 1290 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
| 1200 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop | 1291 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
| 1201 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on | 1292 | # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
| 1202 | # Windows. | 1293 | # Windows. |
| 1203 | # | 1294 | # |
| 1204 | # The HTML Help Workshop contains a compiler that can convert all HTML output | 1295 | # The HTML Help Workshop contains a compiler that can convert all HTML output |
| @@ -1221,28 +1312,28 @@ GENERATE_HTMLHELP = NO | |||
| 1221 | CHM_FILE = | 1312 | CHM_FILE = |
| 1222 | 1313 | ||
| 1223 | # The HHC_LOCATION tag can be used to specify the location (absolute path | 1314 | # The HHC_LOCATION tag can be used to specify the location (absolute path |
| 1224 | # including file name) of the HTML help compiler ( hhc.exe). If non-empty | 1315 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, |
| 1225 | # doxygen will try to run the HTML help compiler on the generated index.hhp. | 1316 | # doxygen will try to run the HTML help compiler on the generated index.hhp. |
| 1226 | # The file has to be specified with full path. | 1317 | # The file has to be specified with full path. |
| 1227 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | 1318 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 1228 | 1319 | ||
| 1229 | HHC_LOCATION = | 1320 | HHC_LOCATION = |
| 1230 | 1321 | ||
| 1231 | # The GENERATE_CHI flag controls if a separate .chi index file is generated ( | 1322 | # The GENERATE_CHI flag controls if a separate .chi index file is generated |
| 1232 | # YES) or that it should be included in the master .chm file ( NO). | 1323 | # (YES) or that it should be included in the master .chm file (NO). |
| 1233 | # The default value is: NO. | 1324 | # The default value is: NO. |
| 1234 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | 1325 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 1235 | 1326 | ||
| 1236 | GENERATE_CHI = NO | 1327 | GENERATE_CHI = NO |
| 1237 | 1328 | ||
| 1238 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) | 1329 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) |
| 1239 | # and project file content. | 1330 | # and project file content. |
| 1240 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | 1331 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 1241 | 1332 | ||
| 1242 | CHM_INDEX_ENCODING = | 1333 | CHM_INDEX_ENCODING = |
| 1243 | 1334 | ||
| 1244 | # The BINARY_TOC flag controls whether a binary table of contents is generated ( | 1335 | # The BINARY_TOC flag controls whether a binary table of contents is generated |
| 1245 | # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it | 1336 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it |
| 1246 | # enables the Previous and Next buttons. | 1337 | # enables the Previous and Next buttons. |
| 1247 | # The default value is: NO. | 1338 | # The default value is: NO. |
| 1248 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | 1339 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| @@ -1274,7 +1365,7 @@ QCH_FILE = | |||
| 1274 | 1365 | ||
| 1275 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help | 1366 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
| 1276 | # Project output. For more information please see Qt Help Project / Namespace | 1367 | # Project output. For more information please see Qt Help Project / Namespace |
| 1277 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). | 1368 | # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). |
| 1278 | # The default value is: org.doxygen.Project. | 1369 | # The default value is: org.doxygen.Project. |
| 1279 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1370 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1280 | 1371 | ||
| @@ -1282,7 +1373,7 @@ QHP_NAMESPACE = org.doxygen.Project | |||
| 1282 | 1373 | ||
| 1283 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt | 1374 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
| 1284 | # Help Project output. For more information please see Qt Help Project / Virtual | 1375 | # Help Project output. For more information please see Qt Help Project / Virtual |
| 1285 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- | 1376 | # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- |
| 1286 | # folders). | 1377 | # folders). |
| 1287 | # The default value is: doc. | 1378 | # The default value is: doc. |
| 1288 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1379 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| @@ -1291,7 +1382,7 @@ QHP_VIRTUAL_FOLDER = doc | |||
| 1291 | 1382 | ||
| 1292 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom | 1383 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
| 1293 | # filter to add. For more information please see Qt Help Project / Custom | 1384 | # filter to add. For more information please see Qt Help Project / Custom |
| 1294 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- | 1385 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- |
| 1295 | # filters). | 1386 | # filters). |
| 1296 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1387 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1297 | 1388 | ||
| @@ -1299,7 +1390,7 @@ QHP_CUST_FILTER_NAME = | |||
| 1299 | 1390 | ||
| 1300 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the | 1391 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
| 1301 | # custom filter to add. For more information please see Qt Help Project / Custom | 1392 | # custom filter to add. For more information please see Qt Help Project / Custom |
| 1302 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- | 1393 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- |
| 1303 | # filters). | 1394 | # filters). |
| 1304 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1395 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1305 | 1396 | ||
| @@ -1307,7 +1398,7 @@ QHP_CUST_FILTER_ATTRS = | |||
| 1307 | 1398 | ||
| 1308 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | 1399 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
| 1309 | # project's filter section matches. Qt Help Project / Filter Attributes (see: | 1400 | # project's filter section matches. Qt Help Project / Filter Attributes (see: |
| 1310 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). | 1401 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). |
| 1311 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1402 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| 1312 | 1403 | ||
| 1313 | QHP_SECT_FILTER_ATTRS = | 1404 | QHP_SECT_FILTER_ATTRS = |
| @@ -1356,7 +1447,7 @@ DISABLE_INDEX = NO | |||
| 1356 | # index structure (just like the one that is generated for HTML Help). For this | 1447 | # index structure (just like the one that is generated for HTML Help). For this |
| 1357 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required | 1448 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required |
| 1358 | # (i.e. any modern browser). Windows users are probably better off using the | 1449 | # (i.e. any modern browser). Windows users are probably better off using the |
| 1359 | # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can | 1450 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can |
| 1360 | # further fine-tune the look of the index. As an example, the default style | 1451 | # further fine-tune the look of the index. As an example, the default style |
| 1361 | # sheet generated by doxygen has an example that shows how to put an image at | 1452 | # sheet generated by doxygen has an example that shows how to put an image at |
| 1362 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has | 1453 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
| @@ -1384,7 +1475,7 @@ ENUM_VALUES_PER_LINE = 1 | |||
| 1384 | 1475 | ||
| 1385 | TREEVIEW_WIDTH = 250 | 1476 | TREEVIEW_WIDTH = 250 |
| 1386 | 1477 | ||
| 1387 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to | 1478 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to |
| 1388 | # external symbols imported via tag files in a separate window. | 1479 | # external symbols imported via tag files in a separate window. |
| 1389 | # The default value is: NO. | 1480 | # The default value is: NO. |
| 1390 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1481 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| @@ -1400,7 +1491,7 @@ EXT_LINKS_IN_WINDOW = NO | |||
| 1400 | 1491 | ||
| 1401 | FORMULA_FONTSIZE = 10 | 1492 | FORMULA_FONTSIZE = 10 |
| 1402 | 1493 | ||
| 1403 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images | 1494 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images |
| 1404 | # generated for formulas are transparent PNGs. Transparent PNGs are not | 1495 | # generated for formulas are transparent PNGs. Transparent PNGs are not |
| 1405 | # supported properly for IE 6.0, but are supported on all modern browsers. | 1496 | # supported properly for IE 6.0, but are supported on all modern browsers. |
| 1406 | # | 1497 | # |
| @@ -1412,8 +1503,8 @@ FORMULA_FONTSIZE = 10 | |||
| 1412 | FORMULA_TRANSPARENT = YES | 1503 | FORMULA_TRANSPARENT = YES |
| 1413 | 1504 | ||
| 1414 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see | 1505 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
| 1415 | # http://www.mathjax.org) which uses client side Javascript for the rendering | 1506 | # https://www.mathjax.org) which uses client side Javascript for the rendering |
| 1416 | # instead of using prerendered bitmaps. Use this if you do not have LaTeX | 1507 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
| 1417 | # installed or if you want to formulas look prettier in the HTML output. When | 1508 | # installed or if you want to formulas look prettier in the HTML output. When |
| 1418 | # enabled you may also need to install MathJax separately and configure the path | 1509 | # enabled you may also need to install MathJax separately and configure the path |
| 1419 | # to it using the MATHJAX_RELPATH option. | 1510 | # to it using the MATHJAX_RELPATH option. |
| @@ -1439,8 +1530,8 @@ MATHJAX_FORMAT = HTML-CSS | |||
| 1439 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax | 1530 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
| 1440 | # Content Delivery Network so you can quickly see the result without installing | 1531 | # Content Delivery Network so you can quickly see the result without installing |
| 1441 | # MathJax. However, it is strongly recommended to install a local copy of | 1532 | # MathJax. However, it is strongly recommended to install a local copy of |
| 1442 | # MathJax from http://www.mathjax.org before deployment. | 1533 | # MathJax from https://www.mathjax.org before deployment. |
| 1443 | # The default value is: http://cdn.mathjax.org/mathjax/latest. | 1534 | # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. |
| 1444 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1535 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| 1445 | 1536 | ||
| 1446 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest | 1537 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
| @@ -1499,9 +1590,9 @@ SERVER_BASED_SEARCH = NO | |||
| 1499 | # external search engine pointed to by the SEARCHENGINE_URL option to obtain the | 1590 | # external search engine pointed to by the SEARCHENGINE_URL option to obtain the |
| 1500 | # search results. | 1591 | # search results. |
| 1501 | # | 1592 | # |
| 1502 | # Doxygen ships with an example indexer ( doxyindexer) and search engine | 1593 | # Doxygen ships with an example indexer (doxyindexer) and search engine |
| 1503 | # (doxysearch.cgi) which are based on the open source search engine library | 1594 | # (doxysearch.cgi) which are based on the open source search engine library |
| 1504 | # Xapian (see: http://xapian.org/). | 1595 | # Xapian (see: https://xapian.org/). |
| 1505 | # | 1596 | # |
| 1506 | # See the section "External Indexing and Searching" for details. | 1597 | # See the section "External Indexing and Searching" for details. |
| 1507 | # The default value is: NO. | 1598 | # The default value is: NO. |
| @@ -1512,9 +1603,9 @@ EXTERNAL_SEARCH = NO | |||
| 1512 | # The SEARCHENGINE_URL should point to a search engine hosted by a web server | 1603 | # The SEARCHENGINE_URL should point to a search engine hosted by a web server |
| 1513 | # which will return the search results when EXTERNAL_SEARCH is enabled. | 1604 | # which will return the search results when EXTERNAL_SEARCH is enabled. |
| 1514 | # | 1605 | # |
| 1515 | # Doxygen ships with an example indexer ( doxyindexer) and search engine | 1606 | # Doxygen ships with an example indexer (doxyindexer) and search engine |
| 1516 | # (doxysearch.cgi) which are based on the open source search engine library | 1607 | # (doxysearch.cgi) which are based on the open source search engine library |
| 1517 | # Xapian (see: http://xapian.org/). See the section "External Indexing and | 1608 | # Xapian (see: https://xapian.org/). See the section "External Indexing and |
| 1518 | # Searching" for details. | 1609 | # Searching" for details. |
| 1519 | # This tag requires that the tag SEARCHENGINE is set to YES. | 1610 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| 1520 | 1611 | ||
| @@ -1550,7 +1641,7 @@ EXTRA_SEARCH_MAPPINGS = | |||
| 1550 | # Configuration options related to the LaTeX output | 1641 | # Configuration options related to the LaTeX output |
| 1551 | #--------------------------------------------------------------------------- | 1642 | #--------------------------------------------------------------------------- |
| 1552 | 1643 | ||
| 1553 | # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. | 1644 | # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. |
| 1554 | # The default value is: YES. | 1645 | # The default value is: YES. |
| 1555 | 1646 | ||
| 1556 | GENERATE_LATEX = NO | 1647 | GENERATE_LATEX = NO |
| @@ -1566,22 +1657,36 @@ LATEX_OUTPUT = latex | |||
| 1566 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | 1657 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
| 1567 | # invoked. | 1658 | # invoked. |
| 1568 | # | 1659 | # |
| 1569 | # Note that when enabling USE_PDFLATEX this option is only used for generating | 1660 | # Note that when not enabling USE_PDFLATEX the default is latex when enabling |
| 1570 | # bitmaps for formulas in the HTML output, but not in the Makefile that is | 1661 | # USE_PDFLATEX the default is pdflatex and when in the later case latex is |
| 1571 | # written to the output directory. | 1662 | # chosen this is overwritten by pdflatex. For specific output languages the |
| 1572 | # The default file is: latex. | 1663 | # default can have been set differently, this depends on the implementation of |
| 1664 | # the output language. | ||
| 1573 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 1665 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1574 | 1666 | ||
| 1575 | LATEX_CMD_NAME = latex | 1667 | LATEX_CMD_NAME = latex |
| 1576 | 1668 | ||
| 1577 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate | 1669 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
| 1578 | # index for LaTeX. | 1670 | # index for LaTeX. |
| 1671 | # Note: This tag is used in the Makefile / make.bat. | ||
| 1672 | # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file | ||
| 1673 | # (.tex). | ||
| 1579 | # The default file is: makeindex. | 1674 | # The default file is: makeindex. |
| 1580 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 1675 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1581 | 1676 | ||
| 1582 | MAKEINDEX_CMD_NAME = makeindex | 1677 | MAKEINDEX_CMD_NAME = makeindex |
| 1583 | 1678 | ||
| 1584 | # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX | 1679 | # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to |
| 1680 | # generate index for LaTeX. In case there is no backslash (\) as first character | ||
| 1681 | # it will be automatically added in the LaTeX code. | ||
| 1682 | # Note: This tag is used in the generated output file (.tex). | ||
| 1683 | # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. | ||
| 1684 | # The default value is: makeindex. | ||
| 1685 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 1686 | |||
| 1687 | LATEX_MAKEINDEX_CMD = makeindex | ||
| 1688 | |||
| 1689 | # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX | ||
| 1585 | # documents. This may be useful for small projects and may help to save some | 1690 | # documents. This may be useful for small projects and may help to save some |
| 1586 | # trees in general. | 1691 | # trees in general. |
| 1587 | # The default value is: NO. | 1692 | # The default value is: NO. |
| @@ -1599,9 +1704,12 @@ COMPACT_LATEX = NO | |||
| 1599 | PAPER_TYPE = a4wide | 1704 | PAPER_TYPE = a4wide |
| 1600 | 1705 | ||
| 1601 | # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names | 1706 | # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names |
| 1602 | # that should be included in the LaTeX output. To get the times font for | 1707 | # that should be included in the LaTeX output. The package can be specified just |
| 1603 | # instance you can specify | 1708 | # by its name or with the correct syntax as to be used with the LaTeX |
| 1604 | # EXTRA_PACKAGES=times | 1709 | # \usepackage command. To get the times font for instance you can specify : |
| 1710 | # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} | ||
| 1711 | # To use the option intlimits with the amsmath package you can specify: | ||
| 1712 | # EXTRA_PACKAGES=[intlimits]{amsmath} | ||
| 1605 | # If left blank no extra packages will be included. | 1713 | # If left blank no extra packages will be included. |
| 1606 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 1714 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1607 | 1715 | ||
| @@ -1616,9 +1724,9 @@ EXTRA_PACKAGES = | |||
| 1616 | # Note: Only use a user-defined header if you know what you are doing! The | 1724 | # Note: Only use a user-defined header if you know what you are doing! The |
| 1617 | # following commands have a special meaning inside the header: $title, | 1725 | # following commands have a special meaning inside the header: $title, |
| 1618 | # $datetime, $date, $doxygenversion, $projectname, $projectnumber, | 1726 | # $datetime, $date, $doxygenversion, $projectname, $projectnumber, |
| 1619 | # $projectbrief, $projectlogo. Doxygen will replace $title with the empy string, | 1727 | # $projectbrief, $projectlogo. Doxygen will replace $title with the empty |
| 1620 | # for the replacement values of the other commands the user is refered to | 1728 | # string, for the replacement values of the other commands the user is referred |
| 1621 | # HTML_HEADER. | 1729 | # to HTML_HEADER. |
| 1622 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 1730 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1623 | 1731 | ||
| 1624 | LATEX_HEADER = | 1732 | LATEX_HEADER = |
| @@ -1634,6 +1742,17 @@ LATEX_HEADER = | |||
| 1634 | 1742 | ||
| 1635 | LATEX_FOOTER = | 1743 | LATEX_FOOTER = |
| 1636 | 1744 | ||
| 1745 | # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined | ||
| 1746 | # LaTeX style sheets that are included after the standard style sheets created | ||
| 1747 | # by doxygen. Using this option one can overrule certain style aspects. Doxygen | ||
| 1748 | # will copy the style sheet files to the output directory. | ||
| 1749 | # Note: The order of the extra style sheet files is of importance (e.g. the last | ||
| 1750 | # style sheet in the list overrules the setting of the previous ones in the | ||
| 1751 | # list). | ||
| 1752 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 1753 | |||
| 1754 | LATEX_EXTRA_STYLESHEET = | ||
| 1755 | |||
| 1637 | # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or | 1756 | # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
| 1638 | # other source files which should be copied to the LATEX_OUTPUT output | 1757 | # other source files which should be copied to the LATEX_OUTPUT output |
| 1639 | # directory. Note that the files will be copied as-is; there are no commands or | 1758 | # directory. Note that the files will be copied as-is; there are no commands or |
| @@ -1652,7 +1771,7 @@ LATEX_EXTRA_FILES = | |||
| 1652 | PDF_HYPERLINKS = NO | 1771 | PDF_HYPERLINKS = NO |
| 1653 | 1772 | ||
| 1654 | # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate | 1773 | # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
| 1655 | # the PDF file directly from the LaTeX files. Set this option to YES to get a | 1774 | # the PDF file directly from the LaTeX files. Set this option to YES, to get a |
| 1656 | # higher quality PDF documentation. | 1775 | # higher quality PDF documentation. |
| 1657 | # The default value is: YES. | 1776 | # The default value is: YES. |
| 1658 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 1777 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| @@ -1687,17 +1806,33 @@ LATEX_SOURCE_CODE = NO | |||
| 1687 | 1806 | ||
| 1688 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the | 1807 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
| 1689 | # bibliography, e.g. plainnat, or ieeetr. See | 1808 | # bibliography, e.g. plainnat, or ieeetr. See |
| 1690 | # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. | 1809 | # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
| 1691 | # The default value is: plain. | 1810 | # The default value is: plain. |
| 1692 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 1811 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1693 | 1812 | ||
| 1694 | LATEX_BIB_STYLE = plain | 1813 | LATEX_BIB_STYLE = plain |
| 1695 | 1814 | ||
| 1815 | # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated | ||
| 1816 | # page will contain the date and time when the page was generated. Setting this | ||
| 1817 | # to NO can help when comparing the output of multiple runs. | ||
| 1818 | # The default value is: NO. | ||
| 1819 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 1820 | |||
| 1821 | LATEX_TIMESTAMP = NO | ||
| 1822 | |||
| 1823 | # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) | ||
| 1824 | # path from which the emoji images will be read. If a relative path is entered, | ||
| 1825 | # it will be relative to the LATEX_OUTPUT directory. If left blank the | ||
| 1826 | # LATEX_OUTPUT directory will be used. | ||
| 1827 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
| 1828 | |||
| 1829 | LATEX_EMOJI_DIRECTORY = | ||
| 1830 | |||
| 1696 | #--------------------------------------------------------------------------- | 1831 | #--------------------------------------------------------------------------- |
| 1697 | # Configuration options related to the RTF output | 1832 | # Configuration options related to the RTF output |
| 1698 | #--------------------------------------------------------------------------- | 1833 | #--------------------------------------------------------------------------- |
| 1699 | 1834 | ||
| 1700 | # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The | 1835 | # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The |
| 1701 | # RTF output is optimized for Word 97 and may not look too pretty with other RTF | 1836 | # RTF output is optimized for Word 97 and may not look too pretty with other RTF |
| 1702 | # readers/editors. | 1837 | # readers/editors. |
| 1703 | # The default value is: NO. | 1838 | # The default value is: NO. |
| @@ -1712,7 +1847,7 @@ GENERATE_RTF = NO | |||
| 1712 | 1847 | ||
| 1713 | RTF_OUTPUT = rtf | 1848 | RTF_OUTPUT = rtf |
| 1714 | 1849 | ||
| 1715 | # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF | 1850 | # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF |
| 1716 | # documents. This may be useful for small projects and may help to save some | 1851 | # documents. This may be useful for small projects and may help to save some |
| 1717 | # trees in general. | 1852 | # trees in general. |
| 1718 | # The default value is: NO. | 1853 | # The default value is: NO. |
| @@ -1732,9 +1867,9 @@ COMPACT_RTF = NO | |||
| 1732 | 1867 | ||
| 1733 | RTF_HYPERLINKS = NO | 1868 | RTF_HYPERLINKS = NO |
| 1734 | 1869 | ||
| 1735 | # Load stylesheet definitions from file. Syntax is similar to doxygen's config | 1870 | # Load stylesheet definitions from file. Syntax is similar to doxygen's |
| 1736 | # file, i.e. a series of assignments. You only have to provide replacements, | 1871 | # configuration file, i.e. a series of assignments. You only have to provide |
| 1737 | # missing definitions are set to their default value. | 1872 | # replacements, missing definitions are set to their default value. |
| 1738 | # | 1873 | # |
| 1739 | # See also section "Doxygen usage" for information on how to generate the | 1874 | # See also section "Doxygen usage" for information on how to generate the |
| 1740 | # default style sheet that doxygen normally uses. | 1875 | # default style sheet that doxygen normally uses. |
| @@ -1743,17 +1878,27 @@ RTF_HYPERLINKS = NO | |||
| 1743 | RTF_STYLESHEET_FILE = | 1878 | RTF_STYLESHEET_FILE = |
| 1744 | 1879 | ||
| 1745 | # Set optional variables used in the generation of an RTF document. Syntax is | 1880 | # Set optional variables used in the generation of an RTF document. Syntax is |
| 1746 | # similar to doxygen's config file. A template extensions file can be generated | 1881 | # similar to doxygen's configuration file. A template extensions file can be |
| 1747 | # using doxygen -e rtf extensionFile. | 1882 | # generated using doxygen -e rtf extensionFile. |
| 1748 | # This tag requires that the tag GENERATE_RTF is set to YES. | 1883 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| 1749 | 1884 | ||
| 1750 | RTF_EXTENSIONS_FILE = | 1885 | RTF_EXTENSIONS_FILE = |
| 1751 | 1886 | ||
| 1887 | # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code | ||
| 1888 | # with syntax highlighting in the RTF output. | ||
| 1889 | # | ||
| 1890 | # Note that which sources are shown also depends on other settings such as | ||
| 1891 | # SOURCE_BROWSER. | ||
| 1892 | # The default value is: NO. | ||
| 1893 | # This tag requires that the tag GENERATE_RTF is set to YES. | ||
| 1894 | |||
| 1895 | RTF_SOURCE_CODE = NO | ||
| 1896 | |||
| 1752 | #--------------------------------------------------------------------------- | 1897 | #--------------------------------------------------------------------------- |
| 1753 | # Configuration options related to the man page output | 1898 | # Configuration options related to the man page output |
| 1754 | #--------------------------------------------------------------------------- | 1899 | #--------------------------------------------------------------------------- |
| 1755 | 1900 | ||
| 1756 | # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for | 1901 | # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for |
| 1757 | # classes and files. | 1902 | # classes and files. |
| 1758 | # The default value is: NO. | 1903 | # The default value is: NO. |
| 1759 | 1904 | ||
| @@ -1797,7 +1942,7 @@ MAN_LINKS = NO | |||
| 1797 | # Configuration options related to the XML output | 1942 | # Configuration options related to the XML output |
| 1798 | #--------------------------------------------------------------------------- | 1943 | #--------------------------------------------------------------------------- |
| 1799 | 1944 | ||
| 1800 | # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that | 1945 | # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that |
| 1801 | # captures the structure of the code including all documentation. | 1946 | # captures the structure of the code including all documentation. |
| 1802 | # The default value is: NO. | 1947 | # The default value is: NO. |
| 1803 | 1948 | ||
| @@ -1811,7 +1956,7 @@ GENERATE_XML = NO | |||
| 1811 | 1956 | ||
| 1812 | XML_OUTPUT = xml | 1957 | XML_OUTPUT = xml |
| 1813 | 1958 | ||
| 1814 | # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program | 1959 | # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program |
| 1815 | # listings (including syntax highlighting and cross-referencing information) to | 1960 | # listings (including syntax highlighting and cross-referencing information) to |
| 1816 | # the XML output. Note that enabling this will significantly increase the size | 1961 | # the XML output. Note that enabling this will significantly increase the size |
| 1817 | # of the XML output. | 1962 | # of the XML output. |
| @@ -1820,11 +1965,18 @@ XML_OUTPUT = xml | |||
| 1820 | 1965 | ||
| 1821 | XML_PROGRAMLISTING = YES | 1966 | XML_PROGRAMLISTING = YES |
| 1822 | 1967 | ||
| 1968 | # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include | ||
| 1969 | # namespace members in file scope as well, matching the HTML output. | ||
| 1970 | # The default value is: NO. | ||
| 1971 | # This tag requires that the tag GENERATE_XML is set to YES. | ||
| 1972 | |||
| 1973 | XML_NS_MEMB_FILE_SCOPE = NO | ||
| 1974 | |||
| 1823 | #--------------------------------------------------------------------------- | 1975 | #--------------------------------------------------------------------------- |
| 1824 | # Configuration options related to the DOCBOOK output | 1976 | # Configuration options related to the DOCBOOK output |
| 1825 | #--------------------------------------------------------------------------- | 1977 | #--------------------------------------------------------------------------- |
| 1826 | 1978 | ||
| 1827 | # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files | 1979 | # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files |
| 1828 | # that can be used to generate PDF. | 1980 | # that can be used to generate PDF. |
| 1829 | # The default value is: NO. | 1981 | # The default value is: NO. |
| 1830 | 1982 | ||
| @@ -1838,7 +1990,7 @@ GENERATE_DOCBOOK = NO | |||
| 1838 | 1990 | ||
| 1839 | DOCBOOK_OUTPUT = docbook | 1991 | DOCBOOK_OUTPUT = docbook |
| 1840 | 1992 | ||
| 1841 | # If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the | 1993 | # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the |
| 1842 | # program listings (including syntax highlighting and cross-referencing | 1994 | # program listings (including syntax highlighting and cross-referencing |
| 1843 | # information) to the DOCBOOK output. Note that enabling this will significantly | 1995 | # information) to the DOCBOOK output. Note that enabling this will significantly |
| 1844 | # increase the size of the DOCBOOK output. | 1996 | # increase the size of the DOCBOOK output. |
| @@ -1851,10 +2003,10 @@ DOCBOOK_PROGRAMLISTING = NO | |||
| 1851 | # Configuration options for the AutoGen Definitions output | 2003 | # Configuration options for the AutoGen Definitions output |
| 1852 | #--------------------------------------------------------------------------- | 2004 | #--------------------------------------------------------------------------- |
| 1853 | 2005 | ||
| 1854 | # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen | 2006 | # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
| 1855 | # Definitions (see http://autogen.sf.net) file that captures the structure of | 2007 | # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures |
| 1856 | # the code including all documentation. Note that this feature is still | 2008 | # the structure of the code including all documentation. Note that this feature |
| 1857 | # experimental and incomplete at the moment. | 2009 | # is still experimental and incomplete at the moment. |
| 1858 | # The default value is: NO. | 2010 | # The default value is: NO. |
| 1859 | 2011 | ||
| 1860 | GENERATE_AUTOGEN_DEF = NO | 2012 | GENERATE_AUTOGEN_DEF = NO |
| @@ -1863,7 +2015,7 @@ GENERATE_AUTOGEN_DEF = NO | |||
| 1863 | # Configuration options related to the Perl module output | 2015 | # Configuration options related to the Perl module output |
| 1864 | #--------------------------------------------------------------------------- | 2016 | #--------------------------------------------------------------------------- |
| 1865 | 2017 | ||
| 1866 | # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module | 2018 | # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module |
| 1867 | # file that captures the structure of the code including all documentation. | 2019 | # file that captures the structure of the code including all documentation. |
| 1868 | # | 2020 | # |
| 1869 | # Note that this feature is still experimental and incomplete at the moment. | 2021 | # Note that this feature is still experimental and incomplete at the moment. |
| @@ -1871,7 +2023,7 @@ GENERATE_AUTOGEN_DEF = NO | |||
| 1871 | 2023 | ||
| 1872 | GENERATE_PERLMOD = NO | 2024 | GENERATE_PERLMOD = NO |
| 1873 | 2025 | ||
| 1874 | # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary | 2026 | # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary |
| 1875 | # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI | 2027 | # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI |
| 1876 | # output from the Perl module output. | 2028 | # output from the Perl module output. |
| 1877 | # The default value is: NO. | 2029 | # The default value is: NO. |
| @@ -1879,9 +2031,9 @@ GENERATE_PERLMOD = NO | |||
| 1879 | 2031 | ||
| 1880 | PERLMOD_LATEX = NO | 2032 | PERLMOD_LATEX = NO |
| 1881 | 2033 | ||
| 1882 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely | 2034 | # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely |
| 1883 | # formatted so it can be parsed by a human reader. This is useful if you want to | 2035 | # formatted so it can be parsed by a human reader. This is useful if you want to |
| 1884 | # understand what is going on. On the other hand, if this tag is set to NO the | 2036 | # understand what is going on. On the other hand, if this tag is set to NO, the |
| 1885 | # size of the Perl module output will be much smaller and Perl will parse it | 2037 | # size of the Perl module output will be much smaller and Perl will parse it |
| 1886 | # just the same. | 2038 | # just the same. |
| 1887 | # The default value is: YES. | 2039 | # The default value is: YES. |
| @@ -1901,14 +2053,14 @@ PERLMOD_MAKEVAR_PREFIX = | |||
| 1901 | # Configuration options related to the preprocessor | 2053 | # Configuration options related to the preprocessor |
| 1902 | #--------------------------------------------------------------------------- | 2054 | #--------------------------------------------------------------------------- |
| 1903 | 2055 | ||
| 1904 | # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all | 2056 | # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all |
| 1905 | # C-preprocessor directives found in the sources and include files. | 2057 | # C-preprocessor directives found in the sources and include files. |
| 1906 | # The default value is: YES. | 2058 | # The default value is: YES. |
| 1907 | 2059 | ||
| 1908 | ENABLE_PREPROCESSING = YES | 2060 | ENABLE_PREPROCESSING = YES |
| 1909 | 2061 | ||
| 1910 | # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names | 2062 | # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names |
| 1911 | # in the source code. If set to NO only conditional compilation will be | 2063 | # in the source code. If set to NO, only conditional compilation will be |
| 1912 | # performed. Macro expansion can be done in a controlled way by setting | 2064 | # performed. Macro expansion can be done in a controlled way by setting |
| 1913 | # EXPAND_ONLY_PREDEF to YES. | 2065 | # EXPAND_ONLY_PREDEF to YES. |
| 1914 | # The default value is: NO. | 2066 | # The default value is: NO. |
| @@ -1924,7 +2076,7 @@ MACRO_EXPANSION = NO | |||
| 1924 | 2076 | ||
| 1925 | EXPAND_ONLY_PREDEF = NO | 2077 | EXPAND_ONLY_PREDEF = NO |
| 1926 | 2078 | ||
| 1927 | # If the SEARCH_INCLUDES tag is set to YES the includes files in the | 2079 | # If the SEARCH_INCLUDES tag is set to YES, the include files in the |
| 1928 | # INCLUDE_PATH will be searched if a #include is found. | 2080 | # INCLUDE_PATH will be searched if a #include is found. |
| 1929 | # The default value is: YES. | 2081 | # The default value is: YES. |
| 1930 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | 2082 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| @@ -2000,37 +2152,32 @@ TAGFILES = | |||
| 2000 | 2152 | ||
| 2001 | GENERATE_TAGFILE = | 2153 | GENERATE_TAGFILE = |
| 2002 | 2154 | ||
| 2003 | # If the ALLEXTERNALS tag is set to YES all external class will be listed in the | 2155 | # If the ALLEXTERNALS tag is set to YES, all external class will be listed in |
| 2004 | # class index. If set to NO only the inherited external classes will be listed. | 2156 | # the class index. If set to NO, only the inherited external classes will be |
| 2157 | # listed. | ||
| 2005 | # The default value is: NO. | 2158 | # The default value is: NO. |
| 2006 | 2159 | ||
| 2007 | ALLEXTERNALS = NO | 2160 | ALLEXTERNALS = NO |
| 2008 | 2161 | ||
| 2009 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in | 2162 | # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed |
| 2010 | # the modules index. If set to NO, only the current project's groups will be | 2163 | # in the modules index. If set to NO, only the current project's groups will be |
| 2011 | # listed. | 2164 | # listed. |
| 2012 | # The default value is: YES. | 2165 | # The default value is: YES. |
| 2013 | 2166 | ||
| 2014 | EXTERNAL_GROUPS = YES | 2167 | EXTERNAL_GROUPS = YES |
| 2015 | 2168 | ||
| 2016 | # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in | 2169 | # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in |
| 2017 | # the related pages index. If set to NO, only the current project's pages will | 2170 | # the related pages index. If set to NO, only the current project's pages will |
| 2018 | # be listed. | 2171 | # be listed. |
| 2019 | # The default value is: YES. | 2172 | # The default value is: YES. |
| 2020 | 2173 | ||
| 2021 | EXTERNAL_PAGES = YES | 2174 | EXTERNAL_PAGES = YES |
| 2022 | 2175 | ||
| 2023 | # The PERL_PATH should be the absolute path and name of the perl script | ||
| 2024 | # interpreter (i.e. the result of 'which perl'). | ||
| 2025 | # The default file (with absolute path) is: /usr/bin/perl. | ||
| 2026 | |||
| 2027 | PERL_PATH = /usr/bin/perl | ||
| 2028 | |||
| 2029 | #--------------------------------------------------------------------------- | 2176 | #--------------------------------------------------------------------------- |
| 2030 | # Configuration options related to the dot tool | 2177 | # Configuration options related to the dot tool |
| 2031 | #--------------------------------------------------------------------------- | 2178 | #--------------------------------------------------------------------------- |
| 2032 | 2179 | ||
| 2033 | # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram | 2180 | # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram |
| 2034 | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to | 2181 | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to |
| 2035 | # NO turns the diagrams off. Note that this option also works with HAVE_DOT | 2182 | # NO turns the diagrams off. Note that this option also works with HAVE_DOT |
| 2036 | # disabled, but it is recommended to install and use dot, since it yields more | 2183 | # disabled, but it is recommended to install and use dot, since it yields more |
| @@ -2039,15 +2186,6 @@ PERL_PATH = /usr/bin/perl | |||
| 2039 | 2186 | ||
| 2040 | CLASS_DIAGRAMS = YES | 2187 | CLASS_DIAGRAMS = YES |
| 2041 | 2188 | ||
| 2042 | # You can define message sequence charts within doxygen comments using the \msc | ||
| 2043 | # command. Doxygen will then run the mscgen tool (see: | ||
| 2044 | # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the | ||
| 2045 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where | ||
| 2046 | # the mscgen tool resides. If left empty the tool is assumed to be found in the | ||
| 2047 | # default search path. | ||
| 2048 | |||
| 2049 | MSCGEN_PATH = | ||
| 2050 | |||
| 2051 | # You can include diagrams made with dia in doxygen documentation. Doxygen will | 2189 | # You can include diagrams made with dia in doxygen documentation. Doxygen will |
| 2052 | # then run dia to produce the diagram and insert it in the documentation. The | 2190 | # then run dia to produce the diagram and insert it in the documentation. The |
| 2053 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. | 2191 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
| @@ -2055,7 +2193,7 @@ MSCGEN_PATH = | |||
| 2055 | 2193 | ||
| 2056 | DIA_PATH = | 2194 | DIA_PATH = |
| 2057 | 2195 | ||
| 2058 | # If set to YES, the inheritance and collaboration graphs will hide inheritance | 2196 | # If set to YES the inheritance and collaboration graphs will hide inheritance |
| 2059 | # and usage relations if the target is undocumented or is not a class. | 2197 | # and usage relations if the target is undocumented or is not a class. |
| 2060 | # The default value is: YES. | 2198 | # The default value is: YES. |
| 2061 | 2199 | ||
| @@ -2128,7 +2266,7 @@ COLLABORATION_GRAPH = YES | |||
| 2128 | 2266 | ||
| 2129 | GROUP_GRAPHS = YES | 2267 | GROUP_GRAPHS = YES |
| 2130 | 2268 | ||
| 2131 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | 2269 | # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and |
| 2132 | # collaboration diagrams in a style similar to the OMG's Unified Modeling | 2270 | # collaboration diagrams in a style similar to the OMG's Unified Modeling |
| 2133 | # Language. | 2271 | # Language. |
| 2134 | # The default value is: NO. | 2272 | # The default value is: NO. |
| @@ -2180,7 +2318,8 @@ INCLUDED_BY_GRAPH = YES | |||
| 2180 | # | 2318 | # |
| 2181 | # Note that enabling this option will significantly increase the time of a run. | 2319 | # Note that enabling this option will significantly increase the time of a run. |
| 2182 | # So in most cases it will be better to enable call graphs for selected | 2320 | # So in most cases it will be better to enable call graphs for selected |
| 2183 | # functions only using the \callgraph command. | 2321 | # functions only using the \callgraph command. Disabling a call graph can be |
| 2322 | # accomplished by means of the command \hidecallgraph. | ||
| 2184 | # The default value is: NO. | 2323 | # The default value is: NO. |
| 2185 | # This tag requires that the tag HAVE_DOT is set to YES. | 2324 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2186 | 2325 | ||
| @@ -2191,7 +2330,8 @@ CALL_GRAPH = NO | |||
| 2191 | # | 2330 | # |
| 2192 | # Note that enabling this option will significantly increase the time of a run. | 2331 | # Note that enabling this option will significantly increase the time of a run. |
| 2193 | # So in most cases it will be better to enable caller graphs for selected | 2332 | # So in most cases it will be better to enable caller graphs for selected |
| 2194 | # functions only using the \callergraph command. | 2333 | # functions only using the \callergraph command. Disabling a caller graph can be |
| 2334 | # accomplished by means of the command \hidecallergraph. | ||
| 2195 | # The default value is: NO. | 2335 | # The default value is: NO. |
| 2196 | # This tag requires that the tag HAVE_DOT is set to YES. | 2336 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2197 | 2337 | ||
| @@ -2214,11 +2354,15 @@ GRAPHICAL_HIERARCHY = YES | |||
| 2214 | DIRECTORY_GRAPH = YES | 2354 | DIRECTORY_GRAPH = YES |
| 2215 | 2355 | ||
| 2216 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | 2356 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
| 2217 | # generated by dot. | 2357 | # generated by dot. For an explanation of the image formats see the section |
| 2358 | # output formats in the documentation of the dot tool (Graphviz (see: | ||
| 2359 | # http://www.graphviz.org/)). | ||
| 2218 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order | 2360 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
| 2219 | # to make the SVG files visible in IE 9+ (other browsers do not have this | 2361 | # to make the SVG files visible in IE 9+ (other browsers do not have this |
| 2220 | # requirement). | 2362 | # requirement). |
| 2221 | # Possible values are: png, jpg, gif and svg. | 2363 | # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, |
| 2364 | # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and | ||
| 2365 | # png:gdiplus:gdiplus. | ||
| 2222 | # The default value is: png. | 2366 | # The default value is: png. |
| 2223 | # This tag requires that the tag HAVE_DOT is set to YES. | 2367 | # This tag requires that the tag HAVE_DOT is set to YES. |
| 2224 | 2368 | ||
| @@ -2266,10 +2410,19 @@ DIAFILE_DIRS = | |||
| 2266 | # PlantUML is not used or called during a preprocessing step. Doxygen will | 2410 | # PlantUML is not used or called during a preprocessing step. Doxygen will |
| 2267 | # generate a warning when it encounters a \startuml command in this case and | 2411 | # generate a warning when it encounters a \startuml command in this case and |
| 2268 | # will not generate output for the diagram. | 2412 | # will not generate output for the diagram. |
| 2269 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
| 2270 | 2413 | ||
| 2271 | PLANTUML_JAR_PATH = | 2414 | PLANTUML_JAR_PATH = |
| 2272 | 2415 | ||
| 2416 | # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a | ||
| 2417 | # configuration file for plantuml. | ||
| 2418 | |||
| 2419 | PLANTUML_CFG_FILE = | ||
| 2420 | |||
| 2421 | # When using plantuml, the specified paths are searched for files specified by | ||
| 2422 | # the !include statement in a plantuml block. | ||
| 2423 | |||
| 2424 | PLANTUML_INCLUDE_PATH = | ||
| 2425 | |||
| 2273 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes | 2426 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
| 2274 | # that will be shown in the graph. If the number of nodes in a graph becomes | 2427 | # that will be shown in the graph. If the number of nodes in a graph becomes |
| 2275 | # larger than this value, doxygen will truncate the graph, which is visualized | 2428 | # larger than this value, doxygen will truncate the graph, which is visualized |
| @@ -2306,7 +2459,7 @@ MAX_DOT_GRAPH_DEPTH = 0 | |||
| 2306 | 2459 | ||
| 2307 | DOT_TRANSPARENT = NO | 2460 | DOT_TRANSPARENT = NO |
| 2308 | 2461 | ||
| 2309 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | 2462 | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output |
| 2310 | # files in one run (i.e. multiple -o and -T options on the command line). This | 2463 | # files in one run (i.e. multiple -o and -T options on the command line). This |
| 2311 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support | 2464 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support |
| 2312 | # this, this feature is disabled by default. | 2465 | # this, this feature is disabled by default. |
| @@ -2323,7 +2476,7 @@ DOT_MULTI_TARGETS = NO | |||
| 2323 | 2476 | ||
| 2324 | GENERATE_LEGEND = YES | 2477 | GENERATE_LEGEND = YES |
| 2325 | 2478 | ||
| 2326 | # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot | 2479 | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot |
| 2327 | # files that are used to generate the various graphs. | 2480 | # files that are used to generate the various graphs. |
| 2328 | # The default value is: YES. | 2481 | # The default value is: YES. |
| 2329 | # This tag requires that the tag HAVE_DOT is set to YES. | 2482 | # This tag requires that the tag HAVE_DOT is set to YES. |
