Commit 6fd9a100daf6714faf69fe69a0fc24e4a8cbfad5
1 parent
67426b12
update for Makefile support
Showing
1 changed file
with
230 additions
and
73 deletions
doc/Doxyfile
| 1 | -# Doxyfile 1.4.1 | 1 | +# Doxyfile 1.5.5 |
| 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,6 +14,14 @@ | @@ -14,6 +14,14 @@ | ||
| 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 | ||
| 18 | +# that follow. The default is UTF-8 which is also the encoding used for all | ||
| 19 | +# text before the first occurrence of this tag. Doxygen uses libiconv (or the | ||
| 20 | +# iconv built into libc) for the transcoding. See | ||
| 21 | +# http://www.gnu.org/software/libiconv for the list of possible encodings. | ||
| 22 | + | ||
| 23 | +DOXYFILE_ENCODING = UTF-8 | ||
| 24 | + | ||
| 17 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded | 25 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
| 18 | # by quotes) that should identify the project. | 26 | # by quotes) that should identify the project. |
| 19 | 27 | ||
| @@ -23,14 +31,14 @@ PROJECT_NAME = GammaLib | @@ -23,14 +31,14 @@ PROJECT_NAME = GammaLib | ||
| 23 | # This could be handy for archiving the generated documentation or | 31 | # This could be handy for archiving the generated documentation or |
| 24 | # if some version control system is used. | 32 | # if some version control system is used. |
| 25 | 33 | ||
| 26 | -PROJECT_NUMBER = 00-04-05rc | 34 | +PROJECT_NUMBER = 00-04-06 |
| 27 | 35 | ||
| 28 | # 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) |
| 29 | # base path where the generated documentation will be put. | 37 | # base path where the generated documentation will be put. |
| 30 | # If a relative path is entered, it will be relative to the location | 38 | # If a relative path is entered, it will be relative to the location |
| 31 | # where doxygen was started. If left blank the current directory will be used. | 39 | # where doxygen was started. If left blank the current directory will be used. |
| 32 | 40 | ||
| 33 | -OUTPUT_DIRECTORY = | 41 | +OUTPUT_DIRECTORY = doc/doxygen |
| 34 | 42 | ||
| 35 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | 43 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
| 36 | # 4096 sub-directories (in 2 levels) under the output directory of each output | 44 | # 4096 sub-directories (in 2 levels) under the output directory of each output |
| @@ -45,24 +53,15 @@ CREATE_SUBDIRS = YES | @@ -45,24 +53,15 @@ CREATE_SUBDIRS = YES | ||
| 45 | # documentation generated by doxygen is written. Doxygen will use this | 53 | # documentation generated by doxygen is written. Doxygen will use this |
| 46 | # information to generate all constant output in the proper language. | 54 | # information to generate all constant output in the proper language. |
| 47 | # The default language is English, other supported languages are: | 55 | # The default language is English, other supported languages are: |
| 48 | -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, | ||
| 49 | -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, | ||
| 50 | -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, | ||
| 51 | -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, | ||
| 52 | -# Swedish, and Ukrainian. | 56 | +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
| 57 | +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, | ||
| 58 | +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), | ||
| 59 | +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, | ||
| 60 | +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, | ||
| 61 | +# and Ukrainian. | ||
| 53 | 62 | ||
| 54 | OUTPUT_LANGUAGE = English | 63 | OUTPUT_LANGUAGE = English |
| 55 | 64 | ||
| 56 | -# This tag can be used to specify the encoding used in the generated output. | ||
| 57 | -# The encoding is not always determined by the language that is chosen, | ||
| 58 | -# but also whether or not the output is meant for Windows or non-Windows users. | ||
| 59 | -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES | ||
| 60 | -# forces the Windows encoding (this is the default for the Windows binary), | ||
| 61 | -# whereas setting the tag to NO uses a Unix-style encoding (the default for | ||
| 62 | -# all platforms other than Windows). | ||
| 63 | - | ||
| 64 | -USE_WINDOWS_ENCODING = NO | ||
| 65 | - | ||
| 66 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | 65 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
| 67 | # include brief member descriptions after the members that are listed in | 66 | # include brief member descriptions after the members that are listed in |
| 68 | # the file and class documentation (similar to JavaDoc). | 67 | # the file and class documentation (similar to JavaDoc). |
| @@ -135,11 +134,19 @@ SHORT_NAMES = NO | @@ -135,11 +134,19 @@ SHORT_NAMES = NO | ||
| 135 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | 134 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
| 136 | # will interpret the first line (until the first dot) of a JavaDoc-style | 135 | # will interpret the first line (until the first dot) of a JavaDoc-style |
| 137 | # comment as the brief description. If set to NO, the JavaDoc | 136 | # comment as the brief description. If set to NO, the JavaDoc |
| 138 | -# comments will behave just like the Qt-style comments (thus requiring an | ||
| 139 | -# explicit @brief command for a brief description. | 137 | +# comments will behave just like regular Qt-style comments |
| 138 | +# (thus requiring an explicit @brief command for a brief description.) | ||
| 140 | 139 | ||
| 141 | JAVADOC_AUTOBRIEF = NO | 140 | JAVADOC_AUTOBRIEF = NO |
| 142 | 141 | ||
| 142 | +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will | ||
| 143 | +# interpret the first line (until the first dot) of a Qt-style | ||
| 144 | +# comment as the brief description. If set to NO, the comments | ||
| 145 | +# will behave just like regular Qt-style comments (thus requiring | ||
| 146 | +# an explicit \brief command for a brief description.) | ||
| 147 | + | ||
| 148 | +QT_AUTOBRIEF = NO | ||
| 149 | + | ||
| 143 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | 150 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
| 144 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// | 151 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// |
| 145 | # comments) as a brief description. This used to be the default behaviour. | 152 | # comments) as a brief description. This used to be the default behaviour. |
| @@ -159,14 +166,13 @@ DETAILS_AT_TOP = NO | @@ -159,14 +166,13 @@ DETAILS_AT_TOP = NO | ||
| 159 | # member inherits the documentation from any documented member that it | 166 | # member inherits the documentation from any documented member that it |
| 160 | # re-implements. | 167 | # re-implements. |
| 161 | 168 | ||
| 162 | -INHERIT_DOCS = NO | 169 | +INHERIT_DOCS = YES |
| 163 | 170 | ||
| 164 | -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | ||
| 165 | -# tag is set to YES, then doxygen will reuse the documentation of the first | ||
| 166 | -# member in the group (if any) for the other members of the group. By default | ||
| 167 | -# all members of a group must be documented explicitly. | 171 | +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
| 172 | +# a new page for each member. If set to NO, the documentation of a member will | ||
| 173 | +# be part of the file/class/namespace that contains it. | ||
| 168 | 174 | ||
| 169 | -DISTRIBUTE_GROUP_DOC = NO | 175 | +SEPARATE_MEMBER_PAGES = NO |
| 170 | 176 | ||
| 171 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. | 177 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
| 172 | # Doxygen uses this value to replace tabs by spaces in code fragments. | 178 | # Doxygen uses this value to replace tabs by spaces in code fragments. |
| @@ -189,13 +195,52 @@ ALIASES = | @@ -189,13 +195,52 @@ ALIASES = | ||
| 189 | 195 | ||
| 190 | OPTIMIZE_OUTPUT_FOR_C = NO | 196 | OPTIMIZE_OUTPUT_FOR_C = NO |
| 191 | 197 | ||
| 192 | -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | ||
| 193 | -# only. Doxygen will then generate output that is more tailored for Java. | ||
| 194 | -# For instance, namespaces will be presented as packages, qualified scopes | ||
| 195 | -# will look different, etc. | 198 | +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
| 199 | +# sources only. Doxygen will then generate output that is more tailored for | ||
| 200 | +# Java. For instance, namespaces will be presented as packages, qualified | ||
| 201 | +# scopes will look different, etc. | ||
| 196 | 202 | ||
| 197 | OPTIMIZE_OUTPUT_JAVA = NO | 203 | OPTIMIZE_OUTPUT_JAVA = NO |
| 198 | 204 | ||
| 205 | +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | ||
| 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 | ||
| 219 | +# set this tag to YES in order to let doxygen match functions declarations and | ||
| 220 | +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | ||
| 221 | +# func(std::string) {}). This also make the inheritance and collaboration | ||
| 222 | +# diagrams that involve STL classes more complete and accurate. | ||
| 223 | + | ||
| 224 | +BUILTIN_STL_SUPPORT = NO | ||
| 225 | + | ||
| 226 | +# If you use Microsoft's C++/CLI language, you should set this option to YES to | ||
| 227 | +# enable parsing support. | ||
| 228 | + | ||
| 229 | +CPP_CLI_SUPPORT = NO | ||
| 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 | +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | ||
| 238 | +# tag is set to YES, then doxygen will reuse the documentation of the first | ||
| 239 | +# member in the group (if any) for the other members of the group. By default | ||
| 240 | +# all members of a group must be documented explicitly. | ||
| 241 | + | ||
| 242 | +DISTRIBUTE_GROUP_DOC = NO | ||
| 243 | + | ||
| 199 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | 244 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
| 200 | # the same type (for instance a group of public functions) to be put as a | 245 | # the same type (for instance a group of public functions) to be put as a |
| 201 | # subgroup of that type (e.g. under the Public Functions section). Set it to | 246 | # subgroup of that type (e.g. under the Public Functions section). Set it to |
| @@ -204,6 +249,16 @@ OPTIMIZE_OUTPUT_JAVA = NO | @@ -204,6 +249,16 @@ OPTIMIZE_OUTPUT_JAVA = NO | ||
| 204 | 249 | ||
| 205 | SUBGROUPING = YES | 250 | SUBGROUPING = YES |
| 206 | 251 | ||
| 252 | +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | ||
| 253 | +# is documented as struct, union, or enum with the name of the typedef. So | ||
| 254 | +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct | ||
| 255 | +# with name TypeT. When disabled the typedef will appear as a member of a file, | ||
| 256 | +# namespace, or class. And the struct will be named TypeS. This can typically | ||
| 257 | +# be useful for C code in case the coding convention dictates that all compound | ||
| 258 | +# types are typedef'ed and only the typedef is referenced, never the tag name. | ||
| 259 | + | ||
| 260 | +TYPEDEF_HIDES_STRUCT = NO | ||
| 261 | + | ||
| 207 | #--------------------------------------------------------------------------- | 262 | #--------------------------------------------------------------------------- |
| 208 | # Build related configuration options | 263 | # Build related configuration options |
| 209 | #--------------------------------------------------------------------------- | 264 | #--------------------------------------------------------------------------- |
| @@ -228,6 +283,7 @@ EXTRACT_STATIC = YES | @@ -228,6 +283,7 @@ EXTRACT_STATIC = YES | ||
| 228 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) | 283 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
| 229 | # defined locally in source files will be included in the documentation. | 284 | # defined locally in source files will be included in the documentation. |
| 230 | # If set to NO only classes defined in header files are included. | 285 | # If set to NO only classes defined in header files are included. |
| 286 | + | ||
| 231 | EXTRACT_LOCAL_CLASSES = YES | 287 | EXTRACT_LOCAL_CLASSES = YES |
| 232 | 288 | ||
| 233 | # This flag is only useful for Objective-C code. When set to YES local | 289 | # This flag is only useful for Objective-C code. When set to YES local |
| @@ -237,6 +293,14 @@ EXTRACT_LOCAL_CLASSES = YES | @@ -237,6 +293,14 @@ EXTRACT_LOCAL_CLASSES = YES | ||
| 237 | 293 | ||
| 238 | EXTRACT_LOCAL_METHODS = NO | 294 | EXTRACT_LOCAL_METHODS = NO |
| 239 | 295 | ||
| 296 | +# If this flag is set to YES, the members of anonymous namespaces will be | ||
| 297 | +# extracted and appear in the documentation as a namespace called | ||
| 298 | +# 'anonymous_namespace{file}', where file will be replaced with the base | ||
| 299 | +# name of the file that contains the anonymous namespace. By default | ||
| 300 | +# anonymous namespace are hidden. | ||
| 301 | + | ||
| 302 | +EXTRACT_ANON_NSPACES = NO | ||
| 303 | + | ||
| 240 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | 304 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
| 241 | # undocumented members of documented classes, files or namespaces. | 305 | # undocumented members of documented classes, files or namespaces. |
| 242 | # If set to NO (the default) these members will be included in the | 306 | # If set to NO (the default) these members will be included in the |
| @@ -312,6 +376,12 @@ SORT_MEMBER_DOCS = YES | @@ -312,6 +376,12 @@ SORT_MEMBER_DOCS = YES | ||
| 312 | 376 | ||
| 313 | SORT_BRIEF_DOCS = NO | 377 | SORT_BRIEF_DOCS = NO |
| 314 | 378 | ||
| 379 | +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the | ||
| 380 | +# hierarchy of group names into alphabetical order. If set to NO (the default) | ||
| 381 | +# the group names will appear in their defined order. | ||
| 382 | + | ||
| 383 | +SORT_GROUP_NAMES = NO | ||
| 384 | + | ||
| 315 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | 385 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
| 316 | # sorted by fully-qualified names, including namespaces. If set to | 386 | # sorted by fully-qualified names, including namespaces. If set to |
| 317 | # NO (the default), the class list will be sorted only by class name, | 387 | # NO (the default), the class list will be sorted only by class name, |
| @@ -319,6 +389,7 @@ SORT_BRIEF_DOCS = NO | @@ -319,6 +389,7 @@ SORT_BRIEF_DOCS = NO | ||
| 319 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | 389 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
| 320 | # Note: This option applies only to the class list, not to the | 390 | # Note: This option applies only to the class list, not to the |
| 321 | # alphabetical list. | 391 | # alphabetical list. |
| 392 | + | ||
| 322 | SORT_BY_SCOPE_NAME = NO | 393 | SORT_BY_SCOPE_NAME = NO |
| 323 | 394 | ||
| 324 | # The GENERATE_TODOLIST tag can be used to enable (YES) or | 395 | # The GENERATE_TODOLIST tag can be used to enable (YES) or |
| @@ -368,16 +439,16 @@ SHOW_USED_FILES = YES | @@ -368,16 +439,16 @@ SHOW_USED_FILES = YES | ||
| 368 | 439 | ||
| 369 | # If the sources in your project are distributed over multiple directories | 440 | # If the sources in your project are distributed over multiple directories |
| 370 | # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy | 441 | # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
| 371 | -# in the documentation. | 442 | +# in the documentation. The default is NO. |
| 372 | 443 | ||
| 373 | SHOW_DIRECTORIES = YES | 444 | SHOW_DIRECTORIES = YES |
| 374 | 445 | ||
| 375 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that | 446 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
| 376 | -# doxygen should invoke to get the current version for each file (typically from the | ||
| 377 | -# version control system). Doxygen will invoke the program by executing (via | 447 | +# doxygen should invoke to get the current version for each file (typically from |
| 448 | +# the version control system). Doxygen will invoke the program by executing (via | ||
| 378 | # popen()) the command <command> <input-file>, where <command> is the value of | 449 | # popen()) the command <command> <input-file>, where <command> is the value of |
| 379 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | 450 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
| 380 | -# provided by doxygen. Whatever the progam writes to standard output | 451 | +# provided by doxygen. Whatever the program writes to standard output |
| 381 | # is used as the file version. See the manual for examples. | 452 | # is used as the file version. See the manual for examples. |
| 382 | 453 | ||
| 383 | FILE_VERSION_FILTER = | 454 | FILE_VERSION_FILTER = |
| @@ -442,16 +513,27 @@ WARN_LOGFILE = | @@ -442,16 +513,27 @@ WARN_LOGFILE = | ||
| 442 | # directories like "/usr/src/myproject". Separate the files or directories | 513 | # directories like "/usr/src/myproject". Separate the files or directories |
| 443 | # with spaces. | 514 | # with spaces. |
| 444 | 515 | ||
| 445 | -INPUT = "../include" "../src" "../inst" | 516 | +INPUT = "include" "src" "inst" |
| 517 | + | ||
| 518 | +# This tag can be used to specify the character encoding of the source files | ||
| 519 | +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | ||
| 520 | +# also the default input encoding. Doxygen uses libiconv (or the iconv built | ||
| 521 | +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | ||
| 522 | +# the list of possible encodings. | ||
| 523 | + | ||
| 524 | +INPUT_ENCODING = UTF-8 | ||
| 446 | 525 | ||
| 447 | # If the value of the INPUT tag contains directories, you can use the | 526 | # If the value of the INPUT tag contains directories, you can use the |
| 448 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | 527 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
| 449 | # and *.h) to filter out the source-files in the directories. If left | 528 | # and *.h) to filter out the source-files in the directories. If left |
| 450 | # blank the following patterns are tested: | 529 | # blank the following patterns are tested: |
| 451 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx | 530 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
| 452 | -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm | 531 | +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
| 453 | 532 | ||
| 454 | -FILE_PATTERNS = *.cpp *.cxx *.hpp *.i | 533 | +FILE_PATTERNS = *.cpp \ |
| 534 | + *.cxx \ | ||
| 535 | + *.hpp \ | ||
| 536 | + *.i | ||
| 455 | 537 | ||
| 456 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories | 538 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
| 457 | # should be searched for input files as well. Possible values are YES and NO. | 539 | # should be searched for input files as well. Possible values are YES and NO. |
| @@ -463,7 +545,7 @@ RECURSIVE = YES | @@ -463,7 +545,7 @@ RECURSIVE = YES | ||
| 463 | # excluded from the INPUT source files. This way you can easily exclude a | 545 | # excluded from the INPUT source files. This way you can easily exclude a |
| 464 | # subdirectory from a directory tree whose root is specified with the INPUT tag. | 546 | # subdirectory from a directory tree whose root is specified with the INPUT tag. |
| 465 | 547 | ||
| 466 | -EXCLUDE = | 548 | +EXCLUDE = ../src/template |
| 467 | 549 | ||
| 468 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or | 550 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
| 469 | # directories that are symbolic links (a Unix filesystem feature) are excluded | 551 | # directories that are symbolic links (a Unix filesystem feature) are excluded |
| @@ -473,10 +555,20 @@ EXCLUDE_SYMLINKS = NO | @@ -473,10 +555,20 @@ EXCLUDE_SYMLINKS = NO | ||
| 473 | 555 | ||
| 474 | # If the value of the INPUT tag contains directories, you can use the | 556 | # If the value of the INPUT tag contains directories, you can use the |
| 475 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | 557 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
| 476 | -# certain files from those directories. | 558 | +# certain files from those directories. Note that the wildcards are matched |
| 559 | +# against the file with absolute path, so to exclude all test directories | ||
| 560 | +# for example use the pattern */test/* | ||
| 477 | 561 | ||
| 478 | EXCLUDE_PATTERNS = | 562 | EXCLUDE_PATTERNS = |
| 479 | 563 | ||
| 564 | +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | ||
| 565 | +# (namespaces, classes, functions, etc.) that should be excluded from the | ||
| 566 | +# output. The symbol name can be a fully qualified name, a word, or if the | ||
| 567 | +# wildcard * is used, a substring. Examples: ANamespace, AClass, | ||
| 568 | +# AClass::ANamespace, ANamespace::*Test | ||
| 569 | + | ||
| 570 | +EXCLUDE_SYMBOLS = | ||
| 571 | + | ||
| 480 | # The EXAMPLE_PATH tag can be used to specify one or more files or | 572 | # The EXAMPLE_PATH tag can be used to specify one or more files or |
| 481 | # directories that contain example code fragments that are included (see | 573 | # directories that contain example code fragments that are included (see |
| 482 | # the \include command). | 574 | # the \include command). |
| @@ -562,6 +654,21 @@ REFERENCED_BY_RELATION = YES | @@ -562,6 +654,21 @@ REFERENCED_BY_RELATION = YES | ||
| 562 | 654 | ||
| 563 | REFERENCES_RELATION = YES | 655 | REFERENCES_RELATION = YES |
| 564 | 656 | ||
| 657 | +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | ||
| 658 | +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | ||
| 659 | +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | ||
| 660 | +# link to the source code. Otherwise they will link to the documentstion. | ||
| 661 | + | ||
| 662 | +REFERENCES_LINK_SOURCE = YES | ||
| 663 | + | ||
| 664 | +# If the USE_HTAGS tag is set to YES then the references to source code | ||
| 665 | +# will point to the HTML generated by the htags(1) tool instead of doxygen | ||
| 666 | +# built-in source browser. The htags tool is part of GNU's global source | ||
| 667 | +# tagging system (see http://www.gnu.org/software/global/global.html). You | ||
| 668 | +# will need version 4.8.6 or higher. | ||
| 669 | + | ||
| 670 | +USE_HTAGS = NO | ||
| 671 | + | ||
| 565 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | 672 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
| 566 | # will generate a verbatim copy of the header file for each class for | 673 | # will generate a verbatim copy of the header file for each class for |
| 567 | # which an include is specified. Set to NO to disable this. | 674 | # which an include is specified. Set to NO to disable this. |
| @@ -641,11 +748,44 @@ HTML_ALIGN_MEMBERS = YES | @@ -641,11 +748,44 @@ HTML_ALIGN_MEMBERS = YES | ||
| 641 | 748 | ||
| 642 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files | 749 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
| 643 | # will be generated that can be used as input for tools like the | 750 | # will be generated that can be used as input for tools like the |
| 644 | -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | 751 | +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
| 645 | # of the generated HTML documentation. | 752 | # of the generated HTML documentation. |
| 646 | 753 | ||
| 647 | GENERATE_HTMLHELP = NO | 754 | GENERATE_HTMLHELP = NO |
| 648 | 755 | ||
| 756 | +# If the GENERATE_DOCSET tag is set to YES, additional index files | ||
| 757 | +# will be generated that can be used as input for Apple's Xcode 3 | ||
| 758 | +# integrated development environment, introduced with OSX 10.5 (Leopard). | ||
| 759 | +# To create a documentation set, doxygen will generate a Makefile in the | ||
| 760 | +# HTML output directory. Running make will produce the docset in that | ||
| 761 | +# directory and running "make install" will install the docset in | ||
| 762 | +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | ||
| 763 | +# it at startup. | ||
| 764 | + | ||
| 765 | +GENERATE_DOCSET = NO | ||
| 766 | + | ||
| 767 | +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | ||
| 768 | +# feed. A documentation feed provides an umbrella under which multiple | ||
| 769 | +# documentation sets from a single provider (such as a company or product suite) | ||
| 770 | +# can be grouped. | ||
| 771 | + | ||
| 772 | +DOCSET_FEEDNAME = "Doxygen generated docs" | ||
| 773 | + | ||
| 774 | +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | ||
| 775 | +# should uniquely identify the documentation set bundle. This should be a | ||
| 776 | +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | ||
| 777 | +# will append .docset to the name. | ||
| 778 | + | ||
| 779 | +DOCSET_BUNDLE_ID = org.doxygen.Project | ||
| 780 | + | ||
| 781 | +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | ||
| 782 | +# documentation will contain sections that can be hidden and shown after the | ||
| 783 | +# page has loaded. For this to work a browser that supports | ||
| 784 | +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | ||
| 785 | +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). | ||
| 786 | + | ||
| 787 | +HTML_DYNAMIC_SECTIONS = NO | ||
| 788 | + | ||
| 649 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | 789 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
| 650 | # be used to specify the file name of the resulting .chm file. You | 790 | # be used to specify the file name of the resulting .chm file. You |
| 651 | # can add a path in front of the file if the result should not be | 791 | # can add a path in front of the file if the result should not be |
| @@ -688,12 +828,20 @@ DISABLE_INDEX = NO | @@ -688,12 +828,20 @@ DISABLE_INDEX = NO | ||
| 688 | 828 | ||
| 689 | ENUM_VALUES_PER_LINE = 4 | 829 | ENUM_VALUES_PER_LINE = 4 |
| 690 | 830 | ||
| 691 | -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | ||
| 692 | -# generated containing a tree-like index structure (just like the one that | 831 | +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
| 832 | +# structure should be generated to display hierarchical information. | ||
| 833 | +# If the tag value is set to FRAME, a side panel will be generated | ||
| 834 | +# containing a tree-like index structure (just like the one that | ||
| 693 | # is generated for HTML Help). For this to work a browser that supports | 835 | # is generated for HTML Help). For this to work a browser that supports |
| 694 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, | 836 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
| 695 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are | 837 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
| 696 | -# probably better off using the HTML help feature. | 838 | +# probably better off using the HTML help feature. Other possible values |
| 839 | +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, | ||
| 840 | +# and Class Hiererachy pages using a tree view instead of an ordered list; | ||
| 841 | +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which | ||
| 842 | +# disables this behavior completely. For backwards compatibility with previous | ||
| 843 | +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE | ||
| 844 | +# respectively. | ||
| 697 | 845 | ||
| 698 | GENERATE_TREEVIEW = YES | 846 | GENERATE_TREEVIEW = YES |
| 699 | 847 | ||
| @@ -828,7 +976,7 @@ RTF_EXTENSIONS_FILE = | @@ -828,7 +976,7 @@ RTF_EXTENSIONS_FILE = | ||
| 828 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | 976 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
| 829 | # generate man pages | 977 | # generate man pages |
| 830 | 978 | ||
| 831 | -GENERATE_MAN = NO | 979 | +GENERATE_MAN = YES |
| 832 | 980 | ||
| 833 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. | 981 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. |
| 834 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | 982 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
| @@ -948,7 +1096,7 @@ MACRO_EXPANSION = NO | @@ -948,7 +1096,7 @@ MACRO_EXPANSION = NO | ||
| 948 | 1096 | ||
| 949 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | 1097 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
| 950 | # then the macro expansion is limited to the macros specified with the | 1098 | # then the macro expansion is limited to the macros specified with the |
| 951 | -# PREDEFINED and EXPAND_AS_PREDEFINED tags. | 1099 | +# PREDEFINED and EXPAND_AS_DEFINED tags. |
| 952 | 1100 | ||
| 953 | EXPAND_ONLY_PREDEF = NO | 1101 | EXPAND_ONLY_PREDEF = NO |
| 954 | 1102 | ||
| @@ -1051,6 +1199,15 @@ PERL_PATH = /usr/bin/perl | @@ -1051,6 +1199,15 @@ PERL_PATH = /usr/bin/perl | ||
| 1051 | 1199 | ||
| 1052 | CLASS_DIAGRAMS = YES | 1200 | CLASS_DIAGRAMS = YES |
| 1053 | 1201 | ||
| 1202 | +# You can define message sequence charts within doxygen comments using the \msc | ||
| 1203 | +# command. Doxygen will then run the mscgen tool (see | ||
| 1204 | +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | ||
| 1205 | +# documentation. The MSCGEN_PATH tag allows you to specify the directory where | ||
| 1206 | +# the mscgen tool resides. If left empty the tool is assumed to be found in the | ||
| 1207 | +# default search path. | ||
| 1208 | + | ||
| 1209 | +MSCGEN_PATH = | ||
| 1210 | + | ||
| 1054 | # If set to YES, the inheritance and collaboration graphs will hide | 1211 | # If set to YES, the inheritance and collaboration graphs will hide |
| 1055 | # inheritance and usage relations if the target is undocumented | 1212 | # inheritance and usage relations if the target is undocumented |
| 1056 | # or is not a class. | 1213 | # or is not a class. |
| @@ -1108,14 +1265,22 @@ INCLUDE_GRAPH = YES | @@ -1108,14 +1265,22 @@ INCLUDE_GRAPH = YES | ||
| 1108 | 1265 | ||
| 1109 | INCLUDED_BY_GRAPH = YES | 1266 | INCLUDED_BY_GRAPH = YES |
| 1110 | 1267 | ||
| 1111 | -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will | ||
| 1112 | -# generate a call dependency graph for every global function or class method. | ||
| 1113 | -# Note that enabling this option will significantly increase the time of a run. | ||
| 1114 | -# So in most cases it will be better to enable call graphs for selected | ||
| 1115 | -# functions only using the \callgraph command. | 1268 | +# If the CALL_GRAPH and HAVE_DOT options are set to YES then |
| 1269 | +# doxygen will generate a call dependency graph for every global function | ||
| 1270 | +# or class method. Note that enabling this option will significantly increase | ||
| 1271 | +# the time of a run. So in most cases it will be better to enable call graphs | ||
| 1272 | +# for selected functions only using the \callgraph command. | ||
| 1116 | 1273 | ||
| 1117 | CALL_GRAPH = NO | 1274 | CALL_GRAPH = NO |
| 1118 | 1275 | ||
| 1276 | +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | ||
| 1277 | +# doxygen will generate a caller dependency graph for every global function | ||
| 1278 | +# or class method. Note that enabling this option will significantly increase | ||
| 1279 | +# the time of a run. So in most cases it will be better to enable caller | ||
| 1280 | +# graphs for selected functions only using the \callergraph command. | ||
| 1281 | + | ||
| 1282 | +CALLER_GRAPH = NO | ||
| 1283 | + | ||
| 1119 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | 1284 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
| 1120 | # will graphical hierarchy of all classes instead of a textual one. | 1285 | # will graphical hierarchy of all classes instead of a textual one. |
| 1121 | 1286 | ||
| @@ -1145,39 +1310,31 @@ DOT_PATH = | @@ -1145,39 +1310,31 @@ DOT_PATH = | ||
| 1145 | 1310 | ||
| 1146 | DOTFILE_DIRS = | 1311 | DOTFILE_DIRS = |
| 1147 | 1312 | ||
| 1148 | -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width | ||
| 1149 | -# (in pixels) of the graphs generated by dot. If a graph becomes larger than | ||
| 1150 | -# this value, doxygen will try to truncate the graph, so that it fits within | ||
| 1151 | -# the specified constraint. Beware that most browsers cannot cope with very | ||
| 1152 | -# large images. | ||
| 1153 | - | ||
| 1154 | -MAX_DOT_GRAPH_WIDTH = 1024 | ||
| 1155 | - | ||
| 1156 | -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height | ||
| 1157 | -# (in pixels) of the graphs generated by dot. If a graph becomes larger than | ||
| 1158 | -# this value, doxygen will try to truncate the graph, so that it fits within | ||
| 1159 | -# the specified constraint. Beware that most browsers cannot cope with very | ||
| 1160 | -# large images. | 1313 | +# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
| 1314 | +# nodes that will be shown in the graph. If the number of nodes in a graph | ||
| 1315 | +# becomes larger than this value, doxygen will truncate the graph, which is | ||
| 1316 | +# visualized by representing a node as a red box. Note that doxygen if the | ||
| 1317 | +# number of direct children of the root node in a graph is already larger than | ||
| 1318 | +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | ||
| 1319 | +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | ||
| 1161 | 1320 | ||
| 1162 | -MAX_DOT_GRAPH_HEIGHT = 1024 | 1321 | +DOT_GRAPH_MAX_NODES = 50 |
| 1163 | 1322 | ||
| 1164 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | 1323 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
| 1165 | # graphs generated by dot. A depth value of 3 means that only nodes reachable | 1324 | # graphs generated by dot. A depth value of 3 means that only nodes reachable |
| 1166 | # from the root by following a path via at most 3 edges will be shown. Nodes | 1325 | # from the root by following a path via at most 3 edges will be shown. Nodes |
| 1167 | # that lay further from the root node will be omitted. Note that setting this | 1326 | # that lay further from the root node will be omitted. Note that setting this |
| 1168 | # option to 1 or 2 may greatly reduce the computation time needed for large | 1327 | # option to 1 or 2 may greatly reduce the computation time needed for large |
| 1169 | -# code bases. Also note that a graph may be further truncated if the graph's | ||
| 1170 | -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH | ||
| 1171 | -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), | ||
| 1172 | -# the graph is not depth-constrained. | 1328 | +# code bases. Also note that the size of a graph can be further restricted by |
| 1329 | +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | ||
| 1173 | 1330 | ||
| 1174 | MAX_DOT_GRAPH_DEPTH = 0 | 1331 | MAX_DOT_GRAPH_DEPTH = 0 |
| 1175 | 1332 | ||
| 1176 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | 1333 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
| 1177 | -# background. This is disabled by default, which results in a white background. | ||
| 1178 | -# Warning: Depending on the platform used, enabling this option may lead to | ||
| 1179 | -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to | ||
| 1180 | -# read). | 1334 | +# background. This is enabled by default, which results in a transparent |
| 1335 | +# background. Warning: Depending on the platform used, enabling this option | ||
| 1336 | +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they | ||
| 1337 | +# become hard to read). | ||
| 1181 | 1338 | ||
| 1182 | DOT_TRANSPARENT = NO | 1339 | DOT_TRANSPARENT = NO |
| 1183 | 1340 | ||
| @@ -1207,4 +1364,4 @@ DOT_CLEANUP = YES | @@ -1207,4 +1364,4 @@ DOT_CLEANUP = YES | ||
| 1207 | # The SEARCHENGINE tag specifies whether or not a search engine should be | 1364 | # The SEARCHENGINE tag specifies whether or not a search engine should be |
| 1208 | # used. If set to NO the values of all tags below this one will be ignored. | 1365 | # used. If set to NO the values of all tags below this one will be ignored. |
| 1209 | 1366 | ||
| 1210 | -SEARCHENGINE = NO | ||
| 1211 | \ No newline at end of file | 1367 | \ No newline at end of file |
| 1368 | +SEARCHENGINE = NO |