annotate ffmpeg/doc/Doxyfile @ 13:844d341cf643 tip

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