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