joachim99@14: # Doxyfile 1.2.15 joachim99@14: joachim99@14: # This file describes the settings to be used by the documentation system joachim99@14: # doxygen (www.doxygen.org) for a project joachim99@14: # joachim99@14: # All text after a hash (#) is considered a comment and will be ignored joachim99@14: # The format is: joachim99@14: # TAG = value [value, ...] joachim99@14: # For lists items can also be appended using: joachim99@14: # TAG += value [value, ...] joachim99@14: # Values that contain spaces should be placed between quotes (" ") joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # General configuration options joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded joachim99@14: # by quotes) that should identify the project. joachim99@14: joachim99@14: PROJECT_NAME = joachim99@14: joachim99@14: # The PROJECT_NUMBER tag can be used to enter a project or revision number. joachim99@14: # This could be handy for archiving the generated documentation or joachim99@14: # if some version control system is used. joachim99@14: joachim99@14: PROJECT_NUMBER = joachim99@14: joachim99@14: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) joachim99@14: # base path where the generated documentation will be put. joachim99@14: # If a relative path is entered, it will be relative to the location joachim99@14: # where doxygen was started. If left blank the current directory will be used. joachim99@14: joachim99@14: OUTPUT_DIRECTORY = ../apidocs/ joachim99@14: joachim99@14: # The OUTPUT_LANGUAGE tag is used to specify the language in which all joachim99@14: # documentation generated by doxygen is written. Doxygen will use this joachim99@14: # information to generate all constant output in the proper language. joachim99@14: # The default language is English, other supported languages are: joachim99@14: # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, joachim99@14: # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, joachim99@14: # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish. joachim99@14: joachim99@14: OUTPUT_LANGUAGE = English joachim99@14: joachim99@14: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in joachim99@14: # documentation are documented, even if no documentation was available. joachim99@14: # Private class members and static file members will be hidden unless joachim99@14: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES joachim99@14: joachim99@14: EXTRACT_ALL = NO joachim99@14: joachim99@14: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class joachim99@14: # will be included in the documentation. joachim99@14: joachim99@14: EXTRACT_PRIVATE = NO joachim99@14: joachim99@14: # If the EXTRACT_STATIC tag is set to YES all static members of a file joachim99@14: # will be included in the documentation. joachim99@14: joachim99@14: EXTRACT_STATIC = YES joachim99@14: joachim99@14: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) joachim99@14: # defined locally in source files will be included in the documentation. joachim99@14: # If set to NO only classes defined in header files are included. joachim99@14: joachim99@14: EXTRACT_LOCAL_CLASSES = NO joachim99@14: joachim99@14: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all joachim99@14: # undocumented members of documented classes, files or namespaces. joachim99@14: # If set to NO (the default) these members will be included in the joachim99@14: # various overviews, but no documentation section is generated. joachim99@14: # This option has no effect if EXTRACT_ALL is enabled. joachim99@14: joachim99@14: HIDE_UNDOC_MEMBERS = NO joachim99@14: joachim99@14: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all joachim99@14: # undocumented classes that are normally visible in the class hierarchy. joachim99@14: # If set to NO (the default) these class will be included in the various joachim99@14: # overviews. This option has no effect if EXTRACT_ALL is enabled. joachim99@14: joachim99@14: HIDE_UNDOC_CLASSES = YES joachim99@14: joachim99@14: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will joachim99@14: # include brief member descriptions after the members that are listed in joachim99@14: # the file and class documentation (similar to JavaDoc). joachim99@14: # Set to NO to disable this. joachim99@14: joachim99@14: BRIEF_MEMBER_DESC = NO joachim99@14: joachim99@14: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend joachim99@14: # the brief description of a member or function before the detailed description. joachim99@14: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the joachim99@14: # brief descriptions will be completely suppressed. joachim99@14: joachim99@14: REPEAT_BRIEF = YES joachim99@14: joachim99@14: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then joachim99@14: # Doxygen will generate a detailed section even if there is only a brief joachim99@14: # description. joachim99@14: joachim99@14: ALWAYS_DETAILED_SEC = YES joachim99@14: joachim99@14: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited joachim99@14: # members of a class in the documentation of that class as if those members were joachim99@14: # ordinary class members. Constructors, destructors and assignment operators of joachim99@14: # the base classes will not be shown. joachim99@14: joachim99@14: INLINE_INHERITED_MEMB = NO joachim99@14: joachim99@14: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full joachim99@14: # path before files name in the file list and in the header files. If set joachim99@14: # to NO the shortest path that makes the file name unique will be used. joachim99@14: joachim99@14: FULL_PATH_NAMES = NO joachim99@14: joachim99@14: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag joachim99@14: # can be used to strip a user defined part of the path. Stripping is joachim99@14: # only done if one of the specified strings matches the left-hand part of joachim99@14: # the path. It is allowed to use relative paths in the argument list. joachim99@14: joachim99@14: STRIP_FROM_PATH = joachim99@14: joachim99@14: # The INTERNAL_DOCS tag determines if documentation joachim99@14: # that is typed after a \internal command is included. If the tag is set joachim99@14: # to NO (the default) then the documentation will be excluded. joachim99@14: # Set it to YES to include the internal documentation. joachim99@14: joachim99@14: INTERNAL_DOCS = NO joachim99@14: joachim99@14: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct joachim99@14: # doxygen to hide any special comment blocks from generated source code joachim99@14: # fragments. Normal C and C++ comments will always remain visible. joachim99@14: joachim99@14: STRIP_CODE_COMMENTS = YES joachim99@14: joachim99@14: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate joachim99@14: # file names in lower case letters. If set to YES upper case letters are also joachim99@14: # allowed. This is useful if you have classes or files whose names only differ joachim99@14: # in case and if your file system supports case sensitive file names. Windows joachim99@14: # users are adviced to set this option to NO. joachim99@14: joachim99@14: CASE_SENSE_NAMES = YES joachim99@14: joachim99@14: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter joachim99@14: # (but less readable) file names. This can be useful is your file systems joachim99@14: # doesn't support long names like on DOS, Mac, or CD-ROM. joachim99@14: joachim99@14: SHORT_NAMES = NO joachim99@14: joachim99@14: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen joachim99@14: # will show members with their full class and namespace scopes in the joachim99@14: # documentation. If set to YES the scope will be hidden. joachim99@14: joachim99@14: HIDE_SCOPE_NAMES = NO joachim99@14: joachim99@14: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen joachim99@14: # will generate a verbatim copy of the header file for each class for joachim99@14: # which an include is specified. Set to NO to disable this. joachim99@14: joachim99@14: VERBATIM_HEADERS = YES joachim99@14: joachim99@14: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen joachim99@14: # will put list of the files that are included by a file in the documentation joachim99@14: # of that file. joachim99@14: joachim99@14: SHOW_INCLUDE_FILES = YES joachim99@14: joachim99@14: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen joachim99@14: # will interpret the first line (until the first dot) of a JavaDoc-style joachim99@14: # comment as the brief description. If set to NO, the JavaDoc joachim99@14: # comments will behave just like the Qt-style comments (thus requiring an joachim99@14: # explict @brief command for a brief description. joachim99@14: joachim99@14: JAVADOC_AUTOBRIEF = YES joachim99@14: joachim99@14: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented joachim99@14: # member inherits the documentation from any documented member that it joachim99@14: # reimplements. joachim99@14: joachim99@14: INHERIT_DOCS = YES joachim99@14: joachim99@14: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] joachim99@14: # is inserted in the documentation for inline members. joachim99@14: joachim99@14: INLINE_INFO = YES joachim99@14: joachim99@14: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen joachim99@14: # will sort the (detailed) documentation of file and class members joachim99@14: # alphabetically by member name. If set to NO the members will appear in joachim99@14: # declaration order. joachim99@14: joachim99@14: SORT_MEMBER_DOCS = NO joachim99@14: joachim99@14: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC joachim99@14: # tag is set to YES, then doxygen will reuse the documentation of the first joachim99@14: # member in the group (if any) for the other members of the group. By default joachim99@14: # all members of a group must be documented explicitly. joachim99@14: joachim99@14: DISTRIBUTE_GROUP_DOC = NO joachim99@14: joachim99@14: # The TAB_SIZE tag can be used to set the number of spaces in a tab. joachim99@14: # Doxygen uses this value to replace tabs by spaces in code fragments. joachim99@14: joachim99@14: TAB_SIZE = 4 joachim99@14: joachim99@14: # The GENERATE_TODOLIST tag can be used to enable (YES) or joachim99@14: # disable (NO) the todo list. This list is created by putting \todo joachim99@14: # commands in the documentation. joachim99@14: joachim99@14: GENERATE_TODOLIST = NO joachim99@14: joachim99@14: # The GENERATE_TESTLIST tag can be used to enable (YES) or joachim99@14: # disable (NO) the test list. This list is created by putting \test joachim99@14: # commands in the documentation. joachim99@14: joachim99@14: GENERATE_TESTLIST = NO joachim99@14: joachim99@14: # The GENERATE_BUGLIST tag can be used to enable (YES) or joachim99@14: # disable (NO) the bug list. This list is created by putting \bug joachim99@14: # commands in the documentation. joachim99@14: joachim99@14: GENERATE_BUGLIST = YES joachim99@14: joachim99@14: # This tag can be used to specify a number of aliases that acts joachim99@14: # as commands in the documentation. An alias has the form "name=value". joachim99@14: # For example adding "sideeffect=\par Side Effects:\n" will allow you to joachim99@14: # put the command \sideeffect (or @sideeffect) in the documentation, which joachim99@14: # will result in a user defined paragraph with heading "Side Effects:". joachim99@14: # You can put \n's in the value part of an alias to insert newlines. joachim99@14: joachim99@14: # @ref in KDE docu are for kdoc, doxygen doesn't need them, so we alias them joachim99@14: # to nothing here joachim99@14: joachim99@14: ALIASES = libdoc=@mainpage \ joachim99@14: sect=

