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