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