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