universe@114: # Doxyfile 1.8.1.2 universe@114: # universe@114: # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. universe@114: # universe@114: # Copyright 2013 Olaf Wintermann. All rights reserved. universe@114: # universe@114: # Redistribution and use in source and binary forms, with or without universe@114: # modification, are permitted provided that the following conditions are met: universe@114: # universe@114: # 1. Redistributions of source code must retain the above copyright universe@114: # notice, this list of conditions and the following disclaimer. universe@114: # universe@114: # 2. Redistributions in binary form must reproduce the above copyright universe@114: # notice, this list of conditions and the following disclaimer in the universe@114: # documentation and/or other materials provided with the distribution. universe@114: # universe@114: # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" universe@114: # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE universe@114: # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE universe@114: # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE universe@114: # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR universe@114: # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF universe@114: # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS universe@114: # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN universe@114: # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) universe@114: # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE universe@114: # POSSIBILITY OF SUCH DAMAGE. universe@114: # universe@114: # This file describes the settings to be used by the documentation system universe@114: # doxygen (www.doxygen.org) for a project. universe@114: # universe@114: # All text after a hash (#) is considered a comment and will be ignored. universe@114: # The format is: universe@114: # TAG = value [value, ...] universe@114: # For lists items can also be appended using: universe@114: # TAG += value [value, ...] universe@114: # Values that contain spaces should be placed between quotes (" "). universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # Project related configuration options universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # This tag specifies the encoding used for all characters in the config file universe@114: # that follow. The default is UTF-8 which is also the encoding used for all universe@114: # text before the first occurrence of this tag. Doxygen uses libiconv (or the universe@114: # iconv built into libc) for the transcoding. See universe@114: # http://www.gnu.org/software/libiconv for the list of possible encodings. universe@114: universe@114: DOXYFILE_ENCODING = UTF-8 universe@114: universe@114: # The PROJECT_NAME tag is a single word (or sequence of words) that should universe@114: # identify the project. Note that if you do not use Doxywizard you need universe@114: # to put quotes around the project name if it contains spaces. universe@114: universe@114: PROJECT_NAME = "ucx" universe@114: universe@114: # The PROJECT_NUMBER tag can be used to enter a project or revision number. universe@114: # This could be handy for archiving the generated documentation or universe@114: # if some version control system is used. universe@114: universe@114: PROJECT_NUMBER = universe@114: universe@114: # Using the PROJECT_BRIEF tag one can provide an optional one line description universe@114: # for a project that appears at the top of each page and should give viewer universe@114: # a quick idea about the purpose of the project. Keep the description short. universe@114: universe@114: PROJECT_BRIEF = "UAP Common Extensions" universe@114: universe@114: # With the PROJECT_LOGO tag one can specify an logo or icon that is universe@114: # included in the documentation. The maximum height of the logo should not universe@114: # exceed 55 pixels and the maximum width should not exceed 200 pixels. universe@114: # Doxygen will copy the logo to the output directory. universe@114: universe@114: PROJECT_LOGO = ./uaplogo.png universe@114: universe@114: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) universe@114: # base path where the generated documentation will be put. universe@114: # If a relative path is entered, it will be relative to the location universe@114: # where doxygen was started. If left blank the current directory will be used. universe@114: universe@114: OUTPUT_DIRECTORY = doc universe@114: universe@114: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create universe@114: # 4096 sub-directories (in 2 levels) under the output directory of each output universe@114: # format and will distribute the generated files over these directories. universe@114: # Enabling this option can be useful when feeding doxygen a huge amount of universe@114: # source files, where putting all generated files in the same directory would universe@114: # otherwise cause performance problems for the file system. universe@114: universe@114: CREATE_SUBDIRS = NO universe@114: universe@114: # The OUTPUT_LANGUAGE tag is used to specify the language in which all universe@114: # documentation generated by doxygen is written. Doxygen will use this universe@114: # information to generate all constant output in the proper language. universe@114: # The default language is English, other supported languages are: universe@114: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, universe@114: # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, universe@114: # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English universe@114: # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, universe@114: # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, universe@114: # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. universe@114: universe@114: OUTPUT_LANGUAGE = English universe@114: universe@114: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will universe@114: # include brief member descriptions after the members that are listed in universe@114: # the file and class documentation (similar to JavaDoc). universe@114: # Set to NO to disable this. universe@114: universe@114: BRIEF_MEMBER_DESC = YES universe@114: universe@114: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend universe@114: # the brief description of a member or function before the detailed description. universe@114: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the universe@114: # brief descriptions will be completely suppressed. universe@114: universe@114: REPEAT_BRIEF = YES universe@114: universe@114: # This tag implements a quasi-intelligent brief description abbreviator universe@114: # that is used to form the text in various listings. Each string universe@114: # in this list, if found as the leading text of the brief description, will be universe@114: # stripped from the text and the result after processing the whole list, is universe@114: # used as the annotated text. Otherwise, the brief description is used as-is. universe@114: # If left blank, the following values are used ("$name" is automatically universe@114: # replaced with the name of the entity): "The $name class" "The $name widget" universe@114: # "The $name file" "is" "provides" "specifies" "contains" universe@114: # "represents" "a" "an" "the" universe@114: universe@114: ABBREVIATE_BRIEF = universe@114: universe@114: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then universe@114: # Doxygen will generate a detailed section even if there is only a brief universe@114: # description. universe@114: universe@114: ALWAYS_DETAILED_SEC = NO universe@114: universe@114: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all universe@114: # inherited members of a class in the documentation of that class as if those universe@114: # members were ordinary class members. Constructors, destructors and assignment universe@114: # operators of the base classes will not be shown. universe@114: universe@114: INLINE_INHERITED_MEMB = NO universe@114: universe@114: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full universe@114: # path before files name in the file list and in the header files. If set universe@114: # to NO the shortest path that makes the file name unique will be used. universe@114: universe@114: FULL_PATH_NAMES = YES universe@114: universe@114: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag universe@114: # can be used to strip a user-defined part of the path. Stripping is universe@114: # only done if one of the specified strings matches the left-hand part of universe@114: # the path. The tag can be used to show relative paths in the file list. universe@114: # If left blank the directory from which doxygen is run is used as the universe@114: # path to strip. universe@114: universe@114: STRIP_FROM_PATH = universe@114: universe@114: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of universe@114: # the path mentioned in the documentation of a class, which tells universe@114: # the reader which header file to include in order to use a class. universe@114: # If left blank only the name of the header file containing the class universe@114: # definition is used. Otherwise one should specify the include paths that universe@114: # are normally passed to the compiler using the -I flag. universe@114: universe@114: STRIP_FROM_INC_PATH = universe@114: universe@114: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter universe@114: # (but less readable) file names. This can be useful if your file system universe@114: # doesn't support long names like on DOS, Mac, or CD-ROM. universe@114: universe@114: SHORT_NAMES = NO universe@114: universe@114: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen universe@114: # will interpret the first line (until the first dot) of a JavaDoc-style universe@114: # comment as the brief description. If set to NO, the JavaDoc universe@114: # comments will behave just like regular Qt-style comments universe@114: # (thus requiring an explicit @brief command for a brief description.) universe@114: universe@114: JAVADOC_AUTOBRIEF = YES universe@114: universe@114: # If the QT_AUTOBRIEF tag is set to YES then Doxygen will universe@114: # interpret the first line (until the first dot) of a Qt-style universe@114: # comment as the brief description. If set to NO, the comments universe@114: # will behave just like regular Qt-style comments (thus requiring universe@114: # an explicit \brief command for a brief description.) universe@114: universe@114: QT_AUTOBRIEF = NO universe@114: universe@114: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen universe@114: # treat a multi-line C++ special comment block (i.e. a block of //! or /// universe@114: # comments) as a brief description. This used to be the default behaviour. universe@114: # The new default is to treat a multi-line C++ comment block as a detailed universe@114: # description. Set this tag to YES if you prefer the old behaviour instead. universe@114: universe@114: MULTILINE_CPP_IS_BRIEF = NO universe@114: universe@114: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented universe@114: # member inherits the documentation from any documented member that it universe@114: # re-implements. universe@114: universe@114: INHERIT_DOCS = YES universe@114: universe@114: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce universe@114: # a new page for each member. If set to NO, the documentation of a member will universe@114: # be part of the file/class/namespace that contains it. universe@114: universe@114: SEPARATE_MEMBER_PAGES = NO universe@114: universe@114: # The TAB_SIZE tag can be used to set the number of spaces in a tab. universe@114: # Doxygen uses this value to replace tabs by spaces in code fragments. universe@114: universe@114: TAB_SIZE = 4 universe@114: universe@114: # This tag can be used to specify a number of aliases that acts universe@114: # as commands in the documentation. An alias has the form "name=value". universe@114: # For example adding "sideeffect=\par Side Effects:\n" will allow you to universe@114: # put the command \sideeffect (or @sideeffect) in the documentation, which universe@114: # will result in a user-defined paragraph with heading "Side Effects:". universe@114: # You can put \n's in the value part of an alias to insert newlines. universe@114: universe@114: ALIASES = universe@114: universe@114: # This tag can be used to specify a number of word-keyword mappings (TCL only). universe@114: # A mapping has the form "name=value". For example adding universe@114: # "class=itcl::class" will allow you to use the command class in the universe@114: # itcl::class meaning. universe@114: universe@114: TCL_SUBST = universe@114: universe@114: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C universe@114: # sources only. Doxygen will then generate output that is more tailored for C. universe@114: # For instance, some of the names that are used will be different. The list universe@114: # of all members will be omitted, etc. universe@114: universe@114: OPTIMIZE_OUTPUT_FOR_C = YES universe@114: universe@114: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java universe@114: # sources only. Doxygen will then generate output that is more tailored for universe@114: # Java. For instance, namespaces will be presented as packages, qualified universe@114: # scopes will look different, etc. universe@114: universe@114: OPTIMIZE_OUTPUT_JAVA = NO universe@114: universe@114: # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran universe@114: # sources only. Doxygen will then generate output that is more tailored for universe@114: # Fortran. universe@114: universe@114: OPTIMIZE_FOR_FORTRAN = NO universe@114: universe@114: # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL universe@114: # sources. Doxygen will then generate output that is tailored for universe@114: # VHDL. universe@114: universe@114: OPTIMIZE_OUTPUT_VHDL = NO universe@114: universe@114: # Doxygen selects the parser to use depending on the extension of the files it universe@114: # parses. With this tag you can assign which parser to use for a given extension. universe@114: # Doxygen has a built-in mapping, but you can override or extend it using this universe@114: # tag. The format is ext=language, where ext is a file extension, and language universe@114: # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, universe@114: # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make universe@114: # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C universe@114: # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions universe@114: # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. universe@114: universe@114: EXTENSION_MAPPING = universe@114: universe@114: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want universe@114: # to include (a tag file for) the STL sources as input, then you should universe@114: # set this tag to YES in order to let doxygen match functions declarations and universe@114: # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. universe@114: # func(std::string) {}). This also makes the inheritance and collaboration universe@114: # diagrams that involve STL classes more complete and accurate. universe@114: universe@114: BUILTIN_STL_SUPPORT = NO universe@114: universe@114: # If you use Microsoft's C++/CLI language, you should set this option to YES to universe@114: # enable parsing support. universe@114: universe@114: CPP_CLI_SUPPORT = NO universe@114: universe@114: # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. universe@114: # Doxygen will parse them like normal C++ but will assume all classes use public universe@114: # instead of private inheritance when no explicit protection keyword is present. universe@114: universe@114: SIP_SUPPORT = NO universe@114: universe@114: # For Microsoft's IDL there are propget and propput attributes to indicate getter universe@114: # and setter methods for a property. Setting this option to YES (the default) universe@114: # will make doxygen replace the get and set methods by a property in the universe@114: # documentation. This will only work if the methods are indeed getting or universe@114: # setting a simple type. If this is not the case, or you want to show the universe@114: # methods anyway, you should set this option to NO. universe@114: universe@114: IDL_PROPERTY_SUPPORT = YES universe@114: universe@114: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC universe@114: # tag is set to YES, then doxygen will reuse the documentation of the first universe@114: # member in the group (if any) for the other members of the group. By default universe@114: # all members of a group must be documented explicitly. universe@114: universe@114: DISTRIBUTE_GROUP_DOC = NO universe@114: universe@114: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of universe@114: # the same type (for instance a group of public functions) to be put as a universe@114: # subgroup of that type (e.g. under the Public Functions section). Set it to universe@114: # NO to prevent subgrouping. Alternatively, this can be done per class using universe@114: # the \nosubgrouping command. universe@114: universe@114: SUBGROUPING = YES universe@114: universe@114: # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and universe@114: # unions are shown inside the group in which they are included (e.g. using universe@114: # @ingroup) instead of on a separate page (for HTML and Man pages) or universe@114: # section (for LaTeX and RTF). universe@114: universe@114: INLINE_GROUPED_CLASSES = NO universe@114: universe@114: # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and universe@114: # unions with only public data fields will be shown inline in the documentation universe@114: # of the scope in which they are defined (i.e. file, namespace, or group universe@114: # documentation), provided this scope is documented. If set to NO (the default), universe@114: # structs, classes, and unions are shown on a separate page (for HTML and Man universe@114: # pages) or section (for LaTeX and RTF). universe@114: universe@114: INLINE_SIMPLE_STRUCTS = NO universe@114: universe@114: # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum universe@114: # is documented as struct, union, or enum with the name of the typedef. So universe@114: # typedef struct TypeS {} TypeT, will appear in the documentation as a struct universe@114: # with name TypeT. When disabled the typedef will appear as a member of a file, universe@114: # namespace, or class. And the struct will be named TypeS. This can typically universe@114: # be useful for C code in case the coding convention dictates that all compound universe@114: # types are typedef'ed and only the typedef is referenced, never the tag name. universe@114: universe@114: TYPEDEF_HIDES_STRUCT = NO universe@114: universe@114: # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to universe@114: # determine which symbols to keep in memory and which to flush to disk. universe@114: # When the cache is full, less often used symbols will be written to disk. universe@114: # For small to medium size projects (<1000 input files) the default value is universe@114: # probably good enough. For larger projects a too small cache size can cause universe@114: # doxygen to be busy swapping symbols to and from disk most of the time universe@114: # causing a significant performance penalty. universe@114: # If the system has enough physical memory increasing the cache will improve the universe@114: # performance by keeping more symbols in memory. Note that the value works on universe@114: # a logarithmic scale so increasing the size by one will roughly double the universe@114: # memory usage. The cache size is given by this formula: universe@114: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, universe@114: # corresponding to a cache size of 2^16 = 65536 symbols. universe@114: universe@114: SYMBOL_CACHE_SIZE = 0 universe@114: universe@114: # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be universe@114: # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given universe@114: # their name and scope. Since this can be an expensive process and often the universe@114: # same symbol appear multiple times in the code, doxygen keeps a cache of universe@114: # pre-resolved symbols. If the cache is too small doxygen will become slower. universe@114: # If the cache is too large, memory is wasted. The cache size is given by this universe@114: # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, universe@114: # corresponding to a cache size of 2^16 = 65536 symbols. universe@114: universe@114: LOOKUP_CACHE_SIZE = 0 universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # Build related configuration options universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in universe@114: # documentation are documented, even if no documentation was available. universe@114: # Private class members and static file members will be hidden unless universe@114: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES universe@114: universe@114: EXTRACT_ALL = NO universe@114: universe@114: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class universe@114: # will be included in the documentation. universe@114: universe@114: EXTRACT_PRIVATE = NO universe@114: universe@114: # If the EXTRACT_STATIC tag is set to YES all static members of a file universe@114: # will be included in the documentation. universe@114: universe@114: EXTRACT_STATIC = NO universe@114: universe@114: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) universe@114: # defined locally in source files will be included in the documentation. universe@114: # If set to NO only classes defined in header files are included. universe@114: universe@114: EXTRACT_LOCAL_CLASSES = YES universe@114: universe@114: # This flag is only useful for Objective-C code. When set to YES local universe@114: # methods, which are defined in the implementation section but not in universe@114: # the interface are included in the documentation. universe@114: # If set to NO (the default) only methods in the interface are included. universe@114: universe@114: EXTRACT_LOCAL_METHODS = NO universe@114: universe@114: # If this flag is set to YES, the members of anonymous namespaces will be universe@114: # extracted and appear in the documentation as a namespace called universe@114: # 'anonymous_namespace{file}', where file will be replaced with the base universe@114: # name of the file that contains the anonymous namespace. By default universe@114: # anonymous namespaces are hidden. universe@114: universe@114: EXTRACT_ANON_NSPACES = NO universe@114: universe@114: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all universe@114: # undocumented members of documented classes, files or namespaces. universe@114: # If set to NO (the default) these members will be included in the universe@114: # various overviews, but no documentation section is generated. universe@114: # This option has no effect if EXTRACT_ALL is enabled. universe@114: universe@114: HIDE_UNDOC_MEMBERS = NO universe@114: universe@114: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all universe@114: # undocumented classes that are normally visible in the class hierarchy. universe@114: # If set to NO (the default) these classes will be included in the various universe@114: # overviews. This option has no effect if EXTRACT_ALL is enabled. universe@114: universe@114: HIDE_UNDOC_CLASSES = NO universe@114: universe@114: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all universe@114: # friend (class|struct|union) declarations. universe@114: # If set to NO (the default) these declarations will be included in the universe@114: # documentation. universe@114: universe@114: HIDE_FRIEND_COMPOUNDS = NO universe@114: universe@114: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any universe@114: # documentation blocks found inside the body of a function. universe@114: # If set to NO (the default) these blocks will be appended to the universe@114: # function's detailed documentation block. universe@114: universe@114: HIDE_IN_BODY_DOCS = NO universe@114: universe@114: # The INTERNAL_DOCS tag determines if documentation universe@114: # that is typed after a \internal command is included. If the tag is set universe@114: # to NO (the default) then the documentation will be excluded. universe@114: # Set it to YES to include the internal documentation. universe@114: universe@114: INTERNAL_DOCS = NO universe@114: universe@114: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate universe@114: # file names in lower-case letters. If set to YES upper-case letters are also universe@114: # allowed. This is useful if you have classes or files whose names only differ universe@114: # in case and if your file system supports case sensitive file names. Windows universe@114: # and Mac users are advised to set this option to NO. universe@114: universe@114: CASE_SENSE_NAMES = YES universe@114: universe@114: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen universe@114: # will show members with their full class and namespace scopes in the universe@114: # documentation. If set to YES the scope will be hidden. universe@114: universe@114: HIDE_SCOPE_NAMES = NO universe@114: universe@114: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen universe@114: # will put a list of the files that are included by a file in the documentation universe@114: # of that file. universe@114: universe@114: SHOW_INCLUDE_FILES = YES universe@114: universe@114: # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen universe@114: # will list include files with double quotes in the documentation universe@114: # rather than with sharp brackets. universe@114: universe@114: FORCE_LOCAL_INCLUDES = NO universe@114: universe@114: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] universe@114: # is inserted in the documentation for inline members. universe@114: universe@114: INLINE_INFO = YES universe@114: universe@114: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen universe@114: # will sort the (detailed) documentation of file and class members universe@114: # alphabetically by member name. If set to NO the members will appear in universe@114: # declaration order. universe@114: universe@114: SORT_MEMBER_DOCS = YES universe@114: universe@114: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the universe@114: # brief documentation of file, namespace and class members alphabetically universe@114: # by member name. If set to NO (the default) the members will appear in universe@114: # declaration order. universe@114: universe@114: SORT_BRIEF_DOCS = NO universe@114: universe@114: # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen universe@114: # will sort the (brief and detailed) documentation of class members so that universe@114: # constructors and destructors are listed first. If set to NO (the default) universe@114: # the constructors will appear in the respective orders defined by universe@114: # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. universe@114: # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO universe@114: # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. universe@114: universe@114: SORT_MEMBERS_CTORS_1ST = NO universe@114: universe@114: # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the universe@114: # hierarchy of group names into alphabetical order. If set to NO (the default) universe@114: # the group names will appear in their defined order. universe@114: universe@114: SORT_GROUP_NAMES = NO universe@114: universe@114: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be universe@114: # sorted by fully-qualified names, including namespaces. If set to universe@114: # NO (the default), the class list will be sorted only by class name, universe@114: # not including the namespace part. universe@114: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. universe@114: # Note: This option applies only to the class list, not to the universe@114: # alphabetical list. universe@114: universe@114: SORT_BY_SCOPE_NAME = NO universe@114: universe@114: # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to universe@114: # do proper type resolution of all parameters of a function it will reject a universe@114: # match between the prototype and the implementation of a member function even universe@114: # if there is only one candidate or it is obvious which candidate to choose universe@114: # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen universe@114: # will still accept a match between prototype and implementation in such cases. universe@114: universe@114: STRICT_PROTO_MATCHING = NO universe@114: universe@114: # The GENERATE_TODOLIST tag can be used to enable (YES) or universe@114: # disable (NO) the todo list. This list is created by putting \todo universe@114: # commands in the documentation. universe@114: universe@114: GENERATE_TODOLIST = YES universe@114: universe@114: # The GENERATE_TESTLIST tag can be used to enable (YES) or universe@114: # disable (NO) the test list. This list is created by putting \test universe@114: # commands in the documentation. universe@114: universe@114: GENERATE_TESTLIST = YES universe@114: universe@114: # The GENERATE_BUGLIST tag can be used to enable (YES) or universe@114: # disable (NO) the bug list. This list is created by putting \bug universe@114: # commands in the documentation. universe@114: universe@114: GENERATE_BUGLIST = YES universe@114: universe@114: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or universe@114: # disable (NO) the deprecated list. This list is created by putting universe@114: # \deprecated commands in the documentation. universe@114: universe@114: GENERATE_DEPRECATEDLIST= YES universe@114: universe@114: # The ENABLED_SECTIONS tag can be used to enable conditional universe@114: # documentation sections, marked by \if sectionname ... \endif. universe@114: universe@114: ENABLED_SECTIONS = universe@114: universe@114: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines universe@114: # the initial value of a variable or macro consists of for it to appear in universe@114: # the documentation. If the initializer consists of more lines than specified universe@114: # here it will be hidden. Use a value of 0 to hide initializers completely. universe@114: # The appearance of the initializer of individual variables and macros in the universe@114: # documentation can be controlled using \showinitializer or \hideinitializer universe@114: # command in the documentation regardless of this setting. universe@114: universe@114: MAX_INITIALIZER_LINES = 30 universe@114: universe@114: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated universe@114: # at the bottom of the documentation of classes and structs. If set to YES the universe@114: # list will mention the files that were used to generate the documentation. universe@114: universe@114: SHOW_USED_FILES = YES universe@114: universe@114: # Set the SHOW_FILES tag to NO to disable the generation of the Files page. universe@114: # This will remove the Files entry from the Quick Index and from the universe@114: # Folder Tree View (if specified). The default is YES. universe@114: universe@114: SHOW_FILES = YES universe@114: universe@114: # Set the SHOW_NAMESPACES tag to NO to disable the generation of the universe@114: # Namespaces page. universe@114: # This will remove the Namespaces entry from the Quick Index universe@114: # and from the Folder Tree View (if specified). The default is YES. universe@114: universe@114: SHOW_NAMESPACES = YES universe@114: universe@114: # The FILE_VERSION_FILTER tag can be used to specify a program or script that universe@114: # doxygen should invoke to get the current version for each file (typically from universe@114: # the version control system). Doxygen will invoke the program by executing (via universe@114: # popen()) the command , where is the value of universe@114: # the FILE_VERSION_FILTER tag, and is the name of an input file universe@114: # provided by doxygen. Whatever the program writes to standard output universe@114: # is used as the file version. See the manual for examples. universe@114: universe@114: FILE_VERSION_FILTER = universe@114: universe@114: # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed universe@114: # by doxygen. The layout file controls the global structure of the generated universe@114: # output files in an output format independent way. The create the layout file universe@114: # that represents doxygen's defaults, run doxygen with the -l option. universe@114: # You can optionally specify a file name after the option, if omitted universe@114: # DoxygenLayout.xml will be used as the name of the layout file. universe@114: universe@114: LAYOUT_FILE = universe@114: universe@114: # The CITE_BIB_FILES tag can be used to specify one or more bib files universe@114: # containing the references data. This must be a list of .bib files. The universe@114: # .bib extension is automatically appended if omitted. Using this command universe@114: # requires the bibtex tool to be installed. See also universe@114: # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style universe@114: # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this universe@114: # feature you need bibtex and perl available in the search path. universe@114: universe@114: CITE_BIB_FILES = universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to warning and progress messages universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # The QUIET tag can be used to turn on/off the messages that are generated universe@114: # by doxygen. Possible values are YES and NO. If left blank NO is used. universe@114: universe@114: QUIET = NO universe@114: universe@114: # The WARNINGS tag can be used to turn on/off the warning messages that are universe@114: # generated by doxygen. Possible values are YES and NO. If left blank universe@114: # NO is used. universe@114: universe@114: WARNINGS = YES universe@114: universe@114: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings universe@114: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will universe@114: # automatically be disabled. universe@114: universe@114: WARN_IF_UNDOCUMENTED = YES universe@114: universe@114: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for universe@114: # potential errors in the documentation, such as not documenting some universe@114: # parameters in a documented function, or documenting parameters that universe@114: # don't exist or using markup commands wrongly. universe@114: universe@114: WARN_IF_DOC_ERROR = YES universe@114: universe@114: # The WARN_NO_PARAMDOC option can be enabled to get warnings for universe@114: # functions that are documented, but have no documentation for their parameters universe@114: # or return value. If set to NO (the default) doxygen will only warn about universe@114: # wrong or incomplete parameter documentation, but not about the absence of universe@114: # documentation. universe@114: universe@115: WARN_NO_PARAMDOC = YES universe@114: universe@114: # The WARN_FORMAT tag determines the format of the warning messages that universe@114: # doxygen can produce. The string should contain the $file, $line, and $text universe@114: # tags, which will be replaced by the file and line number from which the universe@114: # warning originated and the warning text. Optionally the format may contain universe@114: # $version, which will be replaced by the version of the file (if it could universe@114: # be obtained via FILE_VERSION_FILTER) universe@114: universe@114: WARN_FORMAT = "$file:$line: $text" universe@114: universe@114: # The WARN_LOGFILE tag can be used to specify a file to which warning universe@114: # and error messages should be written. If left blank the output is written universe@114: # to stderr. universe@114: universe@114: WARN_LOGFILE = universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to the input files universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # The INPUT tag can be used to specify the files and/or directories that contain universe@114: # documented source files. You may enter file names like "myfile.cpp" or universe@114: # directories like "/usr/src/myproject". Separate the files or directories universe@114: # with spaces. universe@114: universe@114: INPUT = ./ucx universe@114: universe@114: # This tag can be used to specify the character encoding of the source files universe@114: # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is universe@114: # also the default input encoding. Doxygen uses libiconv (or the iconv built universe@114: # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for universe@114: # the list of possible encodings. universe@114: universe@114: INPUT_ENCODING = UTF-8 universe@114: universe@114: # If the value of the INPUT tag contains directories, you can use the universe@114: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp universe@114: # and *.h) to filter out the source-files in the directories. If left universe@114: # blank the following patterns are tested: universe@114: # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh universe@114: # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py universe@114: # *.f90 *.f *.for *.vhd *.vhdl universe@114: universe@114: FILE_PATTERNS = universe@114: universe@114: # The RECURSIVE tag can be used to turn specify whether or not subdirectories universe@114: # should be searched for input files as well. Possible values are YES and NO. universe@114: # If left blank NO is used. universe@114: universe@114: RECURSIVE = YES universe@114: universe@114: # The EXCLUDE tag can be used to specify files and/or directories that should be universe@114: # excluded from the INPUT source files. This way you can easily exclude a universe@114: # subdirectory from a directory tree whose root is specified with the INPUT tag. universe@114: # Note that relative paths are relative to the directory from which doxygen is universe@114: # run. universe@114: universe@114: EXCLUDE = universe@114: universe@114: # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or universe@114: # directories that are symbolic links (a Unix file system feature) are excluded universe@114: # from the input. universe@114: universe@114: EXCLUDE_SYMLINKS = NO universe@114: universe@114: # If the value of the INPUT tag contains directories, you can use the universe@114: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude universe@114: # certain files from those directories. Note that the wildcards are matched universe@114: # against the file with absolute path, so to exclude all test directories universe@114: # for example use the pattern */test/* universe@114: universe@114: EXCLUDE_PATTERNS = universe@114: universe@114: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names universe@114: # (namespaces, classes, functions, etc.) that should be excluded from the universe@114: # output. The symbol name can be a fully qualified name, a word, or if the universe@114: # wildcard * is used, a substring. Examples: ANamespace, AClass, universe@114: # AClass::ANamespace, ANamespace::*Test universe@114: universe@114: EXCLUDE_SYMBOLS = universe@114: universe@114: # The EXAMPLE_PATH tag can be used to specify one or more files or universe@114: # directories that contain example code fragments that are included (see universe@114: # the \include command). universe@114: universe@114: EXAMPLE_PATH = universe@114: universe@114: # If the value of the EXAMPLE_PATH tag contains directories, you can use the universe@114: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp universe@114: # and *.h) to filter out the source-files in the directories. If left universe@114: # blank all files are included. universe@114: universe@114: EXAMPLE_PATTERNS = universe@114: universe@114: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be universe@114: # searched for input files to be used with the \include or \dontinclude universe@114: # commands irrespective of the value of the RECURSIVE tag. universe@114: # Possible values are YES and NO. If left blank NO is used. universe@114: universe@114: EXAMPLE_RECURSIVE = NO universe@114: universe@114: # The IMAGE_PATH tag can be used to specify one or more files or universe@114: # directories that contain image that are included in the documentation (see universe@114: # the \image command). universe@114: universe@114: IMAGE_PATH = universe@114: universe@114: # The INPUT_FILTER tag can be used to specify a program that doxygen should universe@114: # invoke to filter for each input file. Doxygen will invoke the filter program universe@114: # by executing (via popen()) the command , where universe@114: # is the value of the INPUT_FILTER tag, and is the name of an universe@114: # input file. Doxygen will then use the output that the filter program writes universe@114: # to standard output. universe@114: # If FILTER_PATTERNS is specified, this tag will be universe@114: # ignored. universe@114: universe@114: INPUT_FILTER = universe@114: universe@114: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern universe@114: # basis. universe@114: # Doxygen will compare the file name with each pattern and apply the universe@114: # filter if there is a match. universe@114: # The filters are a list of the form: universe@114: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further universe@114: # info on how filters are used. If FILTER_PATTERNS is empty or if universe@114: # non of the patterns match the file name, INPUT_FILTER is applied. universe@114: universe@114: FILTER_PATTERNS = universe@114: universe@114: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using universe@114: # INPUT_FILTER) will be used to filter the input files when producing source universe@114: # files to browse (i.e. when SOURCE_BROWSER is set to YES). universe@114: universe@114: FILTER_SOURCE_FILES = NO universe@114: universe@114: # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file universe@114: # pattern. A pattern will override the setting for FILTER_PATTERN (if any) universe@114: # and it is also possible to disable source filtering for a specific pattern universe@114: # using *.ext= (so without naming a filter). This option only has effect when universe@114: # FILTER_SOURCE_FILES is enabled. universe@114: universe@114: FILTER_SOURCE_PATTERNS = universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to source browsing universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the SOURCE_BROWSER tag is set to YES then a list of source files will universe@114: # be generated. Documented entities will be cross-referenced with these sources. universe@114: # Note: To get rid of all source code in the generated output, make sure also universe@114: # VERBATIM_HEADERS is set to NO. universe@114: universe@114: SOURCE_BROWSER = NO universe@114: universe@114: # Setting the INLINE_SOURCES tag to YES will include the body universe@114: # of functions and classes directly in the documentation. universe@114: universe@114: INLINE_SOURCES = NO universe@114: universe@114: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct universe@114: # doxygen to hide any special comment blocks from generated source code universe@114: # fragments. Normal C and C++ comments will always remain visible. universe@114: universe@114: STRIP_CODE_COMMENTS = YES universe@114: universe@114: # If the REFERENCED_BY_RELATION tag is set to YES universe@114: # then for each documented function all documented universe@114: # functions referencing it will be listed. universe@114: universe@114: REFERENCED_BY_RELATION = NO universe@114: universe@114: # If the REFERENCES_RELATION tag is set to YES universe@114: # then for each documented function all documented entities universe@114: # called/used by that function will be listed. universe@114: universe@114: REFERENCES_RELATION = NO universe@114: universe@114: # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) universe@114: # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from universe@114: # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will universe@114: # link to the source code. universe@114: # Otherwise they will link to the documentation. universe@114: universe@114: REFERENCES_LINK_SOURCE = YES universe@114: universe@114: # If the USE_HTAGS tag is set to YES then the references to source code universe@114: # will point to the HTML generated by the htags(1) tool instead of doxygen universe@114: # built-in source browser. The htags tool is part of GNU's global source universe@114: # tagging system (see http://www.gnu.org/software/global/global.html). You universe@114: # will need version 4.8.6 or higher. universe@114: universe@114: USE_HTAGS = NO universe@114: universe@114: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen universe@114: # will generate a verbatim copy of the header file for each class for universe@114: # which an include is specified. Set to NO to disable this. universe@114: universe@114: VERBATIM_HEADERS = YES universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to the alphabetical class index universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index universe@114: # of all compounds will be generated. Enable this if the project universe@114: # contains a lot of classes, structs, unions or interfaces. universe@114: universe@114: ALPHABETICAL_INDEX = YES universe@114: universe@114: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then universe@114: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns universe@114: # in which this list will be split (can be a number in the range [1..20]) universe@114: universe@114: COLS_IN_ALPHA_INDEX = 5 universe@114: universe@114: # In case all classes in a project start with a common prefix, all universe@114: # classes will be put under the same header in the alphabetical index. universe@114: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that universe@114: # should be ignored while generating the index headers. universe@114: universe@114: IGNORE_PREFIX = universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to the HTML output universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will universe@114: # generate HTML output. universe@114: universe@114: GENERATE_HTML = YES universe@114: universe@114: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. universe@114: # If a relative path is entered the value of OUTPUT_DIRECTORY will be universe@114: # put in front of it. If left blank `html' will be used as the default path. universe@114: universe@114: HTML_OUTPUT = html universe@114: universe@114: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for universe@114: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank universe@114: # doxygen will generate files with .html extension. universe@114: universe@114: HTML_FILE_EXTENSION = .html universe@114: universe@114: # The HTML_HEADER tag can be used to specify a personal HTML header for universe@114: # each generated HTML page. If it is left blank doxygen will generate a universe@114: # standard header. Note that when using a custom header you are responsible universe@114: # for the proper inclusion of any scripts and style sheets that doxygen universe@114: # needs, which is dependent on the configuration options used. universe@114: # It is advised to generate a default header using "doxygen -w html universe@114: # header.html footer.html stylesheet.css YourConfigFile" and then modify universe@114: # that header. Note that the header is subject to change so you typically universe@114: # have to redo this when upgrading to a newer version of doxygen or when universe@114: # changing the value of configuration settings such as GENERATE_TREEVIEW! universe@114: universe@114: HTML_HEADER = universe@114: universe@114: # The HTML_FOOTER tag can be used to specify a personal HTML footer for universe@114: # each generated HTML page. If it is left blank doxygen will generate a universe@114: # standard footer. universe@114: universe@114: HTML_FOOTER = universe@114: universe@114: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading universe@114: # style sheet that is used by each HTML page. It can be used to universe@114: # fine-tune the look of the HTML output. If the tag is left blank doxygen universe@114: # will generate a default style sheet. Note that doxygen will try to copy universe@114: # the style sheet file to the HTML output directory, so don't put your own universe@114: # style sheet in the HTML output directory as well, or it will be erased! universe@114: universe@114: HTML_STYLESHEET = universe@114: universe@114: # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or universe@114: # other source files which should be copied to the HTML output directory. Note universe@114: # that these files will be copied to the base HTML output directory. Use the universe@114: # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these universe@114: # files. In the HTML_STYLESHEET file, use the file name only. Also note that universe@114: # the files will be copied as-is; there are no commands or markers available. universe@114: universe@114: HTML_EXTRA_FILES = universe@114: universe@114: # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. universe@114: # Doxygen will adjust the colors in the style sheet and background images universe@114: # according to this color. Hue is specified as an angle on a colorwheel, universe@114: # see http://en.wikipedia.org/wiki/Hue for more information. universe@114: # For instance the value 0 represents red, 60 is yellow, 120 is green, universe@114: # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. universe@114: # The allowed range is 0 to 359. universe@114: universe@114: HTML_COLORSTYLE_HUE = 220 universe@114: universe@114: # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of universe@114: # the colors in the HTML output. For a value of 0 the output will use universe@114: # grayscales only. A value of 255 will produce the most vivid colors. universe@114: universe@114: HTML_COLORSTYLE_SAT = 100 universe@114: universe@114: # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to universe@114: # the luminance component of the colors in the HTML output. Values below universe@114: # 100 gradually make the output lighter, whereas values above 100 make universe@114: # the output darker. The value divided by 100 is the actual gamma applied, universe@114: # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, universe@114: # and 100 does not change the gamma. universe@114: universe@114: HTML_COLORSTYLE_GAMMA = 80 universe@114: universe@114: # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML universe@114: # page will contain the date and time when the page was generated. Setting universe@114: # this to NO can help when comparing the output of multiple runs. universe@114: universe@114: HTML_TIMESTAMP = YES universe@114: universe@114: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML universe@114: # documentation will contain sections that can be hidden and shown after the universe@114: # page has loaded. For this to work a browser that supports universe@114: # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox universe@114: # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). universe@114: universe@114: HTML_DYNAMIC_SECTIONS = NO universe@114: universe@114: # If the GENERATE_DOCSET tag is set to YES, additional index files universe@114: # will be generated that can be used as input for Apple's Xcode 3 universe@114: # integrated development environment, introduced with OSX 10.5 (Leopard). universe@114: # To create a documentation set, doxygen will generate a Makefile in the universe@114: # HTML output directory. Running make will produce the docset in that universe@114: # directory and running "make install" will install the docset in universe@114: # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find universe@114: # it at startup. universe@114: # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html universe@114: # for more information. universe@114: universe@114: GENERATE_DOCSET = NO universe@114: universe@114: # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the universe@114: # feed. A documentation feed provides an umbrella under which multiple universe@114: # documentation sets from a single provider (such as a company or product suite) universe@114: # can be grouped. universe@114: universe@114: DOCSET_FEEDNAME = "Doxygen generated docs" universe@114: universe@114: # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that universe@114: # should uniquely identify the documentation set bundle. This should be a universe@114: # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen universe@114: # will append .docset to the name. universe@114: universe@114: DOCSET_BUNDLE_ID = org.doxygen.Project universe@114: universe@114: # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify universe@114: # the documentation publisher. This should be a reverse domain-name style universe@114: # string, e.g. com.mycompany.MyDocSet.documentation. universe@114: universe@114: DOCSET_PUBLISHER_ID = org.doxygen.Publisher universe@114: universe@114: # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. universe@114: universe@114: DOCSET_PUBLISHER_NAME = Publisher universe@114: universe@114: # If the GENERATE_HTMLHELP tag is set to YES, additional index files universe@114: # will be generated that can be used as input for tools like the universe@114: # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) universe@114: # of the generated HTML documentation. universe@114: universe@114: GENERATE_HTMLHELP = NO universe@114: universe@114: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can universe@114: # be used to specify the file name of the resulting .chm file. You universe@114: # can add a path in front of the file if the result should not be universe@114: # written to the html output directory. universe@114: universe@114: CHM_FILE = universe@114: universe@114: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can universe@114: # be used to specify the location (absolute path including file name) of universe@114: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run universe@114: # the HTML help compiler on the generated index.hhp. universe@114: universe@114: HHC_LOCATION = universe@114: universe@114: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag universe@114: # controls if a separate .chi index file is generated (YES) or that universe@114: # it should be included in the master .chm file (NO). universe@114: universe@114: GENERATE_CHI = NO universe@114: universe@114: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING universe@114: # is used to encode HtmlHelp index (hhk), content (hhc) and project file universe@114: # content. universe@114: universe@114: CHM_INDEX_ENCODING = universe@114: universe@114: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag universe@114: # controls whether a binary table of contents is generated (YES) or a universe@114: # normal table of contents (NO) in the .chm file. universe@114: universe@114: BINARY_TOC = NO universe@114: universe@114: # The TOC_EXPAND flag can be set to YES to add extra items for group members universe@114: # to the contents of the HTML help documentation and to the tree view. universe@114: universe@114: TOC_EXPAND = NO universe@114: universe@114: # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and universe@114: # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated universe@114: # that can be used as input for Qt's qhelpgenerator to generate a universe@114: # Qt Compressed Help (.qch) of the generated HTML documentation. universe@114: universe@114: GENERATE_QHP = NO universe@114: universe@114: # If the QHG_LOCATION tag is specified, the QCH_FILE tag can universe@114: # be used to specify the file name of the resulting .qch file. universe@114: # The path specified is relative to the HTML output folder. universe@114: universe@114: QCH_FILE = universe@114: universe@114: # The QHP_NAMESPACE tag specifies the namespace to use when generating universe@114: # Qt Help Project output. For more information please see universe@114: # http://doc.trolltech.com/qthelpproject.html#namespace universe@114: universe@114: QHP_NAMESPACE = org.doxygen.Project universe@114: universe@114: # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating universe@114: # Qt Help Project output. For more information please see universe@114: # http://doc.trolltech.com/qthelpproject.html#virtual-folders universe@114: universe@114: QHP_VIRTUAL_FOLDER = doc universe@114: universe@114: # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to universe@114: # add. For more information please see universe@114: # http://doc.trolltech.com/qthelpproject.html#custom-filters universe@114: universe@114: QHP_CUST_FILTER_NAME = universe@114: universe@114: # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the universe@114: # custom filter to add. For more information please see universe@114: # universe@114: # Qt Help Project / Custom Filters. universe@114: universe@114: QHP_CUST_FILTER_ATTRS = universe@114: universe@114: # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this universe@114: # project's universe@114: # filter section matches. universe@114: # universe@114: # Qt Help Project / Filter Attributes. universe@114: universe@114: QHP_SECT_FILTER_ATTRS = universe@114: universe@114: # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can universe@114: # be used to specify the location of Qt's qhelpgenerator. universe@114: # If non-empty doxygen will try to run qhelpgenerator on the generated universe@114: # .qhp file. universe@114: universe@114: QHG_LOCATION = universe@114: universe@114: # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files universe@114: # will be generated, which together with the HTML files, form an Eclipse help universe@114: # plugin. To install this plugin and make it available under the help contents universe@114: # menu in Eclipse, the contents of the directory containing the HTML and XML universe@114: # files needs to be copied into the plugins directory of eclipse. The name of universe@114: # the directory within the plugins directory should be the same as universe@114: # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before universe@114: # the help appears. universe@114: universe@114: GENERATE_ECLIPSEHELP = NO universe@114: universe@114: # A unique identifier for the eclipse help plugin. When installing the plugin universe@114: # the directory name containing the HTML and XML files should also have universe@114: # this name. universe@114: universe@114: ECLIPSE_DOC_ID = org.doxygen.Project universe@114: universe@114: # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) universe@114: # at top of each HTML page. The value NO (the default) enables the index and universe@114: # the value YES disables it. Since the tabs have the same information as the universe@114: # navigation tree you can set this option to NO if you already set universe@114: # GENERATE_TREEVIEW to YES. universe@114: universe@114: DISABLE_INDEX = NO universe@114: universe@114: # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index universe@114: # structure should be generated to display hierarchical information. universe@114: # If the tag value is set to YES, a side panel will be generated universe@114: # containing a tree-like index structure (just like the one that universe@114: # is generated for HTML Help). For this to work a browser that supports universe@114: # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). universe@114: # Windows users are probably better off using the HTML help feature. universe@114: # Since the tree basically has the same information as the tab index you universe@114: # could consider to set DISABLE_INDEX to NO when enabling this option. universe@114: universe@114: GENERATE_TREEVIEW = NO universe@114: universe@114: # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values universe@114: # (range [0,1..20]) that doxygen will group on one line in the generated HTML universe@114: # documentation. Note that a value of 0 will completely suppress the enum universe@114: # values from appearing in the overview section. universe@114: universe@114: ENUM_VALUES_PER_LINE = 4 universe@114: universe@114: universe@114: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be universe@114: # used to set the initial width (in pixels) of the frame in which the tree universe@114: # is shown. universe@114: universe@114: TREEVIEW_WIDTH = 250 universe@114: universe@114: # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open universe@114: # links to external symbols imported via tag files in a separate window. universe@114: universe@114: EXT_LINKS_IN_WINDOW = NO universe@114: universe@114: # Use this tag to change the font size of Latex formulas included universe@114: # as images in the HTML documentation. The default is 10. Note that universe@114: # when you change the font size after a successful doxygen run you need universe@114: # to manually remove any form_*.png images from the HTML output directory universe@114: # to force them to be regenerated. universe@114: universe@114: FORMULA_FONTSIZE = 10 universe@114: universe@114: # Use the FORMULA_TRANPARENT tag to determine whether or not the images universe@114: # generated for formulas are transparent PNGs. Transparent PNGs are universe@114: # not supported properly for IE 6.0, but are supported on all modern browsers. universe@114: # Note that when changing this option you need to delete any form_*.png files universe@114: # in the HTML output before the changes have effect. universe@114: universe@114: FORMULA_TRANSPARENT = YES universe@114: universe@114: # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax universe@114: # (see http://www.mathjax.org) which uses client side Javascript for the universe@114: # rendering instead of using prerendered bitmaps. Use this if you do not universe@114: # have LaTeX installed or if you want to formulas look prettier in the HTML universe@114: # output. When enabled you also need to install MathJax separately and universe@114: # configure the path to it using the MATHJAX_RELPATH option. universe@114: universe@114: USE_MATHJAX = NO universe@114: universe@114: # When MathJax is enabled you need to specify the location relative to the universe@114: # HTML output directory using the MATHJAX_RELPATH option. The destination universe@114: # directory should contain the MathJax.js script. For instance, if the mathjax universe@114: # directory is located at the same level as the HTML output directory, then universe@114: # MATHJAX_RELPATH should be ../mathjax. The default value points to the universe@114: # mathjax.org site, so you can quickly see the result without installing universe@114: # MathJax, but it is strongly recommended to install a local copy of MathJax universe@114: # before deployment. universe@114: universe@114: MATHJAX_RELPATH = http://www.mathjax.org/mathjax universe@114: universe@114: # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension universe@114: # names that should be enabled during MathJax rendering. universe@114: universe@114: MATHJAX_EXTENSIONS = universe@114: universe@114: # When the SEARCHENGINE tag is enabled doxygen will generate a search box universe@114: # for the HTML output. The underlying search engine uses javascript universe@114: # and DHTML and should work on any modern browser. Note that when using universe@114: # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets universe@114: # (GENERATE_DOCSET) there is already a search function so this one should universe@114: # typically be disabled. For large projects the javascript based search engine universe@114: # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. universe@114: universe@114: SEARCHENGINE = YES universe@114: universe@114: # When the SERVER_BASED_SEARCH tag is enabled the search engine will be universe@114: # implemented using a PHP enabled web server instead of at the web client universe@114: # using Javascript. Doxygen will generate the search PHP script and index universe@114: # file to put on the web server. The advantage of the server universe@114: # based approach is that it scales better to large projects and allows universe@114: # full text search. The disadvantages are that it is more difficult to setup universe@114: # and does not have live searching capabilities. universe@114: universe@114: SERVER_BASED_SEARCH = NO universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to the LaTeX output universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will universe@114: # generate Latex output. universe@114: universe@114: GENERATE_LATEX = NO universe@114: universe@114: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. universe@114: # If a relative path is entered the value of OUTPUT_DIRECTORY will be universe@114: # put in front of it. If left blank `latex' will be used as the default path. universe@114: universe@114: LATEX_OUTPUT = latex universe@114: universe@114: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be universe@114: # invoked. If left blank `latex' will be used as the default command name. universe@114: # Note that when enabling USE_PDFLATEX this option is only used for universe@114: # generating bitmaps for formulas in the HTML output, but not in the universe@114: # Makefile that is written to the output directory. universe@114: universe@114: LATEX_CMD_NAME = latex universe@114: universe@114: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to universe@114: # generate index for LaTeX. If left blank `makeindex' will be used as the universe@114: # default command name. universe@114: universe@114: MAKEINDEX_CMD_NAME = makeindex universe@114: universe@114: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact universe@114: # LaTeX documents. This may be useful for small projects and may help to universe@114: # save some trees in general. universe@114: universe@114: COMPACT_LATEX = NO universe@114: universe@114: # The PAPER_TYPE tag can be used to set the paper type that is used universe@114: # by the printer. Possible values are: a4, letter, legal and universe@114: # executive. If left blank a4wide will be used. universe@114: universe@114: PAPER_TYPE = a4 universe@114: universe@114: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX universe@114: # packages that should be included in the LaTeX output. universe@114: universe@114: EXTRA_PACKAGES = universe@114: universe@114: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for universe@114: # the generated latex document. The header should contain everything until universe@114: # the first chapter. If it is left blank doxygen will generate a universe@114: # standard header. Notice: only use this tag if you know what you are doing! universe@114: universe@114: LATEX_HEADER = universe@114: universe@114: # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for universe@114: # the generated latex document. The footer should contain everything after universe@114: # the last chapter. If it is left blank doxygen will generate a universe@114: # standard footer. Notice: only use this tag if you know what you are doing! universe@114: universe@114: LATEX_FOOTER = universe@114: universe@114: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated universe@114: # is prepared for conversion to pdf (using ps2pdf). The pdf file will universe@114: # contain links (just like the HTML output) instead of page references universe@114: # This makes the output suitable for online browsing using a pdf viewer. universe@114: universe@114: PDF_HYPERLINKS = YES universe@114: universe@114: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of universe@114: # plain latex in the generated Makefile. Set this option to YES to get a universe@114: # higher quality PDF documentation. universe@114: universe@114: USE_PDFLATEX = YES universe@114: universe@114: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. universe@114: # command to the generated LaTeX files. This will instruct LaTeX to keep universe@114: # running if errors occur, instead of asking the user for help. universe@114: # This option is also used when generating formulas in HTML. universe@114: universe@114: LATEX_BATCHMODE = NO universe@114: universe@114: # If LATEX_HIDE_INDICES is set to YES then doxygen will not universe@114: # include the index chapters (such as File Index, Compound Index, etc.) universe@114: # in the output. universe@114: universe@114: LATEX_HIDE_INDICES = NO universe@114: universe@114: # If LATEX_SOURCE_CODE is set to YES then doxygen will include universe@114: # source code with syntax highlighting in the LaTeX output. universe@114: # Note that which sources are shown also depends on other settings universe@114: # such as SOURCE_BROWSER. universe@114: universe@114: LATEX_SOURCE_CODE = NO universe@114: universe@114: # The LATEX_BIB_STYLE tag can be used to specify the style to use for the universe@114: # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See universe@114: # http://en.wikipedia.org/wiki/BibTeX for more info. universe@114: universe@114: LATEX_BIB_STYLE = plain universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to the RTF output universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output universe@114: # The RTF output is optimized for Word 97 and may not look very pretty with universe@114: # other RTF readers or editors. universe@114: universe@114: GENERATE_RTF = NO universe@114: universe@114: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. universe@114: # If a relative path is entered the value of OUTPUT_DIRECTORY will be universe@114: # put in front of it. If left blank `rtf' will be used as the default path. universe@114: universe@114: RTF_OUTPUT = rtf universe@114: universe@114: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact universe@114: # RTF documents. This may be useful for small projects and may help to universe@114: # save some trees in general. universe@114: universe@114: COMPACT_RTF = NO universe@114: universe@114: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated universe@114: # will contain hyperlink fields. The RTF file will universe@114: # contain links (just like the HTML output) instead of page references. universe@114: # This makes the output suitable for online browsing using WORD or other universe@114: # programs which support those fields. universe@114: # Note: wordpad (write) and others do not support links. universe@114: universe@114: RTF_HYPERLINKS = NO universe@114: universe@114: # Load style sheet definitions from file. Syntax is similar to doxygen's universe@114: # config file, i.e. a series of assignments. You only have to provide universe@114: # replacements, missing definitions are set to their default value. universe@114: universe@114: RTF_STYLESHEET_FILE = universe@114: universe@114: # Set optional variables used in the generation of an rtf document. universe@114: # Syntax is similar to doxygen's config file. universe@114: universe@114: RTF_EXTENSIONS_FILE = universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to the man page output universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will universe@114: # generate man pages universe@114: universe@115: GENERATE_MAN = YES universe@114: universe@114: # The MAN_OUTPUT tag is used to specify where the man pages will be put. universe@114: # If a relative path is entered the value of OUTPUT_DIRECTORY will be universe@114: # put in front of it. If left blank `man' will be used as the default path. universe@114: universe@114: MAN_OUTPUT = man universe@114: universe@114: # The MAN_EXTENSION tag determines the extension that is added to universe@114: # the generated man pages (default is the subroutine's section .3) universe@114: universe@114: MAN_EXTENSION = .3 universe@114: universe@114: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, universe@114: # then it will generate one additional man file for each entity universe@114: # documented in the real man page(s). These additional files universe@114: # only source the real man page, but without them the man command universe@114: # would be unable to find the correct page. The default is NO. universe@114: universe@114: MAN_LINKS = NO universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to the XML output universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the GENERATE_XML tag is set to YES Doxygen will universe@114: # generate an XML file that captures the structure of universe@114: # the code including all documentation. universe@114: universe@114: GENERATE_XML = NO universe@114: universe@114: # The XML_OUTPUT tag is used to specify where the XML pages will be put. universe@114: # If a relative path is entered the value of OUTPUT_DIRECTORY will be universe@114: # put in front of it. If left blank `xml' will be used as the default path. universe@114: universe@114: XML_OUTPUT = xml universe@114: universe@114: # The XML_SCHEMA tag can be used to specify an XML schema, universe@114: # which can be used by a validating XML parser to check the universe@114: # syntax of the XML files. universe@114: universe@114: XML_SCHEMA = universe@114: universe@114: # The XML_DTD tag can be used to specify an XML DTD, universe@114: # which can be used by a validating XML parser to check the universe@114: # syntax of the XML files. universe@114: universe@114: XML_DTD = universe@114: universe@114: # If the XML_PROGRAMLISTING tag is set to YES Doxygen will universe@114: # dump the program listings (including syntax highlighting universe@114: # and cross-referencing information) to the XML output. Note that universe@114: # enabling this will significantly increase the size of the XML output. universe@114: universe@114: XML_PROGRAMLISTING = YES universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options for the AutoGen Definitions output universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will universe@114: # generate an AutoGen Definitions (see autogen.sf.net) file universe@114: # that captures the structure of the code including all universe@114: # documentation. Note that this feature is still experimental universe@114: # and incomplete at the moment. universe@114: universe@114: GENERATE_AUTOGEN_DEF = NO universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # configuration options related to the Perl module output universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the GENERATE_PERLMOD tag is set to YES Doxygen will universe@114: # generate a Perl module file that captures the structure of universe@114: # the code including all documentation. Note that this universe@114: # feature is still experimental and incomplete at the universe@114: # moment. universe@114: universe@114: GENERATE_PERLMOD = NO universe@114: universe@114: # If the PERLMOD_LATEX tag is set to YES Doxygen will generate universe@114: # the necessary Makefile rules, Perl scripts and LaTeX code to be able universe@114: # to generate PDF and DVI output from the Perl module output. universe@114: universe@114: PERLMOD_LATEX = NO universe@114: universe@114: # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be universe@114: # nicely formatted so it can be parsed by a human reader. universe@114: # This is useful universe@114: # if you want to understand what is going on. universe@114: # On the other hand, if this universe@114: # tag is set to NO the size of the Perl module output will be much smaller universe@114: # and Perl will parse it just the same. universe@114: universe@114: PERLMOD_PRETTY = YES universe@114: universe@114: # The names of the make variables in the generated doxyrules.make file universe@114: # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. universe@114: # This is useful so different doxyrules.make files included by the same universe@114: # Makefile don't overwrite each other's variables. universe@114: universe@114: PERLMOD_MAKEVAR_PREFIX = universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # Configuration options related to the preprocessor universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will universe@114: # evaluate all C-preprocessor directives found in the sources and include universe@114: # files. universe@114: universe@114: ENABLE_PREPROCESSING = YES universe@114: universe@114: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro universe@114: # names in the source code. If set to NO (the default) only conditional universe@114: # compilation will be performed. Macro expansion can be done in a controlled universe@114: # way by setting EXPAND_ONLY_PREDEF to YES. universe@114: universe@114: MACRO_EXPANSION = NO universe@114: universe@114: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES universe@114: # then the macro expansion is limited to the macros specified with the universe@114: # PREDEFINED and EXPAND_AS_DEFINED tags. universe@114: universe@114: EXPAND_ONLY_PREDEF = NO universe@114: universe@114: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files universe@114: # pointed to by INCLUDE_PATH will be searched when a #include is found. universe@114: universe@114: SEARCH_INCLUDES = YES universe@114: universe@114: # The INCLUDE_PATH tag can be used to specify one or more directories that universe@114: # contain include files that are not input files but should be processed by universe@114: # the preprocessor. universe@114: universe@114: INCLUDE_PATH = universe@114: universe@114: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard universe@114: # patterns (like *.h and *.hpp) to filter out the header-files in the universe@114: # directories. If left blank, the patterns specified with FILE_PATTERNS will universe@114: # be used. universe@114: universe@114: INCLUDE_FILE_PATTERNS = universe@114: universe@114: # The PREDEFINED tag can be used to specify one or more macro names that universe@114: # are defined before the preprocessor is started (similar to the -D option of universe@114: # gcc). The argument of the tag is a list of macros of the form: name universe@114: # or name=definition (no spaces). If the definition and the = are universe@114: # omitted =1 is assumed. To prevent a macro definition from being universe@114: # undefined via #undef or recursively expanded use the := operator universe@114: # instead of the = operator. universe@114: universe@114: PREDEFINED = universe@114: universe@114: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then universe@114: # this tag can be used to specify a list of macro names that should be expanded. universe@114: # The macro definition that is found in the sources will be used. universe@114: # Use the PREDEFINED tag if you want to use a different macro definition that universe@114: # overrules the definition found in the source code. universe@114: universe@114: EXPAND_AS_DEFINED = universe@114: universe@114: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then universe@114: # doxygen's preprocessor will remove all references to function-like macros universe@114: # that are alone on a line, have an all uppercase name, and do not end with a universe@114: # semicolon, because these will confuse the parser if not removed. universe@114: universe@114: SKIP_FUNCTION_MACROS = YES universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # Configuration::additions related to external references universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # The TAGFILES option can be used to specify one or more tagfiles. universe@114: # Optionally an initial location of the external documentation universe@114: # can be added for each tagfile. The format of a tag file without universe@114: # this location is as follows: universe@114: # universe@114: # TAGFILES = file1 file2 ... universe@114: # Adding location for the tag files is done as follows: universe@114: # universe@114: # TAGFILES = file1=loc1 "file2 = loc2" ... universe@114: # where "loc1" and "loc2" can be relative or absolute paths or universe@114: # URLs. If a location is present for each tag, the installdox tool universe@114: # does not have to be run to correct the links. universe@114: # Note that each tag file must have a unique name universe@114: # (where the name does NOT include the path) universe@114: # If a tag file is not located in the directory in which doxygen universe@114: # is run, you must also specify the path to the tagfile here. universe@114: universe@114: TAGFILES = universe@114: universe@114: # When a file name is specified after GENERATE_TAGFILE, doxygen will create universe@114: # a tag file that is based on the input files it reads. universe@114: universe@114: GENERATE_TAGFILE = universe@114: universe@114: # If the ALLEXTERNALS tag is set to YES all external classes will be listed universe@114: # in the class index. If set to NO only the inherited external classes universe@114: # will be listed. universe@114: universe@114: ALLEXTERNALS = NO universe@114: universe@114: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed universe@114: # in the modules index. If set to NO, only the current project's groups will universe@114: # be listed. universe@114: universe@114: EXTERNAL_GROUPS = YES universe@114: universe@114: # The PERL_PATH should be the absolute path and name of the perl script universe@114: # interpreter (i.e. the result of `which perl'). universe@114: universe@114: PERL_PATH = /usr/bin/perl universe@114: universe@114: #--------------------------------------------------------------------------- universe@114: # Configuration options related to the dot tool universe@114: #--------------------------------------------------------------------------- universe@114: universe@114: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will universe@114: # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base universe@114: # or super classes. Setting the tag to NO turns the diagrams off. Note that universe@114: # this option also works with HAVE_DOT disabled, but it is recommended to universe@114: # install and use dot, since it yields more powerful graphs. universe@114: universe@114: CLASS_DIAGRAMS = YES universe@114: universe@114: # You can define message sequence charts within doxygen comments using the \msc universe@114: # command. Doxygen will then run the mscgen tool (see universe@114: # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the universe@114: # documentation. The MSCGEN_PATH tag allows you to specify the directory where universe@114: # the mscgen tool resides. If left empty the tool is assumed to be found in the universe@114: # default search path. universe@114: universe@114: MSCGEN_PATH = universe@114: universe@114: # If set to YES, the inheritance and collaboration graphs will hide universe@114: # inheritance and usage relations if the target is undocumented universe@114: # or is not a class. universe@114: universe@114: HIDE_UNDOC_RELATIONS = YES universe@114: universe@114: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is universe@114: # available from the path. This tool is part of Graphviz, a graph visualization universe@114: # toolkit from AT&T and Lucent Bell Labs. The other options in this section universe@114: # have no effect if this option is set to NO (the default) universe@114: universe@114: HAVE_DOT = NO universe@114: universe@114: # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is universe@114: # allowed to run in parallel. When set to 0 (the default) doxygen will universe@114: # base this on the number of processors available in the system. You can set it universe@114: # explicitly to a value larger than 0 to get control over the balance universe@114: # between CPU load and processing speed. universe@114: universe@114: DOT_NUM_THREADS = 0 universe@114: universe@114: # By default doxygen will use the Helvetica font for all dot files that universe@114: # doxygen generates. When you want a differently looking font you can specify universe@114: # the font name using DOT_FONTNAME. You need to make sure dot is able to find universe@114: # the font, which can be done by putting it in a standard location or by setting universe@114: # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the universe@114: # directory containing the font. universe@114: universe@114: DOT_FONTNAME = Helvetica universe@114: universe@114: # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. universe@114: # The default size is 10pt. universe@114: universe@114: DOT_FONTSIZE = 10 universe@114: universe@114: # By default doxygen will tell dot to use the Helvetica font. universe@114: # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to universe@114: # set the path where dot can find it. universe@114: universe@114: DOT_FONTPATH = universe@114: universe@114: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen universe@114: # will generate a graph for each documented class showing the direct and universe@114: # indirect inheritance relations. Setting this tag to YES will force the universe@114: # CLASS_DIAGRAMS tag to NO. universe@114: universe@114: CLASS_GRAPH = YES universe@114: universe@114: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen universe@114: # will generate a graph for each documented class showing the direct and universe@114: # indirect implementation dependencies (inheritance, containment, and universe@114: # class references variables) of the class with other documented classes. universe@114: universe@114: COLLABORATION_GRAPH = YES universe@114: universe@114: # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen universe@114: # will generate a graph for groups, showing the direct groups dependencies universe@114: universe@114: GROUP_GRAPHS = YES universe@114: universe@114: # If the UML_LOOK tag is set to YES doxygen will generate inheritance and universe@114: # collaboration diagrams in a style similar to the OMG's Unified Modeling universe@114: # Language. universe@114: universe@114: UML_LOOK = NO universe@114: universe@114: # If set to YES, the inheritance and collaboration graphs will show the universe@114: # relations between templates and their instances. universe@114: universe@114: TEMPLATE_RELATIONS = NO universe@114: universe@114: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT universe@114: # tags are set to YES then doxygen will generate a graph for each documented universe@114: # file showing the direct and indirect include dependencies of the file with universe@114: # other documented files. universe@114: universe@114: INCLUDE_GRAPH = YES universe@114: universe@114: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and universe@114: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each universe@114: # documented header file showing the documented files that directly or universe@114: # indirectly include this file. universe@114: universe@114: INCLUDED_BY_GRAPH = YES universe@114: universe@114: # If the CALL_GRAPH and HAVE_DOT options are set to YES then universe@114: # doxygen will generate a call dependency graph for every global function universe@114: # or class method. Note that enabling this option will significantly increase universe@114: # the time of a run. So in most cases it will be better to enable call graphs universe@114: # for selected functions only using the \callgraph command. universe@114: universe@114: CALL_GRAPH = NO universe@114: universe@114: # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then universe@114: # doxygen will generate a caller dependency graph for every global function universe@114: # or class method. Note that enabling this option will significantly increase universe@114: # the time of a run. So in most cases it will be better to enable caller universe@114: # graphs for selected functions only using the \callergraph command. universe@114: universe@114: CALLER_GRAPH = NO universe@114: universe@114: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen universe@114: # will generate a graphical hierarchy of all classes instead of a textual one. universe@114: universe@114: GRAPHICAL_HIERARCHY = YES universe@114: universe@114: # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES universe@114: # then doxygen will show the dependencies a directory has on other directories universe@114: # in a graphical way. The dependency relations are determined by the #include universe@114: # relations between the files in the directories. universe@114: universe@114: DIRECTORY_GRAPH = YES universe@114: universe@114: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images universe@114: # generated by dot. Possible values are svg, png, jpg, or gif. universe@114: # If left blank png will be used. If you choose svg you need to set universe@114: # HTML_FILE_EXTENSION to xhtml in order to make the SVG files universe@114: # visible in IE 9+ (other browsers do not have this requirement). universe@114: universe@114: DOT_IMAGE_FORMAT = png universe@114: universe@114: # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to universe@114: # enable generation of interactive SVG images that allow zooming and panning. universe@114: # Note that this requires a modern browser other than Internet Explorer. universe@114: # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you universe@114: # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files universe@114: # visible. Older versions of IE do not have SVG support. universe@114: universe@114: INTERACTIVE_SVG = NO universe@114: universe@114: # The tag DOT_PATH can be used to specify the path where the dot tool can be universe@114: # found. If left blank, it is assumed the dot tool can be found in the path. universe@114: universe@114: DOT_PATH = universe@114: universe@114: # The DOTFILE_DIRS tag can be used to specify one or more directories that universe@114: # contain dot files that are included in the documentation (see the universe@114: # \dotfile command). universe@114: universe@114: DOTFILE_DIRS = universe@114: universe@114: # The MSCFILE_DIRS tag can be used to specify one or more directories that universe@114: # contain msc files that are included in the documentation (see the universe@114: # \mscfile command). universe@114: universe@114: MSCFILE_DIRS = universe@114: universe@114: # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of universe@114: # nodes that will be shown in the graph. If the number of nodes in a graph universe@114: # becomes larger than this value, doxygen will truncate the graph, which is universe@114: # visualized by representing a node as a red box. Note that doxygen if the universe@114: # number of direct children of the root node in a graph is already larger than universe@114: # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note universe@114: # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. universe@114: universe@114: DOT_GRAPH_MAX_NODES = 50 universe@114: universe@114: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the universe@114: # graphs generated by dot. A depth value of 3 means that only nodes reachable universe@114: # from the root by following a path via at most 3 edges will be shown. Nodes universe@114: # that lay further from the root node will be omitted. Note that setting this universe@114: # option to 1 or 2 may greatly reduce the computation time needed for large universe@114: # code bases. Also note that the size of a graph can be further restricted by universe@114: # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. universe@114: universe@114: MAX_DOT_GRAPH_DEPTH = 0 universe@114: universe@114: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent universe@114: # background. This is disabled by default, because dot on Windows does not universe@114: # seem to support this out of the box. Warning: Depending on the platform used, universe@114: # enabling this option may lead to badly anti-aliased labels on the edges of universe@114: # a graph (i.e. they become hard to read). universe@114: universe@114: DOT_TRANSPARENT = NO universe@114: universe@114: # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output universe@114: # files in one run (i.e. multiple -o and -T options on the command line). This universe@114: # makes dot run faster, but since only newer versions of dot (>1.8.10) universe@114: # support this, this feature is disabled by default. universe@114: universe@114: DOT_MULTI_TARGETS = YES universe@114: universe@114: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will universe@114: # generate a legend page explaining the meaning of the various boxes and universe@114: # arrows in the dot generated graphs. universe@114: universe@114: GENERATE_LEGEND = YES universe@114: universe@114: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will universe@114: # remove the intermediate dot files that are used to generate universe@114: # the various graphs. universe@114: universe@114: DOT_CLEANUP = YES