Doxyfile

Wed, 17 Jul 2013 11:47:02 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 17 Jul 2013 11:47:02 +0200
changeset 114
5a0859739b76
child 115
965fd17ed9cf
permissions
-rw-r--r--

added doxyfile and documentation for ucx.h

     1 # Doxyfile 1.8.1.2
     2 #
     3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     4 #
     5 # Copyright 2013 Olaf Wintermann. All rights reserved.
     6 #
     7 # Redistribution and use in source and binary forms, with or without
     8 # modification, are permitted provided that the following conditions are met:
     9 #
    10 #   1. Redistributions of source code must retain the above copyright
    11 #      notice, this list of conditions and the following disclaimer.
    12 #
    13 #   2. Redistributions in binary form must reproduce the above copyright
    14 #      notice, this list of conditions and the following disclaimer in the
    15 #      documentation and/or other materials provided with the distribution.
    16 #
    17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    18 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    19 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    20 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    21 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    22 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    23 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    24 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    25 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    26 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    27 # POSSIBILITY OF SUCH DAMAGE.
    28 #
    29 # This file describes the settings to be used by the documentation system
    30 # doxygen (www.doxygen.org) for a project.
    31 #
    32 # All text after a hash (#) is considered a comment and will be ignored.
    33 # The format is:
    34 #       TAG = value [value, ...]
    35 # For lists items can also be appended using:
    36 #       TAG += value [value, ...]
    37 # Values that contain spaces should be placed between quotes (" ").
    39 #---------------------------------------------------------------------------
    40 # Project related configuration options
    41 #---------------------------------------------------------------------------
    43 # This tag specifies the encoding used for all characters in the config file
    44 # that follow. The default is UTF-8 which is also the encoding used for all
    45 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
    46 # iconv built into libc) for the transcoding. See
    47 # http://www.gnu.org/software/libiconv for the list of possible encodings.
    49 DOXYFILE_ENCODING      = UTF-8
    51 # The PROJECT_NAME tag is a single word (or sequence of words) that should
    52 # identify the project. Note that if you do not use Doxywizard you need
    53 # to put quotes around the project name if it contains spaces.
    55 PROJECT_NAME           = "ucx"
    57 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
    58 # This could be handy for archiving the generated documentation or
    59 # if some version control system is used.
    61 PROJECT_NUMBER         =
    63 # Using the PROJECT_BRIEF tag one can provide an optional one line description
    64 # for a project that appears at the top of each page and should give viewer
    65 # a quick idea about the purpose of the project. Keep the description short.
    67 PROJECT_BRIEF          = "UAP Common Extensions"
    69 # With the PROJECT_LOGO tag one can specify an logo or icon that is
    70 # included in the documentation. The maximum height of the logo should not
    71 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
    72 # Doxygen will copy the logo to the output directory.
    74 PROJECT_LOGO           = ./uaplogo.png
    76 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
    77 # base path where the generated documentation will be put.
    78 # If a relative path is entered, it will be relative to the location
    79 # where doxygen was started. If left blank the current directory will be used.
    81 OUTPUT_DIRECTORY       = doc
    83 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    84 # 4096 sub-directories (in 2 levels) under the output directory of each output
    85 # format and will distribute the generated files over these directories.
    86 # Enabling this option can be useful when feeding doxygen a huge amount of
    87 # source files, where putting all generated files in the same directory would
    88 # otherwise cause performance problems for the file system.
    90 CREATE_SUBDIRS         = NO
    92 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    93 # documentation generated by doxygen is written. Doxygen will use this
    94 # information to generate all constant output in the proper language.
    95 # The default language is English, other supported languages are:
    96 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    97 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
    98 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
    99 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
   100 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
   101 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
   103 OUTPUT_LANGUAGE        = English
   105 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
   106 # include brief member descriptions after the members that are listed in
   107 # the file and class documentation (similar to JavaDoc).
   108 # Set to NO to disable this.
   110 BRIEF_MEMBER_DESC      = YES
   112 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
   113 # the brief description of a member or function before the detailed description.
   114 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
   115 # brief descriptions will be completely suppressed.
   117 REPEAT_BRIEF           = YES
   119 # This tag implements a quasi-intelligent brief description abbreviator
   120 # that is used to form the text in various listings. Each string
   121 # in this list, if found as the leading text of the brief description, will be
   122 # stripped from the text and the result after processing the whole list, is
   123 # used as the annotated text. Otherwise, the brief description is used as-is.
   124 # If left blank, the following values are used ("$name" is automatically
   125 # replaced with the name of the entity): "The $name class" "The $name widget"
   126 # "The $name file" "is" "provides" "specifies" "contains"
   127 # "represents" "a" "an" "the"
   129 ABBREVIATE_BRIEF       =
   131 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
   132 # Doxygen will generate a detailed section even if there is only a brief
   133 # description.
   135 ALWAYS_DETAILED_SEC    = NO
   137 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
   138 # inherited members of a class in the documentation of that class as if those
   139 # members were ordinary class members. Constructors, destructors and assignment
   140 # operators of the base classes will not be shown.
   142 INLINE_INHERITED_MEMB  = NO
   144 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
   145 # path before files name in the file list and in the header files. If set
   146 # to NO the shortest path that makes the file name unique will be used.
   148 FULL_PATH_NAMES        = YES
   150 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
   151 # can be used to strip a user-defined part of the path. Stripping is
   152 # only done if one of the specified strings matches the left-hand part of
   153 # the path. The tag can be used to show relative paths in the file list.
   154 # If left blank the directory from which doxygen is run is used as the
   155 # path to strip.
   157 STRIP_FROM_PATH        =
   159 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
   160 # the path mentioned in the documentation of a class, which tells
   161 # the reader which header file to include in order to use a class.
   162 # If left blank only the name of the header file containing the class
   163 # definition is used. Otherwise one should specify the include paths that
   164 # are normally passed to the compiler using the -I flag.
   166 STRIP_FROM_INC_PATH    =
   168 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
   169 # (but less readable) file names. This can be useful if your file system
   170 # doesn't support long names like on DOS, Mac, or CD-ROM.
   172 SHORT_NAMES            = NO
   174 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
   175 # will interpret the first line (until the first dot) of a JavaDoc-style
   176 # comment as the brief description. If set to NO, the JavaDoc
   177 # comments will behave just like regular Qt-style comments
   178 # (thus requiring an explicit @brief command for a brief description.)
   180 JAVADOC_AUTOBRIEF      = YES
   182 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
   183 # interpret the first line (until the first dot) of a Qt-style
   184 # comment as the brief description. If set to NO, the comments
   185 # will behave just like regular Qt-style comments (thus requiring
   186 # an explicit \brief command for a brief description.)
   188 QT_AUTOBRIEF           = NO
   190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
   191 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
   192 # comments) as a brief description. This used to be the default behaviour.
   193 # The new default is to treat a multi-line C++ comment block as a detailed
   194 # description. Set this tag to YES if you prefer the old behaviour instead.
   196 MULTILINE_CPP_IS_BRIEF = NO
   198 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
   199 # member inherits the documentation from any documented member that it
   200 # re-implements.
   202 INHERIT_DOCS           = YES
   204 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
   205 # a new page for each member. If set to NO, the documentation of a member will
   206 # be part of the file/class/namespace that contains it.
   208 SEPARATE_MEMBER_PAGES  = NO
   210 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
   211 # Doxygen uses this value to replace tabs by spaces in code fragments.
   213 TAB_SIZE               = 4
   215 # This tag can be used to specify a number of aliases that acts
   216 # as commands in the documentation. An alias has the form "name=value".
   217 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
   218 # put the command \sideeffect (or @sideeffect) in the documentation, which
   219 # will result in a user-defined paragraph with heading "Side Effects:".
   220 # You can put \n's in the value part of an alias to insert newlines.
   222 ALIASES                =
   224 # This tag can be used to specify a number of word-keyword mappings (TCL only).
   225 # A mapping has the form "name=value". For example adding
   226 # "class=itcl::class" will allow you to use the command class in the
   227 # itcl::class meaning.
   229 TCL_SUBST              =
   231 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
   232 # sources only. Doxygen will then generate output that is more tailored for C.
   233 # For instance, some of the names that are used will be different. The list
   234 # of all members will be omitted, etc.
   236 OPTIMIZE_OUTPUT_FOR_C  = YES
   238 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
   239 # sources only. Doxygen will then generate output that is more tailored for
   240 # Java. For instance, namespaces will be presented as packages, qualified
   241 # scopes will look different, etc.
   243 OPTIMIZE_OUTPUT_JAVA   = NO
   245 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
   246 # sources only. Doxygen will then generate output that is more tailored for
   247 # Fortran.
   249 OPTIMIZE_FOR_FORTRAN   = NO
   251 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
   252 # sources. Doxygen will then generate output that is tailored for
   253 # VHDL.
   255 OPTIMIZE_OUTPUT_VHDL   = NO
   257 # Doxygen selects the parser to use depending on the extension of the files it
   258 # parses. With this tag you can assign which parser to use for a given extension.
   259 # Doxygen has a built-in mapping, but you can override or extend it using this
   260 # tag. The format is ext=language, where ext is a file extension, and language
   261 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
   262 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
   263 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
   264 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
   265 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
   267 EXTENSION_MAPPING      =
   269 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
   270 # to include (a tag file for) the STL sources as input, then you should
   271 # set this tag to YES in order to let doxygen match functions declarations and
   272 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
   273 # func(std::string) {}). This also makes the inheritance and collaboration
   274 # diagrams that involve STL classes more complete and accurate.
   276 BUILTIN_STL_SUPPORT    = NO
   278 # If you use Microsoft's C++/CLI language, you should set this option to YES to
   279 # enable parsing support.
   281 CPP_CLI_SUPPORT        = NO
   283 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
   284 # Doxygen will parse them like normal C++ but will assume all classes use public
   285 # instead of private inheritance when no explicit protection keyword is present.
   287 SIP_SUPPORT            = NO
   289 # For Microsoft's IDL there are propget and propput attributes to indicate getter
   290 # and setter methods for a property. Setting this option to YES (the default)
   291 # will make doxygen replace the get and set methods by a property in the
   292 # documentation. This will only work if the methods are indeed getting or
   293 # setting a simple type. If this is not the case, or you want to show the
   294 # methods anyway, you should set this option to NO.
   296 IDL_PROPERTY_SUPPORT   = YES
   298 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
   299 # tag is set to YES, then doxygen will reuse the documentation of the first
   300 # member in the group (if any) for the other members of the group. By default
   301 # all members of a group must be documented explicitly.
   303 DISTRIBUTE_GROUP_DOC   = NO
   305 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
   306 # the same type (for instance a group of public functions) to be put as a
   307 # subgroup of that type (e.g. under the Public Functions section). Set it to
   308 # NO to prevent subgrouping. Alternatively, this can be done per class using
   309 # the \nosubgrouping command.
   311 SUBGROUPING            = YES
   313 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
   314 # unions are shown inside the group in which they are included (e.g. using
   315 # @ingroup) instead of on a separate page (for HTML and Man pages) or
   316 # section (for LaTeX and RTF).
   318 INLINE_GROUPED_CLASSES = NO
   320 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
   321 # unions with only public data fields will be shown inline in the documentation
   322 # of the scope in which they are defined (i.e. file, namespace, or group
   323 # documentation), provided this scope is documented. If set to NO (the default),
   324 # structs, classes, and unions are shown on a separate page (for HTML and Man
   325 # pages) or section (for LaTeX and RTF).
   327 INLINE_SIMPLE_STRUCTS  = NO
   329 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
   330 # is documented as struct, union, or enum with the name of the typedef. So
   331 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
   332 # with name TypeT. When disabled the typedef will appear as a member of a file,
   333 # namespace, or class. And the struct will be named TypeS. This can typically
   334 # be useful for C code in case the coding convention dictates that all compound
   335 # types are typedef'ed and only the typedef is referenced, never the tag name.
   337 TYPEDEF_HIDES_STRUCT   = NO
   339 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
   340 # determine which symbols to keep in memory and which to flush to disk.
   341 # When the cache is full, less often used symbols will be written to disk.
   342 # For small to medium size projects (<1000 input files) the default value is
   343 # probably good enough. For larger projects a too small cache size can cause
   344 # doxygen to be busy swapping symbols to and from disk most of the time
   345 # causing a significant performance penalty.
   346 # If the system has enough physical memory increasing the cache will improve the
   347 # performance by keeping more symbols in memory. Note that the value works on
   348 # a logarithmic scale so increasing the size by one will roughly double the
   349 # memory usage. The cache size is given by this formula:
   350 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
   351 # corresponding to a cache size of 2^16 = 65536 symbols.
   353 SYMBOL_CACHE_SIZE      = 0
   355 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
   356 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
   357 # their name and scope. Since this can be an expensive process and often the
   358 # same symbol appear multiple times in the code, doxygen keeps a cache of
   359 # pre-resolved symbols. If the cache is too small doxygen will become slower.
   360 # If the cache is too large, memory is wasted. The cache size is given by this
   361 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
   362 # corresponding to a cache size of 2^16 = 65536 symbols.
   364 LOOKUP_CACHE_SIZE      = 0
   366 #---------------------------------------------------------------------------
   367 # Build related configuration options
   368 #---------------------------------------------------------------------------
   370 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
   371 # documentation are documented, even if no documentation was available.
   372 # Private class members and static file members will be hidden unless
   373 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
   375 EXTRACT_ALL            = NO
   377 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
   378 # will be included in the documentation.
   380 EXTRACT_PRIVATE        = NO
   382 # If the EXTRACT_STATIC tag is set to YES all static members of a file
   383 # will be included in the documentation.
   385 EXTRACT_STATIC         = NO
   387 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
   388 # defined locally in source files will be included in the documentation.
   389 # If set to NO only classes defined in header files are included.
   391 EXTRACT_LOCAL_CLASSES  = YES
   393 # This flag is only useful for Objective-C code. When set to YES local
   394 # methods, which are defined in the implementation section but not in
   395 # the interface are included in the documentation.
   396 # If set to NO (the default) only methods in the interface are included.
   398 EXTRACT_LOCAL_METHODS  = NO
   400 # If this flag is set to YES, the members of anonymous namespaces will be
   401 # extracted and appear in the documentation as a namespace called
   402 # 'anonymous_namespace{file}', where file will be replaced with the base
   403 # name of the file that contains the anonymous namespace. By default
   404 # anonymous namespaces are hidden.
   406 EXTRACT_ANON_NSPACES   = NO
   408 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
   409 # undocumented members of documented classes, files or namespaces.
   410 # If set to NO (the default) these members will be included in the
   411 # various overviews, but no documentation section is generated.
   412 # This option has no effect if EXTRACT_ALL is enabled.
   414 HIDE_UNDOC_MEMBERS     = NO
   416 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
   417 # undocumented classes that are normally visible in the class hierarchy.
   418 # If set to NO (the default) these classes will be included in the various
   419 # overviews. This option has no effect if EXTRACT_ALL is enabled.
   421 HIDE_UNDOC_CLASSES     = NO
   423 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
   424 # friend (class|struct|union) declarations.
   425 # If set to NO (the default) these declarations will be included in the
   426 # documentation.
   428 HIDE_FRIEND_COMPOUNDS  = NO
   430 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
   431 # documentation blocks found inside the body of a function.
   432 # If set to NO (the default) these blocks will be appended to the
   433 # function's detailed documentation block.
   435 HIDE_IN_BODY_DOCS      = NO
   437 # The INTERNAL_DOCS tag determines if documentation
   438 # that is typed after a \internal command is included. If the tag is set
   439 # to NO (the default) then the documentation will be excluded.
   440 # Set it to YES to include the internal documentation.
   442 INTERNAL_DOCS          = NO
   444 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
   445 # file names in lower-case letters. If set to YES upper-case letters are also
   446 # allowed. This is useful if you have classes or files whose names only differ
   447 # in case and if your file system supports case sensitive file names. Windows
   448 # and Mac users are advised to set this option to NO.
   450 CASE_SENSE_NAMES       = YES
   452 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
   453 # will show members with their full class and namespace scopes in the
   454 # documentation. If set to YES the scope will be hidden.
   456 HIDE_SCOPE_NAMES       = NO
   458 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
   459 # will put a list of the files that are included by a file in the documentation
   460 # of that file.
   462 SHOW_INCLUDE_FILES     = YES
   464 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
   465 # will list include files with double quotes in the documentation
   466 # rather than with sharp brackets.
   468 FORCE_LOCAL_INCLUDES   = NO
   470 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
   471 # is inserted in the documentation for inline members.
   473 INLINE_INFO            = YES
   475 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
   476 # will sort the (detailed) documentation of file and class members
   477 # alphabetically by member name. If set to NO the members will appear in
   478 # declaration order.
   480 SORT_MEMBER_DOCS       = YES
   482 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
   483 # brief documentation of file, namespace and class members alphabetically
   484 # by member name. If set to NO (the default) the members will appear in
   485 # declaration order.
   487 SORT_BRIEF_DOCS        = NO
   489 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
   490 # will sort the (brief and detailed) documentation of class members so that
   491 # constructors and destructors are listed first. If set to NO (the default)
   492 # the constructors will appear in the respective orders defined by
   493 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
   494 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
   495 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
   497 SORT_MEMBERS_CTORS_1ST = NO
   499 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
   500 # hierarchy of group names into alphabetical order. If set to NO (the default)
   501 # the group names will appear in their defined order.
   503 SORT_GROUP_NAMES       = NO
   505 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
   506 # sorted by fully-qualified names, including namespaces. If set to
   507 # NO (the default), the class list will be sorted only by class name,
   508 # not including the namespace part.
   509 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
   510 # Note: This option applies only to the class list, not to the
   511 # alphabetical list.
   513 SORT_BY_SCOPE_NAME     = NO
   515 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
   516 # do proper type resolution of all parameters of a function it will reject a
   517 # match between the prototype and the implementation of a member function even
   518 # if there is only one candidate or it is obvious which candidate to choose
   519 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
   520 # will still accept a match between prototype and implementation in such cases.
   522 STRICT_PROTO_MATCHING  = NO
   524 # The GENERATE_TODOLIST tag can be used to enable (YES) or
   525 # disable (NO) the todo list. This list is created by putting \todo
   526 # commands in the documentation.
   528 GENERATE_TODOLIST      = YES
   530 # The GENERATE_TESTLIST tag can be used to enable (YES) or
   531 # disable (NO) the test list. This list is created by putting \test
   532 # commands in the documentation.
   534 GENERATE_TESTLIST      = YES
   536 # The GENERATE_BUGLIST tag can be used to enable (YES) or
   537 # disable (NO) the bug list. This list is created by putting \bug
   538 # commands in the documentation.
   540 GENERATE_BUGLIST       = YES
   542 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
   543 # disable (NO) the deprecated list. This list is created by putting
   544 # \deprecated commands in the documentation.
   546 GENERATE_DEPRECATEDLIST= YES
   548 # The ENABLED_SECTIONS tag can be used to enable conditional
   549 # documentation sections, marked by \if sectionname ... \endif.
   551 ENABLED_SECTIONS       =
   553 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
   554 # the initial value of a variable or macro consists of for it to appear in
   555 # the documentation. If the initializer consists of more lines than specified
   556 # here it will be hidden. Use a value of 0 to hide initializers completely.
   557 # The appearance of the initializer of individual variables and macros in the
   558 # documentation can be controlled using \showinitializer or \hideinitializer
   559 # command in the documentation regardless of this setting.
   561 MAX_INITIALIZER_LINES  = 30
   563 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
   564 # at the bottom of the documentation of classes and structs. If set to YES the
   565 # list will mention the files that were used to generate the documentation.
   567 SHOW_USED_FILES        = YES
   569 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
   570 # This will remove the Files entry from the Quick Index and from the
   571 # Folder Tree View (if specified). The default is YES.
   573 SHOW_FILES             = YES
   575 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
   576 # Namespaces page.
   577 # This will remove the Namespaces entry from the Quick Index
   578 # and from the Folder Tree View (if specified). The default is YES.
   580 SHOW_NAMESPACES        = YES
   582 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
   583 # doxygen should invoke to get the current version for each file (typically from
   584 # the version control system). Doxygen will invoke the program by executing (via
   585 # popen()) the command <command> <input-file>, where <command> is the value of
   586 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
   587 # provided by doxygen. Whatever the program writes to standard output
   588 # is used as the file version. See the manual for examples.
   590 FILE_VERSION_FILTER    =
   592 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
   593 # by doxygen. The layout file controls the global structure of the generated
   594 # output files in an output format independent way. The create the layout file
   595 # that represents doxygen's defaults, run doxygen with the -l option.
   596 # You can optionally specify a file name after the option, if omitted
   597 # DoxygenLayout.xml will be used as the name of the layout file.
   599 LAYOUT_FILE            =
   601 # The CITE_BIB_FILES tag can be used to specify one or more bib files
   602 # containing the references data. This must be a list of .bib files. The
   603 # .bib extension is automatically appended if omitted. Using this command
   604 # requires the bibtex tool to be installed. See also
   605 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
   606 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
   607 # feature you need bibtex and perl available in the search path.
   609 CITE_BIB_FILES         =
   611 #---------------------------------------------------------------------------
   612 # configuration options related to warning and progress messages
   613 #---------------------------------------------------------------------------
   615 # The QUIET tag can be used to turn on/off the messages that are generated
   616 # by doxygen. Possible values are YES and NO. If left blank NO is used.
   618 QUIET                  = NO
   620 # The WARNINGS tag can be used to turn on/off the warning messages that are
   621 # generated by doxygen. Possible values are YES and NO. If left blank
   622 # NO is used.
   624 WARNINGS               = YES
   626 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
   627 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
   628 # automatically be disabled.
   630 WARN_IF_UNDOCUMENTED   = YES
   632 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
   633 # potential errors in the documentation, such as not documenting some
   634 # parameters in a documented function, or documenting parameters that
   635 # don't exist or using markup commands wrongly.
   637 WARN_IF_DOC_ERROR      = YES
   639 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
   640 # functions that are documented, but have no documentation for their parameters
   641 # or return value. If set to NO (the default) doxygen will only warn about
   642 # wrong or incomplete parameter documentation, but not about the absence of
   643 # documentation.
   645 WARN_NO_PARAMDOC       = NO
   647 # The WARN_FORMAT tag determines the format of the warning messages that
   648 # doxygen can produce. The string should contain the $file, $line, and $text
   649 # tags, which will be replaced by the file and line number from which the
   650 # warning originated and the warning text. Optionally the format may contain
   651 # $version, which will be replaced by the version of the file (if it could
   652 # be obtained via FILE_VERSION_FILTER)
   654 WARN_FORMAT            = "$file:$line: $text"
   656 # The WARN_LOGFILE tag can be used to specify a file to which warning
   657 # and error messages should be written. If left blank the output is written
   658 # to stderr.
   660 WARN_LOGFILE           =
   662 #---------------------------------------------------------------------------
   663 # configuration options related to the input files
   664 #---------------------------------------------------------------------------
   666 # The INPUT tag can be used to specify the files and/or directories that contain
   667 # documented source files. You may enter file names like "myfile.cpp" or
   668 # directories like "/usr/src/myproject". Separate the files or directories
   669 # with spaces.
   671 INPUT                  = ./ucx
   673 # This tag can be used to specify the character encoding of the source files
   674 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
   675 # also the default input encoding. Doxygen uses libiconv (or the iconv built
   676 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
   677 # the list of possible encodings.
   679 INPUT_ENCODING         = UTF-8
   681 # If the value of the INPUT tag contains directories, you can use the
   682 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
   683 # and *.h) to filter out the source-files in the directories. If left
   684 # blank the following patterns are tested:
   685 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
   686 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
   687 # *.f90 *.f *.for *.vhd *.vhdl
   689 FILE_PATTERNS          =
   691 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
   692 # should be searched for input files as well. Possible values are YES and NO.
   693 # If left blank NO is used.
   695 RECURSIVE              = YES
   697 # The EXCLUDE tag can be used to specify files and/or directories that should be
   698 # excluded from the INPUT source files. This way you can easily exclude a
   699 # subdirectory from a directory tree whose root is specified with the INPUT tag.
   700 # Note that relative paths are relative to the directory from which doxygen is
   701 # run.
   703 EXCLUDE                =
   705 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
   706 # directories that are symbolic links (a Unix file system feature) are excluded
   707 # from the input.
   709 EXCLUDE_SYMLINKS       = NO
   711 # If the value of the INPUT tag contains directories, you can use the
   712 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
   713 # certain files from those directories. Note that the wildcards are matched
   714 # against the file with absolute path, so to exclude all test directories
   715 # for example use the pattern */test/*
   717 EXCLUDE_PATTERNS       = 
   719 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
   720 # (namespaces, classes, functions, etc.) that should be excluded from the
   721 # output. The symbol name can be a fully qualified name, a word, or if the
   722 # wildcard * is used, a substring. Examples: ANamespace, AClass,
   723 # AClass::ANamespace, ANamespace::*Test
   725 EXCLUDE_SYMBOLS        =
   727 # The EXAMPLE_PATH tag can be used to specify one or more files or
   728 # directories that contain example code fragments that are included (see
   729 # the \include command).
   731 EXAMPLE_PATH           =
   733 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
   734 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
   735 # and *.h) to filter out the source-files in the directories. If left
   736 # blank all files are included.
   738 EXAMPLE_PATTERNS       =
   740 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
   741 # searched for input files to be used with the \include or \dontinclude
   742 # commands irrespective of the value of the RECURSIVE tag.
   743 # Possible values are YES and NO. If left blank NO is used.
   745 EXAMPLE_RECURSIVE      = NO
   747 # The IMAGE_PATH tag can be used to specify one or more files or
   748 # directories that contain image that are included in the documentation (see
   749 # the \image command).
   751 IMAGE_PATH             =
   753 # The INPUT_FILTER tag can be used to specify a program that doxygen should
   754 # invoke to filter for each input file. Doxygen will invoke the filter program
   755 # by executing (via popen()) the command <filter> <input-file>, where <filter>
   756 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
   757 # input file. Doxygen will then use the output that the filter program writes
   758 # to standard output.
   759 # If FILTER_PATTERNS is specified, this tag will be
   760 # ignored.
   762 INPUT_FILTER           =
   764 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
   765 # basis.
   766 # Doxygen will compare the file name with each pattern and apply the
   767 # filter if there is a match.
   768 # The filters are a list of the form:
   769 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
   770 # info on how filters are used. If FILTER_PATTERNS is empty or if
   771 # non of the patterns match the file name, INPUT_FILTER is applied.
   773 FILTER_PATTERNS        =
   775 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
   776 # INPUT_FILTER) will be used to filter the input files when producing source
   777 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
   779 FILTER_SOURCE_FILES    = NO
   781 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
   782 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
   783 # and it is also possible to disable source filtering for a specific pattern
   784 # using *.ext= (so without naming a filter). This option only has effect when
   785 # FILTER_SOURCE_FILES is enabled.
   787 FILTER_SOURCE_PATTERNS =
   789 #---------------------------------------------------------------------------
   790 # configuration options related to source browsing
   791 #---------------------------------------------------------------------------
   793 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
   794 # be generated. Documented entities will be cross-referenced with these sources.
   795 # Note: To get rid of all source code in the generated output, make sure also
   796 # VERBATIM_HEADERS is set to NO.
   798 SOURCE_BROWSER         = NO
   800 # Setting the INLINE_SOURCES tag to YES will include the body
   801 # of functions and classes directly in the documentation.
   803 INLINE_SOURCES         = NO
   805 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
   806 # doxygen to hide any special comment blocks from generated source code
   807 # fragments. Normal C and C++ comments will always remain visible.
   809 STRIP_CODE_COMMENTS    = YES
   811 # If the REFERENCED_BY_RELATION tag is set to YES
   812 # then for each documented function all documented
   813 # functions referencing it will be listed.
   815 REFERENCED_BY_RELATION = NO
   817 # If the REFERENCES_RELATION tag is set to YES
   818 # then for each documented function all documented entities
   819 # called/used by that function will be listed.
   821 REFERENCES_RELATION    = NO
   823 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
   824 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
   825 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
   826 # link to the source code.
   827 # Otherwise they will link to the documentation.
   829 REFERENCES_LINK_SOURCE = YES
   831 # If the USE_HTAGS tag is set to YES then the references to source code
   832 # will point to the HTML generated by the htags(1) tool instead of doxygen
   833 # built-in source browser. The htags tool is part of GNU's global source
   834 # tagging system (see http://www.gnu.org/software/global/global.html). You
   835 # will need version 4.8.6 or higher.
   837 USE_HTAGS              = NO
   839 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
   840 # will generate a verbatim copy of the header file for each class for
   841 # which an include is specified. Set to NO to disable this.
   843 VERBATIM_HEADERS       = YES
   845 #---------------------------------------------------------------------------
   846 # configuration options related to the alphabetical class index
   847 #---------------------------------------------------------------------------
   849 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
   850 # of all compounds will be generated. Enable this if the project
   851 # contains a lot of classes, structs, unions or interfaces.
   853 ALPHABETICAL_INDEX     = YES
   855 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
   856 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
   857 # in which this list will be split (can be a number in the range [1..20])
   859 COLS_IN_ALPHA_INDEX    = 5
   861 # In case all classes in a project start with a common prefix, all
   862 # classes will be put under the same header in the alphabetical index.
   863 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
   864 # should be ignored while generating the index headers.
   866 IGNORE_PREFIX          =
   868 #---------------------------------------------------------------------------
   869 # configuration options related to the HTML output
   870 #---------------------------------------------------------------------------
   872 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
   873 # generate HTML output.
   875 GENERATE_HTML          = YES
   877 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
   878 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
   879 # put in front of it. If left blank `html' will be used as the default path.
   881 HTML_OUTPUT            = html
   883 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
   884 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
   885 # doxygen will generate files with .html extension.
   887 HTML_FILE_EXTENSION    = .html
   889 # The HTML_HEADER tag can be used to specify a personal HTML header for
   890 # each generated HTML page. If it is left blank doxygen will generate a
   891 # standard header. Note that when using a custom header you are responsible
   892 #  for the proper inclusion of any scripts and style sheets that doxygen
   893 # needs, which is dependent on the configuration options used.
   894 # It is advised to generate a default header using "doxygen -w html
   895 # header.html footer.html stylesheet.css YourConfigFile" and then modify
   896 # that header. Note that the header is subject to change so you typically
   897 # have to redo this when upgrading to a newer version of doxygen or when
   898 # changing the value of configuration settings such as GENERATE_TREEVIEW!
   900 HTML_HEADER            =
   902 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
   903 # each generated HTML page. If it is left blank doxygen will generate a
   904 # standard footer.
   906 HTML_FOOTER            =
   908 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
   909 # style sheet that is used by each HTML page. It can be used to
   910 # fine-tune the look of the HTML output. If the tag is left blank doxygen
   911 # will generate a default style sheet. Note that doxygen will try to copy
   912 # the style sheet file to the HTML output directory, so don't put your own
   913 # style sheet in the HTML output directory as well, or it will be erased!
   915 HTML_STYLESHEET        =
   917 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
   918 # other source files which should be copied to the HTML output directory. Note
   919 # that these files will be copied to the base HTML output directory. Use the
   920 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
   921 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
   922 # the files will be copied as-is; there are no commands or markers available.
   924 HTML_EXTRA_FILES       =
   926 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
   927 # Doxygen will adjust the colors in the style sheet and background images
   928 # according to this color. Hue is specified as an angle on a colorwheel,
   929 # see http://en.wikipedia.org/wiki/Hue for more information.
   930 # For instance the value 0 represents red, 60 is yellow, 120 is green,
   931 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
   932 # The allowed range is 0 to 359.
   934 HTML_COLORSTYLE_HUE    = 220
   936 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
   937 # the colors in the HTML output. For a value of 0 the output will use
   938 # grayscales only. A value of 255 will produce the most vivid colors.
   940 HTML_COLORSTYLE_SAT    = 100
   942 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
   943 # the luminance component of the colors in the HTML output. Values below
   944 # 100 gradually make the output lighter, whereas values above 100 make
   945 # the output darker. The value divided by 100 is the actual gamma applied,
   946 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
   947 # and 100 does not change the gamma.
   949 HTML_COLORSTYLE_GAMMA  = 80
   951 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
   952 # page will contain the date and time when the page was generated. Setting
   953 # this to NO can help when comparing the output of multiple runs.
   955 HTML_TIMESTAMP         = YES
   957 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
   958 # documentation will contain sections that can be hidden and shown after the
   959 # page has loaded. For this to work a browser that supports
   960 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
   961 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
   963 HTML_DYNAMIC_SECTIONS  = NO
   965 # If the GENERATE_DOCSET tag is set to YES, additional index files
   966 # will be generated that can be used as input for Apple's Xcode 3
   967 # integrated development environment, introduced with OSX 10.5 (Leopard).
   968 # To create a documentation set, doxygen will generate a Makefile in the
   969 # HTML output directory. Running make will produce the docset in that
   970 # directory and running "make install" will install the docset in
   971 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
   972 # it at startup.
   973 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
   974 # for more information.
   976 GENERATE_DOCSET        = NO
   978 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
   979 # feed. A documentation feed provides an umbrella under which multiple
   980 # documentation sets from a single provider (such as a company or product suite)
   981 # can be grouped.
   983 DOCSET_FEEDNAME        = "Doxygen generated docs"
   985 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
   986 # should uniquely identify the documentation set bundle. This should be a
   987 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
   988 # will append .docset to the name.
   990 DOCSET_BUNDLE_ID       = org.doxygen.Project
   992 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
   993 # the documentation publisher. This should be a reverse domain-name style
   994 # string, e.g. com.mycompany.MyDocSet.documentation.
   996 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
   998 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
  1000 DOCSET_PUBLISHER_NAME  = Publisher
  1002 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  1003 # will be generated that can be used as input for tools like the
  1004 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
  1005 # of the generated HTML documentation.
  1007 GENERATE_HTMLHELP      = NO
  1009 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  1010 # be used to specify the file name of the resulting .chm file. You
  1011 # can add a path in front of the file if the result should not be
  1012 # written to the html output directory.
  1014 CHM_FILE               =
  1016 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  1017 # be used to specify the location (absolute path including file name) of
  1018 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  1019 # the HTML help compiler on the generated index.hhp.
  1021 HHC_LOCATION           =
  1023 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  1024 # controls if a separate .chi index file is generated (YES) or that
  1025 # it should be included in the master .chm file (NO).
  1027 GENERATE_CHI           = NO
  1029 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
  1030 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
  1031 # content.
  1033 CHM_INDEX_ENCODING     =
  1035 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  1036 # controls whether a binary table of contents is generated (YES) or a
  1037 # normal table of contents (NO) in the .chm file.
  1039 BINARY_TOC             = NO
  1041 # The TOC_EXPAND flag can be set to YES to add extra items for group members
  1042 # to the contents of the HTML help documentation and to the tree view.
  1044 TOC_EXPAND             = NO
  1046 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1047 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
  1048 # that can be used as input for Qt's qhelpgenerator to generate a
  1049 # Qt Compressed Help (.qch) of the generated HTML documentation.
  1051 GENERATE_QHP           = NO
  1053 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
  1054 # be used to specify the file name of the resulting .qch file.
  1055 # The path specified is relative to the HTML output folder.
  1057 QCH_FILE               =
  1059 # The QHP_NAMESPACE tag specifies the namespace to use when generating
  1060 # Qt Help Project output. For more information please see
  1061 # http://doc.trolltech.com/qthelpproject.html#namespace
  1063 QHP_NAMESPACE          = org.doxygen.Project
  1065 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
  1066 # Qt Help Project output. For more information please see
  1067 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
  1069 QHP_VIRTUAL_FOLDER     = doc
  1071 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
  1072 # add. For more information please see
  1073 # http://doc.trolltech.com/qthelpproject.html#custom-filters
  1075 QHP_CUST_FILTER_NAME   =
  1077 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
  1078 # custom filter to add. For more information please see
  1079 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
  1080 # Qt Help Project / Custom Filters</a>.
  1082 QHP_CUST_FILTER_ATTRS  =
  1084 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1085 # project's
  1086 # filter section matches.
  1087 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
  1088 # Qt Help Project / Filter Attributes</a>.
  1090 QHP_SECT_FILTER_ATTRS  =
  1092 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
  1093 # be used to specify the location of Qt's qhelpgenerator.
  1094 # If non-empty doxygen will try to run qhelpgenerator on the generated
  1095 # .qhp file.
  1097 QHG_LOCATION           =
  1099 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
  1100 #  will be generated, which together with the HTML files, form an Eclipse help
  1101 # plugin. To install this plugin and make it available under the help contents
  1102 # menu in Eclipse, the contents of the directory containing the HTML and XML
  1103 # files needs to be copied into the plugins directory of eclipse. The name of
  1104 # the directory within the plugins directory should be the same as
  1105 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
  1106 # the help appears.
  1108 GENERATE_ECLIPSEHELP   = NO
  1110 # A unique identifier for the eclipse help plugin. When installing the plugin
  1111 # the directory name containing the HTML and XML files should also have
  1112 # this name.
  1114 ECLIPSE_DOC_ID         = org.doxygen.Project
  1116 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
  1117 # at top of each HTML page. The value NO (the default) enables the index and
  1118 # the value YES disables it. Since the tabs have the same information as the
  1119 # navigation tree you can set this option to NO if you already set
  1120 # GENERATE_TREEVIEW to YES.
  1122 DISABLE_INDEX          = NO
  1124 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1125 # structure should be generated to display hierarchical information.
  1126 # If the tag value is set to YES, a side panel will be generated
  1127 # containing a tree-like index structure (just like the one that
  1128 # is generated for HTML Help). For this to work a browser that supports
  1129 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
  1130 # Windows users are probably better off using the HTML help feature.
  1131 # Since the tree basically has the same information as the tab index you
  1132 # could consider to set DISABLE_INDEX to NO when enabling this option.
  1134 GENERATE_TREEVIEW      = NO
  1136 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
  1137 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
  1138 # documentation. Note that a value of 0 will completely suppress the enum
  1139 # values from appearing in the overview section.
  1141 ENUM_VALUES_PER_LINE   = 4
  1144 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  1145 # used to set the initial width (in pixels) of the frame in which the tree
  1146 # is shown.
  1148 TREEVIEW_WIDTH         = 250
  1150 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
  1151 # links to external symbols imported via tag files in a separate window.
  1153 EXT_LINKS_IN_WINDOW    = NO
  1155 # Use this tag to change the font size of Latex formulas included
  1156 # as images in the HTML documentation. The default is 10. Note that
  1157 # when you change the font size after a successful doxygen run you need
  1158 # to manually remove any form_*.png images from the HTML output directory
  1159 # to force them to be regenerated.
  1161 FORMULA_FONTSIZE       = 10
  1163 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1164 # generated for formulas are transparent PNGs. Transparent PNGs are
  1165 # not supported properly for IE 6.0, but are supported on all modern browsers.
  1166 # Note that when changing this option you need to delete any form_*.png files
  1167 # in the HTML output before the changes have effect.
  1169 FORMULA_TRANSPARENT    = YES
  1171 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
  1172 # (see http://www.mathjax.org) which uses client side Javascript for the
  1173 # rendering instead of using prerendered bitmaps. Use this if you do not
  1174 # have LaTeX installed or if you want to formulas look prettier in the HTML
  1175 # output. When enabled you also need to install MathJax separately and
  1176 # configure the path to it using the MATHJAX_RELPATH option.
  1178 USE_MATHJAX            = NO
  1180 # When MathJax is enabled you need to specify the location relative to the
  1181 # HTML output directory using the MATHJAX_RELPATH option. The destination
  1182 # directory should contain the MathJax.js script. For instance, if the mathjax
  1183 # directory is located at the same level as the HTML output directory, then
  1184 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
  1185 # mathjax.org site, so you can quickly see the result without installing
  1186 # MathJax, but it is strongly recommended to install a local copy of MathJax
  1187 # before deployment.
  1189 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
  1191 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
  1192 # names that should be enabled during MathJax rendering.
  1194 MATHJAX_EXTENSIONS     =
  1196 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
  1197 # for the HTML output. The underlying search engine uses javascript
  1198 # and DHTML and should work on any modern browser. Note that when using
  1199 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
  1200 # (GENERATE_DOCSET) there is already a search function so this one should
  1201 # typically be disabled. For large projects the javascript based search engine
  1202 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
  1204 SEARCHENGINE           = YES
  1206 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1207 # implemented using a PHP enabled web server instead of at the web client
  1208 # using Javascript. Doxygen will generate the search PHP script and index
  1209 # file to put on the web server. The advantage of the server
  1210 # based approach is that it scales better to large projects and allows
  1211 # full text search. The disadvantages are that it is more difficult to setup
  1212 # and does not have live searching capabilities.
  1214 SERVER_BASED_SEARCH    = NO
  1216 #---------------------------------------------------------------------------
  1217 # configuration options related to the LaTeX output
  1218 #---------------------------------------------------------------------------
  1220 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  1221 # generate Latex output.
  1223 GENERATE_LATEX         = NO
  1225 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  1226 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1227 # put in front of it. If left blank `latex' will be used as the default path.
  1229 LATEX_OUTPUT           = latex
  1231 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1232 # invoked. If left blank `latex' will be used as the default command name.
  1233 # Note that when enabling USE_PDFLATEX this option is only used for
  1234 # generating bitmaps for formulas in the HTML output, but not in the
  1235 # Makefile that is written to the output directory.
  1237 LATEX_CMD_NAME         = latex
  1239 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  1240 # generate index for LaTeX. If left blank `makeindex' will be used as the
  1241 # default command name.
  1243 MAKEINDEX_CMD_NAME     = makeindex
  1245 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  1246 # LaTeX documents. This may be useful for small projects and may help to
  1247 # save some trees in general.
  1249 COMPACT_LATEX          = NO
  1251 # The PAPER_TYPE tag can be used to set the paper type that is used
  1252 # by the printer. Possible values are: a4, letter, legal and
  1253 # executive. If left blank a4wide will be used.
  1255 PAPER_TYPE             = a4
  1257 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  1258 # packages that should be included in the LaTeX output.
  1260 EXTRA_PACKAGES         =
  1262 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  1263 # the generated latex document. The header should contain everything until
  1264 # the first chapter. If it is left blank doxygen will generate a
  1265 # standard header. Notice: only use this tag if you know what you are doing!
  1267 LATEX_HEADER           =
  1269 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
  1270 # the generated latex document. The footer should contain everything after
  1271 # the last chapter. If it is left blank doxygen will generate a
  1272 # standard footer. Notice: only use this tag if you know what you are doing!
  1274 LATEX_FOOTER           =
  1276 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  1277 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  1278 # contain links (just like the HTML output) instead of page references
  1279 # This makes the output suitable for online browsing using a pdf viewer.
  1281 PDF_HYPERLINKS         = YES
  1283 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  1284 # plain latex in the generated Makefile. Set this option to YES to get a
  1285 # higher quality PDF documentation.
  1287 USE_PDFLATEX           = YES
  1289 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  1290 # command to the generated LaTeX files. This will instruct LaTeX to keep
  1291 # running if errors occur, instead of asking the user for help.
  1292 # This option is also used when generating formulas in HTML.
  1294 LATEX_BATCHMODE        = NO
  1296 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  1297 # include the index chapters (such as File Index, Compound Index, etc.)
  1298 # in the output.
  1300 LATEX_HIDE_INDICES     = NO
  1302 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
  1303 # source code with syntax highlighting in the LaTeX output.
  1304 # Note that which sources are shown also depends on other settings
  1305 # such as SOURCE_BROWSER.
  1307 LATEX_SOURCE_CODE      = NO
  1309 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1310 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
  1311 # http://en.wikipedia.org/wiki/BibTeX for more info.
  1313 LATEX_BIB_STYLE        = plain
  1315 #---------------------------------------------------------------------------
  1316 # configuration options related to the RTF output
  1317 #---------------------------------------------------------------------------
  1319 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  1320 # The RTF output is optimized for Word 97 and may not look very pretty with
  1321 # other RTF readers or editors.
  1323 GENERATE_RTF           = NO
  1325 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  1326 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1327 # put in front of it. If left blank `rtf' will be used as the default path.
  1329 RTF_OUTPUT             = rtf
  1331 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  1332 # RTF documents. This may be useful for small projects and may help to
  1333 # save some trees in general.
  1335 COMPACT_RTF            = NO
  1337 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  1338 # will contain hyperlink fields. The RTF file will
  1339 # contain links (just like the HTML output) instead of page references.
  1340 # This makes the output suitable for online browsing using WORD or other
  1341 # programs which support those fields.
  1342 # Note: wordpad (write) and others do not support links.
  1344 RTF_HYPERLINKS         = NO
  1346 # Load style sheet definitions from file. Syntax is similar to doxygen's
  1347 # config file, i.e. a series of assignments. You only have to provide
  1348 # replacements, missing definitions are set to their default value.
  1350 RTF_STYLESHEET_FILE    =
  1352 # Set optional variables used in the generation of an rtf document.
  1353 # Syntax is similar to doxygen's config file.
  1355 RTF_EXTENSIONS_FILE    =
  1357 #---------------------------------------------------------------------------
  1358 # configuration options related to the man page output
  1359 #---------------------------------------------------------------------------
  1361 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  1362 # generate man pages
  1364 GENERATE_MAN           = NO
  1366 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  1367 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1368 # put in front of it. If left blank `man' will be used as the default path.
  1370 MAN_OUTPUT             = man
  1372 # The MAN_EXTENSION tag determines the extension that is added to
  1373 # the generated man pages (default is the subroutine's section .3)
  1375 MAN_EXTENSION          = .3
  1377 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  1378 # then it will generate one additional man file for each entity
  1379 # documented in the real man page(s). These additional files
  1380 # only source the real man page, but without them the man command
  1381 # would be unable to find the correct page. The default is NO.
  1383 MAN_LINKS              = NO
  1385 #---------------------------------------------------------------------------
  1386 # configuration options related to the XML output
  1387 #---------------------------------------------------------------------------
  1389 # If the GENERATE_XML tag is set to YES Doxygen will
  1390 # generate an XML file that captures the structure of
  1391 # the code including all documentation.
  1393 GENERATE_XML           = NO
  1395 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  1396 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1397 # put in front of it. If left blank `xml' will be used as the default path.
  1399 XML_OUTPUT             = xml
  1401 # The XML_SCHEMA tag can be used to specify an XML schema,
  1402 # which can be used by a validating XML parser to check the
  1403 # syntax of the XML files.
  1405 XML_SCHEMA             =
  1407 # The XML_DTD tag can be used to specify an XML DTD,
  1408 # which can be used by a validating XML parser to check the
  1409 # syntax of the XML files.
  1411 XML_DTD                =
  1413 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  1414 # dump the program listings (including syntax highlighting
  1415 # and cross-referencing information) to the XML output. Note that
  1416 # enabling this will significantly increase the size of the XML output.
  1418 XML_PROGRAMLISTING     = YES
  1420 #---------------------------------------------------------------------------
  1421 # configuration options for the AutoGen Definitions output
  1422 #---------------------------------------------------------------------------
  1424 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  1425 # generate an AutoGen Definitions (see autogen.sf.net) file
  1426 # that captures the structure of the code including all
  1427 # documentation. Note that this feature is still experimental
  1428 # and incomplete at the moment.
  1430 GENERATE_AUTOGEN_DEF   = NO
  1432 #---------------------------------------------------------------------------
  1433 # configuration options related to the Perl module output
  1434 #---------------------------------------------------------------------------
  1436 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  1437 # generate a Perl module file that captures the structure of
  1438 # the code including all documentation. Note that this
  1439 # feature is still experimental and incomplete at the
  1440 # moment.
  1442 GENERATE_PERLMOD       = NO
  1444 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  1445 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  1446 # to generate PDF and DVI output from the Perl module output.
  1448 PERLMOD_LATEX          = NO
  1450 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  1451 # nicely formatted so it can be parsed by a human reader.
  1452 # This is useful
  1453 # if you want to understand what is going on.
  1454 # On the other hand, if this
  1455 # tag is set to NO the size of the Perl module output will be much smaller
  1456 # and Perl will parse it just the same.
  1458 PERLMOD_PRETTY         = YES
  1460 # The names of the make variables in the generated doxyrules.make file
  1461 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  1462 # This is useful so different doxyrules.make files included by the same
  1463 # Makefile don't overwrite each other's variables.
  1465 PERLMOD_MAKEVAR_PREFIX =
  1467 #---------------------------------------------------------------------------
  1468 # Configuration options related to the preprocessor
  1469 #---------------------------------------------------------------------------
  1471 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  1472 # evaluate all C-preprocessor directives found in the sources and include
  1473 # files.
  1475 ENABLE_PREPROCESSING   = YES
  1477 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  1478 # names in the source code. If set to NO (the default) only conditional
  1479 # compilation will be performed. Macro expansion can be done in a controlled
  1480 # way by setting EXPAND_ONLY_PREDEF to YES.
  1482 MACRO_EXPANSION        = NO
  1484 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  1485 # then the macro expansion is limited to the macros specified with the
  1486 # PREDEFINED and EXPAND_AS_DEFINED tags.
  1488 EXPAND_ONLY_PREDEF     = NO
  1490 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  1491 # pointed to by INCLUDE_PATH will be searched when a #include is found.
  1493 SEARCH_INCLUDES        = YES
  1495 # The INCLUDE_PATH tag can be used to specify one or more directories that
  1496 # contain include files that are not input files but should be processed by
  1497 # the preprocessor.
  1499 INCLUDE_PATH           =
  1501 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1502 # patterns (like *.h and *.hpp) to filter out the header-files in the
  1503 # directories. If left blank, the patterns specified with FILE_PATTERNS will
  1504 # be used.
  1506 INCLUDE_FILE_PATTERNS  =
  1508 # The PREDEFINED tag can be used to specify one or more macro names that
  1509 # are defined before the preprocessor is started (similar to the -D option of
  1510 # gcc). The argument of the tag is a list of macros of the form: name
  1511 # or name=definition (no spaces). If the definition and the = are
  1512 # omitted =1 is assumed. To prevent a macro definition from being
  1513 # undefined via #undef or recursively expanded use the := operator
  1514 # instead of the = operator.
  1516 PREDEFINED             =
  1518 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  1519 # this tag can be used to specify a list of macro names that should be expanded.
  1520 # The macro definition that is found in the sources will be used.
  1521 # Use the PREDEFINED tag if you want to use a different macro definition that
  1522 # overrules the definition found in the source code.
  1524 EXPAND_AS_DEFINED      =
  1526 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  1527 # doxygen's preprocessor will remove all references to function-like macros
  1528 # that are alone on a line, have an all uppercase name, and do not end with a
  1529 # semicolon, because these will confuse the parser if not removed.
  1531 SKIP_FUNCTION_MACROS   = YES
  1533 #---------------------------------------------------------------------------
  1534 # Configuration::additions related to external references
  1535 #---------------------------------------------------------------------------
  1537 # The TAGFILES option can be used to specify one or more tagfiles.
  1538 # Optionally an initial location of the external documentation
  1539 # can be added for each tagfile. The format of a tag file without
  1540 # this location is as follows:
  1542 # TAGFILES = file1 file2 ...
  1543 # Adding location for the tag files is done as follows:
  1545 # TAGFILES = file1=loc1 "file2 = loc2" ...
  1546 # where "loc1" and "loc2" can be relative or absolute paths or
  1547 # URLs. If a location is present for each tag, the installdox tool
  1548 # does not have to be run to correct the links.
  1549 # Note that each tag file must have a unique name
  1550 # (where the name does NOT include the path)
  1551 # If a tag file is not located in the directory in which doxygen
  1552 # is run, you must also specify the path to the tagfile here.
  1554 TAGFILES               =
  1556 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  1557 # a tag file that is based on the input files it reads.
  1559 GENERATE_TAGFILE       =
  1561 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  1562 # in the class index. If set to NO only the inherited external classes
  1563 # will be listed.
  1565 ALLEXTERNALS           = NO
  1567 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  1568 # in the modules index. If set to NO, only the current project's groups will
  1569 # be listed.
  1571 EXTERNAL_GROUPS        = YES
  1573 # The PERL_PATH should be the absolute path and name of the perl script
  1574 # interpreter (i.e. the result of `which perl').
  1576 PERL_PATH              = /usr/bin/perl
  1578 #---------------------------------------------------------------------------
  1579 # Configuration options related to the dot tool
  1580 #---------------------------------------------------------------------------
  1582 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  1583 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  1584 # or super classes. Setting the tag to NO turns the diagrams off. Note that
  1585 # this option also works with HAVE_DOT disabled, but it is recommended to
  1586 # install and use dot, since it yields more powerful graphs.
  1588 CLASS_DIAGRAMS         = YES
  1590 # You can define message sequence charts within doxygen comments using the \msc
  1591 # command. Doxygen will then run the mscgen tool (see
  1592 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  1593 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1594 # the mscgen tool resides. If left empty the tool is assumed to be found in the
  1595 # default search path.
  1597 MSCGEN_PATH            =
  1599 # If set to YES, the inheritance and collaboration graphs will hide
  1600 # inheritance and usage relations if the target is undocumented
  1601 # or is not a class.
  1603 HIDE_UNDOC_RELATIONS   = YES
  1605 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1606 # available from the path. This tool is part of Graphviz, a graph visualization
  1607 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  1608 # have no effect if this option is set to NO (the default)
  1610 HAVE_DOT               = NO
  1612 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
  1613 # allowed to run in parallel. When set to 0 (the default) doxygen will
  1614 # base this on the number of processors available in the system. You can set it
  1615 # explicitly to a value larger than 0 to get control over the balance
  1616 # between CPU load and processing speed.
  1618 DOT_NUM_THREADS        = 0
  1620 # By default doxygen will use the Helvetica font for all dot files that
  1621 # doxygen generates. When you want a differently looking font you can specify
  1622 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
  1623 # the font, which can be done by putting it in a standard location or by setting
  1624 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
  1625 # directory containing the font.
  1627 DOT_FONTNAME           = Helvetica
  1629 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
  1630 # The default size is 10pt.
  1632 DOT_FONTSIZE           = 10
  1634 # By default doxygen will tell dot to use the Helvetica font.
  1635 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
  1636 # set the path where dot can find it.
  1638 DOT_FONTPATH           =
  1640 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1641 # will generate a graph for each documented class showing the direct and
  1642 # indirect inheritance relations. Setting this tag to YES will force the
  1643 # CLASS_DIAGRAMS tag to NO.
  1645 CLASS_GRAPH            = YES
  1647 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1648 # will generate a graph for each documented class showing the direct and
  1649 # indirect implementation dependencies (inheritance, containment, and
  1650 # class references variables) of the class with other documented classes.
  1652 COLLABORATION_GRAPH    = YES
  1654 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  1655 # will generate a graph for groups, showing the direct groups dependencies
  1657 GROUP_GRAPHS           = YES
  1659 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  1660 # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1661 # Language.
  1663 UML_LOOK               = NO
  1665 # If set to YES, the inheritance and collaboration graphs will show the
  1666 # relations between templates and their instances.
  1668 TEMPLATE_RELATIONS     = NO
  1670 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  1671 # tags are set to YES then doxygen will generate a graph for each documented
  1672 # file showing the direct and indirect include dependencies of the file with
  1673 # other documented files.
  1675 INCLUDE_GRAPH          = YES
  1677 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  1678 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  1679 # documented header file showing the documented files that directly or
  1680 # indirectly include this file.
  1682 INCLUDED_BY_GRAPH      = YES
  1684 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
  1685 # doxygen will generate a call dependency graph for every global function
  1686 # or class method. Note that enabling this option will significantly increase
  1687 # the time of a run. So in most cases it will be better to enable call graphs
  1688 # for selected functions only using the \callgraph command.
  1690 CALL_GRAPH             = NO
  1692 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
  1693 # doxygen will generate a caller dependency graph for every global function
  1694 # or class method. Note that enabling this option will significantly increase
  1695 # the time of a run. So in most cases it will be better to enable caller
  1696 # graphs for selected functions only using the \callergraph command.
  1698 CALLER_GRAPH           = NO
  1700 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  1701 # will generate a graphical hierarchy of all classes instead of a textual one.
  1703 GRAPHICAL_HIERARCHY    = YES
  1705 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  1706 # then doxygen will show the dependencies a directory has on other directories
  1707 # in a graphical way. The dependency relations are determined by the #include
  1708 # relations between the files in the directories.
  1710 DIRECTORY_GRAPH        = YES
  1712 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1713 # generated by dot. Possible values are svg, png, jpg, or gif.
  1714 # If left blank png will be used. If you choose svg you need to set
  1715 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
  1716 # visible in IE 9+ (other browsers do not have this requirement).
  1718 DOT_IMAGE_FORMAT       = png
  1720 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  1721 # enable generation of interactive SVG images that allow zooming and panning.
  1722 # Note that this requires a modern browser other than Internet Explorer.
  1723 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
  1724 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
  1725 # visible. Older versions of IE do not have SVG support.
  1727 INTERACTIVE_SVG        = NO
  1729 # The tag DOT_PATH can be used to specify the path where the dot tool can be
  1730 # found. If left blank, it is assumed the dot tool can be found in the path.
  1732 DOT_PATH               =
  1734 # The DOTFILE_DIRS tag can be used to specify one or more directories that
  1735 # contain dot files that are included in the documentation (see the
  1736 # \dotfile command).
  1738 DOTFILE_DIRS           =
  1740 # The MSCFILE_DIRS tag can be used to specify one or more directories that
  1741 # contain msc files that are included in the documentation (see the
  1742 # \mscfile command).
  1744 MSCFILE_DIRS           =
  1746 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  1747 # nodes that will be shown in the graph. If the number of nodes in a graph
  1748 # becomes larger than this value, doxygen will truncate the graph, which is
  1749 # visualized by representing a node as a red box. Note that doxygen if the
  1750 # number of direct children of the root node in a graph is already larger than
  1751 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
  1752 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1754 DOT_GRAPH_MAX_NODES    = 50
  1756 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  1757 # graphs generated by dot. A depth value of 3 means that only nodes reachable
  1758 # from the root by following a path via at most 3 edges will be shown. Nodes
  1759 # that lay further from the root node will be omitted. Note that setting this
  1760 # option to 1 or 2 may greatly reduce the computation time needed for large
  1761 # code bases. Also note that the size of a graph can be further restricted by
  1762 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1764 MAX_DOT_GRAPH_DEPTH    = 0
  1766 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1767 # background. This is disabled by default, because dot on Windows does not
  1768 # seem to support this out of the box. Warning: Depending on the platform used,
  1769 # enabling this option may lead to badly anti-aliased labels on the edges of
  1770 # a graph (i.e. they become hard to read).
  1772 DOT_TRANSPARENT        = NO
  1774 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  1775 # files in one run (i.e. multiple -o and -T options on the command line). This
  1776 # makes dot run faster, but since only newer versions of dot (>1.8.10)
  1777 # support this, this feature is disabled by default.
  1779 DOT_MULTI_TARGETS      = YES
  1781 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  1782 # generate a legend page explaining the meaning of the various boxes and
  1783 # arrows in the dot generated graphs.
  1785 GENERATE_LEGEND        = YES
  1787 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  1788 # remove the intermediate dot files that are used to generate
  1789 # the various graphs.
  1791 DOT_CLEANUP            = YES

mercurial