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