diff options
| author | 2009-07-25 18:12:49 +0200 | |
|---|---|---|
| committer | 2009-07-25 18:12:49 +0200 | |
| commit | da94f0ebc7232e8e9d0e629fe559b7bc93d9a1c6 (patch) | |
| tree | 30d2087ecbc46538ffffda56e075b4242040914b /doxygen.cfg | |
| parent | 0e255cfe381caedf0375e6834021333d971f8050 (diff) | |
| download | libimobiledevice-da94f0ebc7232e8e9d0e629fe559b7bc93d9a1c6.tar.gz libimobiledevice-da94f0ebc7232e8e9d0e629fe559b7bc93d9a1c6.tar.bz2 | |
Update doxygen config and allow generation of documentation
Diffstat (limited to 'doxygen.cfg')
| -rw-r--r-- | doxygen.cfg | 269 |
1 files changed, 196 insertions, 73 deletions
diff --git a/doxygen.cfg b/doxygen.cfg index 990802c..0942031 100644 --- a/doxygen.cfg +++ b/doxygen.cfg | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | # Doxyfile 1.5.3 | 1 | # Doxyfile 1.5.6 |
| 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 |
| @@ -14,11 +14,11 @@ | |||
| 14 | # Project related configuration options | 14 | # Project related configuration options |
| 15 | #--------------------------------------------------------------------------- | 15 | #--------------------------------------------------------------------------- |
| 16 | 16 | ||
| 17 | # This tag specifies the encoding used for all characters in the config file that | 17 | # This tag specifies the encoding used for all characters in the config file |
| 18 | # follow. The default is UTF-8 which is also the encoding used for all text before | 18 | # that follow. The default is UTF-8 which is also the encoding used for all |
| 19 | # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into | 19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the |
| 20 | # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of | 20 | # iconv built into libc) for the transcoding. See |
| 21 | # possible encodings. | 21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. |
| 22 | 22 | ||
| 23 | DOXYFILE_ENCODING = UTF-8 | 23 | DOXYFILE_ENCODING = UTF-8 |
| 24 | 24 | ||
| @@ -31,7 +31,7 @@ PROJECT_NAME = libiphone | |||
| 31 | # This could be handy for archiving the generated documentation or | 31 | # This could be handy for archiving the generated documentation or |
| 32 | # if some version control system is used. | 32 | # if some version control system is used. |
| 33 | 33 | ||
| 34 | PROJECT_NUMBER = 0.1.0 | 34 | PROJECT_NUMBER = 0.9.1 |
| 35 | 35 | ||
| 36 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | 36 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
| 37 | # base path where the generated documentation will be put. | 37 | # base path where the generated documentation will be put. |
| @@ -54,10 +54,11 @@ CREATE_SUBDIRS = NO | |||
| 54 | # information to generate all constant output in the proper language. | 54 | # information to generate all constant output in the proper language. |
| 55 | # The default language is English, other supported languages are: | 55 | # The default language is English, other supported languages are: |
| 56 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | 56 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
| 57 | # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, | 57 | # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, |
| 58 | # Italian, Japanese, Japanese-en (Japanese with English messages), Korean, | 58 | # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), |
| 59 | # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, | 59 | # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, |
| 60 | # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. | 60 | # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, |
| 61 | # and Ukrainian. | ||
| 61 | 62 | ||
| 62 | OUTPUT_LANGUAGE = English | 63 | OUTPUT_LANGUAGE = English |
| 63 | 64 | ||
| @@ -113,7 +114,7 @@ FULL_PATH_NAMES = YES | |||
| 113 | # If left blank the directory from which doxygen is run is used as the | 114 | # If left blank the directory from which doxygen is run is used as the |
| 114 | # path to strip. | 115 | # path to strip. |
| 115 | 116 | ||
| 116 | STRIP_FROM_PATH = | 117 | STRIP_FROM_PATH = include |
| 117 | 118 | ||
| 118 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of | 119 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
| 119 | # the path mentioned in the documentation of a class, which tells | 120 | # the path mentioned in the documentation of a class, which tells |
| @@ -195,14 +196,26 @@ ALIASES = | |||
| 195 | OPTIMIZE_OUTPUT_FOR_C = YES | 196 | OPTIMIZE_OUTPUT_FOR_C = YES |
| 196 | 197 | ||
| 197 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java | 198 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
| 198 | # sources only. Doxygen will then generate output that is more tailored for Java. | 199 | # sources only. Doxygen will then generate output that is more tailored for |
| 199 | # For instance, namespaces will be presented as packages, qualified scopes | 200 | # Java. For instance, namespaces will be presented as packages, qualified |
| 200 | # will look different, etc. | 201 | # scopes will look different, etc. |
| 201 | 202 | ||
| 202 | OPTIMIZE_OUTPUT_JAVA = NO | 203 | OPTIMIZE_OUTPUT_JAVA = NO |
| 203 | 204 | ||
| 204 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to | 205 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
| 205 | # include (a tag file for) the STL sources as input, then you should | 206 | # sources only. Doxygen will then generate output that is more tailored for |
| 207 | # Fortran. | ||
| 208 | |||
| 209 | OPTIMIZE_FOR_FORTRAN = NO | ||
| 210 | |||
| 211 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | ||
| 212 | # sources. Doxygen will then generate output that is tailored for | ||
| 213 | # VHDL. | ||
| 214 | |||
| 215 | OPTIMIZE_OUTPUT_VHDL = NO | ||
| 216 | |||
| 217 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | ||
| 218 | # to include (a tag file for) the STL sources as input, then you should | ||
| 206 | # set this tag to YES in order to let doxygen match functions declarations and | 219 | # set this tag to YES in order to let doxygen match functions declarations and |
| 207 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | 220 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
| 208 | # func(std::string) {}). This also make the inheritance and collaboration | 221 | # func(std::string) {}). This also make the inheritance and collaboration |
| @@ -215,6 +228,21 @@ BUILTIN_STL_SUPPORT = NO | |||
| 215 | 228 | ||
| 216 | CPP_CLI_SUPPORT = NO | 229 | CPP_CLI_SUPPORT = NO |
| 217 | 230 | ||
| 231 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. | ||
| 232 | # Doxygen will parse them like normal C++ but will assume all classes use public | ||
| 233 | # instead of private inheritance when no explicit protection keyword is present. | ||
| 234 | |||
| 235 | SIP_SUPPORT = NO | ||
| 236 | |||
| 237 | # For Microsoft's IDL there are propget and propput attributes to indicate getter | ||
| 238 | # and setter methods for a property. Setting this option to YES (the default) | ||
| 239 | # will make doxygen to replace the get and set methods by a property in the | ||
| 240 | # documentation. This will only work if the methods are indeed getting or | ||
| 241 | # setting a simple type. If this is not the case, or you want to show the | ||
| 242 | # methods anyway, you should set this option to NO. | ||
| 243 | |||
| 244 | IDL_PROPERTY_SUPPORT = YES | ||
| 245 | |||
| 218 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | 246 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
| 219 | # tag is set to YES, then doxygen will reuse the documentation of the first | 247 | # tag is set to YES, then doxygen will reuse the documentation of the first |
| 220 | # member in the group (if any) for the other members of the group. By default | 248 | # member in the group (if any) for the other members of the group. By default |
| @@ -228,7 +256,17 @@ DISTRIBUTE_GROUP_DOC = NO | |||
| 228 | # NO to prevent subgrouping. Alternatively, this can be done per class using | 256 | # NO to prevent subgrouping. Alternatively, this can be done per class using |
| 229 | # the \nosubgrouping command. | 257 | # the \nosubgrouping command. |
| 230 | 258 | ||
| 231 | SUBGROUPING = YES | 259 | SUBGROUPING = NO |
| 260 | |||
| 261 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | ||
| 262 | # is documented as struct, union, or enum with the name of the typedef. So | ||
| 263 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | ||
| 264 | # with name TypeT. When disabled the typedef will appear as a member of a file, | ||
| 265 | # namespace, or class. And the struct will be named TypeS. This can typically | ||
| 266 | # be useful for C code in case the coding convention dictates that all compound | ||
| 267 | # types are typedef'ed and only the typedef is referenced, never the tag name. | ||
| 268 | |||
| 269 | TYPEDEF_HIDES_STRUCT = YES | ||
| 232 | 270 | ||
| 233 | #--------------------------------------------------------------------------- | 271 | #--------------------------------------------------------------------------- |
| 234 | # Build related configuration options | 272 | # Build related configuration options |
| @@ -239,7 +277,7 @@ SUBGROUPING = YES | |||
| 239 | # Private class members and static file members will be hidden unless | 277 | # Private class members and static file members will be hidden unless |
| 240 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | 278 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
| 241 | 279 | ||
| 242 | EXTRACT_ALL = YES | 280 | EXTRACT_ALL = NO |
| 243 | 281 | ||
| 244 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class | 282 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
| 245 | # will be included in the documentation. | 283 | # will be included in the documentation. |
| @@ -255,7 +293,7 @@ EXTRACT_STATIC = NO | |||
| 255 | # defined locally in source files will be included in the documentation. | 293 | # defined locally in source files will be included in the documentation. |
| 256 | # If set to NO only classes defined in header files are included. | 294 | # If set to NO only classes defined in header files are included. |
| 257 | 295 | ||
| 258 | EXTRACT_LOCAL_CLASSES = YES | 296 | EXTRACT_LOCAL_CLASSES = NO |
| 259 | 297 | ||
| 260 | # This flag is only useful for Objective-C code. When set to YES local | 298 | # This flag is only useful for Objective-C code. When set to YES local |
| 261 | # methods, which are defined in the implementation section but not in | 299 | # methods, which are defined in the implementation section but not in |
| @@ -264,10 +302,11 @@ EXTRACT_LOCAL_CLASSES = YES | |||
| 264 | 302 | ||
| 265 | EXTRACT_LOCAL_METHODS = NO | 303 | EXTRACT_LOCAL_METHODS = NO |
| 266 | 304 | ||
| 267 | # If this flag is set to YES, the members of anonymous namespaces will be extracted | 305 | # If this flag is set to YES, the members of anonymous namespaces will be |
| 268 | # and appear in the documentation as a namespace called 'anonymous_namespace{file}', | 306 | # extracted and appear in the documentation as a namespace called |
| 269 | # where file will be replaced with the base name of the file that contains the anonymous | 307 | # 'anonymous_namespace{file}', where file will be replaced with the base |
| 270 | # namespace. By default anonymous namespace are hidden. | 308 | # name of the file that contains the anonymous namespace. By default |
| 309 | # anonymous namespace are hidden. | ||
| 271 | 310 | ||
| 272 | EXTRACT_ANON_NSPACES = NO | 311 | EXTRACT_ANON_NSPACES = NO |
| 273 | 312 | ||
| @@ -313,7 +352,7 @@ INTERNAL_DOCS = NO | |||
| 313 | # in case and if your file system supports case sensitive file names. Windows | 352 | # in case and if your file system supports case sensitive file names. Windows |
| 314 | # and Mac users are advised to set this option to NO. | 353 | # and Mac users are advised to set this option to NO. |
| 315 | 354 | ||
| 316 | CASE_SENSE_NAMES = YES | 355 | CASE_SENSE_NAMES = NO |
| 317 | 356 | ||
| 318 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | 357 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
| 319 | # will show members with their full class and namespace scopes in the | 358 | # will show members with their full class and namespace scopes in the |
| @@ -325,7 +364,7 @@ HIDE_SCOPE_NAMES = NO | |||
| 325 | # will put a list of the files that are included by a file in the documentation | 364 | # will put a list of the files that are included by a file in the documentation |
| 326 | # of that file. | 365 | # of that file. |
| 327 | 366 | ||
| 328 | SHOW_INCLUDE_FILES = YES | 367 | SHOW_INCLUDE_FILES = NO |
| 329 | 368 | ||
| 330 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | 369 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
| 331 | # is inserted in the documentation for inline members. | 370 | # is inserted in the documentation for inline members. |
| @@ -346,6 +385,12 @@ SORT_MEMBER_DOCS = YES | |||
| 346 | 385 | ||
| 347 | SORT_BRIEF_DOCS = NO | 386 | SORT_BRIEF_DOCS = NO |
| 348 | 387 | ||
| 388 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the | ||
| 389 | # hierarchy of group names into alphabetical order. If set to NO (the default) | ||
| 390 | # the group names will appear in their defined order. | ||
| 391 | |||
| 392 | SORT_GROUP_NAMES = NO | ||
| 393 | |||
| 349 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | 394 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
| 350 | # sorted by fully-qualified names, including namespaces. If set to | 395 | # sorted by fully-qualified names, including namespaces. If set to |
| 351 | # NO (the default), the class list will be sorted only by class name, | 396 | # NO (the default), the class list will be sorted only by class name, |
| @@ -407,9 +452,21 @@ SHOW_USED_FILES = YES | |||
| 407 | 452 | ||
| 408 | SHOW_DIRECTORIES = NO | 453 | SHOW_DIRECTORIES = NO |
| 409 | 454 | ||
| 455 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. | ||
| 456 | # This will remove the Files entry from the Quick Index and from the | ||
| 457 | # Folder Tree View (if specified). The default is YES. | ||
| 458 | |||
| 459 | SHOW_FILES = YES | ||
| 460 | |||
| 461 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the | ||
| 462 | # Namespaces page. This will remove the Namespaces entry from the Quick Index | ||
| 463 | # and from the Folder Tree View (if specified). The default is YES. | ||
| 464 | |||
| 465 | SHOW_NAMESPACES = YES | ||
| 466 | |||
| 410 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that | 467 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
| 411 | # doxygen should invoke to get the current version for each file (typically from the | 468 | # doxygen should invoke to get the current version for each file (typically from |
| 412 | # version control system). Doxygen will invoke the program by executing (via | 469 | # the version control system). Doxygen will invoke the program by executing (via |
| 413 | # popen()) the command <command> <input-file>, where <command> is the value of | 470 | # popen()) the command <command> <input-file>, where <command> is the value of |
| 414 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | 471 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
| 415 | # provided by doxygen. Whatever the program writes to standard output | 472 | # provided by doxygen. Whatever the program writes to standard output |
| @@ -477,12 +534,13 @@ WARN_LOGFILE = | |||
| 477 | # directories like "/usr/src/myproject". Separate the files or directories | 534 | # directories like "/usr/src/myproject". Separate the files or directories |
| 478 | # with spaces. | 535 | # with spaces. |
| 479 | 536 | ||
| 480 | INPUT = src | 537 | INPUT = src include/libiphone |
| 481 | 538 | ||
| 482 | # This tag can be used to specify the character encoding of the source files that | 539 | # This tag can be used to specify the character encoding of the source files |
| 483 | # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default | 540 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
| 484 | # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. | 541 | # also the default input encoding. Doxygen uses libiconv (or the iconv built |
| 485 | # See http://www.gnu.org/software/libiconv for the list of possible encodings. | 542 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
| 543 | # the list of possible encodings. | ||
| 486 | 544 | ||
| 487 | INPUT_ENCODING = UTF-8 | 545 | INPUT_ENCODING = UTF-8 |
| 488 | 546 | ||
| @@ -491,7 +549,7 @@ INPUT_ENCODING = UTF-8 | |||
| 491 | # and *.h) to filter out the source-files in the directories. If left | 549 | # and *.h) to filter out the source-files in the directories. If left |
| 492 | # blank the following patterns are tested: | 550 | # blank the following patterns are tested: |
| 493 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx | 551 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
| 494 | # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py | 552 | # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
| 495 | 553 | ||
| 496 | FILE_PATTERNS = | 554 | FILE_PATTERNS = |
| 497 | 555 | ||
| @@ -505,7 +563,7 @@ RECURSIVE = NO | |||
| 505 | # excluded from the INPUT source files. This way you can easily exclude a | 563 | # excluded from the INPUT source files. This way you can easily exclude a |
| 506 | # subdirectory from a directory tree whose root is specified with the INPUT tag. | 564 | # subdirectory from a directory tree whose root is specified with the INPUT tag. |
| 507 | 565 | ||
| 508 | EXCLUDE = src/main.c src/ifuse.c | 566 | EXCLUDE = dev |
| 509 | 567 | ||
| 510 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or | 568 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
| 511 | # directories that are symbolic links (a Unix filesystem feature) are excluded | 569 | # directories that are symbolic links (a Unix filesystem feature) are excluded |
| @@ -522,9 +580,10 @@ EXCLUDE_SYMLINKS = NO | |||
| 522 | EXCLUDE_PATTERNS = | 580 | EXCLUDE_PATTERNS = |
| 523 | 581 | ||
| 524 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | 582 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
| 525 | # (namespaces, classes, functions, etc.) that should be excluded from the output. | 583 | # (namespaces, classes, functions, etc.) that should be excluded from the |
| 526 | # The symbol name can be a fully qualified name, a word, or if the wildcard * is used, | 584 | # output. The symbol name can be a fully qualified name, a word, or if the |
| 527 | # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test | 585 | # wildcard * is used, a substring. Examples: ANamespace, AClass, |
| 586 | # AClass::ANamespace, ANamespace::*Test | ||
| 528 | 587 | ||
| 529 | EXCLUDE_SYMBOLS = | 588 | EXCLUDE_SYMBOLS = |
| 530 | 589 | ||
| @@ -586,11 +645,9 @@ FILTER_SOURCE_FILES = NO | |||
| 586 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will | 645 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
| 587 | # be generated. Documented entities will be cross-referenced with these sources. | 646 | # be generated. Documented entities will be cross-referenced with these sources. |
| 588 | # Note: To get rid of all source code in the generated output, make sure also | 647 | # Note: To get rid of all source code in the generated output, make sure also |
| 589 | # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH | 648 | # VERBATIM_HEADERS is set to NO. |
| 590 | # then you must also enable this option. If you don't then doxygen will produce | ||
| 591 | # a warning and turn it on anyway | ||
| 592 | 649 | ||
| 593 | SOURCE_BROWSER = YES | 650 | SOURCE_BROWSER = NO |
| 594 | 651 | ||
| 595 | # Setting the INLINE_SOURCES tag to YES will include the body | 652 | # Setting the INLINE_SOURCES tag to YES will include the body |
| 596 | # of functions and classes directly in the documentation. | 653 | # of functions and classes directly in the documentation. |
| @@ -603,13 +660,13 @@ INLINE_SOURCES = NO | |||
| 603 | 660 | ||
| 604 | STRIP_CODE_COMMENTS = YES | 661 | STRIP_CODE_COMMENTS = YES |
| 605 | 662 | ||
| 606 | # If the REFERENCED_BY_RELATION tag is set to YES (the default) | 663 | # If the REFERENCED_BY_RELATION tag is set to YES |
| 607 | # then for each documented function all documented | 664 | # then for each documented function all documented |
| 608 | # functions referencing it will be listed. | 665 | # functions referencing it will be listed. |
| 609 | 666 | ||
| 610 | REFERENCED_BY_RELATION = YES | 667 | REFERENCED_BY_RELATION = YES |
| 611 | 668 | ||
| 612 | # If the REFERENCES_RELATION tag is set to YES (the default) | 669 | # If the REFERENCES_RELATION tag is set to YES |
| 613 | # then for each documented function all documented entities | 670 | # then for each documented function all documented entities |
| 614 | # called/used by that function will be listed. | 671 | # called/used by that function will be listed. |
| 615 | 672 | ||
| @@ -634,7 +691,7 @@ USE_HTAGS = NO | |||
| 634 | # will generate a verbatim copy of the header file for each class for | 691 | # will generate a verbatim copy of the header file for each class for |
| 635 | # which an include is specified. Set to NO to disable this. | 692 | # which an include is specified. Set to NO to disable this. |
| 636 | 693 | ||
| 637 | VERBATIM_HEADERS = YES | 694 | VERBATIM_HEADERS = NO |
| 638 | 695 | ||
| 639 | #--------------------------------------------------------------------------- | 696 | #--------------------------------------------------------------------------- |
| 640 | # configuration options related to the alphabetical class index | 697 | # configuration options related to the alphabetical class index |
| @@ -709,11 +766,36 @@ HTML_ALIGN_MEMBERS = YES | |||
| 709 | 766 | ||
| 710 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files | 767 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
| 711 | # will be generated that can be used as input for tools like the | 768 | # will be generated that can be used as input for tools like the |
| 712 | # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | 769 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
| 713 | # of the generated HTML documentation. | 770 | # of the generated HTML documentation. |
| 714 | 771 | ||
| 715 | GENERATE_HTMLHELP = NO | 772 | GENERATE_HTMLHELP = NO |
| 716 | 773 | ||
| 774 | # If the GENERATE_DOCSET tag is set to YES, additional index files | ||
| 775 | # will be generated that can be used as input for Apple's Xcode 3 | ||
| 776 | # integrated development environment, introduced with OSX 10.5 (Leopard). | ||
| 777 | # To create a documentation set, doxygen will generate a Makefile in the | ||
| 778 | # HTML output directory. Running make will produce the docset in that | ||
| 779 | # directory and running "make install" will install the docset in | ||
| 780 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | ||
| 781 | # it at startup. | ||
| 782 | |||
| 783 | GENERATE_DOCSET = NO | ||
| 784 | |||
| 785 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | ||
| 786 | # feed. A documentation feed provides an umbrella under which multiple | ||
| 787 | # documentation sets from a single provider (such as a company or product suite) | ||
| 788 | # can be grouped. | ||
| 789 | |||
| 790 | DOCSET_FEEDNAME = "Doxygen generated docs" | ||
| 791 | |||
| 792 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | ||
| 793 | # should uniquely identify the documentation set bundle. This should be a | ||
| 794 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | ||
| 795 | # will append .docset to the name. | ||
| 796 | |||
| 797 | DOCSET_BUNDLE_ID = org.doxygen.Project | ||
| 798 | |||
| 717 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | 799 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
| 718 | # documentation will contain sections that can be hidden and shown after the | 800 | # documentation will contain sections that can be hidden and shown after the |
| 719 | # page has loaded. For this to work a browser that supports | 801 | # page has loaded. For this to work a browser that supports |
| @@ -742,6 +824,12 @@ HHC_LOCATION = | |||
| 742 | 824 | ||
| 743 | GENERATE_CHI = NO | 825 | GENERATE_CHI = NO |
| 744 | 826 | ||
| 827 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | ||
| 828 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file | ||
| 829 | # content. | ||
| 830 | |||
| 831 | CHM_INDEX_ENCODING = | ||
| 832 | |||
| 745 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | 833 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
| 746 | # controls whether a binary table of contents is generated (YES) or a | 834 | # controls whether a binary table of contents is generated (YES) or a |
| 747 | # normal table of contents (NO) in the .chm file. | 835 | # normal table of contents (NO) in the .chm file. |
| @@ -764,14 +852,22 @@ DISABLE_INDEX = NO | |||
| 764 | 852 | ||
| 765 | ENUM_VALUES_PER_LINE = 4 | 853 | ENUM_VALUES_PER_LINE = 4 |
| 766 | 854 | ||
| 767 | # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | 855 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
| 768 | # generated containing a tree-like index structure (just like the one that | 856 | # structure should be generated to display hierarchical information. |
| 857 | # If the tag value is set to FRAME, a side panel will be generated | ||
| 858 | # containing a tree-like index structure (just like the one that | ||
| 769 | # is generated for HTML Help). For this to work a browser that supports | 859 | # is generated for HTML Help). For this to work a browser that supports |
| 770 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, | 860 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
| 771 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are | 861 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
| 772 | # probably better off using the HTML help feature. | 862 | # probably better off using the HTML help feature. Other possible values |
| 863 | # for this tag are: HIERARCHIES, which will generate the Groups, Directories, | ||
| 864 | # and Class Hiererachy pages using a tree view instead of an ordered list; | ||
| 865 | # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which | ||
| 866 | # disables this behavior completely. For backwards compatibility with previous | ||
| 867 | # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE | ||
| 868 | # respectively. | ||
| 773 | 869 | ||
| 774 | GENERATE_TREEVIEW = YES | 870 | GENERATE_TREEVIEW = NONE |
| 775 | 871 | ||
| 776 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | 872 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
| 777 | # used to set the initial width (in pixels) of the frame in which the tree | 873 | # used to set the initial width (in pixels) of the frame in which the tree |
| @@ -779,6 +875,14 @@ GENERATE_TREEVIEW = YES | |||
| 779 | 875 | ||
| 780 | TREEVIEW_WIDTH = 250 | 876 | TREEVIEW_WIDTH = 250 |
| 781 | 877 | ||
| 878 | # Use this tag to change the font size of Latex formulas included | ||
| 879 | # as images in the HTML documentation. The default is 10. Note that | ||
| 880 | # when you change the font size after a successful doxygen run you need | ||
| 881 | # to manually remove any form_*.png images from the HTML output directory | ||
| 882 | # to force them to be regenerated. | ||
| 883 | |||
| 884 | FORMULA_FONTSIZE = 10 | ||
| 885 | |||
| 782 | #--------------------------------------------------------------------------- | 886 | #--------------------------------------------------------------------------- |
| 783 | # configuration options related to the LaTeX output | 887 | # configuration options related to the LaTeX output |
| 784 | #--------------------------------------------------------------------------- | 888 | #--------------------------------------------------------------------------- |
| @@ -1031,7 +1135,7 @@ EXPAND_ONLY_PREDEF = NO | |||
| 1031 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | 1135 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
| 1032 | # in the INCLUDE_PATH (see below) will be search if a #include is found. | 1136 | # in the INCLUDE_PATH (see below) will be search if a #include is found. |
| 1033 | 1137 | ||
| 1034 | SEARCH_INCLUDES = YES | 1138 | SEARCH_INCLUDES = NO |
| 1035 | 1139 | ||
| 1036 | # The INCLUDE_PATH tag can be used to specify one or more directories that | 1140 | # The INCLUDE_PATH tag can be used to specify one or more directories that |
| 1037 | # contain include files that are not input files but should be processed by | 1141 | # contain include files that are not input files but should be processed by |
| @@ -1128,10 +1232,11 @@ PERL_PATH = /usr/bin/perl | |||
| 1128 | CLASS_DIAGRAMS = YES | 1232 | CLASS_DIAGRAMS = YES |
| 1129 | 1233 | ||
| 1130 | # You can define message sequence charts within doxygen comments using the \msc | 1234 | # You can define message sequence charts within doxygen comments using the \msc |
| 1131 | # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to | 1235 | # command. Doxygen will then run the mscgen tool (see |
| 1132 | # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to | 1236 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
| 1133 | # specify the directory where the mscgen tool resides. If left empty the tool is assumed to | 1237 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where |
| 1134 | # be found in the default search path. | 1238 | # the mscgen tool resides. If left empty the tool is assumed to be found in the |
| 1239 | # default search path. | ||
| 1135 | 1240 | ||
| 1136 | MSCGEN_PATH = | 1241 | MSCGEN_PATH = |
| 1137 | 1242 | ||
| @@ -1148,6 +1253,24 @@ HIDE_UNDOC_RELATIONS = YES | |||
| 1148 | 1253 | ||
| 1149 | HAVE_DOT = NO | 1254 | HAVE_DOT = NO |
| 1150 | 1255 | ||
| 1256 | # By default doxygen will write a font called FreeSans.ttf to the output | ||
| 1257 | # directory and reference it in all dot files that doxygen generates. This | ||
| 1258 | # font does not include all possible unicode characters however, so when you need | ||
| 1259 | # these (or just want a differently looking font) you can specify the font name | ||
| 1260 | # using DOT_FONTNAME. You need need to make sure dot is able to find the font, | ||
| 1261 | # which can be done by putting it in a standard location or by setting the | ||
| 1262 | # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory | ||
| 1263 | # containing the font. | ||
| 1264 | |||
| 1265 | DOT_FONTNAME = FreeSans | ||
| 1266 | |||
| 1267 | # By default doxygen will tell dot to use the output directory to look for the | ||
| 1268 | # FreeSans.ttf font (which doxygen will put there itself). If you specify a | ||
| 1269 | # different font using DOT_FONTNAME you can set the path where dot | ||
| 1270 | # can find it using this tag. | ||
| 1271 | |||
| 1272 | DOT_FONTPATH = | ||
| 1273 | |||
| 1151 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | 1274 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
| 1152 | # will generate a graph for each documented class showing the direct and | 1275 | # will generate a graph for each documented class showing the direct and |
| 1153 | # indirect inheritance relations. Setting this tag to YES will force the | 1276 | # indirect inheritance relations. Setting this tag to YES will force the |
| @@ -1192,19 +1315,19 @@ INCLUDE_GRAPH = YES | |||
| 1192 | 1315 | ||
| 1193 | INCLUDED_BY_GRAPH = YES | 1316 | INCLUDED_BY_GRAPH = YES |
| 1194 | 1317 | ||
| 1195 | # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will | 1318 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then |
| 1196 | # generate a call dependency graph for every global function or class method. | 1319 | # doxygen will generate a call dependency graph for every global function |
| 1197 | # Note that enabling this option will significantly increase the time of a run. | 1320 | # or class method. Note that enabling this option will significantly increase |
| 1198 | # So in most cases it will be better to enable call graphs for selected | 1321 | # the time of a run. So in most cases it will be better to enable call graphs |
| 1199 | # functions only using the \callgraph command. | 1322 | # for selected functions only using the \callgraph command. |
| 1200 | 1323 | ||
| 1201 | CALL_GRAPH = NO | 1324 | CALL_GRAPH = NO |
| 1202 | 1325 | ||
| 1203 | # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will | 1326 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
| 1204 | # generate a caller dependency graph for every global function or class method. | 1327 | # doxygen will generate a caller dependency graph for every global function |
| 1205 | # Note that enabling this option will significantly increase the time of a run. | 1328 | # or class method. Note that enabling this option will significantly increase |
| 1206 | # So in most cases it will be better to enable caller graphs for selected | 1329 | # the time of a run. So in most cases it will be better to enable caller |
| 1207 | # functions only using the \callergraph command. | 1330 | # graphs for selected functions only using the \callergraph command. |
| 1208 | 1331 | ||
| 1209 | CALLER_GRAPH = NO | 1332 | CALLER_GRAPH = NO |
| 1210 | 1333 | ||
| @@ -1237,12 +1360,12 @@ DOT_PATH = | |||
| 1237 | 1360 | ||
| 1238 | DOTFILE_DIRS = | 1361 | DOTFILE_DIRS = |
| 1239 | 1362 | ||
| 1240 | # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | 1363 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
| 1241 | # nodes that will be shown in the graph. If the number of nodes in a graph | 1364 | # nodes that will be shown in the graph. If the number of nodes in a graph |
| 1242 | # becomes larger than this value, doxygen will truncate the graph, which is | 1365 | # becomes larger than this value, doxygen will truncate the graph, which is |
| 1243 | # visualized by representing a node as a red box. Note that doxygen if the number | 1366 | # visualized by representing a node as a red box. Note that doxygen if the |
| 1244 | # of direct children of the root node in a graph is already larger than | 1367 | # number of direct children of the root node in a graph is already larger than |
| 1245 | # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note | 1368 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
| 1246 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | 1369 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
| 1247 | 1370 | ||
| 1248 | DOT_GRAPH_MAX_NODES = 50 | 1371 | DOT_GRAPH_MAX_NODES = 50 |
| @@ -1258,10 +1381,10 @@ DOT_GRAPH_MAX_NODES = 50 | |||
| 1258 | MAX_DOT_GRAPH_DEPTH = 0 | 1381 | MAX_DOT_GRAPH_DEPTH = 0 |
| 1259 | 1382 | ||
| 1260 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | 1383 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
| 1261 | # background. This is disabled by default, which results in a white background. | 1384 | # background. This is enabled by default, which results in a transparent |
| 1262 | # Warning: Depending on the platform used, enabling this option may lead to | 1385 | # background. Warning: Depending on the platform used, enabling this option |
| 1263 | # badly anti-aliased labels on the edges of a graph (i.e. they become hard to | 1386 | # may lead to badly anti-aliased labels on the edges of a graph (i.e. they |
| 1264 | # read). | 1387 | # become hard to read). |
| 1265 | 1388 | ||
| 1266 | DOT_TRANSPARENT = NO | 1389 | DOT_TRANSPARENT = NO |
| 1267 | 1390 | ||
