Tristan Matthews | 0a329cc | 2013-07-17 13:20:14 -0400 | [diff] [blame] | 1 | # Doxyfile 1.3-rc3
|
| 2 |
|
| 3 | # This file describes the settings to be used by the documentation system
|
| 4 | # doxygen (www.doxygen.org) for a project
|
| 5 | #
|
| 6 | # All text after a hash (#) is considered a comment and will be ignored
|
| 7 | # The format is:
|
| 8 | # TAG = value [value, ...]
|
| 9 | # For lists items can also be appended using:
|
| 10 | # TAG += value [value, ...]
|
| 11 | # Values that contain spaces should be placed between quotes (" ")
|
| 12 |
|
| 13 | #---------------------------------------------------------------------------
|
| 14 | # General configuration options
|
| 15 | #---------------------------------------------------------------------------
|
| 16 |
|
| 17 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
| 18 | # by quotes) that should identify the project.
|
| 19 |
|
| 20 | PROJECT_NAME = "PJNATH Reference"
|
| 21 |
|
| 22 | # The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
| 23 | # This could be handy for archiving the generated documentation or
|
| 24 | # if some version control system is used.
|
| 25 |
|
| 26 | PROJECT_NUMBER = $(PJ_VERSION)
|
| 27 |
|
| 28 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
| 29 | # base path where the generated documentation will be put.
|
| 30 | # 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.
|
| 32 |
|
| 33 | OUTPUT_DIRECTORY = docs/$(PJ_VERSION)
|
| 34 |
|
| 35 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
| 36 | # documentation generated by doxygen is written. Doxygen will use this
|
| 37 | # information to generate all constant output in the proper language.
|
| 38 | # The default language is English, other supported languages are:
|
| 39 | # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
|
| 40 | # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
|
| 41 | # (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
|
| 42 | # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
|
| 43 |
|
| 44 | OUTPUT_LANGUAGE = English
|
| 45 |
|
| 46 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
| 47 | # documentation are documented, even if no documentation was available.
|
| 48 | # Private class members and static file members will be hidden unless
|
| 49 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
| 50 |
|
| 51 | EXTRACT_ALL = NO
|
| 52 |
|
| 53 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
| 54 | # will be included in the documentation.
|
| 55 |
|
| 56 | EXTRACT_PRIVATE = NO
|
| 57 |
|
| 58 | # If the EXTRACT_STATIC tag is set to YES all static members of a file
|
| 59 | # will be included in the documentation.
|
| 60 |
|
| 61 | EXTRACT_STATIC = NO
|
| 62 |
|
| 63 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
|
| 64 | # defined locally in source files will be included in the documentation.
|
| 65 | # If set to NO only classes defined in header files are included.
|
| 66 |
|
| 67 | EXTRACT_LOCAL_CLASSES = YES
|
| 68 |
|
| 69 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
| 70 | # undocumented members of documented classes, files or namespaces.
|
| 71 | # If set to NO (the default) these members will be included in the
|
| 72 | # various overviews, but no documentation section is generated.
|
| 73 | # This option has no effect if EXTRACT_ALL is enabled.
|
| 74 |
|
| 75 | HIDE_UNDOC_MEMBERS = NO
|
| 76 |
|
| 77 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
| 78 | # undocumented classes that are normally visible in the class hierarchy.
|
| 79 | # If set to NO (the default) these class will be included in the various
|
| 80 | # overviews. This option has no effect if EXTRACT_ALL is enabled.
|
| 81 |
|
| 82 | HIDE_UNDOC_CLASSES = NO
|
| 83 |
|
| 84 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
|
| 85 | # friend (class|struct|union) declarations.
|
| 86 | # If set to NO (the default) these declarations will be included in the
|
| 87 | # documentation.
|
| 88 |
|
| 89 | HIDE_FRIEND_COMPOUNDS = NO
|
| 90 |
|
| 91 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
|
| 92 | # documentation blocks found inside the body of a function.
|
| 93 | # If set to NO (the default) these blocks will be appended to the
|
| 94 | # function's detailed documentation block.
|
| 95 |
|
| 96 | HIDE_IN_BODY_DOCS = NO
|
| 97 |
|
| 98 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
| 99 | # include brief member descriptions after the members that are listed in
|
| 100 | # the file and class documentation (similar to JavaDoc).
|
| 101 | # Set to NO to disable this.
|
| 102 |
|
| 103 | BRIEF_MEMBER_DESC = YES
|
| 104 |
|
| 105 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
| 106 | # the brief description of a member or function before the detailed description.
|
| 107 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
| 108 | # brief descriptions will be completely suppressed.
|
| 109 |
|
| 110 | REPEAT_BRIEF = NO
|
| 111 |
|
| 112 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
| 113 | # Doxygen will generate a detailed section even if there is only a brief
|
| 114 | # description.
|
| 115 |
|
| 116 | ALWAYS_DETAILED_SEC = NO
|
| 117 |
|
| 118 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
|
| 119 | # members of a class in the documentation of that class as if those members were
|
| 120 | # ordinary class members. Constructors, destructors and assignment operators of
|
| 121 | # the base classes will not be shown.
|
| 122 |
|
| 123 | INLINE_INHERITED_MEMB = NO
|
| 124 |
|
| 125 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
| 126 | # path before files name in the file list and in the header files. If set
|
| 127 | # to NO the shortest path that makes the file name unique will be used.
|
| 128 |
|
| 129 | FULL_PATH_NAMES = NO
|
| 130 |
|
| 131 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
|
| 132 | # can be used to strip a user defined part of the path. Stripping is
|
| 133 | # only done if one of the specified strings matches the left-hand part of
|
| 134 | # the path. It is allowed to use relative paths in the argument list.
|
| 135 |
|
| 136 | STRIP_FROM_PATH = "c:\project\pjproject"
|
| 137 |
|
| 138 | # The INTERNAL_DOCS tag determines if documentation
|
| 139 | # that is typed after a \internal command is included. If the tag is set
|
| 140 | # to NO (the default) then the documentation will be excluded.
|
| 141 | # Set it to YES to include the internal documentation.
|
| 142 |
|
| 143 | INTERNAL_DOCS = NO
|
| 144 |
|
| 145 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
| 146 | # file names in lower case letters. If set to YES upper case letters are also
|
| 147 | # allowed. This is useful if you have classes or files whose names only differ
|
| 148 | # in case and if your file system supports case sensitive file names. Windows
|
| 149 | # users are adviced to set this option to NO.
|
| 150 |
|
| 151 | CASE_SENSE_NAMES = YES
|
| 152 |
|
| 153 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
| 154 | # (but less readable) file names. This can be useful is your file systems
|
| 155 | # doesn't support long names like on DOS, Mac, or CD-ROM.
|
| 156 |
|
| 157 | SHORT_NAMES = NO
|
| 158 |
|
| 159 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
| 160 | # will show members with their full class and namespace scopes in the
|
| 161 | # documentation. If set to YES the scope will be hidden.
|
| 162 |
|
| 163 | HIDE_SCOPE_NAMES = NO
|
| 164 |
|
| 165 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
| 166 | # will generate a verbatim copy of the header file for each class for
|
| 167 | # which an include is specified. Set to NO to disable this.
|
| 168 |
|
| 169 | VERBATIM_HEADERS = YES
|
| 170 |
|
| 171 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
|
| 172 | # will put list of the files that are included by a file in the documentation
|
| 173 | # of that file.
|
| 174 |
|
| 175 | SHOW_INCLUDE_FILES = NO
|
| 176 |
|
| 177 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
| 178 | # will interpret the first line (until the first dot) of a JavaDoc-style
|
| 179 | # comment as the brief description. If set to NO, the JavaDoc
|
| 180 | # comments will behave just like the Qt-style comments (thus requiring an
|
| 181 | # explict @brief command for a brief description.
|
| 182 |
|
| 183 | JAVADOC_AUTOBRIEF = NO
|
| 184 |
|
| 185 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
|
| 186 | # treat a multi-line C++ special comment block (i.e. a block of //! or ///
|
| 187 | # comments) as a brief description. This used to be the default behaviour.
|
| 188 | # The new default is to treat a multi-line C++ comment block as a detailed
|
| 189 | # description. Set this tag to YES if you prefer the old behaviour instead.
|
| 190 |
|
| 191 | MULTILINE_CPP_IS_BRIEF = NO
|
| 192 |
|
| 193 | # If the DETAILS_AT_TOP tag is set to YES then Doxygen
|
| 194 | # will output the detailed description near the top, like JavaDoc.
|
| 195 | # If set to NO, the detailed description appears after the member
|
| 196 | # documentation.
|
| 197 |
|
| 198 | DETAILS_AT_TOP = YES
|
| 199 |
|
| 200 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
| 201 | # member inherits the documentation from any documented member that it
|
| 202 | # reimplements.
|
| 203 |
|
| 204 | INHERIT_DOCS = YES
|
| 205 |
|
| 206 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
| 207 | # is inserted in the documentation for inline members.
|
| 208 |
|
| 209 | INLINE_INFO = YES
|
| 210 |
|
| 211 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
| 212 | # will sort the (detailed) documentation of file and class members
|
| 213 | # alphabetically by member name. If set to NO the members will appear in
|
| 214 | # declaration order.
|
| 215 |
|
| 216 | SORT_MEMBER_DOCS = YES
|
| 217 |
|
| 218 | # 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
|
| 220 | # member in the group (if any) for the other members of the group. By default
|
| 221 | # all members of a group must be documented explicitly.
|
| 222 |
|
| 223 | DISTRIBUTE_GROUP_DOC = NO
|
| 224 |
|
| 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
| 226 | # Doxygen uses this value to replace tabs by spaces in code fragments.
|
| 227 |
|
| 228 | TAB_SIZE = 8
|
| 229 |
|
| 230 | # The GENERATE_TODOLIST tag can be used to enable (YES) or
|
| 231 | # disable (NO) the todo list. This list is created by putting \todo
|
| 232 | # commands in the documentation.
|
| 233 |
|
| 234 | GENERATE_TODOLIST = YES
|
| 235 |
|
| 236 | # The GENERATE_TESTLIST tag can be used to enable (YES) or
|
| 237 | # disable (NO) the test list. This list is created by putting \test
|
| 238 | # commands in the documentation.
|
| 239 |
|
| 240 | GENERATE_TESTLIST = YES
|
| 241 |
|
| 242 | # The GENERATE_BUGLIST tag can be used to enable (YES) or
|
| 243 | # disable (NO) the bug list. This list is created by putting \bug
|
| 244 | # commands in the documentation.
|
| 245 |
|
| 246 | GENERATE_BUGLIST = YES
|
| 247 |
|
| 248 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
|
| 249 | # disable (NO) the deprecated list. This list is created by putting
|
| 250 | # \deprecated commands in the documentation.
|
| 251 |
|
| 252 | GENERATE_DEPRECATEDLIST= YES
|
| 253 |
|
| 254 | # This tag can be used to specify a number of aliases that acts
|
| 255 | # as commands in the documentation. An alias has the form "name=value".
|
| 256 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
| 257 | # put the command \sideeffect (or @sideeffect) in the documentation, which
|
| 258 | # will result in a user defined paragraph with heading "Side Effects:".
|
| 259 | # You can put \n's in the value part of an alias to insert newlines.
|
| 260 |
|
| 261 | ALIASES =
|
| 262 |
|
| 263 | # The ENABLED_SECTIONS tag can be used to enable conditional
|
| 264 | # documentation sections, marked by \if sectionname ... \endif.
|
| 265 |
|
| 266 | ENABLED_SECTIONS =
|
| 267 |
|
| 268 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
| 269 | # the initial value of a variable or define consist of for it to appear in
|
| 270 | # the documentation. If the initializer consists of more lines than specified
|
| 271 | # here it will be hidden. Use a value of 0 to hide initializers completely.
|
| 272 | # The appearance of the initializer of individual variables and defines in the
|
| 273 | # documentation can be controlled using \showinitializer or \hideinitializer
|
| 274 | # command in the documentation regardless of this setting.
|
| 275 |
|
| 276 | MAX_INITIALIZER_LINES = 30
|
| 277 |
|
| 278 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
| 279 | # only. Doxygen will then generate output that is more tailored for C.
|
| 280 | # For instance some of the names that are used will be different. The list
|
| 281 | # of all members will be omitted, etc.
|
| 282 |
|
| 283 | OPTIMIZE_OUTPUT_FOR_C = YES
|
| 284 |
|
| 285 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
|
| 286 | # only. Doxygen will then generate output that is more tailored for Java.
|
| 287 | # For instance namespaces will be presented as packages, qualified scopes
|
| 288 | # will look different, etc.
|
| 289 |
|
| 290 | OPTIMIZE_OUTPUT_JAVA = NO
|
| 291 |
|
| 292 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
| 293 | # at the bottom of the documentation of classes and structs. If set to YES the
|
| 294 | # list will mention the files that were used to generate the documentation.
|
| 295 |
|
| 296 | SHOW_USED_FILES = YES
|
| 297 | TYPEDEF_HIDES_STRUCT = YES
|
| 298 |
|
| 299 | #---------------------------------------------------------------------------
|
| 300 | # configuration options related to warning and progress messages
|
| 301 | #---------------------------------------------------------------------------
|
| 302 |
|
| 303 | # The QUIET tag can be used to turn on/off the messages that are generated
|
| 304 | # by doxygen. Possible values are YES and NO. If left blank NO is used.
|
| 305 |
|
| 306 | QUIET = NO
|
| 307 |
|
| 308 | # The WARNINGS tag can be used to turn on/off the warning messages that are
|
| 309 | # generated by doxygen. Possible values are YES and NO. If left blank
|
| 310 | # NO is used.
|
| 311 |
|
| 312 | WARNINGS = YES
|
| 313 |
|
| 314 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
| 315 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
| 316 | # automatically be disabled.
|
| 317 |
|
| 318 | WARN_IF_UNDOCUMENTED = YES
|
| 319 |
|
| 320 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
|
| 321 | # potential errors in the documentation, such as not documenting some
|
| 322 | # parameters in a documented function, or documenting parameters that
|
| 323 | # don't exist or using markup commands wrongly.
|
| 324 |
|
| 325 | WARN_IF_DOC_ERROR = YES
|
| 326 |
|
| 327 | # The WARN_FORMAT tag determines the format of the warning messages that
|
| 328 | # doxygen can produce. The string should contain the $file, $line, and $text
|
| 329 | # tags, which will be replaced by the file and line number from which the
|
| 330 | # warning originated and the warning text.
|
| 331 |
|
| 332 | WARN_FORMAT = "$file:$line: $text"
|
| 333 |
|
| 334 | # The WARN_LOGFILE tag can be used to specify a file to which warning
|
| 335 | # and error messages should be written. If left blank the output is written
|
| 336 | # to stderr.
|
| 337 |
|
| 338 | WARN_LOGFILE =
|
| 339 |
|
| 340 | #---------------------------------------------------------------------------
|
| 341 | # configuration options related to the input files
|
| 342 | #---------------------------------------------------------------------------
|
| 343 |
|
| 344 | # The INPUT tag can be used to specify the files and/or directories that contain
|
| 345 | # documented source files. You may enter file names like "myfile.cpp" or
|
| 346 | # directories like "/usr/src/myproject". Separate the files or directories
|
| 347 | # with spaces.
|
| 348 |
|
| 349 | INPUT = docs include/pjnath
|
| 350 |
|
| 351 | # If the value of the INPUT tag contains directories, you can use the
|
| 352 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
| 353 | # and *.h) to filter out the source-files in the directories. If left
|
| 354 | # blank the following patterns are tested:
|
| 355 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
|
| 356 | # *.h++ *.idl *.odl
|
| 357 |
|
| 358 | FILE_PATTERNS = *.h *.c
|
| 359 |
|
| 360 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
| 361 | # should be searched for input files as well. Possible values are YES and NO.
|
| 362 | # If left blank NO is used.
|
| 363 |
|
| 364 | RECURSIVE = YES
|
| 365 |
|
| 366 | # The EXCLUDE tag can be used to specify files and/or directories that should
|
| 367 | # excluded from the INPUT source files. This way you can easily exclude a
|
| 368 | # subdirectory from a directory tree whose root is specified with the INPUT tag.
|
| 369 |
|
| 370 | EXCLUDE =
|
| 371 |
|
| 372 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
|
| 373 | # that are symbolic links (a Unix filesystem feature) are excluded from the input.
|
| 374 |
|
| 375 | EXCLUDE_SYMLINKS = NO
|
| 376 |
|
| 377 | # If the value of the INPUT tag contains directories, you can use the
|
| 378 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
| 379 | # certain files from those directories.
|
| 380 |
|
| 381 | EXCLUDE_PATTERNS = "*_i.h" "*/compat/*"
|
| 382 |
|
| 383 | # The EXAMPLE_PATH tag can be used to specify one or more files or
|
| 384 | # directories that contain example code fragments that are included (see
|
| 385 | # the \include command).
|
| 386 |
|
| 387 | EXAMPLE_PATH = ../pjsip-apps/src/samples src/pjturn-client
|
| 388 |
|
| 389 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
| 390 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
| 391 | # and *.h) to filter out the source-files in the directories. If left
|
| 392 | # blank all files are included.
|
| 393 |
|
| 394 | EXAMPLE_PATTERNS =
|
| 395 |
|
| 396 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
| 397 | # searched for input files to be used with the \include or \dontinclude
|
| 398 | # commands irrespective of the value of the RECURSIVE tag.
|
| 399 | # Possible values are YES and NO. If left blank NO is used.
|
| 400 |
|
| 401 | EXAMPLE_RECURSIVE = YES
|
| 402 |
|
| 403 | # The IMAGE_PATH tag can be used to specify one or more files or
|
| 404 | # directories that contain image that are included in the documentation (see
|
| 405 | # the \image command).
|
| 406 |
|
| 407 | IMAGE_PATH = docs
|
| 408 |
|
| 409 | # The INPUT_FILTER tag can be used to specify a program that doxygen should
|
| 410 | # invoke to filter for each input file. Doxygen will invoke the filter program
|
| 411 | # by executing (via popen()) the command <filter> <input-file>, where <filter>
|
| 412 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
| 413 | # input file. Doxygen will then use the output that the filter program writes
|
| 414 | # to standard output.
|
| 415 |
|
| 416 | INPUT_FILTER =
|
| 417 |
|
| 418 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
| 419 | # INPUT_FILTER) will be used to filter the input files when producing source
|
| 420 | # files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
| 421 |
|
| 422 | FILTER_SOURCE_FILES = NO
|
| 423 |
|
| 424 | #---------------------------------------------------------------------------
|
| 425 | # configuration options related to source browsing
|
| 426 | #---------------------------------------------------------------------------
|
| 427 |
|
| 428 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
| 429 | # be generated. Documented entities will be cross-referenced with these sources.
|
| 430 |
|
| 431 | SOURCE_BROWSER = NO
|
| 432 |
|
| 433 | # Setting the INLINE_SOURCES tag to YES will include the body
|
| 434 | # of functions and classes directly in the documentation.
|
| 435 |
|
| 436 | INLINE_SOURCES = NO
|
| 437 |
|
| 438 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
| 439 | # doxygen to hide any special comment blocks from generated source code
|
| 440 | # fragments. Normal C and C++ comments will always remain visible.
|
| 441 |
|
| 442 | STRIP_CODE_COMMENTS = YES
|
| 443 |
|
| 444 | # If the REFERENCED_BY_RELATION tag is set to YES (the default)
|
| 445 | # then for each documented function all documented
|
| 446 | # functions referencing it will be listed.
|
| 447 |
|
| 448 | REFERENCED_BY_RELATION = YES
|
| 449 |
|
| 450 | # If the REFERENCES_RELATION tag is set to YES (the default)
|
| 451 | # then for each documented function all documented entities
|
| 452 | # called/used by that function will be listed.
|
| 453 |
|
| 454 | REFERENCES_RELATION = YES
|
| 455 |
|
| 456 | #---------------------------------------------------------------------------
|
| 457 | # configuration options related to the alphabetical class index
|
| 458 | #---------------------------------------------------------------------------
|
| 459 |
|
| 460 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
| 461 | # of all compounds will be generated. Enable this if the project
|
| 462 | # contains a lot of classes, structs, unions or interfaces.
|
| 463 |
|
| 464 | ALPHABETICAL_INDEX = NO
|
| 465 |
|
| 466 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
| 467 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
| 468 | # in which this list will be split (can be a number in the range [1..20])
|
| 469 |
|
| 470 | COLS_IN_ALPHA_INDEX = 5
|
| 471 |
|
| 472 | # In case all classes in a project start with a common prefix, all
|
| 473 | # classes will be put under the same header in the alphabetical index.
|
| 474 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
| 475 | # should be ignored while generating the index headers.
|
| 476 |
|
| 477 | IGNORE_PREFIX =
|
| 478 |
|
| 479 | #---------------------------------------------------------------------------
|
| 480 | # configuration options related to the HTML output
|
| 481 | #---------------------------------------------------------------------------
|
| 482 |
|
| 483 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
| 484 | # generate HTML output.
|
| 485 |
|
| 486 | GENERATE_HTML = YES
|
| 487 |
|
| 488 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
| 489 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| 490 | # put in front of it. If left blank `html' will be used as the default path.
|
| 491 |
|
| 492 | HTML_OUTPUT = html
|
| 493 |
|
| 494 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
| 495 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
| 496 | # doxygen will generate files with .html extension.
|
| 497 |
|
| 498 | HTML_FILE_EXTENSION = .htm
|
| 499 |
|
| 500 | # The HTML_HEADER tag can be used to specify a personal HTML header for
|
| 501 | # each generated HTML page. If it is left blank doxygen will generate a
|
| 502 | # standard header.
|
| 503 |
|
| 504 | HTML_HEADER = docs/header.html
|
| 505 |
|
| 506 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
| 507 | # each generated HTML page. If it is left blank doxygen will generate a
|
| 508 | # standard footer.
|
| 509 |
|
| 510 | HTML_FOOTER = docs/footer.html
|
| 511 |
|
| 512 | # The HTML_STYLESHEET tag can be used to specify a user defined cascading
|
| 513 | # style sheet that is used by each HTML page. It can be used to
|
| 514 | # fine-tune the look of the HTML output. If the tag is left blank doxygen
|
| 515 | # will generate a default style sheet
|
| 516 |
|
| 517 | HTML_STYLESHEET = docs/doxygen.css
|
| 518 |
|
| 519 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
| 520 | # files or namespaces will be aligned in HTML using tables. If set to
|
| 521 | # NO a bullet list will be used.
|
| 522 |
|
| 523 | HTML_ALIGN_MEMBERS = YES
|
| 524 |
|
| 525 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
| 526 | # will be generated that can be used as input for tools like the
|
| 527 | # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
|
| 528 | # of the generated HTML documentation.
|
| 529 |
|
| 530 | GENERATE_HTMLHELP = NO
|
| 531 |
|
| 532 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
|
| 533 | # be used to specify the file name of the resulting .chm file. You
|
| 534 | # can add a path in front of the file if the result should not be
|
| 535 | # written to the html output dir.
|
| 536 |
|
| 537 | CHM_FILE =
|
| 538 |
|
| 539 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
|
| 540 | # be used to specify the location (absolute path including file name) of
|
| 541 | # the HTML help compiler (hhc.exe). If non empty doxygen will try to run
|
| 542 | # the html help compiler on the generated index.hhp.
|
| 543 |
|
| 544 | HHC_LOCATION =
|
| 545 |
|
| 546 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
|
| 547 | # controls if a separate .chi index file is generated (YES) or that
|
| 548 | # it should be included in the master .chm file (NO).
|
| 549 |
|
| 550 | GENERATE_CHI = NO
|
| 551 |
|
| 552 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
| 553 | # controls whether a binary table of contents is generated (YES) or a
|
| 554 | # normal table of contents (NO) in the .chm file.
|
| 555 |
|
| 556 | BINARY_TOC = NO
|
| 557 |
|
| 558 | # The TOC_EXPAND flag can be set to YES to add extra items for group members
|
| 559 | # to the contents of the Html help documentation and to the tree view.
|
| 560 |
|
| 561 | TOC_EXPAND = NO
|
| 562 |
|
| 563 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
| 564 | # top of each HTML page. The value NO (the default) enables the index and
|
| 565 | # the value YES disables it.
|
| 566 |
|
| 567 | DISABLE_INDEX = NO
|
| 568 |
|
| 569 | # This tag can be used to set the number of enum values (range [1..20])
|
| 570 | # that doxygen will group on one line in the generated HTML documentation.
|
| 571 |
|
| 572 | ENUM_VALUES_PER_LINE = 1
|
| 573 |
|
| 574 | # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
|
| 575 | # generated containing a tree-like index structure (just like the one that
|
| 576 | # is generated for HTML Help). For this to work a browser that supports
|
| 577 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla,
|
| 578 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
|
| 579 | # probably better off using the HTML help feature.
|
| 580 |
|
| 581 | GENERATE_TREEVIEW = NO
|
| 582 |
|
| 583 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
| 584 | # used to set the initial width (in pixels) of the frame in which the tree
|
| 585 | # is shown.
|
| 586 |
|
| 587 | TREEVIEW_WIDTH = 250
|
| 588 |
|
| 589 | #---------------------------------------------------------------------------
|
| 590 | # configuration options related to the LaTeX output
|
| 591 | #---------------------------------------------------------------------------
|
| 592 |
|
| 593 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
| 594 | # generate Latex output.
|
| 595 |
|
| 596 | GENERATE_LATEX = NO
|
| 597 |
|
| 598 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
| 599 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| 600 | # put in front of it. If left blank `latex' will be used as the default path.
|
| 601 |
|
| 602 | LATEX_OUTPUT = latex
|
| 603 |
|
| 604 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
| 605 | # invoked. If left blank `latex' will be used as the default command name.
|
| 606 |
|
| 607 | LATEX_CMD_NAME = latex
|
| 608 |
|
| 609 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
| 610 | # generate index for LaTeX. If left blank `makeindex' will be used as the
|
| 611 | # default command name.
|
| 612 |
|
| 613 | MAKEINDEX_CMD_NAME = makeindex
|
| 614 |
|
| 615 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
| 616 | # LaTeX documents. This may be useful for small projects and may help to
|
| 617 | # save some trees in general.
|
| 618 |
|
| 619 | COMPACT_LATEX = NO
|
| 620 |
|
| 621 | # The PAPER_TYPE tag can be used to set the paper type that is used
|
| 622 | # by the printer. Possible values are: a4, a4wide, letter, legal and
|
| 623 | # executive. If left blank a4wide will be used.
|
| 624 |
|
| 625 | PAPER_TYPE = a4wide
|
| 626 |
|
| 627 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
| 628 | # packages that should be included in the LaTeX output.
|
| 629 |
|
| 630 | EXTRA_PACKAGES =
|
| 631 |
|
| 632 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
| 633 | # the generated latex document. The header should contain everything until
|
| 634 | # the first chapter. If it is left blank doxygen will generate a
|
| 635 | # standard header. Notice: only use this tag if you know what you are doing!
|
| 636 |
|
| 637 | LATEX_HEADER =
|
| 638 |
|
| 639 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
| 640 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
| 641 | # contain links (just like the HTML output) instead of page references
|
| 642 | # This makes the output suitable for online browsing using a pdf viewer.
|
| 643 |
|
| 644 | PDF_HYPERLINKS = YES
|
| 645 |
|
| 646 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
| 647 | # plain latex in the generated Makefile. Set this option to YES to get a
|
| 648 | # higher quality PDF documentation.
|
| 649 |
|
| 650 | USE_PDFLATEX = YES
|
| 651 |
|
| 652 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
| 653 | # command to the generated LaTeX files. This will instruct LaTeX to keep
|
| 654 | # running if errors occur, instead of asking the user for help.
|
| 655 | # This option is also used when generating formulas in HTML.
|
| 656 |
|
| 657 | LATEX_BATCHMODE = NO
|
| 658 |
|
| 659 | #---------------------------------------------------------------------------
|
| 660 | # configuration options related to the RTF output
|
| 661 | #---------------------------------------------------------------------------
|
| 662 |
|
| 663 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
| 664 | # The RTF output is optimised for Word 97 and may not look very pretty with
|
| 665 | # other RTF readers or editors.
|
| 666 |
|
| 667 | GENERATE_RTF = NO
|
| 668 |
|
| 669 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
| 670 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| 671 | # put in front of it. If left blank `rtf' will be used as the default path.
|
| 672 |
|
| 673 | RTF_OUTPUT = rtf
|
| 674 |
|
| 675 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
| 676 | # RTF documents. This may be useful for small projects and may help to
|
| 677 | # save some trees in general.
|
| 678 |
|
| 679 | COMPACT_RTF = NO
|
| 680 |
|
| 681 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
| 682 | # will contain hyperlink fields. The RTF file will
|
| 683 | # contain links (just like the HTML output) instead of page references.
|
| 684 | # This makes the output suitable for online browsing using WORD or other
|
| 685 | # programs which support those fields.
|
| 686 | # Note: wordpad (write) and others do not support links.
|
| 687 |
|
| 688 | RTF_HYPERLINKS = NO
|
| 689 |
|
| 690 | # Load stylesheet definitions from file. Syntax is similar to doxygen's
|
| 691 | # config file, i.e. a series of assigments. You only have to provide
|
| 692 | # replacements, missing definitions are set to their default value.
|
| 693 |
|
| 694 | RTF_STYLESHEET_FILE =
|
| 695 |
|
| 696 | # Set optional variables used in the generation of an rtf document.
|
| 697 | # Syntax is similar to doxygen's config file.
|
| 698 |
|
| 699 | RTF_EXTENSIONS_FILE =
|
| 700 |
|
| 701 | #---------------------------------------------------------------------------
|
| 702 | # configuration options related to the man page output
|
| 703 | #---------------------------------------------------------------------------
|
| 704 |
|
| 705 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
| 706 | # generate man pages
|
| 707 |
|
| 708 | GENERATE_MAN = NO
|
| 709 |
|
| 710 | # The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
| 711 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| 712 | # put in front of it. If left blank `man' will be used as the default path.
|
| 713 |
|
| 714 | MAN_OUTPUT = man
|
| 715 |
|
| 716 | # The MAN_EXTENSION tag determines the extension that is added to
|
| 717 | # the generated man pages (default is the subroutine's section .3)
|
| 718 |
|
| 719 | MAN_EXTENSION = .3
|
| 720 |
|
| 721 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
|
| 722 | # then it will generate one additional man file for each entity
|
| 723 | # documented in the real man page(s). These additional files
|
| 724 | # only source the real man page, but without them the man command
|
| 725 | # would be unable to find the correct page. The default is NO.
|
| 726 |
|
| 727 | MAN_LINKS = NO
|
| 728 |
|
| 729 | #---------------------------------------------------------------------------
|
| 730 | # configuration options related to the XML output
|
| 731 | #---------------------------------------------------------------------------
|
| 732 |
|
| 733 | # If the GENERATE_XML tag is set to YES Doxygen will
|
| 734 | # generate an XML file that captures the structure of
|
| 735 | # the code including all documentation. Note that this
|
| 736 | # feature is still experimental and incomplete at the
|
| 737 | # moment.
|
| 738 |
|
| 739 | GENERATE_XML = NO
|
| 740 |
|
| 741 | # The XML_SCHEMA tag can be used to specify an XML schema,
|
| 742 | # which can be used by a validating XML parser to check the
|
| 743 | # syntax of the XML files.
|
| 744 |
|
| 745 | XML_SCHEMA =
|
| 746 |
|
| 747 | # The XML_DTD tag can be used to specify an XML DTD,
|
| 748 | # which can be used by a validating XML parser to check the
|
| 749 | # syntax of the XML files.
|
| 750 |
|
| 751 | XML_DTD =
|
| 752 |
|
| 753 | #---------------------------------------------------------------------------
|
| 754 | # configuration options for the AutoGen Definitions output
|
| 755 | #---------------------------------------------------------------------------
|
| 756 |
|
| 757 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
| 758 | # generate an AutoGen Definitions (see autogen.sf.net) file
|
| 759 | # that captures the structure of the code including all
|
| 760 | # documentation. Note that this feature is still experimental
|
| 761 | # and incomplete at the moment.
|
| 762 |
|
| 763 | GENERATE_AUTOGEN_DEF = NO
|
| 764 |
|
| 765 | #---------------------------------------------------------------------------
|
| 766 | # configuration options related to the Perl module output
|
| 767 | #---------------------------------------------------------------------------
|
| 768 |
|
| 769 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will
|
| 770 | # generate a Perl module file that captures the structure of
|
| 771 | # the code including all documentation. Note that this
|
| 772 | # feature is still experimental and incomplete at the
|
| 773 | # moment.
|
| 774 |
|
| 775 | GENERATE_PERLMOD = NO
|
| 776 |
|
| 777 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
|
| 778 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able
|
| 779 | # to generate PDF and DVI output from the Perl module output.
|
| 780 |
|
| 781 | PERLMOD_LATEX = NO
|
| 782 |
|
| 783 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
| 784 | # nicely formatted so it can be parsed by a human reader. This is useful
|
| 785 | # if you want to understand what is going on. On the other hand, if this
|
| 786 | # tag is set to NO the size of the Perl module output will be much smaller
|
| 787 | # and Perl will parse it just the same.
|
| 788 |
|
| 789 | PERLMOD_PRETTY = YES
|
| 790 |
|
| 791 | # The names of the make variables in the generated doxyrules.make file
|
| 792 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
|
| 793 | # This is useful so different doxyrules.make files included by the same
|
| 794 | # Makefile don't overwrite each other's variables.
|
| 795 |
|
| 796 | PERLMOD_MAKEVAR_PREFIX =
|
| 797 |
|
| 798 | #---------------------------------------------------------------------------
|
| 799 | # Configuration options related to the preprocessor
|
| 800 | #---------------------------------------------------------------------------
|
| 801 |
|
| 802 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
| 803 | # evaluate all C-preprocessor directives found in the sources and include
|
| 804 | # files.
|
| 805 |
|
| 806 | ENABLE_PREPROCESSING = YES
|
| 807 |
|
| 808 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
| 809 | # names in the source code. If set to NO (the default) only conditional
|
| 810 | # compilation will be performed. Macro expansion can be done in a controlled
|
| 811 | # way by setting EXPAND_ONLY_PREDEF to YES.
|
| 812 |
|
| 813 | MACRO_EXPANSION = YES
|
| 814 |
|
| 815 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
| 816 | # then the macro expansion is limited to the macros specified with the
|
| 817 | # PREDEFINED and EXPAND_AS_PREDEFINED tags.
|
| 818 |
|
| 819 | EXPAND_ONLY_PREDEF = NO
|
| 820 |
|
| 821 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
| 822 | # in the INCLUDE_PATH (see below) will be search if a #include is found.
|
| 823 |
|
| 824 | SEARCH_INCLUDES = YES
|
| 825 |
|
| 826 | # The INCLUDE_PATH tag can be used to specify one or more directories that
|
| 827 | # contain include files that are not input files but should be processed by
|
| 828 | # the preprocessor.
|
| 829 |
|
| 830 | INCLUDE_PATH =
|
| 831 |
|
| 832 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
| 833 | # patterns (like *.h and *.hpp) to filter out the header-files in the
|
| 834 | # directories. If left blank, the patterns specified with FILE_PATTERNS will
|
| 835 | # be used.
|
| 836 |
|
| 837 | INCLUDE_FILE_PATTERNS =
|
| 838 |
|
| 839 | # The PREDEFINED tag can be used to specify one or more macro names that
|
| 840 | # are defined before the preprocessor is started (similar to the -D option of
|
| 841 | # gcc). The argument of the tag is a list of macros of the form: name
|
| 842 | # or name=definition (no spaces). If the definition and the = are
|
| 843 | # omitted =1 is assumed.
|
| 844 |
|
| 845 | PREDEFINED = PJ_DECL(x)=x PJ_DEF(x)=x PJ_IDECL(x)=x \
|
| 846 | PJ_IDEF(x)=x PJ_INLINE(x)=x \
|
| 847 | PJ_DECL_NO_RETURN(x)=x \
|
| 848 | PJ_HAS_HIGH_RES_TIMER=1 \
|
| 849 | PJ_LOG_MAX_LEVEL=4 \
|
| 850 | PJ_HAS_SEMAPHORE=1 \
|
| 851 | PJ_HAS_EVENT_OBJ=1
|
| 852 |
|
| 853 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
| 854 | # this tag can be used to specify a list of macro names that should be expanded.
|
| 855 | # The macro definition that is found in the sources will be used.
|
| 856 | # Use the PREDEFINED tag if you want to use a different macro definition.
|
| 857 |
|
| 858 | EXPAND_AS_DEFINED =
|
| 859 |
|
| 860 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
| 861 | # doxygen's preprocessor will remove all function-like macros that are alone
|
| 862 | # on a line, have an all uppercase name, and do not end with a semicolon. Such
|
| 863 | # function macros are typically used for boiler-plate code, and will confuse the
|
| 864 | # parser if not removed.
|
| 865 |
|
| 866 | SKIP_FUNCTION_MACROS = YES
|
| 867 |
|
| 868 | #---------------------------------------------------------------------------
|
| 869 | # Configuration::addtions related to external references
|
| 870 | #---------------------------------------------------------------------------
|
| 871 |
|
| 872 | # The TAGFILES tag can be used to specify one or more tagfiles.
|
| 873 |
|
| 874 | TAGFILES = ../pjlib/docs/pjlib.tag=../../../pjlib/docs/html ../pjlib-util/docs/pjlib-util.tag=../../../pjlib-util/docs/html ../pjsip/docs/pjsip.tag=../../../pjsip/docs/html ../pjmedia/docs/pjmedia.tag=../../../pjmedia/docs/html
|
| 875 |
|
| 876 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
| 877 | # a tag file that is based on the input files it reads.
|
| 878 |
|
| 879 | GENERATE_TAGFILE = ../pjnath/docs/pjnath.tag
|
| 880 |
|
| 881 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
| 882 | # in the class index. If set to NO only the inherited external classes
|
| 883 | # will be listed.
|
| 884 |
|
| 885 | ALLEXTERNALS = NO
|
| 886 |
|
| 887 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
| 888 | # in the modules index. If set to NO, only the current project's groups will
|
| 889 | # be listed.
|
| 890 |
|
| 891 | EXTERNAL_GROUPS = NO
|
| 892 |
|
| 893 | # The PERL_PATH should be the absolute path and name of the perl script
|
| 894 | # interpreter (i.e. the result of `which perl').
|
| 895 |
|
| 896 | #PERL_PATH = /usr/bin/perl
|
| 897 | PERL_PATH = /c/Perl/bin/perl
|
| 898 |
|
| 899 | #---------------------------------------------------------------------------
|
| 900 | # Configuration options related to the dot tool
|
| 901 | #---------------------------------------------------------------------------
|
| 902 |
|
| 903 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
| 904 | # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
|
| 905 | # super classes. Setting the tag to NO turns the diagrams off. Note that this
|
| 906 | # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
|
| 907 | # recommended to install and use dot, since it yield more powerful graphs.
|
| 908 |
|
| 909 | CLASS_DIAGRAMS = NO
|
| 910 |
|
| 911 | # If set to YES, the inheritance and collaboration graphs will hide
|
| 912 | # inheritance and usage relations if the target is undocumented
|
| 913 | # or is not a class.
|
| 914 |
|
| 915 | HIDE_UNDOC_RELATIONS = YES
|
| 916 |
|
| 917 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
| 918 | # available from the path. This tool is part of Graphviz, a graph visualization
|
| 919 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
| 920 | # have no effect if this option is set to NO (the default)
|
| 921 |
|
| 922 | HAVE_DOT = NO
|
| 923 |
|
| 924 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
| 925 | # will generate a graph for each documented class showing the direct and
|
| 926 | # indirect inheritance relations. Setting this tag to YES will force the
|
| 927 | # the CLASS_DIAGRAMS tag to NO.
|
| 928 |
|
| 929 | CLASS_GRAPH = YES
|
| 930 |
|
| 931 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
| 932 | # will generate a graph for each documented class showing the direct and
|
| 933 | # indirect implementation dependencies (inheritance, containment, and
|
| 934 | # class references variables) of the class with other documented classes.
|
| 935 |
|
| 936 | COLLABORATION_GRAPH = YES
|
| 937 |
|
| 938 | # If set to YES, the inheritance and collaboration graphs will show the
|
| 939 | # relations between templates and their instances.
|
| 940 |
|
| 941 | TEMPLATE_RELATIONS = YES
|
| 942 |
|
| 943 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
| 944 | # tags are set to YES then doxygen will generate a graph for each documented
|
| 945 | # file showing the direct and indirect include dependencies of the file with
|
| 946 | # other documented files.
|
| 947 |
|
| 948 | INCLUDE_GRAPH = YES
|
| 949 |
|
| 950 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
| 951 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
| 952 | # documented header file showing the documented files that directly or
|
| 953 | # indirectly include this file.
|
| 954 |
|
| 955 | INCLUDED_BY_GRAPH = YES
|
| 956 |
|
| 957 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
| 958 | # will graphical hierarchy of all classes instead of a textual one.
|
| 959 |
|
| 960 | GRAPHICAL_HIERARCHY = YES
|
| 961 |
|
| 962 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
| 963 | # generated by dot. Possible values are png, jpg, or gif
|
| 964 | # If left blank png will be used.
|
| 965 |
|
| 966 | DOT_IMAGE_FORMAT = png
|
| 967 |
|
| 968 | # The tag DOT_PATH can be used to specify the path where the dot tool can be
|
| 969 | # found. If left blank, it is assumed the dot tool can be found on the path.
|
| 970 |
|
| 971 | DOT_PATH =
|
| 972 |
|
| 973 | # The DOTFILE_DIRS tag can be used to specify one or more directories that
|
| 974 | # contain dot files that are included in the documentation (see the
|
| 975 | # \dotfile command).
|
| 976 |
|
| 977 | DOTFILE_DIRS =
|
| 978 |
|
| 979 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
| 980 | # generate a legend page explaining the meaning of the various boxes and
|
| 981 | # arrows in the dot generated graphs.
|
| 982 |
|
| 983 | GENERATE_LEGEND = YES
|
| 984 |
|
| 985 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
| 986 | # remove the intermedate dot files that are used to generate
|
| 987 | # the various graphs.
|
| 988 |
|
| 989 | DOT_CLEANUP = YES
|
| 990 |
|
| 991 | #---------------------------------------------------------------------------
|
| 992 | # Configuration::addtions related to the search engine
|
| 993 | #---------------------------------------------------------------------------
|
| 994 |
|
| 995 | # The SEARCHENGINE tag specifies whether or not a search engine should be
|
| 996 | # used. If set to NO the values of all tags below this one will be ignored.
|
| 997 |
|
| 998 | SEARCHENGINE = NO
|
| 999 |
|
| 1000 | # The CGI_NAME tag should be the name of the CGI script that
|
| 1001 | # starts the search engine (doxysearch) with the correct parameters.
|
| 1002 | # A script with this name will be generated by doxygen.
|
| 1003 |
|
| 1004 | #CGI_NAME = search.cgi
|
| 1005 |
|
| 1006 | # The CGI_URL tag should be the absolute URL to the directory where the
|
| 1007 | # cgi binaries are located. See the documentation of your http daemon for
|
| 1008 | # details.
|
| 1009 |
|
| 1010 | #CGI_URL =
|
| 1011 |
|
| 1012 | # The DOC_URL tag should be the absolute URL to the directory where the
|
| 1013 | # documentation is located. If left blank the absolute path to the
|
| 1014 | # documentation, with file:// prepended to it, will be used.
|
| 1015 |
|
| 1016 | #DOC_URL =
|
| 1017 |
|
| 1018 | # The DOC_ABSPATH tag should be the absolute path to the directory where the
|
| 1019 | # documentation is located. If left blank the directory on the local machine
|
| 1020 | # will be used.
|
| 1021 |
|
| 1022 | #DOC_ABSPATH =
|
| 1023 |
|
| 1024 | # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
|
| 1025 | # is installed.
|
| 1026 |
|
| 1027 | #BIN_ABSPATH = /usr/local/bin/
|
| 1028 |
|
| 1029 | # The EXT_DOC_PATHS tag can be used to specify one or more paths to
|
| 1030 | # documentation generated for other projects. This allows doxysearch to search
|
| 1031 | # the documentation for these projects as well.
|
| 1032 |
|
| 1033 | #EXT_DOC_PATHS =
|