\ joachim99@14: reimplemented= \ joachim99@14: "deprecated=This class or method is obsolete, it is provided for compatibility only." \ joachim99@14: obsolete=@deprecated \ joachim99@14: ref= joachim99@14: joachim99@14: # The ENABLED_SECTIONS tag can be used to enable conditional joachim99@14: # documentation sections, marked by \if sectionname ... \endif. joachim99@14: joachim99@14: ENABLED_SECTIONS = joachim99@14: joachim99@14: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines joachim99@14: # the initial value of a variable or define consist of for it to appear in joachim99@14: # the documentation. If the initializer consists of more lines than specified joachim99@14: # here it will be hidden. Use a value of 0 to hide initializers completely. joachim99@14: # The appearance of the initializer of individual variables and defines in the joachim99@14: # documentation can be controlled using \showinitializer or \hideinitializer joachim99@14: # command in the documentation regardless of this setting. joachim99@14: joachim99@14: MAX_INITIALIZER_LINES = 30 joachim99@14: joachim99@14: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources joachim99@14: # only. Doxygen will then generate output that is more tailored for C. joachim99@14: # For instance some of the names that are used will be different. The list joachim99@14: # of all members will be omitted, etc. joachim99@14: joachim99@14: OPTIMIZE_OUTPUT_FOR_C = NO joachim99@14: joachim99@14: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources joachim99@14: # only. Doxygen will then generate output that is more tailored for Java. joachim99@14: # For instance namespaces will be presented as packages, qualified scopes joachim99@14: # will look different, etc. joachim99@14: joachim99@14: OPTIMIZE_OUTPUT_JAVA = NO joachim99@14: joachim99@14: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated joachim99@14: # at the bottom of the documentation of classes and structs. If set to YES the joachim99@14: # list will mention the files that were used to generate the documentation. joachim99@14: joachim99@14: SHOW_USED_FILES = YES joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to warning and progress messages joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # The QUIET tag can be used to turn on/off the messages that are generated joachim99@14: # by doxygen. Possible values are YES and NO. If left blank NO is used. joachim99@14: joachim99@14: QUIET = YES joachim99@14: joachim99@14: # The WARNINGS tag can be used to turn on/off the warning messages that are joachim99@14: # generated by doxygen. Possible values are YES and NO. If left blank joachim99@14: # NO is used. joachim99@14: joachim99@14: WARNINGS = YES joachim99@14: joachim99@14: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings joachim99@14: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will joachim99@14: # automatically be disabled. joachim99@14: joachim99@14: WARN_IF_UNDOCUMENTED = NO joachim99@14: joachim99@14: # The WARN_FORMAT tag determines the format of the warning messages that joachim99@14: # doxygen can produce. The string should contain the $file, $line, and $text joachim99@14: # tags, which will be replaced by the file and line number from which the joachim99@14: # warning originated and the warning text. joachim99@14: joachim99@14: WARN_FORMAT = joachim99@14: joachim99@14: # The WARN_LOGFILE tag can be used to specify a file to which warning joachim99@14: # and error messages should be written. If left blank the output is written joachim99@14: # to stderr. joachim99@14: joachim99@14: WARN_LOGFILE = joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to the input files joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # The INPUT tag can be used to specify the files and/or directories that contain joachim99@14: # documented source files. You may enter file names like "myfile.cpp" or joachim99@14: # directories like "/usr/src/myproject". Separate the files or directories joachim99@14: # with spaces. joachim99@14: joachim99@14: INPUT = joachim99@14: joachim99@14: # If the value of the INPUT tag contains directories, you can use the joachim99@14: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp joachim99@14: # and *.h) to filter out the source-files in the directories. If left joachim99@14: # blank the following patterns are tested: joachim99@14: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp joachim99@14: # *.h++ *.idl *.odl joachim99@14: joachim99@14: FILE_PATTERNS = *.h \ joachim99@14: *.cpp \ joachim99@14: *.cc \ joachim99@14: *.hpp joachim99@14: joachim99@14: # The RECURSIVE tag can be used to turn specify whether or not subdirectories joachim99@14: # should be searched for input files as well. Possible values are YES and NO. joachim99@14: # If left blank NO is used. joachim99@14: joachim99@14: RECURSIVE = YES joachim99@14: joachim99@14: # The EXCLUDE tag can be used to specify files and/or directories that should joachim99@14: # excluded from the INPUT source files. This way you can easily exclude a joachim99@14: # subdirectory from a directory tree whose root is specified with the INPUT tag. joachim99@14: joachim99@14: EXCLUDE = joachim99@14: joachim99@14: # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories joachim99@14: # that are symbolic links (a Unix filesystem feature) are excluded from the input. joachim99@14: joachim99@14: EXCLUDE_SYMLINKS = NO joachim99@14: joachim99@14: # If the value of the INPUT tag contains directories, you can use the joachim99@14: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude joachim99@14: # certain files from those directories. joachim99@14: joachim99@14: EXCLUDE_PATTERNS = *.moc.* \ joachim99@14: moc* \ joachim99@14: *.all_cpp.* \ joachim99@14: *unload.* \ joachim99@14: */test/* \ joachim99@14: */tests/* joachim99@14: joachim99@14: # The EXAMPLE_PATH tag can be used to specify one or more files or joachim99@14: # directories that contain example code fragments that are included (see joachim99@14: # the \include command). joachim99@14: joachim99@14: EXAMPLE_PATH = joachim99@14: joachim99@14: # If the value of the EXAMPLE_PATH tag contains directories, you can use the joachim99@14: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp joachim99@14: # and *.h) to filter out the source-files in the directories. If left joachim99@14: # blank all files are included. joachim99@14: joachim99@14: EXAMPLE_PATTERNS = joachim99@14: joachim99@14: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be joachim99@14: # searched for input files to be used with the \include or \dontinclude joachim99@14: # commands irrespective of the value of the RECURSIVE tag. joachim99@14: # Possible values are YES and NO. If left blank NO is used. joachim99@14: joachim99@14: EXAMPLE_RECURSIVE = NO joachim99@14: joachim99@14: # The IMAGE_PATH tag can be used to specify one or more files or joachim99@14: # directories that contain image that are included in the documentation (see joachim99@14: # the \image command). joachim99@14: joachim99@14: IMAGE_PATH = joachim99@14: joachim99@14: # The INPUT_FILTER tag can be used to specify a program that doxygen should joachim99@14: # invoke to filter for each input file. Doxygen will invoke the filter program joachim99@14: # by executing (via popen()) the command , where joachim99@14: # is the value of the INPUT_FILTER tag, and is the name of an joachim99@14: # input file. Doxygen will then use the output that the filter program writes joachim99@14: # to standard output. joachim99@14: joachim99@14: INPUT_FILTER = joachim99@14: joachim99@14: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using joachim99@14: # INPUT_FILTER) will be used to filter the input files when producing source joachim99@14: # files to browse. joachim99@14: joachim99@14: FILTER_SOURCE_FILES = NO joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to source browsing joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the SOURCE_BROWSER tag is set to YES then a list of source files will joachim99@14: # be generated. Documented entities will be cross-referenced with these sources. joachim99@14: joachim99@14: SOURCE_BROWSER = YES joachim99@14: joachim99@14: # Setting the INLINE_SOURCES tag to YES will include the body joachim99@14: # of functions and classes directly in the documentation. joachim99@14: joachim99@14: INLINE_SOURCES = NO joachim99@14: joachim99@14: # If the REFERENCED_BY_RELATION tag is set to YES (the default) joachim99@14: # then for each documented function all documented joachim99@14: # functions referencing it will be listed. joachim99@14: joachim99@14: REFERENCED_BY_RELATION = YES joachim99@14: joachim99@14: # If the REFERENCES_RELATION tag is set to YES (the default) joachim99@14: # then for each documented function all documented entities joachim99@14: # called/used by that function will be listed. joachim99@14: joachim99@14: REFERENCES_RELATION = YES joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to the alphabetical class index joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index joachim99@14: # of all compounds will be generated. Enable this if the project joachim99@14: # contains a lot of classes, structs, unions or interfaces. joachim99@14: joachim99@14: ALPHABETICAL_INDEX = YES joachim99@14: joachim99@14: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then joachim99@14: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns joachim99@14: # in which this list will be split (can be a number in the range [1..20]) joachim99@14: joachim99@14: COLS_IN_ALPHA_INDEX = 3 joachim99@14: joachim99@14: # In case all classes in a project start with a common prefix, all joachim99@14: # classes will be put under the same header in the alphabetical index. joachim99@14: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that joachim99@14: # should be ignored while generating the index headers. joachim99@14: joachim99@14: IGNORE_PREFIX = K joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to the HTML output joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will joachim99@14: # generate HTML output. joachim99@14: joachim99@14: GENERATE_HTML = NO joachim99@14: joachim99@14: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. joachim99@14: # If a relative path is entered the value of OUTPUT_DIRECTORY will be joachim99@14: # put in front of it. If left blank `html' will be used as the default path. joachim99@14: joachim99@14: HTML_OUTPUT = joachim99@14: joachim99@14: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for joachim99@14: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank joachim99@14: # doxygen will generate files with .html extension. joachim99@14: joachim99@14: HTML_FILE_EXTENSION = .html joachim99@14: joachim99@14: # The HTML_HEADER tag can be used to specify a personal HTML header for joachim99@14: # each generated HTML page. If it is left blank doxygen will generate a joachim99@14: # standard header. joachim99@14: joachim99@14: HTML_HEADER = ../apidocs/common/header.html joachim99@14: joachim99@14: # The HTML_FOOTER tag can be used to specify a personal HTML footer for joachim99@14: # each generated HTML page. If it is left blank doxygen will generate a joachim99@14: # standard footer. joachim99@14: joachim99@14: HTML_FOOTER = ../apidocs/common/footer.html joachim99@14: joachim99@14: # The HTML_STYLESHEET tag can be used to specify a user defined cascading joachim99@14: # style sheet that is used by each HTML page. It can be used to joachim99@14: # fine-tune the look of the HTML output. If the tag is left blank doxygen joachim99@14: # will generate a default style sheet joachim99@14: joachim99@14: HTML_STYLESHEET = ../apidocs/common/doxygen.css joachim99@14: joachim99@14: # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, joachim99@14: # files or namespaces will be aligned in HTML using tables. If set to joachim99@14: # NO a bullet list will be used. joachim99@14: joachim99@14: HTML_ALIGN_MEMBERS = YES joachim99@14: joachim99@14: # If the GENERATE_HTMLHELP tag is set to YES, additional index files joachim99@14: # will be generated that can be used as input for tools like the joachim99@14: # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) joachim99@14: # of the generated HTML documentation. joachim99@14: joachim99@14: GENERATE_HTMLHELP = NO joachim99@14: joachim99@14: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag joachim99@14: # controls if a separate .chi index file is generated (YES) or that joachim99@14: # it should be included in the master .chm file (NO). joachim99@14: joachim99@14: GENERATE_CHI = NO joachim99@14: joachim99@14: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag joachim99@14: # controls whether a binary table of contents is generated (YES) or a joachim99@14: # normal table of contents (NO) in the .chm file. joachim99@14: joachim99@14: BINARY_TOC = NO joachim99@14: joachim99@14: # The TOC_EXPAND flag can be set to YES to add extra items for group members joachim99@14: # to the contents of the Html help documentation and to the tree view. joachim99@14: joachim99@14: TOC_EXPAND = NO joachim99@14: joachim99@14: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at joachim99@14: # top of each HTML page. The value NO (the default) enables the index and joachim99@14: # the value YES disables it. joachim99@14: joachim99@14: DISABLE_INDEX = YES joachim99@14: joachim99@14: # This tag can be used to set the number of enum values (range [1..20]) joachim99@14: # that doxygen will group on one line in the generated HTML documentation. joachim99@14: joachim99@14: ENUM_VALUES_PER_LINE = 4 joachim99@14: joachim99@14: # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be joachim99@14: # generated containing a tree-like index structure (just like the one that joachim99@14: # is generated for HTML Help). For this to work a browser that supports joachim99@14: # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, joachim99@14: # or Internet explorer 4.0+). Note that for large projects the tree generation joachim99@14: # can take a very long time. In such cases it is better to disable this feature. joachim99@14: # Windows users are probably better off using the HTML help feature. joachim99@14: joachim99@14: GENERATE_TREEVIEW = NO joachim99@14: joachim99@14: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be joachim99@14: # used to set the initial width (in pixels) of the frame in which the tree joachim99@14: # is shown. joachim99@14: joachim99@14: TREEVIEW_WIDTH = 250 joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to the LaTeX output joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will joachim99@14: # generate Latex output. joachim99@14: joachim99@14: GENERATE_LATEX = NO joachim99@14: joachim99@14: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. joachim99@14: # If a relative path is entered the value of OUTPUT_DIRECTORY will be joachim99@14: # put in front of it. If left blank `latex' will be used as the default path. joachim99@14: joachim99@14: LATEX_OUTPUT = joachim99@14: joachim99@14: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name. joachim99@14: joachim99@14: LATEX_CMD_NAME = latex joachim99@14: joachim99@14: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to joachim99@14: # generate index for LaTeX. If left blank `makeindex' will be used as the joachim99@14: # default command name. joachim99@14: joachim99@14: MAKEINDEX_CMD_NAME = makeindex joachim99@14: joachim99@14: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact joachim99@14: # LaTeX documents. This may be useful for small projects and may help to joachim99@14: # save some trees in general. joachim99@14: joachim99@14: COMPACT_LATEX = NO joachim99@14: joachim99@14: # The PAPER_TYPE tag can be used to set the paper type that is used joachim99@14: # by the printer. Possible values are: a4, a4wide, letter, legal and joachim99@14: # executive. If left blank a4wide will be used. joachim99@14: joachim99@14: PAPER_TYPE = a4wide joachim99@14: joachim99@14: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX joachim99@14: # packages that should be included in the LaTeX output. joachim99@14: joachim99@14: EXTRA_PACKAGES = joachim99@14: joachim99@14: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for joachim99@14: # the generated latex document. The header should contain everything until joachim99@14: # the first chapter. If it is left blank doxygen will generate a joachim99@14: # standard header. Notice: only use this tag if you know what you are doing! joachim99@14: joachim99@14: LATEX_HEADER = joachim99@14: joachim99@14: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated joachim99@14: # is prepared for conversion to pdf (using ps2pdf). The pdf file will joachim99@14: # contain links (just like the HTML output) instead of page references joachim99@14: # This makes the output suitable for online browsing using a pdf viewer. joachim99@14: joachim99@14: PDF_HYPERLINKS = NO joachim99@14: joachim99@14: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of joachim99@14: # plain latex in the generated Makefile. Set this option to YES to get a joachim99@14: # higher quality PDF documentation. joachim99@14: joachim99@14: USE_PDFLATEX = NO joachim99@14: joachim99@14: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. joachim99@14: # command to the generated LaTeX files. This will instruct LaTeX to keep joachim99@14: # running if errors occur, instead of asking the user for help. joachim99@14: # This option is also used when generating formulas in HTML. joachim99@14: joachim99@14: LATEX_BATCHMODE = NO joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to the RTF output joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output joachim99@14: # The RTF output is optimised for Word 97 and may not look very pretty with joachim99@14: # other RTF readers or editors. joachim99@14: joachim99@14: GENERATE_RTF = NO joachim99@14: joachim99@14: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. joachim99@14: # If a relative path is entered the value of OUTPUT_DIRECTORY will be joachim99@14: # put in front of it. If left blank `rtf' will be used as the default path. joachim99@14: joachim99@14: RTF_OUTPUT = joachim99@14: joachim99@14: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact joachim99@14: # RTF documents. This may be useful for small projects and may help to joachim99@14: # save some trees in general. joachim99@14: joachim99@14: COMPACT_RTF = NO joachim99@14: joachim99@14: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated joachim99@14: # will contain hyperlink fields. The RTF file will joachim99@14: # contain links (just like the HTML output) instead of page references. joachim99@14: # This makes the output suitable for online browsing using WORD or other joachim99@14: # programs which support those fields. joachim99@14: # Note: wordpad (write) and others do not support links. joachim99@14: joachim99@14: RTF_HYPERLINKS = NO joachim99@14: joachim99@14: # Load stylesheet definitions from file. Syntax is similar to doxygen's joachim99@14: # config file, i.e. a series of assigments. You only have to provide joachim99@14: # replacements, missing definitions are set to their default value. joachim99@14: joachim99@14: RTF_STYLESHEET_FILE = joachim99@14: joachim99@14: # Set optional variables used in the generation of an rtf document. joachim99@14: # Syntax is similar to doxygen's config file. joachim99@14: joachim99@14: RTF_EXTENSIONS_FILE = joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to the man page output joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will joachim99@14: # generate man pages joachim99@14: joachim99@14: GENERATE_MAN = NO joachim99@14: joachim99@14: # The MAN_OUTPUT tag is used to specify where the man pages will be put. joachim99@14: # If a relative path is entered the value of OUTPUT_DIRECTORY will be joachim99@14: # put in front of it. If left blank `man' will be used as the default path. joachim99@14: joachim99@14: MAN_OUTPUT = joachim99@14: joachim99@14: # The MAN_EXTENSION tag determines the extension that is added to joachim99@14: # the generated man pages (default is the subroutine's section .3) joachim99@14: joachim99@14: MAN_EXTENSION = .kde3 joachim99@14: joachim99@14: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, joachim99@14: # then it will generate one additional man file for each entity joachim99@14: # documented in the real man page(s). These additional files joachim99@14: # only source the real man page, but without them the man command joachim99@14: # would be unable to find the correct page. The default is NO. joachim99@14: joachim99@14: MAN_LINKS = YES joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options related to the XML output joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the GENERATE_XML tag is set to YES Doxygen will joachim99@14: # generate an XML file that captures the structure of joachim99@14: # the code including all documentation. Note that this joachim99@14: # feature is still experimental and incomplete at the joachim99@14: # moment. joachim99@14: joachim99@14: GENERATE_XML = NO joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # configuration options for the AutoGen Definitions output joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will joachim99@14: # generate an AutoGen Definitions (see autogen.sf.net) file joachim99@14: # that captures the structure of the code including all joachim99@14: # documentation. Note that this feature is still experimental joachim99@14: # and incomplete at the moment. joachim99@14: joachim99@14: GENERATE_AUTOGEN_DEF = NO joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # Configuration options related to the preprocessor joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will joachim99@14: # evaluate all C-preprocessor directives found in the sources and include joachim99@14: # files. joachim99@14: joachim99@14: ENABLE_PREPROCESSING = YES joachim99@14: joachim99@14: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro joachim99@14: # names in the source code. If set to NO (the default) only conditional joachim99@14: # compilation will be performed. Macro expansion can be done in a controlled joachim99@14: # way by setting EXPAND_ONLY_PREDEF to YES. joachim99@14: joachim99@14: MACRO_EXPANSION = NO joachim99@14: joachim99@14: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES joachim99@14: # then the macro expansion is limited to the macros specified with the joachim99@14: # PREDEFINED and EXPAND_AS_PREDEFINED tags. joachim99@14: joachim99@14: EXPAND_ONLY_PREDEF = NO joachim99@14: joachim99@14: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files joachim99@14: # in the INCLUDE_PATH (see below) will be search if a #include is found. joachim99@14: joachim99@14: SEARCH_INCLUDES = YES joachim99@14: joachim99@14: # The INCLUDE_PATH tag can be used to specify one or more directories that joachim99@14: # contain include files that are not input files but should be processed by joachim99@14: # the preprocessor. joachim99@14: joachim99@14: INCLUDE_PATH = joachim99@14: joachim99@14: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard joachim99@14: # patterns (like *.h and *.hpp) to filter out the header-files in the joachim99@14: # directories. If left blank, the patterns specified with FILE_PATTERNS will joachim99@14: # be used. joachim99@14: joachim99@14: INCLUDE_FILE_PATTERNS = joachim99@14: joachim99@14: # The PREDEFINED tag can be used to specify one or more macro names that joachim99@14: # are defined before the preprocessor is started (similar to the -D option of joachim99@14: # gcc). The argument of the tag is a list of macros of the form: name joachim99@14: # or name=definition (no spaces). If the definition and the = are joachim99@14: # omitted =1 is assumed. joachim99@14: joachim99@14: PREDEFINED = QT_VERSION=305 joachim99@14: joachim99@14: # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then joachim99@14: # this tag can be used to specify a list of macro names that should be expanded. joachim99@14: # The macro definition that is found in the sources will be used. joachim99@14: # Use the PREDEFINED tag if you want to use a different macro definition. joachim99@14: joachim99@14: EXPAND_AS_DEFINED = joachim99@14: joachim99@14: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then joachim99@14: # doxygen's preprocessor will remove all function-like macros that are alone joachim99@14: # on a line and do not end with a semicolon. Such function macros are typically joachim99@14: # used for boiler-plate code, and will confuse the parser if not removed. joachim99@14: joachim99@14: SKIP_FUNCTION_MACROS = YES joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # Configuration::addtions related to external references joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # The TAGFILES tag can be used to specify one or more tagfiles. joachim99@14: joachim99@14: TAGFILES = joachim99@14: joachim99@14: # When a file name is specified after GENERATE_TAGFILE, doxygen will create joachim99@14: # a tag file that is based on the input files it reads. joachim99@14: joachim99@14: GENERATE_TAGFILE = joachim99@14: joachim99@14: # If the ALLEXTERNALS tag is set to YES all external classes will be listed joachim99@14: # in the class index. If set to NO only the inherited external classes joachim99@14: # will be listed. joachim99@14: joachim99@14: ALLEXTERNALS = NO joachim99@14: joachim99@14: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed joachim99@14: # in the modules index. If set to NO, only the current project's groups will joachim99@14: # be listed. joachim99@14: joachim99@14: EXTERNAL_GROUPS = NO joachim99@14: joachim99@14: # The PERL_PATH should be the absolute path and name of the perl script joachim99@14: # interpreter (i.e. the result of `which perl'). joachim99@14: joachim99@14: PERL_PATH = joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # Configuration options related to the dot tool joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will joachim99@14: # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or joachim99@14: # super classes. Setting the tag to NO turns the diagrams off. Note that this joachim99@14: # option is superceded by the HAVE_DOT option below. This is only a fallback. It is joachim99@14: # recommended to install and use dot, since it yield more powerful graphs. joachim99@14: joachim99@14: CLASS_DIAGRAMS = YES joachim99@14: joachim99@14: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is joachim99@14: # available from the path. This tool is part of Graphviz, a graph visualization joachim99@14: # toolkit from AT&T and Lucent Bell Labs. The other options in this section joachim99@14: # have no effect if this option is set to NO (the default) joachim99@14: joachim99@14: HAVE_DOT = NO joachim99@14: joachim99@14: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen joachim99@14: # will generate a graph for each documented class showing the direct and joachim99@14: # indirect inheritance relations. Setting this tag to YES will force the joachim99@14: # the CLASS_DIAGRAMS tag to NO. joachim99@14: joachim99@14: CLASS_GRAPH = YES joachim99@14: joachim99@14: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen joachim99@14: # will generate a graph for each documented class showing the direct and joachim99@14: # indirect implementation dependencies (inheritance, containment, and joachim99@14: # class references variables) of the class with other documented classes. joachim99@14: joachim99@14: COLLABORATION_GRAPH = YES joachim99@14: joachim99@14: # If set to YES, the inheritance and collaboration graphs will show the joachim99@14: # relations between templates and their instances. joachim99@14: joachim99@14: TEMPLATE_RELATIONS = YES joachim99@14: joachim99@14: # If set to YES, the inheritance and collaboration graphs will hide joachim99@14: # inheritance and usage relations if the target is undocumented joachim99@14: # or is not a class. joachim99@14: joachim99@14: HIDE_UNDOC_RELATIONS = NO joachim99@14: joachim99@14: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT joachim99@14: # tags are set to YES then doxygen will generate a graph for each documented joachim99@14: # file showing the direct and indirect include dependencies of the file with joachim99@14: # other documented files. joachim99@14: joachim99@14: INCLUDE_GRAPH = YES joachim99@14: joachim99@14: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and joachim99@14: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each joachim99@14: # documented header file showing the documented files that directly or joachim99@14: # indirectly include this file. joachim99@14: joachim99@14: INCLUDED_BY_GRAPH = YES joachim99@14: joachim99@14: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen joachim99@14: # will graphical hierarchy of all classes instead of a textual one. joachim99@14: joachim99@14: GRAPHICAL_HIERARCHY = NO joachim99@14: joachim99@14: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images joachim99@14: # generated by dot. Possible values are png, jpg, or gif joachim99@14: # If left blank png will be used. joachim99@14: joachim99@14: DOT_IMAGE_FORMAT = png joachim99@14: joachim99@14: # The tag DOT_PATH can be used to specify the path where the dot tool can be joachim99@14: # found. If left blank, it is assumed the dot tool can be found on the path. joachim99@14: joachim99@14: DOT_PATH = joachim99@14: joachim99@14: # The DOTFILE_DIRS tag can be used to specify one or more directories that joachim99@14: # contain dot files that are included in the documentation (see the joachim99@14: # \dotfile command). joachim99@14: joachim99@14: DOTFILE_DIRS = joachim99@14: joachim99@14: # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width joachim99@14: # (in pixels) of the graphs generated by dot. If a graph becomes larger than joachim99@14: # this value, doxygen will try to truncate the graph, so that it fits within joachim99@14: # the specified constraint. Beware that most browsers cannot cope with very joachim99@14: # large images. joachim99@14: joachim99@14: MAX_DOT_GRAPH_WIDTH = 800 joachim99@14: joachim99@14: # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height joachim99@14: # (in pixels) of the graphs generated by dot. If a graph becomes larger than joachim99@14: # this value, doxygen will try to truncate the graph, so that it fits within joachim99@14: # the specified constraint. Beware that most browsers cannot cope with very joachim99@14: # large images. joachim99@14: joachim99@14: MAX_DOT_GRAPH_HEIGHT = 1024 joachim99@14: joachim99@14: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will joachim99@14: # generate a legend page explaining the meaning of the various boxes and joachim99@14: # arrows in the dot generated graphs. joachim99@14: joachim99@14: GENERATE_LEGEND = YES joachim99@14: joachim99@14: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will joachim99@14: # remove the intermedate dot files that are used to generate joachim99@14: # the various graphs. joachim99@14: joachim99@14: DOT_CLEANUP = YES joachim99@14: joachim99@14: #--------------------------------------------------------------------------- joachim99@14: # Configuration::addtions related to the search engine joachim99@14: #--------------------------------------------------------------------------- joachim99@14: joachim99@14: # The SEARCHENGINE tag specifies whether or not a search engine should be joachim99@14: # used. If set to NO the values of all tags below this one will be ignored. joachim99@14: joachim99@14: SEARCHENGINE = NO joachim99@14: joachim99@14: # The CGI_NAME tag should be the name of the CGI script that joachim99@14: # starts the search engine (doxysearch) with the correct parameters. joachim99@14: # A script with this name will be generated by doxygen. joachim99@14: joachim99@14: CGI_NAME = joachim99@14: joachim99@14: # The CGI_URL tag should be the absolute URL to the directory where the joachim99@14: # cgi binaries are located. See the documentation of your http daemon for joachim99@14: # details. joachim99@14: joachim99@14: CGI_URL = joachim99@14: joachim99@14: # The DOC_URL tag should be the absolute URL to the directory where the joachim99@14: # documentation is located. If left blank the absolute path to the joachim99@14: # documentation, with file:// prepended to it, will be used. joachim99@14: joachim99@14: DOC_URL = joachim99@14: joachim99@14: # The DOC_ABSPATH tag should be the absolute path to the directory where the joachim99@14: # documentation is located. If left blank the directory on the local machine joachim99@14: # will be used. joachim99@14: joachim99@14: DOC_ABSPATH = joachim99@14: joachim99@14: # The BIN_ABSPATH tag must point to the directory where the doxysearch binary joachim99@14: # is installed. joachim99@14: joachim99@14: BIN_ABSPATH = joachim99@14: joachim99@14: # The EXT_DOC_PATHS tag can be used to specify one or more paths to joachim99@14: # documentation generated for other projects. This allows doxysearch to search joachim99@14: # the documentation for these projects as well. joachim99@14: joachim99@14: EXT_DOC_PATHS =