Warning, /plasma/oxygen-gtk/Doxyfile is written in an unsupported language. File is not indexed.

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