Warning, /sdk/kdesvn/Doxyfile.in is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.5.7.1
0002
0003 # This file describes the settings to be used by the documentation system
0004 # doxygen (www.doxygen.org) for a project
0005 #
0006 # All text after a hash (#) is considered a comment and will be ignored
0007 # The format is:
0008 # TAG = value [value, ...]
0009 # For lists items can also be appended using:
0010 # TAG += value [value, ...]
0011 # Values that contain spaces should be placed between quotes (" ")
0012
0013 #---------------------------------------------------------------------------
0014 # Project related configuration options
0015 #---------------------------------------------------------------------------
0016
0017 # This tag specifies the encoding used for all characters in the config file
0018 # that follow. The default is UTF-8 which is also the encoding used for all
0019 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
0020 # iconv built into libc) for the transcoding. See
0021 # http://www.gnu.org/software/libiconv for the list of possible encodings.
0022
0023 DOXYFILE_ENCODING = UTF-8
0024
0025 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
0026 # by quotes) that should identify the project.
0027
0028 PROJECT_NAME = KDESvn
0029
0030 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
0031 # This could be handy for archiving the generated documentation or
0032 # if some version control system is used.
0033
0034 PROJECT_NUMBER = @VERSION@
0035
0036 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
0037 # base path where the generated documentation will be put.
0038 # If a relative path is entered, it will be relative to the location
0039 # where doxygen was started. If left blank the current directory will be used.
0040
0041 OUTPUT_DIRECTORY = api_doc
0042
0043 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
0044 # 4096 sub-directories (in 2 levels) under the output directory of each output
0045 # format and will distribute the generated files over these directories.
0046 # Enabling this option can be useful when feeding doxygen a huge amount of
0047 # source files, where putting all generated files in the same directory would
0048 # otherwise cause performance problems for the file system.
0049
0050 CREATE_SUBDIRS = NO
0051
0052 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
0053 # documentation generated by doxygen is written. Doxygen will use this
0054 # information to generate all constant output in the proper language.
0055 # The default language is English, other supported languages are:
0056 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
0057 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
0058 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
0059 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
0060 # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
0061 # Spanish, Swedish, and Ukrainian.
0062
0063 OUTPUT_LANGUAGE = English
0064
0065 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
0066 # include brief member descriptions after the members that are listed in
0067 # the file and class documentation (similar to JavaDoc).
0068 # Set to NO to disable this.
0069
0070 BRIEF_MEMBER_DESC = YES
0071
0072 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
0073 # the brief description of a member or function before the detailed description.
0074 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0075 # brief descriptions will be completely suppressed.
0076
0077 REPEAT_BRIEF = YES
0078
0079 # This tag implements a quasi-intelligent brief description abbreviator
0080 # that is used to form the text in various listings. Each string
0081 # in this list, if found as the leading text of the brief description, will be
0082 # stripped from the text and the result after processing the whole list, is
0083 # used as the annotated text. Otherwise, the brief description is used as-is.
0084 # If left blank, the following values are used ("$name" is automatically
0085 # replaced with the name of the entity): "The $name class" "The $name widget"
0086 # "The $name file" "is" "provides" "specifies" "contains"
0087 # "represents" "a" "an" "the"
0088
0089 ABBREVIATE_BRIEF = "The $name class" \
0090 "The $name widget" \
0091 "The $name file" \
0092 is \
0093 provides \
0094 specifies \
0095 contains \
0096 represents \
0097 a \
0098 an \
0099 the
0100
0101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
0102 # Doxygen will generate a detailed section even if there is only a brief
0103 # description.
0104
0105 ALWAYS_DETAILED_SEC = YES
0106
0107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
0108 # inherited members of a class in the documentation of that class as if those
0109 # members were ordinary class members. Constructors, destructors and assignment
0110 # operators of the base classes will not be shown.
0111
0112 INLINE_INHERITED_MEMB = YES
0113
0114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
0115 # path before files name in the file list and in the header files. If set
0116 # to NO the shortest path that makes the file name unique will be used.
0117
0118 FULL_PATH_NAMES = NO
0119
0120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
0121 # can be used to strip a user-defined part of the path. Stripping is
0122 # only done if one of the specified strings matches the left-hand part of
0123 # the path. The tag can be used to show relative paths in the file list.
0124 # If left blank the directory from which doxygen is run is used as the
0125 # path to strip.
0126
0127 STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@
0128
0129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
0130 # the path mentioned in the documentation of a class, which tells
0131 # the reader which header file to include in order to use a class.
0132 # If left blank only the name of the header file containing the class
0133 # definition is used. Otherwise one should specify the include paths that
0134 # are normally passed to the compiler using the -I flag.
0135
0136 STRIP_FROM_INC_PATH =
0137
0138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
0139 # (but less readable) file names. This can be useful is your file systems
0140 # doesn't support long names like on DOS, Mac, or CD-ROM.
0141
0142 SHORT_NAMES = NO
0143
0144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
0145 # will interpret the first line (until the first dot) of a JavaDoc-style
0146 # comment as the brief description. If set to NO, the JavaDoc
0147 # comments will behave just like regular Qt-style comments
0148 # (thus requiring an explicit @brief command for a brief description.)
0149
0150 JAVADOC_AUTOBRIEF = NO
0151
0152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
0153 # interpret the first line (until the first dot) of a Qt-style
0154 # comment as the brief description. If set to NO, the comments
0155 # will behave just like regular Qt-style comments (thus requiring
0156 # an explicit \brief command for a brief description.)
0157
0158 QT_AUTOBRIEF = NO
0159
0160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
0161 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
0162 # comments) as a brief description. This used to be the default behaviour.
0163 # The new default is to treat a multi-line C++ comment block as a detailed
0164 # description. Set this tag to YES if you prefer the old behaviour instead.
0165
0166 MULTILINE_CPP_IS_BRIEF = NO
0167
0168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
0169 # member inherits the documentation from any documented member that it
0170 # re-implements.
0171
0172 INHERIT_DOCS = YES
0173
0174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
0175 # a new page for each member. If set to NO, the documentation of a member will
0176 # be part of the file/class/namespace that contains it.
0177
0178 SEPARATE_MEMBER_PAGES = NO
0179
0180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
0181 # Doxygen uses this value to replace tabs by spaces in code fragments.
0182
0183 TAB_SIZE = 4
0184
0185 # This tag can be used to specify a number of aliases that acts
0186 # as commands in the documentation. An alias has the form "name=value".
0187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
0188 # put the command \sideeffect (or @sideeffect) in the documentation, which
0189 # will result in a user-defined paragraph with heading "Side Effects:".
0190 # You can put \n's in the value part of an alias to insert newlines.
0191
0192 ALIASES =
0193
0194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
0195 # sources only. Doxygen will then generate output that is more tailored for C.
0196 # For instance, some of the names that are used will be different. The list
0197 # of all members will be omitted, etc.
0198
0199 OPTIMIZE_OUTPUT_FOR_C = NO
0200
0201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
0202 # sources only. Doxygen will then generate output that is more tailored for
0203 # Java. For instance, namespaces will be presented as packages, qualified
0204 # scopes will look different, etc.
0205
0206 OPTIMIZE_OUTPUT_JAVA = NO
0207
0208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
0209 # sources only. Doxygen will then generate output that is more tailored for
0210 # Fortran.
0211
0212 OPTIMIZE_FOR_FORTRAN = NO
0213
0214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
0215 # sources. Doxygen will then generate output that is tailored for
0216 # VHDL.
0217
0218 OPTIMIZE_OUTPUT_VHDL = NO
0219
0220 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
0221 # to include (a tag file for) the STL sources as input, then you should
0222 # set this tag to YES in order to let doxygen match functions declarations and
0223 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
0224 # func(std::string) {}). This also make the inheritance and collaboration
0225 # diagrams that involve STL classes more complete and accurate.
0226
0227 BUILTIN_STL_SUPPORT = YES
0228
0229 # If you use Microsoft's C++/CLI language, you should set this option to YES to
0230 # enable parsing support.
0231
0232 CPP_CLI_SUPPORT = NO
0233
0234 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
0235 # Doxygen will parse them like normal C++ but will assume all classes use public
0236 # instead of private inheritance when no explicit protection keyword is present.
0237
0238 SIP_SUPPORT = NO
0239
0240 # For Microsoft's IDL there are propget and propput attributes to indicate getter
0241 # and setter methods for a property. Setting this option to YES (the default)
0242 # will make doxygen to replace the get and set methods by a property in the
0243 # documentation. This will only work if the methods are indeed getting or
0244 # setting a simple type. If this is not the case, or you want to show the
0245 # methods anyway, you should set this option to NO.
0246
0247 IDL_PROPERTY_SUPPORT = YES
0248
0249 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
0250 # tag is set to YES, then doxygen will reuse the documentation of the first
0251 # member in the group (if any) for the other members of the group. By default
0252 # all members of a group must be documented explicitly.
0253
0254 DISTRIBUTE_GROUP_DOC = NO
0255
0256 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
0257 # the same type (for instance a group of public functions) to be put as a
0258 # subgroup of that type (e.g. under the Public Functions section). Set it to
0259 # NO to prevent subgrouping. Alternatively, this can be done per class using
0260 # the \nosubgrouping command.
0261
0262 SUBGROUPING = YES
0263
0264 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
0265 # is documented as struct, union, or enum with the name of the typedef. So
0266 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
0267 # with name TypeT. When disabled the typedef will appear as a member of a file,
0268 # namespace, or class. And the struct will be named TypeS. This can typically
0269 # be useful for C code in case the coding convention dictates that all compound
0270 # types are typedef'ed and only the typedef is referenced, never the tag name.
0271
0272 TYPEDEF_HIDES_STRUCT = NO
0273
0274 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
0275 # determine which symbols to keep in memory and which to flush to disk.
0276 # When the cache is full, less often used symbols will be written to disk.
0277 # For small to medium size projects (<1000 input files) the default value is
0278 # probably good enough. For larger projects a too small cache size can cause
0279 # doxygen to be busy swapping symbols to and from disk most of the time
0280 # causing a significant performance penality.
0281 # If the system has enough physical memory increasing the cache will improve the
0282 # performance by keeping more symbols in memory. Note that the value works on
0283 # a logarithmic scale so increasing the size by one will rougly double the
0284 # memory usage. The cache size is given by this formula:
0285 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
0286 # corresponding to a cache size of 2^16 = 65536 symbols
0287
0288 SYMBOL_CACHE_SIZE = 0
0289
0290 #---------------------------------------------------------------------------
0291 # Build related configuration options
0292 #---------------------------------------------------------------------------
0293
0294 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
0295 # documentation are documented, even if no documentation was available.
0296 # Private class members and static file members will be hidden unless
0297 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
0298
0299 EXTRACT_ALL = YES
0300
0301 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
0302 # will be included in the documentation.
0303
0304 EXTRACT_PRIVATE = YES
0305
0306 # If the EXTRACT_STATIC tag is set to YES all static members of a file
0307 # will be included in the documentation.
0308
0309 EXTRACT_STATIC = YES
0310
0311 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
0312 # defined locally in source files will be included in the documentation.
0313 # If set to NO only classes defined in header files are included.
0314
0315 EXTRACT_LOCAL_CLASSES = YES
0316
0317 # This flag is only useful for Objective-C code. When set to YES local
0318 # methods, which are defined in the implementation section but not in
0319 # the interface are included in the documentation.
0320 # If set to NO (the default) only methods in the interface are included.
0321
0322 EXTRACT_LOCAL_METHODS = NO
0323
0324 # If this flag is set to YES, the members of anonymous namespaces will be
0325 # extracted and appear in the documentation as a namespace called
0326 # 'anonymous_namespace{file}', where file will be replaced with the base
0327 # name of the file that contains the anonymous namespace. By default
0328 # anonymous namespace are hidden.
0329
0330 EXTRACT_ANON_NSPACES = NO
0331
0332 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
0333 # undocumented members of documented classes, files or namespaces.
0334 # If set to NO (the default) these members will be included in the
0335 # various overviews, but no documentation section is generated.
0336 # This option has no effect if EXTRACT_ALL is enabled.
0337
0338 HIDE_UNDOC_MEMBERS = NO
0339
0340 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
0341 # undocumented classes that are normally visible in the class hierarchy.
0342 # If set to NO (the default) these classes will be included in the various
0343 # overviews. This option has no effect if EXTRACT_ALL is enabled.
0344
0345 HIDE_UNDOC_CLASSES = NO
0346
0347 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
0348 # friend (class|struct|union) declarations.
0349 # If set to NO (the default) these declarations will be included in the
0350 # documentation.
0351
0352 HIDE_FRIEND_COMPOUNDS = NO
0353
0354 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
0355 # documentation blocks found inside the body of a function.
0356 # If set to NO (the default) these blocks will be appended to the
0357 # function's detailed documentation block.
0358
0359 HIDE_IN_BODY_DOCS = NO
0360
0361 # The INTERNAL_DOCS tag determines if documentation
0362 # that is typed after a \internal command is included. If the tag is set
0363 # to NO (the default) then the documentation will be excluded.
0364 # Set it to YES to include the internal documentation.
0365
0366 INTERNAL_DOCS = YES
0367
0368 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
0369 # file names in lower-case letters. If set to YES upper-case letters are also
0370 # allowed. This is useful if you have classes or files whose names only differ
0371 # in case and if your file system supports case sensitive file names. Windows
0372 # and Mac users are advised to set this option to NO.
0373
0374 CASE_SENSE_NAMES = YES
0375
0376 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
0377 # will show members with their full class and namespace scopes in the
0378 # documentation. If set to YES the scope will be hidden.
0379
0380 HIDE_SCOPE_NAMES = NO
0381
0382 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
0383 # will put a list of the files that are included by a file in the documentation
0384 # of that file.
0385
0386 SHOW_INCLUDE_FILES = YES
0387
0388 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
0389 # is inserted in the documentation for inline members.
0390
0391 INLINE_INFO = YES
0392
0393 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
0394 # will sort the (detailed) documentation of file and class members
0395 # alphabetically by member name. If set to NO the members will appear in
0396 # declaration order.
0397
0398 SORT_MEMBER_DOCS = YES
0399
0400 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
0401 # brief documentation of file, namespace and class members alphabetically
0402 # by member name. If set to NO (the default) the members will appear in
0403 # declaration order.
0404
0405 SORT_BRIEF_DOCS = YES
0406
0407 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
0408 # hierarchy of group names into alphabetical order. If set to NO (the default)
0409 # the group names will appear in their defined order.
0410
0411 SORT_GROUP_NAMES = NO
0412
0413 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
0414 # sorted by fully-qualified names, including namespaces. If set to
0415 # NO (the default), the class list will be sorted only by class name,
0416 # not including the namespace part.
0417 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
0418 # Note: This option applies only to the class list, not to the
0419 # alphabetical list.
0420
0421 SORT_BY_SCOPE_NAME = NO
0422
0423 # The GENERATE_TODOLIST tag can be used to enable (YES) or
0424 # disable (NO) the todo list. This list is created by putting \todo
0425 # commands in the documentation.
0426
0427 GENERATE_TODOLIST = YES
0428
0429 # The GENERATE_TESTLIST tag can be used to enable (YES) or
0430 # disable (NO) the test list. This list is created by putting \test
0431 # commands in the documentation.
0432
0433 GENERATE_TESTLIST = YES
0434
0435 # The GENERATE_BUGLIST tag can be used to enable (YES) or
0436 # disable (NO) the bug list. This list is created by putting \bug
0437 # commands in the documentation.
0438
0439 GENERATE_BUGLIST = YES
0440
0441 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
0442 # disable (NO) the deprecated list. This list is created by putting
0443 # \deprecated commands in the documentation.
0444
0445 GENERATE_DEPRECATEDLIST= YES
0446
0447 # The ENABLED_SECTIONS tag can be used to enable conditional
0448 # documentation sections, marked by \if sectionname ... \endif.
0449
0450 ENABLED_SECTIONS =
0451
0452 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
0453 # the initial value of a variable or define consists of for it to appear in
0454 # the documentation. If the initializer consists of more lines than specified
0455 # here it will be hidden. Use a value of 0 to hide initializers completely.
0456 # The appearance of the initializer of individual variables and defines in the
0457 # documentation can be controlled using \showinitializer or \hideinitializer
0458 # command in the documentation regardless of this setting.
0459
0460 MAX_INITIALIZER_LINES = 30
0461
0462 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
0463 # at the bottom of the documentation of classes and structs. If set to YES the
0464 # list will mention the files that were used to generate the documentation.
0465
0466 SHOW_USED_FILES = YES
0467
0468 # If the sources in your project are distributed over multiple directories
0469 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
0470 # in the documentation. The default is NO.
0471
0472 SHOW_DIRECTORIES = YES
0473
0474 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
0475 # This will remove the Files entry from the Quick Index and from the
0476 # Folder Tree View (if specified). The default is YES.
0477
0478 SHOW_FILES = YES
0479
0480 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
0481 # Namespaces page. This will remove the Namespaces entry from the Quick Index
0482 # and from the Folder Tree View (if specified). The default is YES.
0483
0484 SHOW_NAMESPACES = YES
0485
0486 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
0487 # doxygen should invoke to get the current version for each file (typically from
0488 # the version control system). Doxygen will invoke the program by executing (via
0489 # popen()) the command <command> <input-file>, where <command> is the value of
0490 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
0491 # provided by doxygen. Whatever the program writes to standard output
0492 # is used as the file version. See the manual for examples.
0493
0494 FILE_VERSION_FILTER =
0495
0496 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
0497 # doxygen. The layout file controls the global structure of the generated output files
0498 # in an output format independent way. The create the layout file that represents
0499 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
0500 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
0501 # of the layout file.
0502
0503 LAYOUT_FILE =
0504
0505 #---------------------------------------------------------------------------
0506 # configuration options related to warning and progress messages
0507 #---------------------------------------------------------------------------
0508
0509 # The QUIET tag can be used to turn on/off the messages that are generated
0510 # by doxygen. Possible values are YES and NO. If left blank NO is used.
0511
0512 QUIET = NO
0513
0514 # The WARNINGS tag can be used to turn on/off the warning messages that are
0515 # generated by doxygen. Possible values are YES and NO. If left blank
0516 # NO is used.
0517
0518 WARNINGS = YES
0519
0520 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
0521 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
0522 # automatically be disabled.
0523
0524 WARN_IF_UNDOCUMENTED = YES
0525
0526 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
0527 # potential errors in the documentation, such as not documenting some
0528 # parameters in a documented function, or documenting parameters that
0529 # don't exist or using markup commands wrongly.
0530
0531 WARN_IF_DOC_ERROR = YES
0532
0533 # This WARN_NO_PARAMDOC option can be abled to get warnings for
0534 # functions that are documented, but have no documentation for their parameters
0535 # or return value. If set to NO (the default) doxygen will only warn about
0536 # wrong or incomplete parameter documentation, but not about the absence of
0537 # documentation.
0538
0539 WARN_NO_PARAMDOC = NO
0540
0541 # The WARN_FORMAT tag determines the format of the warning messages that
0542 # doxygen can produce. The string should contain the $file, $line, and $text
0543 # tags, which will be replaced by the file and line number from which the
0544 # warning originated and the warning text. Optionally the format may contain
0545 # $version, which will be replaced by the version of the file (if it could
0546 # be obtained via FILE_VERSION_FILTER)
0547
0548 WARN_FORMAT = "$file:$line: $text"
0549
0550 # The WARN_LOGFILE tag can be used to specify a file to which warning
0551 # and error messages should be written. If left blank the output is written
0552 # to stderr.
0553
0554 WARN_LOGFILE = @CMAKE_BINARY_DIR@/doxygen-warning.log
0555
0556 #---------------------------------------------------------------------------
0557 # configuration options related to the input files
0558 #---------------------------------------------------------------------------
0559
0560 # The INPUT tag can be used to specify the files and/or directories that contain
0561 # documented source files. You may enter file names like "myfile.cpp" or
0562 # directories like "/usr/src/myproject". Separate the files or directories
0563 # with spaces.
0564
0565 INPUT = @CMAKE_SOURCE_DIR@/src \
0566 @SUBVERSION_INCLUDE_DIR@
0567
0568 # This tag can be used to specify the character encoding of the source files
0569 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
0570 # also the default input encoding. Doxygen uses libiconv (or the iconv built
0571 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
0572 # the list of possible encodings.
0573
0574 INPUT_ENCODING = UTF-8
0575
0576 # If the value of the INPUT tag contains directories, you can use the
0577 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0578 # and *.h) to filter out the source-files in the directories. If left
0579 # blank the following patterns are tested:
0580 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
0581 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
0582
0583 FILE_PATTERNS = *.c \
0584 *.cc \
0585 *.cxx \
0586 *.cpp \
0587 *.c++ \
0588 *.java \
0589 *.ii \
0590 *.ixx \
0591 *.ipp \
0592 *.i++ \
0593 *.inl \
0594 *.h \
0595 *.hh \
0596 *.hxx \
0597 *.hpp \
0598 *.h++ \
0599 *.idl \
0600 *.odl \
0601 *.cs \
0602 *.php \
0603 *.php3 \
0604 *.inc \
0605 *.m \
0606 *.mm \
0607 *.dox \
0608 *.C \
0609 *.CC \
0610 *.C++ \
0611 *.II \
0612 *.I++ \
0613 *.H \
0614 *.HH \
0615 *.H++ \
0616 *.CS \
0617 *.PHP \
0618 *.PHP3 \
0619 *.M \
0620 *.MM \
0621 *.C \
0622 *.H \
0623 *.tlh \
0624 *.diff \
0625 *.patch \
0626 *.moc \
0627 *.xpm \
0628 *.dox
0629
0630 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
0631 # should be searched for input files as well. Possible values are YES and NO.
0632 # If left blank NO is used.
0633
0634 RECURSIVE = YES
0635
0636 # The EXCLUDE tag can be used to specify files and/or directories that should
0637 # excluded from the INPUT source files. This way you can easily exclude a
0638 # subdirectory from a directory tree whose root is specified with the INPUT tag.
0639
0640 EXCLUDE =
0641
0642 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
0643 # directories that are symbolic links (a Unix filesystem feature) are excluded
0644 # from the input.
0645
0646 EXCLUDE_SYMLINKS = NO
0647
0648 # If the value of the INPUT tag contains directories, you can use the
0649 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
0650 # certain files from those directories. Note that the wildcards are matched
0651 # against the file with absolute path, so to exclude all test directories
0652 # for example use the pattern */test/*
0653
0654 EXCLUDE_PATTERNS = *moc* \
0655 *.svn/*
0656
0657 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
0658 # (namespaces, classes, functions, etc.) that should be excluded from the
0659 # output. The symbol name can be a fully qualified name, a word, or if the
0660 # wildcard * is used, a substring. Examples: ANamespace, AClass,
0661 # AClass::ANamespace, ANamespace::*Test
0662
0663 EXCLUDE_SYMBOLS =
0664
0665 # The EXAMPLE_PATH tag can be used to specify one or more files or
0666 # directories that contain example code fragments that are included (see
0667 # the \include command).
0668
0669 EXAMPLE_PATH =
0670
0671 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
0672 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0673 # and *.h) to filter out the source-files in the directories. If left
0674 # blank all files are included.
0675
0676 EXAMPLE_PATTERNS = *
0677
0678 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
0679 # searched for input files to be used with the \include or \dontinclude
0680 # commands irrespective of the value of the RECURSIVE tag.
0681 # Possible values are YES and NO. If left blank NO is used.
0682
0683 EXAMPLE_RECURSIVE = NO
0684
0685 # The IMAGE_PATH tag can be used to specify one or more files or
0686 # directories that contain image that are included in the documentation (see
0687 # the \image command).
0688
0689 IMAGE_PATH =
0690
0691 # The INPUT_FILTER tag can be used to specify a program that doxygen should
0692 # invoke to filter for each input file. Doxygen will invoke the filter program
0693 # by executing (via popen()) the command <filter> <input-file>, where <filter>
0694 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
0695 # input file. Doxygen will then use the output that the filter program writes
0696 # to standard output. If FILTER_PATTERNS is specified, this tag will be
0697 # ignored.
0698
0699 INPUT_FILTER =
0700
0701 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
0702 # basis. Doxygen will compare the file name with each pattern and apply the
0703 # filter if there is a match. The filters are a list of the form:
0704 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
0705 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
0706 # is applied to all files.
0707
0708 FILTER_PATTERNS =
0709
0710 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
0711 # INPUT_FILTER) will be used to filter the input files when producing source
0712 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
0713
0714 FILTER_SOURCE_FILES = NO
0715
0716 #---------------------------------------------------------------------------
0717 # configuration options related to source browsing
0718 #---------------------------------------------------------------------------
0719
0720 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
0721 # be generated. Documented entities will be cross-referenced with these sources.
0722 # Note: To get rid of all source code in the generated output, make sure also
0723 # VERBATIM_HEADERS is set to NO.
0724
0725 SOURCE_BROWSER = YES
0726
0727 # Setting the INLINE_SOURCES tag to YES will include the body
0728 # of functions and classes directly in the documentation.
0729
0730 INLINE_SOURCES = NO
0731
0732 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
0733 # doxygen to hide any special comment blocks from generated source code
0734 # fragments. Normal C and C++ comments will always remain visible.
0735
0736 STRIP_CODE_COMMENTS = YES
0737
0738 # If the REFERENCED_BY_RELATION tag is set to YES
0739 # then for each documented function all documented
0740 # functions referencing it will be listed.
0741
0742 REFERENCED_BY_RELATION = YES
0743
0744 # If the REFERENCES_RELATION tag is set to YES
0745 # then for each documented function all documented entities
0746 # called/used by that function will be listed.
0747
0748 REFERENCES_RELATION = YES
0749
0750 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
0751 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
0752 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
0753 # link to the source code. Otherwise they will link to the documentstion.
0754
0755 REFERENCES_LINK_SOURCE = YES
0756
0757 # If the USE_HTAGS tag is set to YES then the references to source code
0758 # will point to the HTML generated by the htags(1) tool instead of doxygen
0759 # built-in source browser. The htags tool is part of GNU's global source
0760 # tagging system (see http://www.gnu.org/software/global/global.html). You
0761 # will need version 4.8.6 or higher.
0762
0763 USE_HTAGS = NO
0764
0765 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
0766 # will generate a verbatim copy of the header file for each class for
0767 # which an include is specified. Set to NO to disable this.
0768
0769 VERBATIM_HEADERS = YES
0770
0771 #---------------------------------------------------------------------------
0772 # configuration options related to the alphabetical class index
0773 #---------------------------------------------------------------------------
0774
0775 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
0776 # of all compounds will be generated. Enable this if the project
0777 # contains a lot of classes, structs, unions or interfaces.
0778
0779 ALPHABETICAL_INDEX = YES
0780
0781 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
0782 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
0783 # in which this list will be split (can be a number in the range [1..20])
0784
0785 COLS_IN_ALPHA_INDEX = 5
0786
0787 # In case all classes in a project start with a common prefix, all
0788 # classes will be put under the same header in the alphabetical index.
0789 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
0790 # should be ignored while generating the index headers.
0791
0792 IGNORE_PREFIX =
0793
0794 #---------------------------------------------------------------------------
0795 # configuration options related to the HTML output
0796 #---------------------------------------------------------------------------
0797
0798 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
0799 # generate HTML output.
0800
0801 GENERATE_HTML = YES
0802
0803 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
0804 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0805 # put in front of it. If left blank `html' will be used as the default path.
0806
0807 HTML_OUTPUT = html
0808
0809 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
0810 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
0811 # doxygen will generate files with .html extension.
0812
0813 HTML_FILE_EXTENSION = .html
0814
0815 # The HTML_HEADER tag can be used to specify a personal HTML header for
0816 # each generated HTML page. If it is left blank doxygen will generate a
0817 # standard header.
0818
0819 HTML_HEADER =
0820
0821 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
0822 # each generated HTML page. If it is left blank doxygen will generate a
0823 # standard footer.
0824
0825 HTML_FOOTER =
0826
0827 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
0828 # style sheet that is used by each HTML page. It can be used to
0829 # fine-tune the look of the HTML output. If the tag is left blank doxygen
0830 # will generate a default style sheet. Note that doxygen will try to copy
0831 # the style sheet file to the HTML output directory, so don't put your own
0832 # stylesheet in the HTML output directory as well, or it will be erased!
0833
0834 HTML_STYLESHEET =
0835
0836 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
0837 # files or namespaces will be aligned in HTML using tables. If set to
0838 # NO a bullet list will be used.
0839
0840 HTML_ALIGN_MEMBERS = YES
0841
0842 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
0843 # documentation will contain sections that can be hidden and shown after the
0844 # page has loaded. For this to work a browser that supports
0845 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
0846 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
0847
0848 HTML_DYNAMIC_SECTIONS = NO
0849
0850 # If the GENERATE_DOCSET tag is set to YES, additional index files
0851 # will be generated that can be used as input for Apple's Xcode 3
0852 # integrated development environment, introduced with OSX 10.5 (Leopard).
0853 # To create a documentation set, doxygen will generate a Makefile in the
0854 # HTML output directory. Running make will produce the docset in that
0855 # directory and running "make install" will install the docset in
0856 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
0857 # it at startup.
0858 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
0859
0860 GENERATE_DOCSET = NO
0861
0862 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
0863 # feed. A documentation feed provides an umbrella under which multiple
0864 # documentation sets from a single provider (such as a company or product suite)
0865 # can be grouped.
0866
0867 DOCSET_FEEDNAME = "Doxygen generated docs"
0868
0869 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
0870 # should uniquely identify the documentation set bundle. This should be a
0871 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
0872 # will append .docset to the name.
0873
0874 DOCSET_BUNDLE_ID = org.doxygen.Project
0875
0876 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
0877 # will be generated that can be used as input for tools like the
0878 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
0879 # of the generated HTML documentation.
0880
0881 GENERATE_HTMLHELP = NO
0882
0883 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
0884 # be used to specify the file name of the resulting .chm file. You
0885 # can add a path in front of the file if the result should not be
0886 # written to the html output directory.
0887
0888 CHM_FILE =
0889
0890 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
0891 # be used to specify the location (absolute path including file name) of
0892 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
0893 # the HTML help compiler on the generated index.hhp.
0894
0895 HHC_LOCATION =
0896
0897 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
0898 # controls if a separate .chi index file is generated (YES) or that
0899 # it should be included in the master .chm file (NO).
0900
0901 GENERATE_CHI = NO
0902
0903 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
0904 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
0905 # content.
0906
0907 CHM_INDEX_ENCODING =
0908
0909 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
0910 # controls whether a binary table of contents is generated (YES) or a
0911 # normal table of contents (NO) in the .chm file.
0912
0913 BINARY_TOC = NO
0914
0915 # The TOC_EXPAND flag can be set to YES to add extra items for group members
0916 # to the contents of the HTML help documentation and to the tree view.
0917
0918 TOC_EXPAND = NO
0919
0920 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
0921 # are set, an additional index file will be generated that can be used as input for
0922 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
0923 # HTML documentation.
0924
0925 GENERATE_QHP = NO
0926
0927 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
0928 # be used to specify the file name of the resulting .qch file.
0929 # The path specified is relative to the HTML output folder.
0930
0931 QCH_FILE =
0932
0933 # The QHP_NAMESPACE tag specifies the namespace to use when generating
0934 # Qt Help Project output. For more information please see
0935 # <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
0936
0937 QHP_NAMESPACE = org.doxygen.Project
0938
0939 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
0940 # Qt Help Project output. For more information please see
0941 # <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
0942
0943 QHP_VIRTUAL_FOLDER = doc
0944
0945 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
0946 # be used to specify the location of Qt's qhelpgenerator.
0947 # If non-empty doxygen will try to run qhelpgenerator on the generated
0948 # .qhp file .
0949
0950 QHG_LOCATION =
0951
0952 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
0953 # top of each HTML page. The value NO (the default) enables the index and
0954 # the value YES disables it.
0955
0956 DISABLE_INDEX = NO
0957
0958 # This tag can be used to set the number of enum values (range [1..20])
0959 # that doxygen will group on one line in the generated HTML documentation.
0960
0961 ENUM_VALUES_PER_LINE = 4
0962
0963 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
0964 # structure should be generated to display hierarchical information.
0965 # If the tag value is set to FRAME, a side panel will be generated
0966 # containing a tree-like index structure (just like the one that
0967 # is generated for HTML Help). For this to work a browser that supports
0968 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
0969 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
0970 # probably better off using the HTML help feature. Other possible values
0971 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
0972 # and Class Hierarchy pages using a tree view instead of an ordered list;
0973 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
0974 # disables this behavior completely. For backwards compatibility with previous
0975 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
0976 # respectively.
0977
0978 GENERATE_TREEVIEW = NO
0979
0980 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
0981 # used to set the initial width (in pixels) of the frame in which the tree
0982 # is shown.
0983
0984 TREEVIEW_WIDTH = 250
0985
0986 # Use this tag to change the font size of Latex formulas included
0987 # as images in the HTML documentation. The default is 10. Note that
0988 # when you change the font size after a successful doxygen run you need
0989 # to manually remove any form_*.png images from the HTML output directory
0990 # to force them to be regenerated.
0991
0992 FORMULA_FONTSIZE = 10
0993
0994 #---------------------------------------------------------------------------
0995 # configuration options related to the LaTeX output
0996 #---------------------------------------------------------------------------
0997
0998 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
0999 # generate Latex output.
1000
1001 GENERATE_LATEX = NO
1002
1003 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1004 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1005 # put in front of it. If left blank `latex' will be used as the default path.
1006
1007 LATEX_OUTPUT = latex
1008
1009 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1010 # invoked. If left blank `latex' will be used as the default command name.
1011
1012 LATEX_CMD_NAME = latex
1013
1014 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1015 # generate index for LaTeX. If left blank `makeindex' will be used as the
1016 # default command name.
1017
1018 MAKEINDEX_CMD_NAME = makeindex
1019
1020 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1021 # LaTeX documents. This may be useful for small projects and may help to
1022 # save some trees in general.
1023
1024 COMPACT_LATEX = YES
1025
1026 # The PAPER_TYPE tag can be used to set the paper type that is used
1027 # by the printer. Possible values are: a4, a4wide, letter, legal and
1028 # executive. If left blank a4wide will be used.
1029
1030 PAPER_TYPE = a4wide
1031
1032 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1033 # packages that should be included in the LaTeX output.
1034
1035 EXTRA_PACKAGES =
1036
1037 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1038 # the generated latex document. The header should contain everything until
1039 # the first chapter. If it is left blank doxygen will generate a
1040 # standard header. Notice: only use this tag if you know what you are doing!
1041
1042 LATEX_HEADER =
1043
1044 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1045 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1046 # contain links (just like the HTML output) instead of page references
1047 # This makes the output suitable for online browsing using a pdf viewer.
1048
1049 PDF_HYPERLINKS = YES
1050
1051 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1052 # plain latex in the generated Makefile. Set this option to YES to get a
1053 # higher quality PDF documentation.
1054
1055 USE_PDFLATEX = YES
1056
1057 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1058 # command to the generated LaTeX files. This will instruct LaTeX to keep
1059 # running if errors occur, instead of asking the user for help.
1060 # This option is also used when generating formulas in HTML.
1061
1062 LATEX_BATCHMODE = NO
1063
1064 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1065 # include the index chapters (such as File Index, Compound Index, etc.)
1066 # in the output.
1067
1068 LATEX_HIDE_INDICES = NO
1069
1070 #---------------------------------------------------------------------------
1071 # configuration options related to the RTF output
1072 #---------------------------------------------------------------------------
1073
1074 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1075 # The RTF output is optimized for Word 97 and may not look very pretty with
1076 # other RTF readers or editors.
1077
1078 GENERATE_RTF = NO
1079
1080 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1081 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1082 # put in front of it. If left blank `rtf' will be used as the default path.
1083
1084 RTF_OUTPUT = rtf
1085
1086 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1087 # RTF documents. This may be useful for small projects and may help to
1088 # save some trees in general.
1089
1090 COMPACT_RTF = NO
1091
1092 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1093 # will contain hyperlink fields. The RTF file will
1094 # contain links (just like the HTML output) instead of page references.
1095 # This makes the output suitable for online browsing using WORD or other
1096 # programs which support those fields.
1097 # Note: wordpad (write) and others do not support links.
1098
1099 RTF_HYPERLINKS = NO
1100
1101 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1102 # config file, i.e. a series of assignments. You only have to provide
1103 # replacements, missing definitions are set to their default value.
1104
1105 RTF_STYLESHEET_FILE =
1106
1107 # Set optional variables used in the generation of an rtf document.
1108 # Syntax is similar to doxygen's config file.
1109
1110 RTF_EXTENSIONS_FILE =
1111
1112 #---------------------------------------------------------------------------
1113 # configuration options related to the man page output
1114 #---------------------------------------------------------------------------
1115
1116 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1117 # generate man pages
1118
1119 GENERATE_MAN = NO
1120
1121 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1122 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1123 # put in front of it. If left blank `man' will be used as the default path.
1124
1125 MAN_OUTPUT = man
1126
1127 # The MAN_EXTENSION tag determines the extension that is added to
1128 # the generated man pages (default is the subroutine's section .3)
1129
1130 MAN_EXTENSION = .3
1131
1132 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1133 # then it will generate one additional man file for each entity
1134 # documented in the real man page(s). These additional files
1135 # only source the real man page, but without them the man command
1136 # would be unable to find the correct page. The default is NO.
1137
1138 MAN_LINKS = NO
1139
1140 #---------------------------------------------------------------------------
1141 # configuration options related to the XML output
1142 #---------------------------------------------------------------------------
1143
1144 # If the GENERATE_XML tag is set to YES Doxygen will
1145 # generate an XML file that captures the structure of
1146 # the code including all documentation.
1147
1148 GENERATE_XML = NO
1149
1150 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1151 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1152 # put in front of it. If left blank `xml' will be used as the default path.
1153
1154 XML_OUTPUT = xml
1155
1156 # The XML_SCHEMA tag can be used to specify an XML schema,
1157 # which can be used by a validating XML parser to check the
1158 # syntax of the XML files.
1159
1160 XML_SCHEMA =
1161
1162 # The XML_DTD tag can be used to specify an XML DTD,
1163 # which can be used by a validating XML parser to check the
1164 # syntax of the XML files.
1165
1166 XML_DTD =
1167
1168 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1169 # dump the program listings (including syntax highlighting
1170 # and cross-referencing information) to the XML output. Note that
1171 # enabling this will significantly increase the size of the XML output.
1172
1173 XML_PROGRAMLISTING = YES
1174
1175 #---------------------------------------------------------------------------
1176 # configuration options for the AutoGen Definitions output
1177 #---------------------------------------------------------------------------
1178
1179 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1180 # generate an AutoGen Definitions (see autogen.sf.net) file
1181 # that captures the structure of the code including all
1182 # documentation. Note that this feature is still experimental
1183 # and incomplete at the moment.
1184
1185 GENERATE_AUTOGEN_DEF = NO
1186
1187 #---------------------------------------------------------------------------
1188 # configuration options related to the Perl module output
1189 #---------------------------------------------------------------------------
1190
1191 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1192 # generate a Perl module file that captures the structure of
1193 # the code including all documentation. Note that this
1194 # feature is still experimental and incomplete at the
1195 # moment.
1196
1197 GENERATE_PERLMOD = NO
1198
1199 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1200 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1201 # to generate PDF and DVI output from the Perl module output.
1202
1203 PERLMOD_LATEX = NO
1204
1205 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1206 # nicely formatted so it can be parsed by a human reader. This is useful
1207 # if you want to understand what is going on. On the other hand, if this
1208 # tag is set to NO the size of the Perl module output will be much smaller
1209 # and Perl will parse it just the same.
1210
1211 PERLMOD_PRETTY = YES
1212
1213 # The names of the make variables in the generated doxyrules.make file
1214 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1215 # This is useful so different doxyrules.make files included by the same
1216 # Makefile don't overwrite each other's variables.
1217
1218 PERLMOD_MAKEVAR_PREFIX =
1219
1220 #---------------------------------------------------------------------------
1221 # Configuration options related to the preprocessor
1222 #---------------------------------------------------------------------------
1223
1224 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1225 # evaluate all C-preprocessor directives found in the sources and include
1226 # files.
1227
1228 ENABLE_PREPROCESSING = YES
1229
1230 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1231 # names in the source code. If set to NO (the default) only conditional
1232 # compilation will be performed. Macro expansion can be done in a controlled
1233 # way by setting EXPAND_ONLY_PREDEF to YES.
1234
1235 MACRO_EXPANSION = NO
1236
1237 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1238 # then the macro expansion is limited to the macros specified with the
1239 # PREDEFINED and EXPAND_AS_DEFINED tags.
1240
1241 EXPAND_ONLY_PREDEF = NO
1242
1243 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1244 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1245
1246 SEARCH_INCLUDES = YES
1247
1248 # The INCLUDE_PATH tag can be used to specify one or more directories that
1249 # contain include files that are not input files but should be processed by
1250 # the preprocessor.
1251
1252 INCLUDE_PATH = @SUBVERSION_INCLUDE_DIR@
1253
1254 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1255 # patterns (like *.h and *.hpp) to filter out the header-files in the
1256 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1257 # be used.
1258
1259 INCLUDE_FILE_PATTERNS = *.h \
1260 *.hpp
1261
1262 # The PREDEFINED tag can be used to specify one or more macro names that
1263 # are defined before the preprocessor is started (similar to the -D option of
1264 # gcc). The argument of the tag is a list of macros of the form: name
1265 # or name=definition (no spaces). If the definition and the = are
1266 # omitted =1 is assumed. To prevent a macro definition from being
1267 # undefined via #undef or recursively expanded use the := operator
1268 # instead of the = operator.
1269
1270 PREDEFINED =
1271
1272 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1273 # this tag can be used to specify a list of macro names that should be expanded.
1274 # The macro definition that is found in the sources will be used.
1275 # Use the PREDEFINED tag if you want to use a different macro definition.
1276
1277 EXPAND_AS_DEFINED =
1278
1279 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1280 # doxygen's preprocessor will remove all function-like macros that are alone
1281 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1282 # function macros are typically used for boiler-plate code, and will confuse
1283 # the parser if not removed.
1284
1285 SKIP_FUNCTION_MACROS = YES
1286
1287 #---------------------------------------------------------------------------
1288 # Configuration::additions related to external references
1289 #---------------------------------------------------------------------------
1290
1291 # The TAGFILES option can be used to specify one or more tagfiles.
1292 # Optionally an initial location of the external documentation
1293 # can be added for each tagfile. The format of a tag file without
1294 # this location is as follows:
1295 # TAGFILES = file1 file2 ...
1296 # Adding location for the tag files is done as follows:
1297 # TAGFILES = file1=loc1 "file2 = loc2" ...
1298 # where "loc1" and "loc2" can be relative or absolute paths or
1299 # URLs. If a location is present for each tag, the installdox tool
1300 # does not have to be run to correct the links.
1301 # Note that each tag file must have a unique name
1302 # (where the name does NOT include the path)
1303 # If a tag file is not located in the directory in which doxygen
1304 # is run, you must also specify the path to the tagfile here.
1305
1306 TAGFILES =
1307
1308 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1309 # a tag file that is based on the input files it reads.
1310
1311 GENERATE_TAGFILE = @CMAKE_BINARY_DIR@/api_doc/html/kdesvn.tag
1312
1313 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1314 # in the class index. If set to NO only the inherited external classes
1315 # will be listed.
1316
1317 ALLEXTERNALS = NO
1318
1319 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1320 # in the modules index. If set to NO, only the current project's groups will
1321 # be listed.
1322
1323 EXTERNAL_GROUPS = YES
1324
1325 # The PERL_PATH should be the absolute path and name of the perl script
1326 # interpreter (i.e. the result of `which perl').
1327
1328 PERL_PATH = /usr/bin/perl
1329
1330 #---------------------------------------------------------------------------
1331 # Configuration options related to the dot tool
1332 #---------------------------------------------------------------------------
1333
1334 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1335 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1336 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1337 # this option is superseded by the HAVE_DOT option below. This is only a
1338 # fallback. It is recommended to install and use dot, since it yields more
1339 # powerful graphs.
1340
1341 CLASS_DIAGRAMS = YES
1342
1343 # You can define message sequence charts within doxygen comments using the \msc
1344 # command. Doxygen will then run the mscgen tool (see
1345 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1346 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1347 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1348 # default search path.
1349
1350 MSCGEN_PATH =
1351
1352 # If set to YES, the inheritance and collaboration graphs will hide
1353 # inheritance and usage relations if the target is undocumented
1354 # or is not a class.
1355
1356 HIDE_UNDOC_RELATIONS = NO
1357
1358 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1359 # available from the path. This tool is part of Graphviz, a graph visualization
1360 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1361 # have no effect if this option is set to NO (the default)
1362
1363 HAVE_DOT = YES
1364
1365 # By default doxygen will write a font called FreeSans.ttf to the output
1366 # directory and reference it in all dot files that doxygen generates. This
1367 # font does not include all possible unicode characters however, so when you need
1368 # these (or just want a differently looking font) you can specify the font name
1369 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1370 # which can be done by putting it in a standard location or by setting the
1371 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1372 # containing the font.
1373
1374 DOT_FONTNAME = FreeSans
1375
1376 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1377 # The default size is 10pt.
1378
1379 DOT_FONTSIZE = 10
1380
1381 # By default doxygen will tell dot to use the output directory to look for the
1382 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1383 # different font using DOT_FONTNAME you can set the path where dot
1384 # can find it using this tag.
1385
1386 DOT_FONTPATH =
1387
1388 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1389 # will generate a graph for each documented class showing the direct and
1390 # indirect inheritance relations. Setting this tag to YES will force the
1391 # the CLASS_DIAGRAMS tag to NO.
1392
1393 CLASS_GRAPH = YES
1394
1395 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1396 # will generate a graph for each documented class showing the direct and
1397 # indirect implementation dependencies (inheritance, containment, and
1398 # class references variables) of the class with other documented classes.
1399
1400 COLLABORATION_GRAPH = YES
1401
1402 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1403 # will generate a graph for groups, showing the direct groups dependencies
1404
1405 GROUP_GRAPHS = YES
1406
1407 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1408 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1409 # Language.
1410
1411 UML_LOOK = YES
1412
1413 # If set to YES, the inheritance and collaboration graphs will show the
1414 # relations between templates and their instances.
1415
1416 TEMPLATE_RELATIONS = YES
1417
1418 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1419 # tags are set to YES then doxygen will generate a graph for each documented
1420 # file showing the direct and indirect include dependencies of the file with
1421 # other documented files.
1422
1423 INCLUDE_GRAPH = YES
1424
1425 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1426 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1427 # documented header file showing the documented files that directly or
1428 # indirectly include this file.
1429
1430 INCLUDED_BY_GRAPH = YES
1431
1432 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1433 # doxygen will generate a call dependency graph for every global function
1434 # or class method. Note that enabling this option will significantly increase
1435 # the time of a run. So in most cases it will be better to enable call graphs
1436 # for selected functions only using the \callgraph command.
1437
1438 CALL_GRAPH = YES
1439
1440 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1441 # doxygen will generate a caller dependency graph for every global function
1442 # or class method. Note that enabling this option will significantly increase
1443 # the time of a run. So in most cases it will be better to enable caller
1444 # graphs for selected functions only using the \callergraph command.
1445
1446 CALLER_GRAPH = YES
1447
1448 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1449 # will graphical hierarchy of all classes instead of a textual one.
1450
1451 GRAPHICAL_HIERARCHY = YES
1452
1453 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1454 # then doxygen will show the dependencies a directory has on other directories
1455 # in a graphical way. The dependency relations are determined by the #include
1456 # relations between the files in the directories.
1457
1458 DIRECTORY_GRAPH = YES
1459
1460 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1461 # generated by dot. Possible values are png, jpg, or gif
1462 # If left blank png will be used.
1463
1464 DOT_IMAGE_FORMAT = png
1465
1466 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1467 # found. If left blank, it is assumed the dot tool can be found in the path.
1468
1469 DOT_PATH =
1470
1471 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1472 # contain dot files that are included in the documentation (see the
1473 # \dotfile command).
1474
1475 DOTFILE_DIRS =
1476
1477 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1478 # nodes that will be shown in the graph. If the number of nodes in a graph
1479 # becomes larger than this value, doxygen will truncate the graph, which is
1480 # visualized by representing a node as a red box. Note that doxygen if the
1481 # number of direct children of the root node in a graph is already larger than
1482 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1483 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1484
1485 DOT_GRAPH_MAX_NODES = 50
1486
1487 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1488 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1489 # from the root by following a path via at most 3 edges will be shown. Nodes
1490 # that lay further from the root node will be omitted. Note that setting this
1491 # option to 1 or 2 may greatly reduce the computation time needed for large
1492 # code bases. Also note that the size of a graph can be further restricted by
1493 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1494
1495 MAX_DOT_GRAPH_DEPTH = 1000
1496
1497 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1498 # background. This is disabled by default, because dot on Windows does not
1499 # seem to support this out of the box. Warning: Depending on the platform used,
1500 # enabling this option may lead to badly anti-aliased labels on the edges of
1501 # a graph (i.e. they become hard to read).
1502
1503 DOT_TRANSPARENT = YES
1504
1505 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1506 # files in one run (i.e. multiple -o and -T options on the command line). This
1507 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1508 # support this, this feature is disabled by default.
1509
1510 DOT_MULTI_TARGETS = YES
1511
1512 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1513 # generate a legend page explaining the meaning of the various boxes and
1514 # arrows in the dot generated graphs.
1515
1516 GENERATE_LEGEND = YES
1517
1518 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1519 # remove the intermediate dot files that are used to generate
1520 # the various graphs.
1521
1522 DOT_CLEANUP = YES
1523
1524 #---------------------------------------------------------------------------
1525 # Configuration::additions related to the search engine
1526 #---------------------------------------------------------------------------
1527
1528 # The SEARCHENGINE tag specifies whether or not a search engine should be
1529 # used. If set to NO the values of all tags below this one will be ignored.
1530
1531 SEARCHENGINE = YES
1532 SERVER_BASED_SEARCH = NO