Chris@151: # Doxyfile 1.5.8 Chris@151: Chris@151: # This file describes the settings to be used by the documentation system Chris@151: # doxygen (www.doxygen.org) for a project Chris@151: # Chris@151: # All text after a hash (#) is considered a comment and will be ignored Chris@151: # The format is: Chris@151: # TAG = value [value, ...] Chris@151: # For lists items can also be appended using: Chris@151: # TAG += value [value, ...] Chris@151: # Values that contain spaces should be placed between quotes (" ") Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # Project related configuration options Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # This tag specifies the encoding used for all characters in the config file Chris@151: # that follow. The default is UTF-8 which is also the encoding used for all Chris@151: # text before the first occurrence of this tag. Doxygen uses libiconv (or the Chris@151: # iconv built into libc) for the transcoding. See Chris@151: # http://www.gnu.org/software/libiconv for the list of possible encodings. Chris@151: Chris@151: DOXYFILE_ENCODING = UTF-8 Chris@151: Chris@151: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded Chris@151: # by quotes) that should identify the project. Chris@151: Chris@151: PROJECT_NAME = "qm-dsp" Chris@151: Chris@151: # The PROJECT_NUMBER tag can be used to enter a project or revision number. Chris@151: # This could be handy for archiving the generated documentation or Chris@151: # if some version control system is used. Chris@151: Chris@151: PROJECT_NUMBER = 1.8 Chris@151: Chris@151: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) Chris@151: # base path where the generated documentation will be put. Chris@151: # If a relative path is entered, it will be relative to the location Chris@151: # where doxygen was started. If left blank the current directory will be used. Chris@151: Chris@151: OUTPUT_DIRECTORY = doc Chris@151: Chris@151: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create Chris@151: # 4096 sub-directories (in 2 levels) under the output directory of each output Chris@151: # format and will distribute the generated files over these directories. Chris@151: # Enabling this option can be useful when feeding doxygen a huge amount of Chris@151: # source files, where putting all generated files in the same directory would Chris@151: # otherwise cause performance problems for the file system. Chris@151: Chris@151: CREATE_SUBDIRS = NO Chris@151: Chris@151: # The OUTPUT_LANGUAGE tag is used to specify the language in which all Chris@151: # documentation generated by doxygen is written. Doxygen will use this Chris@151: # information to generate all constant output in the proper language. Chris@151: # The default language is English, other supported languages are: Chris@151: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, Chris@151: # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, Chris@151: # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), Chris@151: # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, Chris@151: # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, Chris@151: # Spanish, Swedish, and Ukrainian. Chris@151: Chris@151: OUTPUT_LANGUAGE = English Chris@151: Chris@151: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will Chris@151: # include brief member descriptions after the members that are listed in Chris@151: # the file and class documentation (similar to JavaDoc). Chris@151: # Set to NO to disable this. Chris@151: Chris@151: BRIEF_MEMBER_DESC = YES Chris@151: Chris@151: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend Chris@151: # the brief description of a member or function before the detailed description. Chris@151: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the Chris@151: # brief descriptions will be completely suppressed. Chris@151: Chris@151: REPEAT_BRIEF = YES Chris@151: Chris@151: # This tag implements a quasi-intelligent brief description abbreviator Chris@151: # that is used to form the text in various listings. Each string Chris@151: # in this list, if found as the leading text of the brief description, will be Chris@151: # stripped from the text and the result after processing the whole list, is Chris@151: # used as the annotated text. Otherwise, the brief description is used as-is. Chris@151: # If left blank, the following values are used ("$name" is automatically Chris@151: # replaced with the name of the entity): "The $name class" "The $name widget" Chris@151: # "The $name file" "is" "provides" "specifies" "contains" Chris@151: # "represents" "a" "an" "the" Chris@151: Chris@151: ABBREVIATE_BRIEF = Chris@151: Chris@151: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then Chris@151: # Doxygen will generate a detailed section even if there is only a brief Chris@151: # description. Chris@151: Chris@151: ALWAYS_DETAILED_SEC = NO Chris@151: Chris@151: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all Chris@151: # inherited members of a class in the documentation of that class as if those Chris@151: # members were ordinary class members. Constructors, destructors and assignment Chris@151: # operators of the base classes will not be shown. Chris@151: Chris@151: INLINE_INHERITED_MEMB = YES Chris@151: Chris@151: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full Chris@151: # path before files name in the file list and in the header files. If set Chris@151: # to NO the shortest path that makes the file name unique will be used. Chris@151: Chris@151: FULL_PATH_NAMES = NO Chris@151: Chris@151: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag Chris@151: # can be used to strip a user-defined part of the path. Stripping is Chris@151: # only done if one of the specified strings matches the left-hand part of Chris@151: # the path. The tag can be used to show relative paths in the file list. Chris@151: # If left blank the directory from which doxygen is run is used as the Chris@151: # path to strip. Chris@151: Chris@151: STRIP_FROM_PATH = Chris@151: Chris@151: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of Chris@151: # the path mentioned in the documentation of a class, which tells Chris@151: # the reader which header file to include in order to use a class. Chris@151: # If left blank only the name of the header file containing the class Chris@151: # definition is used. Otherwise one should specify the include paths that Chris@151: # are normally passed to the compiler using the -I flag. Chris@151: Chris@151: STRIP_FROM_INC_PATH = Chris@151: Chris@151: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter Chris@151: # (but less readable) file names. This can be useful is your file systems Chris@151: # doesn't support long names like on DOS, Mac, or CD-ROM. Chris@151: Chris@151: SHORT_NAMES = NO Chris@151: Chris@151: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen Chris@151: # will interpret the first line (until the first dot) of a JavaDoc-style Chris@151: # comment as the brief description. If set to NO, the JavaDoc Chris@151: # comments will behave just like regular Qt-style comments Chris@151: # (thus requiring an explicit @brief command for a brief description.) Chris@151: Chris@151: JAVADOC_AUTOBRIEF = YES Chris@151: Chris@151: # If the QT_AUTOBRIEF tag is set to YES then Doxygen will Chris@151: # interpret the first line (until the first dot) of a Qt-style Chris@151: # comment as the brief description. If set to NO, the comments Chris@151: # will behave just like regular Qt-style comments (thus requiring Chris@151: # an explicit \brief command for a brief description.) Chris@151: Chris@151: QT_AUTOBRIEF = NO Chris@151: Chris@151: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen Chris@151: # treat a multi-line C++ special comment block (i.e. a block of //! or /// Chris@151: # comments) as a brief description. This used to be the default behaviour. Chris@151: # The new default is to treat a multi-line C++ comment block as a detailed Chris@151: # description. Set this tag to YES if you prefer the old behaviour instead. Chris@151: Chris@151: MULTILINE_CPP_IS_BRIEF = NO Chris@151: Chris@151: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented Chris@151: # member inherits the documentation from any documented member that it Chris@151: # re-implements. Chris@151: Chris@151: INHERIT_DOCS = YES Chris@151: Chris@151: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce Chris@151: # a new page for each member. If set to NO, the documentation of a member will Chris@151: # be part of the file/class/namespace that contains it. Chris@151: Chris@151: SEPARATE_MEMBER_PAGES = NO Chris@151: Chris@151: # The TAB_SIZE tag can be used to set the number of spaces in a tab. Chris@151: # Doxygen uses this value to replace tabs by spaces in code fragments. Chris@151: Chris@151: TAB_SIZE = 8 Chris@151: Chris@151: # This tag can be used to specify a number of aliases that acts Chris@151: # as commands in the documentation. An alias has the form "name=value". Chris@151: # For example adding "sideeffect=\par Side Effects:\n" will allow you to Chris@151: # put the command \sideeffect (or @sideeffect) in the documentation, which Chris@151: # will result in a user-defined paragraph with heading "Side Effects:". Chris@151: # You can put \n's in the value part of an alias to insert newlines. Chris@151: Chris@151: ALIASES = Chris@151: Chris@151: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C Chris@151: # sources only. Doxygen will then generate output that is more tailored for C. Chris@151: # For instance, some of the names that are used will be different. The list Chris@151: # of all members will be omitted, etc. Chris@151: Chris@151: OPTIMIZE_OUTPUT_FOR_C = NO Chris@151: Chris@151: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java Chris@151: # sources only. Doxygen will then generate output that is more tailored for Chris@151: # Java. For instance, namespaces will be presented as packages, qualified Chris@151: # scopes will look different, etc. Chris@151: Chris@151: OPTIMIZE_OUTPUT_JAVA = NO Chris@151: Chris@151: # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran Chris@151: # sources only. Doxygen will then generate output that is more tailored for Chris@151: # Fortran. Chris@151: Chris@151: OPTIMIZE_FOR_FORTRAN = NO Chris@151: Chris@151: # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL Chris@151: # sources. Doxygen will then generate output that is tailored for Chris@151: # VHDL. Chris@151: Chris@151: OPTIMIZE_OUTPUT_VHDL = NO Chris@151: Chris@151: # Doxygen selects the parser to use depending on the extension of the files it parses. Chris@151: # With this tag you can assign which parser to use for a given extension. Chris@151: # Doxygen has a built-in mapping, but you can override or extend it using this tag. Chris@151: # The format is ext=language, where ext is a file extension, and language is one of Chris@151: # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, Chris@151: # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat Chris@151: # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), Chris@151: # use: inc=Fortran f=C Chris@151: Chris@151: EXTENSION_MAPPING = Chris@151: Chris@151: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want Chris@151: # to include (a tag file for) the STL sources as input, then you should Chris@151: # set this tag to YES in order to let doxygen match functions declarations and Chris@151: # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. Chris@151: # func(std::string) {}). This also make the inheritance and collaboration Chris@151: # diagrams that involve STL classes more complete and accurate. Chris@151: Chris@151: BUILTIN_STL_SUPPORT = NO Chris@151: Chris@151: # If you use Microsoft's C++/CLI language, you should set this option to YES to Chris@151: # enable parsing support. Chris@151: Chris@151: CPP_CLI_SUPPORT = NO Chris@151: Chris@151: # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. Chris@151: # Doxygen will parse them like normal C++ but will assume all classes use public Chris@151: # instead of private inheritance when no explicit protection keyword is present. Chris@151: Chris@151: SIP_SUPPORT = NO Chris@151: Chris@151: # For Microsoft's IDL there are propget and propput attributes to indicate getter Chris@151: # and setter methods for a property. Setting this option to YES (the default) Chris@151: # will make doxygen to replace the get and set methods by a property in the Chris@151: # documentation. This will only work if the methods are indeed getting or Chris@151: # setting a simple type. If this is not the case, or you want to show the Chris@151: # methods anyway, you should set this option to NO. Chris@151: Chris@151: IDL_PROPERTY_SUPPORT = YES Chris@151: Chris@151: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC Chris@151: # tag is set to YES, then doxygen will reuse the documentation of the first Chris@151: # member in the group (if any) for the other members of the group. By default Chris@151: # all members of a group must be documented explicitly. Chris@151: Chris@151: DISTRIBUTE_GROUP_DOC = NO Chris@151: Chris@151: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of Chris@151: # the same type (for instance a group of public functions) to be put as a Chris@151: # subgroup of that type (e.g. under the Public Functions section). Set it to Chris@151: # NO to prevent subgrouping. Alternatively, this can be done per class using Chris@151: # the \nosubgrouping command. Chris@151: Chris@151: SUBGROUPING = YES Chris@151: Chris@151: # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum Chris@151: # is documented as struct, union, or enum with the name of the typedef. So Chris@151: # typedef struct TypeS {} TypeT, will appear in the documentation as a struct Chris@151: # with name TypeT. When disabled the typedef will appear as a member of a file, Chris@151: # namespace, or class. And the struct will be named TypeS. This can typically Chris@151: # be useful for C code in case the coding convention dictates that all compound Chris@151: # types are typedef'ed and only the typedef is referenced, never the tag name. Chris@151: Chris@151: TYPEDEF_HIDES_STRUCT = NO Chris@151: Chris@151: # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to Chris@151: # determine which symbols to keep in memory and which to flush to disk. Chris@151: # When the cache is full, less often used symbols will be written to disk. Chris@151: # For small to medium size projects (<1000 input files) the default value is Chris@151: # probably good enough. For larger projects a too small cache size can cause Chris@151: # doxygen to be busy swapping symbols to and from disk most of the time Chris@151: # causing a significant performance penality. Chris@151: # If the system has enough physical memory increasing the cache will improve the Chris@151: # performance by keeping more symbols in memory. Note that the value works on Chris@151: # a logarithmic scale so increasing the size by one will rougly double the Chris@151: # memory usage. The cache size is given by this formula: Chris@151: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, Chris@151: # corresponding to a cache size of 2^16 = 65536 symbols Chris@151: Chris@151: SYMBOL_CACHE_SIZE = 0 Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # Build related configuration options Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in Chris@151: # documentation are documented, even if no documentation was available. Chris@151: # Private class members and static file members will be hidden unless Chris@151: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES Chris@151: Chris@151: EXTRACT_ALL = YES Chris@151: Chris@151: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class Chris@151: # will be included in the documentation. Chris@151: Chris@151: EXTRACT_PRIVATE = YES Chris@151: Chris@151: # If the EXTRACT_STATIC tag is set to YES all static members of a file Chris@151: # will be included in the documentation. Chris@151: Chris@151: EXTRACT_STATIC = YES Chris@151: Chris@151: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) Chris@151: # defined locally in source files will be included in the documentation. Chris@151: # If set to NO only classes defined in header files are included. Chris@151: Chris@151: EXTRACT_LOCAL_CLASSES = YES Chris@151: Chris@151: # This flag is only useful for Objective-C code. When set to YES local Chris@151: # methods, which are defined in the implementation section but not in Chris@151: # the interface are included in the documentation. Chris@151: # If set to NO (the default) only methods in the interface are included. Chris@151: Chris@151: EXTRACT_LOCAL_METHODS = NO Chris@151: Chris@151: # If this flag is set to YES, the members of anonymous namespaces will be Chris@151: # extracted and appear in the documentation as a namespace called Chris@151: # 'anonymous_namespace{file}', where file will be replaced with the base Chris@151: # name of the file that contains the anonymous namespace. By default Chris@151: # anonymous namespace are hidden. Chris@151: Chris@151: EXTRACT_ANON_NSPACES = NO Chris@151: Chris@151: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all Chris@151: # undocumented members of documented classes, files or namespaces. Chris@151: # If set to NO (the default) these members will be included in the Chris@151: # various overviews, but no documentation section is generated. Chris@151: # This option has no effect if EXTRACT_ALL is enabled. Chris@151: Chris@151: HIDE_UNDOC_MEMBERS = NO Chris@151: Chris@151: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all Chris@151: # undocumented classes that are normally visible in the class hierarchy. Chris@151: # If set to NO (the default) these classes will be included in the various Chris@151: # overviews. This option has no effect if EXTRACT_ALL is enabled. Chris@151: Chris@151: HIDE_UNDOC_CLASSES = NO Chris@151: Chris@151: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all Chris@151: # friend (class|struct|union) declarations. Chris@151: # If set to NO (the default) these declarations will be included in the Chris@151: # documentation. Chris@151: Chris@151: HIDE_FRIEND_COMPOUNDS = NO Chris@151: Chris@151: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any Chris@151: # documentation blocks found inside the body of a function. Chris@151: # If set to NO (the default) these blocks will be appended to the Chris@151: # function's detailed documentation block. Chris@151: Chris@151: HIDE_IN_BODY_DOCS = NO Chris@151: Chris@151: # The INTERNAL_DOCS tag determines if documentation Chris@151: # that is typed after a \internal command is included. If the tag is set Chris@151: # to NO (the default) then the documentation will be excluded. Chris@151: # Set it to YES to include the internal documentation. Chris@151: Chris@151: INTERNAL_DOCS = NO Chris@151: Chris@151: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate Chris@151: # file names in lower-case letters. If set to YES upper-case letters are also Chris@151: # allowed. This is useful if you have classes or files whose names only differ Chris@151: # in case and if your file system supports case sensitive file names. Windows Chris@151: # and Mac users are advised to set this option to NO. Chris@151: Chris@151: CASE_SENSE_NAMES = YES Chris@151: Chris@151: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen Chris@151: # will show members with their full class and namespace scopes in the Chris@151: # documentation. If set to YES the scope will be hidden. Chris@151: Chris@151: HIDE_SCOPE_NAMES = NO Chris@151: Chris@151: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen Chris@151: # will put a list of the files that are included by a file in the documentation Chris@151: # of that file. Chris@151: Chris@151: SHOW_INCLUDE_FILES = YES Chris@151: Chris@151: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] Chris@151: # is inserted in the documentation for inline members. Chris@151: Chris@151: INLINE_INFO = YES Chris@151: Chris@151: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen Chris@151: # will sort the (detailed) documentation of file and class members Chris@151: # alphabetically by member name. If set to NO the members will appear in Chris@151: # declaration order. Chris@151: Chris@151: SORT_MEMBER_DOCS = NO Chris@151: Chris@151: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the Chris@151: # brief documentation of file, namespace and class members alphabetically Chris@151: # by member name. If set to NO (the default) the members will appear in Chris@151: # declaration order. Chris@151: Chris@151: SORT_BRIEF_DOCS = NO Chris@151: Chris@151: # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the Chris@151: # hierarchy of group names into alphabetical order. If set to NO (the default) Chris@151: # the group names will appear in their defined order. Chris@151: Chris@151: SORT_GROUP_NAMES = NO Chris@151: Chris@151: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be Chris@151: # sorted by fully-qualified names, including namespaces. If set to Chris@151: # NO (the default), the class list will be sorted only by class name, Chris@151: # not including the namespace part. Chris@151: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. Chris@151: # Note: This option applies only to the class list, not to the Chris@151: # alphabetical list. Chris@151: Chris@151: SORT_BY_SCOPE_NAME = NO Chris@151: Chris@151: # The GENERATE_TODOLIST tag can be used to enable (YES) or Chris@151: # disable (NO) the todo list. This list is created by putting \todo Chris@151: # commands in the documentation. Chris@151: Chris@151: GENERATE_TODOLIST = YES Chris@151: Chris@151: # The GENERATE_TESTLIST tag can be used to enable (YES) or Chris@151: # disable (NO) the test list. This list is created by putting \test Chris@151: # commands in the documentation. Chris@151: Chris@151: GENERATE_TESTLIST = YES Chris@151: Chris@151: # The GENERATE_BUGLIST tag can be used to enable (YES) or Chris@151: # disable (NO) the bug list. This list is created by putting \bug Chris@151: # commands in the documentation. Chris@151: Chris@151: GENERATE_BUGLIST = YES Chris@151: Chris@151: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or Chris@151: # disable (NO) the deprecated list. This list is created by putting Chris@151: # \deprecated commands in the documentation. Chris@151: Chris@151: GENERATE_DEPRECATEDLIST= YES Chris@151: Chris@151: # The ENABLED_SECTIONS tag can be used to enable conditional Chris@151: # documentation sections, marked by \if sectionname ... \endif. Chris@151: Chris@151: ENABLED_SECTIONS = Chris@151: Chris@151: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines Chris@151: # the initial value of a variable or define consists of for it to appear in Chris@151: # the documentation. If the initializer consists of more lines than specified Chris@151: # here it will be hidden. Use a value of 0 to hide initializers completely. Chris@151: # The appearance of the initializer of individual variables and defines in the Chris@151: # documentation can be controlled using \showinitializer or \hideinitializer Chris@151: # command in the documentation regardless of this setting. Chris@151: Chris@151: MAX_INITIALIZER_LINES = 30 Chris@151: Chris@151: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated Chris@151: # at the bottom of the documentation of classes and structs. If set to YES the Chris@151: # list will mention the files that were used to generate the documentation. Chris@151: Chris@151: SHOW_USED_FILES = YES Chris@151: Chris@151: # If the sources in your project are distributed over multiple directories Chris@151: # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy Chris@151: # in the documentation. The default is NO. Chris@151: Chris@151: SHOW_DIRECTORIES = YES Chris@151: Chris@151: # Set the SHOW_FILES tag to NO to disable the generation of the Files page. Chris@151: # This will remove the Files entry from the Quick Index and from the Chris@151: # Folder Tree View (if specified). The default is YES. Chris@151: Chris@151: SHOW_FILES = YES Chris@151: Chris@151: # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Chris@151: # Namespaces page. Chris@151: # This will remove the Namespaces entry from the Quick Index Chris@151: # and from the Folder Tree View (if specified). The default is YES. Chris@151: Chris@151: SHOW_NAMESPACES = YES Chris@151: Chris@151: # The FILE_VERSION_FILTER tag can be used to specify a program or script that Chris@151: # doxygen should invoke to get the current version for each file (typically from Chris@151: # the version control system). Doxygen will invoke the program by executing (via Chris@151: # popen()) the command , where is the value of Chris@151: # the FILE_VERSION_FILTER tag, and is the name of an input file Chris@151: # provided by doxygen. Whatever the program writes to standard output Chris@151: # is used as the file version. See the manual for examples. Chris@151: Chris@151: FILE_VERSION_FILTER = Chris@151: Chris@151: # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by Chris@151: # doxygen. The layout file controls the global structure of the generated output files Chris@151: # in an output format independent way. The create the layout file that represents Chris@151: # doxygen's defaults, run doxygen with the -l option. You can optionally specify a Chris@151: # file name after the option, if omitted DoxygenLayout.xml will be used as the name Chris@151: # of the layout file. Chris@151: Chris@151: LAYOUT_FILE = Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to warning and progress messages Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # The QUIET tag can be used to turn on/off the messages that are generated Chris@151: # by doxygen. Possible values are YES and NO. If left blank NO is used. Chris@151: Chris@151: QUIET = NO Chris@151: Chris@151: # The WARNINGS tag can be used to turn on/off the warning messages that are Chris@151: # generated by doxygen. Possible values are YES and NO. If left blank Chris@151: # NO is used. Chris@151: Chris@151: WARNINGS = YES Chris@151: Chris@151: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings Chris@151: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will Chris@151: # automatically be disabled. Chris@151: Chris@151: WARN_IF_UNDOCUMENTED = YES Chris@151: Chris@151: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for Chris@151: # potential errors in the documentation, such as not documenting some Chris@151: # parameters in a documented function, or documenting parameters that Chris@151: # don't exist or using markup commands wrongly. Chris@151: Chris@151: WARN_IF_DOC_ERROR = YES Chris@151: Chris@151: # This WARN_NO_PARAMDOC option can be abled to get warnings for Chris@151: # functions that are documented, but have no documentation for their parameters Chris@151: # or return value. If set to NO (the default) doxygen will only warn about Chris@151: # wrong or incomplete parameter documentation, but not about the absence of Chris@151: # documentation. Chris@151: Chris@151: WARN_NO_PARAMDOC = YES Chris@151: Chris@151: # The WARN_FORMAT tag determines the format of the warning messages that Chris@151: # doxygen can produce. The string should contain the $file, $line, and $text Chris@151: # tags, which will be replaced by the file and line number from which the Chris@151: # warning originated and the warning text. Optionally the format may contain Chris@151: # $version, which will be replaced by the version of the file (if it could Chris@151: # be obtained via FILE_VERSION_FILTER) Chris@151: Chris@151: WARN_FORMAT = "$file:$line: $text" Chris@151: Chris@151: # The WARN_LOGFILE tag can be used to specify a file to which warning Chris@151: # and error messages should be written. If left blank the output is written Chris@151: # to stderr. Chris@151: Chris@151: WARN_LOGFILE = docs/doxygen/warning.log Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to the input files Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # The INPUT tag can be used to specify the files and/or directories that contain Chris@151: # documented source files. You may enter file names like "myfile.cpp" or Chris@151: # directories like "/usr/src/myproject". Separate the files or directories Chris@151: # with spaces. Chris@151: Chris@151: INPUT = base dsp maths Chris@151: Chris@151: # This tag can be used to specify the character encoding of the source files Chris@151: # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is Chris@151: # also the default input encoding. Doxygen uses libiconv (or the iconv built Chris@151: # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for Chris@151: # the list of possible encodings. Chris@151: Chris@151: INPUT_ENCODING = UTF-8 Chris@151: Chris@151: # If the value of the INPUT tag contains directories, you can use the Chris@151: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp Chris@151: # and *.h) to filter out the source-files in the directories. If left Chris@151: # blank the following patterns are tested: Chris@151: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx Chris@151: # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 Chris@151: Chris@151: FILE_PATTERNS = *.h \ Chris@151: *.C \ Chris@151: *.cpp \ Chris@151: *.cc \ Chris@151: doc-overview Chris@151: Chris@151: # The RECURSIVE tag can be used to turn specify whether or not subdirectories Chris@151: # should be searched for input files as well. Possible values are YES and NO. Chris@151: # If left blank NO is used. Chris@151: Chris@151: RECURSIVE = YES Chris@151: Chris@151: # The EXCLUDE tag can be used to specify files and/or directories that should Chris@151: # excluded from the INPUT source files. This way you can easily exclude a Chris@151: # subdirectory from a directory tree whose root is specified with the INPUT tag. Chris@151: Chris@151: EXCLUDE = Chris@151: Chris@151: # The EXCLUDE_SYMLINKS tag can be used select whether or not files or Chris@151: # directories that are symbolic links (a Unix filesystem feature) are excluded Chris@151: # from the input. Chris@151: Chris@151: EXCLUDE_SYMLINKS = NO Chris@151: Chris@151: # If the value of the INPUT tag contains directories, you can use the Chris@151: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude Chris@151: # certain files from those directories. Note that the wildcards are matched Chris@151: # against the file with absolute path, so to exclude all test directories Chris@151: # for example use the pattern */test/* Chris@151: Chris@151: EXCLUDE_PATTERNS = qrc_*.cpp \ Chris@151: moc_*.cpp \ Chris@151: *.moc.cpp \ Chris@151: *_skel.cpp Chris@151: Chris@151: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names Chris@151: # (namespaces, classes, functions, etc.) that should be excluded from the Chris@151: # output. The symbol name can be a fully qualified name, a word, or if the Chris@151: # wildcard * is used, a substring. Examples: ANamespace, AClass, Chris@151: # AClass::ANamespace, ANamespace::*Test Chris@151: Chris@151: EXCLUDE_SYMBOLS = Chris@151: Chris@151: # The EXAMPLE_PATH tag can be used to specify one or more files or Chris@151: # directories that contain example code fragments that are included (see Chris@151: # the \include command). Chris@151: Chris@151: EXAMPLE_PATH = Chris@151: Chris@151: # If the value of the EXAMPLE_PATH tag contains directories, you can use the Chris@151: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp Chris@151: # and *.h) to filter out the source-files in the directories. If left Chris@151: # blank all files are included. Chris@151: Chris@151: EXAMPLE_PATTERNS = Chris@151: Chris@151: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be Chris@151: # searched for input files to be used with the \include or \dontinclude Chris@151: # commands irrespective of the value of the RECURSIVE tag. Chris@151: # Possible values are YES and NO. If left blank NO is used. Chris@151: Chris@151: EXAMPLE_RECURSIVE = NO Chris@151: Chris@151: # The IMAGE_PATH tag can be used to specify one or more files or Chris@151: # directories that contain image that are included in the documentation (see Chris@151: # the \image command). Chris@151: Chris@151: IMAGE_PATH = Chris@151: Chris@151: # The INPUT_FILTER tag can be used to specify a program that doxygen should Chris@151: # invoke to filter for each input file. Doxygen will invoke the filter program Chris@151: # by executing (via popen()) the command , where Chris@151: # is the value of the INPUT_FILTER tag, and is the name of an Chris@151: # input file. Doxygen will then use the output that the filter program writes Chris@151: # to standard output. Chris@151: # If FILTER_PATTERNS is specified, this tag will be Chris@151: # ignored. Chris@151: Chris@151: INPUT_FILTER = Chris@151: Chris@151: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern Chris@151: # basis. Chris@151: # Doxygen will compare the file name with each pattern and apply the Chris@151: # filter if there is a match. Chris@151: # The filters are a list of the form: Chris@151: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further Chris@151: # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER Chris@151: # is applied to all files. Chris@151: Chris@151: FILTER_PATTERNS = Chris@151: Chris@151: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using Chris@151: # INPUT_FILTER) will be used to filter the input files when producing source Chris@151: # files to browse (i.e. when SOURCE_BROWSER is set to YES). Chris@151: Chris@151: FILTER_SOURCE_FILES = NO Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to source browsing Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the SOURCE_BROWSER tag is set to YES then a list of source files will Chris@151: # be generated. Documented entities will be cross-referenced with these sources. Chris@151: # Note: To get rid of all source code in the generated output, make sure also Chris@151: # VERBATIM_HEADERS is set to NO. Chris@151: Chris@151: SOURCE_BROWSER = YES Chris@151: Chris@151: # Setting the INLINE_SOURCES tag to YES will include the body Chris@151: # of functions and classes directly in the documentation. Chris@151: Chris@151: INLINE_SOURCES = NO Chris@151: Chris@151: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct Chris@151: # doxygen to hide any special comment blocks from generated source code Chris@151: # fragments. Normal C and C++ comments will always remain visible. Chris@151: Chris@151: STRIP_CODE_COMMENTS = YES Chris@151: Chris@151: # If the REFERENCED_BY_RELATION tag is set to YES Chris@151: # then for each documented function all documented Chris@151: # functions referencing it will be listed. Chris@151: Chris@151: REFERENCED_BY_RELATION = YES Chris@151: Chris@151: # If the REFERENCES_RELATION tag is set to YES Chris@151: # then for each documented function all documented entities Chris@151: # called/used by that function will be listed. Chris@151: Chris@151: REFERENCES_RELATION = YES Chris@151: Chris@151: # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) Chris@151: # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from Chris@151: # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will Chris@151: # link to the source code. Chris@151: # Otherwise they will link to the documentation. Chris@151: Chris@151: REFERENCES_LINK_SOURCE = YES Chris@151: Chris@151: # If the USE_HTAGS tag is set to YES then the references to source code Chris@151: # will point to the HTML generated by the htags(1) tool instead of doxygen Chris@151: # built-in source browser. The htags tool is part of GNU's global source Chris@151: # tagging system (see http://www.gnu.org/software/global/global.html). You Chris@151: # will need version 4.8.6 or higher. Chris@151: Chris@151: USE_HTAGS = NO Chris@151: Chris@151: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen Chris@151: # will generate a verbatim copy of the header file for each class for Chris@151: # which an include is specified. Set to NO to disable this. Chris@151: Chris@151: VERBATIM_HEADERS = YES Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to the alphabetical class index Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index Chris@151: # of all compounds will be generated. Enable this if the project Chris@151: # contains a lot of classes, structs, unions or interfaces. Chris@151: Chris@151: ALPHABETICAL_INDEX = NO Chris@151: Chris@151: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then Chris@151: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns Chris@151: # in which this list will be split (can be a number in the range [1..20]) Chris@151: Chris@151: COLS_IN_ALPHA_INDEX = 3 Chris@151: Chris@151: # In case all classes in a project start with a common prefix, all Chris@151: # classes will be put under the same header in the alphabetical index. Chris@151: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that Chris@151: # should be ignored while generating the index headers. Chris@151: Chris@151: IGNORE_PREFIX = Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to the HTML output Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will Chris@151: # generate HTML output. Chris@151: Chris@151: GENERATE_HTML = YES Chris@151: Chris@151: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. Chris@151: # If a relative path is entered the value of OUTPUT_DIRECTORY will be Chris@151: # put in front of it. If left blank `html' will be used as the default path. Chris@151: Chris@151: HTML_OUTPUT = html Chris@151: Chris@151: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for Chris@151: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank Chris@151: # doxygen will generate files with .html extension. Chris@151: Chris@151: HTML_FILE_EXTENSION = .html Chris@151: Chris@151: # The HTML_HEADER tag can be used to specify a personal HTML header for Chris@151: # each generated HTML page. If it is left blank doxygen will generate a Chris@151: # standard header. Chris@151: Chris@151: HTML_HEADER = Chris@151: Chris@151: # The HTML_FOOTER tag can be used to specify a personal HTML footer for Chris@151: # each generated HTML page. If it is left blank doxygen will generate a Chris@151: # standard footer. Chris@151: Chris@151: HTML_FOOTER = Chris@151: Chris@151: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading Chris@151: # style sheet that is used by each HTML page. It can be used to Chris@151: # fine-tune the look of the HTML output. If the tag is left blank doxygen Chris@151: # will generate a default style sheet. Note that doxygen will try to copy Chris@151: # the style sheet file to the HTML output directory, so don't put your own Chris@151: # stylesheet in the HTML output directory as well, or it will be erased! Chris@151: Chris@151: HTML_STYLESHEET = Chris@151: Chris@151: # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, Chris@151: # files or namespaces will be aligned in HTML using tables. If set to Chris@151: # NO a bullet list will be used. Chris@151: Chris@151: HTML_ALIGN_MEMBERS = YES Chris@151: Chris@151: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML Chris@151: # documentation will contain sections that can be hidden and shown after the Chris@151: # page has loaded. For this to work a browser that supports Chris@151: # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox Chris@151: # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). Chris@151: Chris@151: HTML_DYNAMIC_SECTIONS = NO Chris@151: Chris@151: # If the GENERATE_DOCSET tag is set to YES, additional index files Chris@151: # will be generated that can be used as input for Apple's Xcode 3 Chris@151: # integrated development environment, introduced with OSX 10.5 (Leopard). Chris@151: # To create a documentation set, doxygen will generate a Makefile in the Chris@151: # HTML output directory. Running make will produce the docset in that Chris@151: # directory and running "make install" will install the docset in Chris@151: # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find Chris@151: # it at startup. Chris@151: # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. Chris@151: Chris@151: GENERATE_DOCSET = NO Chris@151: Chris@151: # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the Chris@151: # feed. A documentation feed provides an umbrella under which multiple Chris@151: # documentation sets from a single provider (such as a company or product suite) Chris@151: # can be grouped. Chris@151: Chris@151: DOCSET_FEEDNAME = "Doxygen generated docs" Chris@151: Chris@151: # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that Chris@151: # should uniquely identify the documentation set bundle. This should be a Chris@151: # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen Chris@151: # will append .docset to the name. Chris@151: Chris@151: DOCSET_BUNDLE_ID = org.doxygen.Project Chris@151: Chris@151: # If the GENERATE_HTMLHELP tag is set to YES, additional index files Chris@151: # will be generated that can be used as input for tools like the Chris@151: # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) Chris@151: # of the generated HTML documentation. Chris@151: Chris@151: GENERATE_HTMLHELP = NO Chris@151: Chris@151: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can Chris@151: # be used to specify the file name of the resulting .chm file. You Chris@151: # can add a path in front of the file if the result should not be Chris@151: # written to the html output directory. Chris@151: Chris@151: CHM_FILE = Chris@151: Chris@151: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can Chris@151: # be used to specify the location (absolute path including file name) of Chris@151: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run Chris@151: # the HTML help compiler on the generated index.hhp. Chris@151: Chris@151: HHC_LOCATION = Chris@151: Chris@151: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag Chris@151: # controls if a separate .chi index file is generated (YES) or that Chris@151: # it should be included in the master .chm file (NO). Chris@151: Chris@151: GENERATE_CHI = NO Chris@151: Chris@151: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING Chris@151: # is used to encode HtmlHelp index (hhk), content (hhc) and project file Chris@151: # content. Chris@151: Chris@151: CHM_INDEX_ENCODING = Chris@151: Chris@151: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag Chris@151: # controls whether a binary table of contents is generated (YES) or a Chris@151: # normal table of contents (NO) in the .chm file. Chris@151: Chris@151: BINARY_TOC = NO Chris@151: Chris@151: # The TOC_EXPAND flag can be set to YES to add extra items for group members Chris@151: # to the contents of the HTML help documentation and to the tree view. Chris@151: Chris@151: TOC_EXPAND = NO Chris@151: Chris@151: # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER Chris@151: # are set, an additional index file will be generated that can be used as input for Chris@151: # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated Chris@151: # HTML documentation. Chris@151: Chris@151: GENERATE_QHP = NO Chris@151: Chris@151: # If the QHG_LOCATION tag is specified, the QCH_FILE tag can Chris@151: # be used to specify the file name of the resulting .qch file. Chris@151: # The path specified is relative to the HTML output folder. Chris@151: Chris@151: QCH_FILE = Chris@151: Chris@151: # The QHP_NAMESPACE tag specifies the namespace to use when generating Chris@151: # Qt Help Project output. For more information please see Chris@151: # http://doc.trolltech.com/qthelpproject.html#namespace Chris@151: Chris@151: QHP_NAMESPACE = Chris@151: Chris@151: # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Chris@151: # Qt Help Project output. For more information please see Chris@151: # http://doc.trolltech.com/qthelpproject.html#virtual-folders Chris@151: Chris@151: QHP_VIRTUAL_FOLDER = doc Chris@151: Chris@151: # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. Chris@151: # For more information please see Chris@151: # http://doc.trolltech.com/qthelpproject.html#custom-filters Chris@151: Chris@151: QHP_CUST_FILTER_NAME = Chris@151: Chris@151: # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see Chris@151: # Qt Help Project / Custom Filters. Chris@151: Chris@151: QHP_CUST_FILTER_ATTRS = Chris@151: Chris@151: # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's Chris@151: # filter section matches. Chris@151: # Qt Help Project / Filter Attributes. Chris@151: Chris@151: QHP_SECT_FILTER_ATTRS = Chris@151: Chris@151: # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can Chris@151: # be used to specify the location of Qt's qhelpgenerator. Chris@151: # If non-empty doxygen will try to run qhelpgenerator on the generated Chris@151: # .qhp file. Chris@151: Chris@151: QHG_LOCATION = Chris@151: Chris@151: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at Chris@151: # top of each HTML page. The value NO (the default) enables the index and Chris@151: # the value YES disables it. Chris@151: Chris@151: DISABLE_INDEX = NO Chris@151: Chris@151: # This tag can be used to set the number of enum values (range [1..20]) Chris@151: # that doxygen will group on one line in the generated HTML documentation. Chris@151: Chris@151: ENUM_VALUES_PER_LINE = 4 Chris@151: Chris@151: # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index Chris@151: # structure should be generated to display hierarchical information. Chris@151: # If the tag value is set to FRAME, a side panel will be generated Chris@151: # containing a tree-like index structure (just like the one that Chris@151: # is generated for HTML Help). For this to work a browser that supports Chris@151: # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, Chris@151: # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are Chris@151: # probably better off using the HTML help feature. Other possible values Chris@151: # for this tag are: HIERARCHIES, which will generate the Groups, Directories, Chris@151: # and Class Hierarchy pages using a tree view instead of an ordered list; Chris@151: # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which Chris@151: # disables this behavior completely. For backwards compatibility with previous Chris@151: # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE Chris@151: # respectively. Chris@151: Chris@151: GENERATE_TREEVIEW = YES Chris@151: Chris@151: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be Chris@151: # used to set the initial width (in pixels) of the frame in which the tree Chris@151: # is shown. Chris@151: Chris@151: TREEVIEW_WIDTH = 250 Chris@151: Chris@151: # Use this tag to change the font size of Latex formulas included Chris@151: # as images in the HTML documentation. The default is 10. Note that Chris@151: # when you change the font size after a successful doxygen run you need Chris@151: # to manually remove any form_*.png images from the HTML output directory Chris@151: # to force them to be regenerated. Chris@151: Chris@151: FORMULA_FONTSIZE = 10 Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to the LaTeX output Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will Chris@151: # generate Latex output. Chris@151: Chris@151: GENERATE_LATEX = NO Chris@151: Chris@151: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. Chris@151: # If a relative path is entered the value of OUTPUT_DIRECTORY will be Chris@151: # put in front of it. If left blank `latex' will be used as the default path. Chris@151: Chris@151: LATEX_OUTPUT = latex Chris@151: Chris@151: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be Chris@151: # invoked. If left blank `latex' will be used as the default command name. Chris@151: Chris@151: LATEX_CMD_NAME = latex Chris@151: Chris@151: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to Chris@151: # generate index for LaTeX. If left blank `makeindex' will be used as the Chris@151: # default command name. Chris@151: Chris@151: MAKEINDEX_CMD_NAME = makeindex Chris@151: Chris@151: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact Chris@151: # LaTeX documents. This may be useful for small projects and may help to Chris@151: # save some trees in general. Chris@151: Chris@151: COMPACT_LATEX = NO Chris@151: Chris@151: # The PAPER_TYPE tag can be used to set the paper type that is used Chris@151: # by the printer. Possible values are: a4, a4wide, letter, legal and Chris@151: # executive. If left blank a4wide will be used. Chris@151: Chris@151: PAPER_TYPE = a4wide Chris@151: Chris@151: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX Chris@151: # packages that should be included in the LaTeX output. Chris@151: Chris@151: EXTRA_PACKAGES = Chris@151: Chris@151: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for Chris@151: # the generated latex document. The header should contain everything until Chris@151: # the first chapter. If it is left blank doxygen will generate a Chris@151: # standard header. Notice: only use this tag if you know what you are doing! Chris@151: Chris@151: LATEX_HEADER = Chris@151: Chris@151: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated Chris@151: # is prepared for conversion to pdf (using ps2pdf). The pdf file will Chris@151: # contain links (just like the HTML output) instead of page references Chris@151: # This makes the output suitable for online browsing using a pdf viewer. Chris@151: Chris@151: PDF_HYPERLINKS = NO Chris@151: Chris@151: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of Chris@151: # plain latex in the generated Makefile. Set this option to YES to get a Chris@151: # higher quality PDF documentation. Chris@151: Chris@151: USE_PDFLATEX = NO Chris@151: Chris@151: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. Chris@151: # command to the generated LaTeX files. This will instruct LaTeX to keep Chris@151: # running if errors occur, instead of asking the user for help. Chris@151: # This option is also used when generating formulas in HTML. Chris@151: Chris@151: LATEX_BATCHMODE = NO Chris@151: Chris@151: # If LATEX_HIDE_INDICES is set to YES then doxygen will not Chris@151: # include the index chapters (such as File Index, Compound Index, etc.) Chris@151: # in the output. Chris@151: Chris@151: LATEX_HIDE_INDICES = NO Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to the RTF output Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output Chris@151: # The RTF output is optimized for Word 97 and may not look very pretty with Chris@151: # other RTF readers or editors. Chris@151: Chris@151: GENERATE_RTF = NO Chris@151: Chris@151: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. Chris@151: # If a relative path is entered the value of OUTPUT_DIRECTORY will be Chris@151: # put in front of it. If left blank `rtf' will be used as the default path. Chris@151: Chris@151: RTF_OUTPUT = rtf Chris@151: Chris@151: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact Chris@151: # RTF documents. This may be useful for small projects and may help to Chris@151: # save some trees in general. Chris@151: Chris@151: COMPACT_RTF = NO Chris@151: Chris@151: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated Chris@151: # will contain hyperlink fields. The RTF file will Chris@151: # contain links (just like the HTML output) instead of page references. Chris@151: # This makes the output suitable for online browsing using WORD or other Chris@151: # programs which support those fields. Chris@151: # Note: wordpad (write) and others do not support links. Chris@151: Chris@151: RTF_HYPERLINKS = NO Chris@151: Chris@151: # Load stylesheet definitions from file. Syntax is similar to doxygen's Chris@151: # config file, i.e. a series of assignments. You only have to provide Chris@151: # replacements, missing definitions are set to their default value. Chris@151: Chris@151: RTF_STYLESHEET_FILE = Chris@151: Chris@151: # Set optional variables used in the generation of an rtf document. Chris@151: # Syntax is similar to doxygen's config file. Chris@151: Chris@151: RTF_EXTENSIONS_FILE = Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to the man page output Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will Chris@151: # generate man pages Chris@151: Chris@151: GENERATE_MAN = NO Chris@151: Chris@151: # The MAN_OUTPUT tag is used to specify where the man pages will be put. Chris@151: # If a relative path is entered the value of OUTPUT_DIRECTORY will be Chris@151: # put in front of it. If left blank `man' will be used as the default path. Chris@151: Chris@151: MAN_OUTPUT = man Chris@151: Chris@151: # The MAN_EXTENSION tag determines the extension that is added to Chris@151: # the generated man pages (default is the subroutine's section .3) Chris@151: Chris@151: MAN_EXTENSION = .3 Chris@151: Chris@151: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, Chris@151: # then it will generate one additional man file for each entity Chris@151: # documented in the real man page(s). These additional files Chris@151: # only source the real man page, but without them the man command Chris@151: # would be unable to find the correct page. The default is NO. Chris@151: Chris@151: MAN_LINKS = NO Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to the XML output Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the GENERATE_XML tag is set to YES Doxygen will Chris@151: # generate an XML file that captures the structure of Chris@151: # the code including all documentation. Chris@151: Chris@151: GENERATE_XML = NO Chris@151: Chris@151: # The XML_OUTPUT tag is used to specify where the XML pages will be put. Chris@151: # If a relative path is entered the value of OUTPUT_DIRECTORY will be Chris@151: # put in front of it. If left blank `xml' will be used as the default path. Chris@151: Chris@151: XML_OUTPUT = xml Chris@151: Chris@151: # The XML_SCHEMA tag can be used to specify an XML schema, Chris@151: # which can be used by a validating XML parser to check the Chris@151: # syntax of the XML files. Chris@151: Chris@151: XML_SCHEMA = Chris@151: Chris@151: # The XML_DTD tag can be used to specify an XML DTD, Chris@151: # which can be used by a validating XML parser to check the Chris@151: # syntax of the XML files. Chris@151: Chris@151: XML_DTD = Chris@151: Chris@151: # If the XML_PROGRAMLISTING tag is set to YES Doxygen will Chris@151: # dump the program listings (including syntax highlighting Chris@151: # and cross-referencing information) to the XML output. Note that Chris@151: # enabling this will significantly increase the size of the XML output. Chris@151: Chris@151: XML_PROGRAMLISTING = YES Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options for the AutoGen Definitions output Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will Chris@151: # generate an AutoGen Definitions (see autogen.sf.net) file Chris@151: # that captures the structure of the code including all Chris@151: # documentation. Note that this feature is still experimental Chris@151: # and incomplete at the moment. Chris@151: Chris@151: GENERATE_AUTOGEN_DEF = NO Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # configuration options related to the Perl module output Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the GENERATE_PERLMOD tag is set to YES Doxygen will Chris@151: # generate a Perl module file that captures the structure of Chris@151: # the code including all documentation. Note that this Chris@151: # feature is still experimental and incomplete at the Chris@151: # moment. Chris@151: Chris@151: GENERATE_PERLMOD = NO Chris@151: Chris@151: # If the PERLMOD_LATEX tag is set to YES Doxygen will generate Chris@151: # the necessary Makefile rules, Perl scripts and LaTeX code to be able Chris@151: # to generate PDF and DVI output from the Perl module output. Chris@151: Chris@151: PERLMOD_LATEX = NO Chris@151: Chris@151: # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be Chris@151: # nicely formatted so it can be parsed by a human reader. Chris@151: # This is useful Chris@151: # if you want to understand what is going on. Chris@151: # On the other hand, if this Chris@151: # tag is set to NO the size of the Perl module output will be much smaller Chris@151: # and Perl will parse it just the same. Chris@151: Chris@151: PERLMOD_PRETTY = YES Chris@151: Chris@151: # The names of the make variables in the generated doxyrules.make file Chris@151: # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. Chris@151: # This is useful so different doxyrules.make files included by the same Chris@151: # Makefile don't overwrite each other's variables. Chris@151: Chris@151: PERLMOD_MAKEVAR_PREFIX = Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # Configuration options related to the preprocessor Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will Chris@151: # evaluate all C-preprocessor directives found in the sources and include Chris@151: # files. Chris@151: Chris@151: ENABLE_PREPROCESSING = YES Chris@151: Chris@151: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro Chris@151: # names in the source code. If set to NO (the default) only conditional Chris@151: # compilation will be performed. Macro expansion can be done in a controlled Chris@151: # way by setting EXPAND_ONLY_PREDEF to YES. Chris@151: Chris@151: MACRO_EXPANSION = NO Chris@151: Chris@151: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES Chris@151: # then the macro expansion is limited to the macros specified with the Chris@151: # PREDEFINED and EXPAND_AS_DEFINED tags. Chris@151: Chris@151: EXPAND_ONLY_PREDEF = NO Chris@151: Chris@151: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files Chris@151: # in the INCLUDE_PATH (see below) will be search if a #include is found. Chris@151: Chris@151: SEARCH_INCLUDES = NO Chris@151: Chris@151: # The INCLUDE_PATH tag can be used to specify one or more directories that Chris@151: # contain include files that are not input files but should be processed by Chris@151: # the preprocessor. Chris@151: Chris@151: INCLUDE_PATH = Chris@151: Chris@151: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard Chris@151: # patterns (like *.h and *.hpp) to filter out the header-files in the Chris@151: # directories. If left blank, the patterns specified with FILE_PATTERNS will Chris@151: # be used. Chris@151: Chris@151: INCLUDE_FILE_PATTERNS = Chris@151: Chris@151: # The PREDEFINED tag can be used to specify one or more macro names that Chris@151: # are defined before the preprocessor is started (similar to the -D option of Chris@151: # gcc). The argument of the tag is a list of macros of the form: name Chris@151: # or name=definition (no spaces). If the definition and the = are Chris@151: # omitted =1 is assumed. To prevent a macro definition from being Chris@151: # undefined via #undef or recursively expanded use the := operator Chris@151: # instead of the = operator. Chris@151: Chris@151: PREDEFINED = _VAMP_NO_PLUGIN_NAMESPACE Chris@151: Chris@151: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then Chris@151: # this tag can be used to specify a list of macro names that should be expanded. Chris@151: # The macro definition that is found in the sources will be used. Chris@151: # Use the PREDEFINED tag if you want to use a different macro definition. Chris@151: Chris@151: EXPAND_AS_DEFINED = Chris@151: Chris@151: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then Chris@151: # doxygen's preprocessor will remove all function-like macros that are alone Chris@151: # on a line, have an all uppercase name, and do not end with a semicolon. Such Chris@151: # function macros are typically used for boiler-plate code, and will confuse Chris@151: # the parser if not removed. Chris@151: Chris@151: SKIP_FUNCTION_MACROS = YES Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # Configuration::additions related to external references Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # The TAGFILES option can be used to specify one or more tagfiles. Chris@151: # Optionally an initial location of the external documentation Chris@151: # can be added for each tagfile. The format of a tag file without Chris@151: # this location is as follows: Chris@151: # Chris@151: # TAGFILES = file1 file2 ... Chris@151: # Adding location for the tag files is done as follows: Chris@151: # Chris@151: # TAGFILES = file1=loc1 "file2 = loc2" ... Chris@151: # where "loc1" and "loc2" can be relative or absolute paths or Chris@151: # URLs. If a location is present for each tag, the installdox tool Chris@151: # does not have to be run to correct the links. Chris@151: # Note that each tag file must have a unique name Chris@151: # (where the name does NOT include the path) Chris@151: # If a tag file is not located in the directory in which doxygen Chris@151: # is run, you must also specify the path to the tagfile here. Chris@151: Chris@151: TAGFILES = Chris@151: Chris@151: # When a file name is specified after GENERATE_TAGFILE, doxygen will create Chris@151: # a tag file that is based on the input files it reads. Chris@151: Chris@151: GENERATE_TAGFILE = Chris@151: Chris@151: # If the ALLEXTERNALS tag is set to YES all external classes will be listed Chris@151: # in the class index. If set to NO only the inherited external classes Chris@151: # will be listed. Chris@151: Chris@151: ALLEXTERNALS = NO Chris@151: Chris@151: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed Chris@151: # in the modules index. If set to NO, only the current project's groups will Chris@151: # be listed. Chris@151: Chris@151: EXTERNAL_GROUPS = YES Chris@151: Chris@151: # The PERL_PATH should be the absolute path and name of the perl script Chris@151: # interpreter (i.e. the result of `which perl'). Chris@151: Chris@151: PERL_PATH = /usr/bin/perl Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # Configuration options related to the dot tool Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will Chris@151: # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base Chris@151: # or super classes. Setting the tag to NO turns the diagrams off. Note that Chris@151: # this option is superseded by the HAVE_DOT option below. This is only a Chris@151: # fallback. It is recommended to install and use dot, since it yields more Chris@151: # powerful graphs. Chris@151: Chris@151: CLASS_DIAGRAMS = YES Chris@151: Chris@151: # You can define message sequence charts within doxygen comments using the \msc Chris@151: # command. Doxygen will then run the mscgen tool (see Chris@151: # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the Chris@151: # documentation. The MSCGEN_PATH tag allows you to specify the directory where Chris@151: # the mscgen tool resides. If left empty the tool is assumed to be found in the Chris@151: # default search path. Chris@151: Chris@151: MSCGEN_PATH = Chris@151: Chris@151: # If set to YES, the inheritance and collaboration graphs will hide Chris@151: # inheritance and usage relations if the target is undocumented Chris@151: # or is not a class. Chris@151: Chris@151: HIDE_UNDOC_RELATIONS = YES Chris@151: Chris@151: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is Chris@151: # available from the path. This tool is part of Graphviz, a graph visualization Chris@151: # toolkit from AT&T and Lucent Bell Labs. The other options in this section Chris@151: # have no effect if this option is set to NO (the default) Chris@151: Chris@151: HAVE_DOT = YES Chris@151: Chris@151: # By default doxygen will write a font called FreeSans.ttf to the output Chris@151: # directory and reference it in all dot files that doxygen generates. This Chris@151: # font does not include all possible unicode characters however, so when you need Chris@151: # these (or just want a differently looking font) you can specify the font name Chris@151: # using DOT_FONTNAME. You need need to make sure dot is able to find the font, Chris@151: # which can be done by putting it in a standard location or by setting the Chris@151: # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory Chris@151: # containing the font. Chris@151: Chris@151: DOT_FONTNAME = DejaVuSansCondensed Chris@151: Chris@151: # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. Chris@151: # The default size is 10pt. Chris@151: Chris@151: DOT_FONTSIZE = 9 Chris@151: Chris@151: # By default doxygen will tell dot to use the output directory to look for the Chris@151: # FreeSans.ttf font (which doxygen will put there itself). If you specify a Chris@151: # different font using DOT_FONTNAME you can set the path where dot Chris@151: # can find it using this tag. Chris@151: Chris@151: DOT_FONTPATH = /usr/share/fonts/truetype/ttf-dejavu Chris@151: Chris@151: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen Chris@151: # will generate a graph for each documented class showing the direct and Chris@151: # indirect inheritance relations. Setting this tag to YES will force the Chris@151: # the CLASS_DIAGRAMS tag to NO. Chris@151: Chris@151: CLASS_GRAPH = YES Chris@151: Chris@151: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen Chris@151: # will generate a graph for each documented class showing the direct and Chris@151: # indirect implementation dependencies (inheritance, containment, and Chris@151: # class references variables) of the class with other documented classes. Chris@151: Chris@151: COLLABORATION_GRAPH = NO Chris@151: Chris@151: # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen Chris@151: # will generate a graph for groups, showing the direct groups dependencies Chris@151: Chris@151: GROUP_GRAPHS = YES Chris@151: Chris@151: # If the UML_LOOK tag is set to YES doxygen will generate inheritance and Chris@151: # collaboration diagrams in a style similar to the OMG's Unified Modeling Chris@151: # Language. Chris@151: Chris@151: UML_LOOK = NO Chris@151: Chris@151: # If set to YES, the inheritance and collaboration graphs will show the Chris@151: # relations between templates and their instances. Chris@151: Chris@151: TEMPLATE_RELATIONS = NO Chris@151: Chris@151: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT Chris@151: # tags are set to YES then doxygen will generate a graph for each documented Chris@151: # file showing the direct and indirect include dependencies of the file with Chris@151: # other documented files. Chris@151: Chris@151: INCLUDE_GRAPH = YES Chris@151: Chris@151: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and Chris@151: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each Chris@151: # documented header file showing the documented files that directly or Chris@151: # indirectly include this file. Chris@151: Chris@151: INCLUDED_BY_GRAPH = YES Chris@151: Chris@151: # If the CALL_GRAPH and HAVE_DOT options are set to YES then Chris@151: # doxygen will generate a call dependency graph for every global function Chris@151: # or class method. Note that enabling this option will significantly increase Chris@151: # the time of a run. So in most cases it will be better to enable call graphs Chris@151: # for selected functions only using the \callgraph command. Chris@151: Chris@151: CALL_GRAPH = NO Chris@151: Chris@151: # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then Chris@151: # doxygen will generate a caller dependency graph for every global function Chris@151: # or class method. Note that enabling this option will significantly increase Chris@151: # the time of a run. So in most cases it will be better to enable caller Chris@151: # graphs for selected functions only using the \callergraph command. Chris@151: Chris@151: CALLER_GRAPH = NO Chris@151: Chris@151: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen Chris@151: # will graphical hierarchy of all classes instead of a textual one. Chris@151: Chris@151: GRAPHICAL_HIERARCHY = YES Chris@151: Chris@151: # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES Chris@151: # then doxygen will show the dependencies a directory has on other directories Chris@151: # in a graphical way. The dependency relations are determined by the #include Chris@151: # relations between the files in the directories. Chris@151: Chris@151: DIRECTORY_GRAPH = YES Chris@151: Chris@151: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images Chris@151: # generated by dot. Possible values are png, jpg, or gif Chris@151: # If left blank png will be used. Chris@151: Chris@151: DOT_IMAGE_FORMAT = png Chris@151: Chris@151: # The tag DOT_PATH can be used to specify the path where the dot tool can be Chris@151: # found. If left blank, it is assumed the dot tool can be found in the path. Chris@151: Chris@151: DOT_PATH = Chris@151: Chris@151: # The DOTFILE_DIRS tag can be used to specify one or more directories that Chris@151: # contain dot files that are included in the documentation (see the Chris@151: # \dotfile command). Chris@151: Chris@151: DOTFILE_DIRS = Chris@151: Chris@151: # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of Chris@151: # nodes that will be shown in the graph. If the number of nodes in a graph Chris@151: # becomes larger than this value, doxygen will truncate the graph, which is Chris@151: # visualized by representing a node as a red box. Note that doxygen if the Chris@151: # number of direct children of the root node in a graph is already larger than Chris@151: # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note Chris@151: # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. Chris@151: Chris@151: DOT_GRAPH_MAX_NODES = 50 Chris@151: Chris@151: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the Chris@151: # graphs generated by dot. A depth value of 3 means that only nodes reachable Chris@151: # from the root by following a path via at most 3 edges will be shown. Nodes Chris@151: # that lay further from the root node will be omitted. Note that setting this Chris@151: # option to 1 or 2 may greatly reduce the computation time needed for large Chris@151: # code bases. Also note that the size of a graph can be further restricted by Chris@151: # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. Chris@151: Chris@151: MAX_DOT_GRAPH_DEPTH = 0 Chris@151: Chris@151: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent Chris@151: # background. This is disabled by default, because dot on Windows does not Chris@151: # seem to support this out of the box. Warning: Depending on the platform used, Chris@151: # enabling this option may lead to badly anti-aliased labels on the edges of Chris@151: # a graph (i.e. they become hard to read). Chris@151: Chris@151: DOT_TRANSPARENT = NO Chris@151: Chris@151: # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output Chris@151: # files in one run (i.e. multiple -o and -T options on the command line). This Chris@151: # makes dot run faster, but since only newer versions of dot (>1.8.10) Chris@151: # support this, this feature is disabled by default. Chris@151: Chris@151: DOT_MULTI_TARGETS = YES Chris@151: Chris@151: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will Chris@151: # generate a legend page explaining the meaning of the various boxes and Chris@151: # arrows in the dot generated graphs. Chris@151: Chris@151: GENERATE_LEGEND = YES Chris@151: Chris@151: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will Chris@151: # remove the intermediate dot files that are used to generate Chris@151: # the various graphs. Chris@151: Chris@151: DOT_CLEANUP = YES Chris@151: Chris@151: #--------------------------------------------------------------------------- Chris@151: # Options related to the search engine Chris@151: #--------------------------------------------------------------------------- Chris@151: Chris@151: # The SEARCHENGINE tag specifies whether or not a search engine should be Chris@151: # used. If set to NO the values of all tags below this one will be ignored. Chris@151: Chris@151: SEARCHENGINE = NO