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