c@148: # Doxyfile 1.8.7 c@148: c@148: # This file describes the settings to be used by the documentation system c@148: # doxygen (www.doxygen.org) for a project. c@148: # c@148: # All text after a double hash (##) is considered a comment and is placed in c@148: # front of the TAG it is preceding. c@148: # c@148: # All text after a single hash (#) is considered a comment and will be ignored. c@148: # The format is: c@148: # TAG = value [value, ...] c@148: # For lists, items can also be appended using: c@148: # TAG += value [value, ...] c@148: # Values that contain spaces should be placed between quotes (\" \"). c@148: c@148: #--------------------------------------------------------------------------- c@148: # Project related configuration options c@148: #--------------------------------------------------------------------------- c@148: c@148: # This tag specifies the encoding used for all characters in the config file c@148: # that follow. The default is UTF-8 which is also the encoding used for all text c@148: # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv c@148: # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv c@148: # for the list of possible encodings. c@148: # The default value is: UTF-8. c@148: c@148: DOXYFILE_ENCODING = UTF-8 c@148: c@148: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by c@148: # double-quotes, unless you are using Doxywizard) that should identify the c@148: # project for which the documentation is generated. This name is used in the c@148: # title of most generated pages and in a few other places. c@148: # The default value is: My Project. c@148: c@148: PROJECT_NAME = "Constant-Q Library" c@148: c@148: # The PROJECT_NUMBER tag can be used to enter a project or revision number. This c@148: # could be handy for archiving the generated documentation or if some version c@148: # control system is used. c@148: c@148: PROJECT_NUMBER = c@148: c@148: # Using the PROJECT_BRIEF tag one can provide an optional one line description c@148: # for a project that appears at the top of each page and should give viewer a c@148: # quick idea about the purpose of the project. Keep the description short. c@148: c@148: PROJECT_BRIEF = c@148: c@148: # With the PROJECT_LOGO tag one can specify an logo or icon that is included in c@148: # the documentation. The maximum height of the logo should not exceed 55 pixels c@148: # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo c@148: # to the output directory. c@148: c@148: PROJECT_LOGO = c@148: c@148: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path c@148: # into which the generated documentation will be written. If a relative path is c@148: # entered, it will be relative to the location where doxygen was started. If c@148: # left blank the current directory will be used. c@148: c@148: OUTPUT_DIRECTORY = doc c@148: c@148: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- c@148: # directories (in 2 levels) under the output directory of each output format and c@148: # will distribute the generated files over these directories. Enabling this c@148: # option can be useful when feeding doxygen a huge amount of source files, where c@148: # putting all generated files in the same directory would otherwise causes c@148: # performance problems for the file system. c@148: # The default value is: NO. c@148: c@148: CREATE_SUBDIRS = NO c@148: c@148: # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII c@148: # characters to appear in the names of generated files. If set to NO, non-ASCII c@148: # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode c@148: # U+3044. c@148: # The default value is: NO. c@148: c@148: ALLOW_UNICODE_NAMES = NO c@148: c@148: # The OUTPUT_LANGUAGE tag is used to specify the language in which all c@148: # documentation generated by doxygen is written. Doxygen will use this c@148: # information to generate all constant output in the proper language. c@148: # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, c@148: # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), c@148: # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, c@148: # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), c@148: # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, c@148: # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, c@148: # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, c@148: # Ukrainian and Vietnamese. c@148: # The default value is: English. c@148: c@148: OUTPUT_LANGUAGE = English c@148: c@148: # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member c@148: # descriptions after the members that are listed in the file and class c@148: # documentation (similar to Javadoc). Set to NO to disable this. c@148: # The default value is: YES. c@148: c@148: BRIEF_MEMBER_DESC = YES c@148: c@148: # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief c@148: # description of a member or function before the detailed description c@148: # c@148: # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the c@148: # brief descriptions will be completely suppressed. c@148: # The default value is: YES. c@148: c@148: REPEAT_BRIEF = YES c@148: c@148: # This tag implements a quasi-intelligent brief description abbreviator that is c@148: # used to form the text in various listings. Each string in this list, if found c@148: # as the leading text of the brief description, will be stripped from the text c@148: # and the result, after processing the whole list, is used as the annotated c@148: # text. Otherwise, the brief description is used as-is. If left blank, the c@148: # following values are used ($name is automatically replaced with the name of c@148: # the entity):The $name class, The $name widget, The $name file, is, provides, c@148: # specifies, contains, represents, a, an and the. c@148: c@148: ABBREVIATE_BRIEF = c@148: c@148: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then c@148: # doxygen will generate a detailed section even if there is only a brief c@148: # description. c@148: # The default value is: NO. c@148: c@148: ALWAYS_DETAILED_SEC = NO c@148: c@148: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all c@148: # inherited members of a class in the documentation of that class as if those c@148: # members were ordinary class members. Constructors, destructors and assignment c@148: # operators of the base classes will not be shown. c@148: # The default value is: NO. c@148: c@148: INLINE_INHERITED_MEMB = NO c@148: c@148: # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path c@148: # before files name in the file list and in the header files. If set to NO the c@148: # shortest path that makes the file name unique will be used c@148: # The default value is: YES. c@148: c@148: FULL_PATH_NAMES = YES c@148: c@148: # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. c@148: # Stripping is only done if one of the specified strings matches the left-hand c@148: # part of the path. The tag can be used to show relative paths in the file list. c@148: # If left blank the directory from which doxygen is run is used as the path to c@148: # strip. c@148: # c@148: # Note that you can specify absolute paths here, but also relative paths, which c@148: # will be relative from the directory where doxygen is started. c@148: # This tag requires that the tag FULL_PATH_NAMES is set to YES. c@148: c@148: STRIP_FROM_PATH = c@148: c@148: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the c@148: # path mentioned in the documentation of a class, which tells the reader which c@148: # header file to include in order to use a class. If left blank only the name of c@148: # the header file containing the class definition is used. Otherwise one should c@148: # specify the list of include paths that are normally passed to the compiler c@148: # using the -I flag. c@148: c@148: STRIP_FROM_INC_PATH = c@148: c@148: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but c@148: # less readable) file names. This can be useful is your file systems doesn't c@148: # support long names like on DOS, Mac, or CD-ROM. c@148: # The default value is: NO. c@148: c@148: SHORT_NAMES = NO c@148: c@148: # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the c@148: # first line (until the first dot) of a Javadoc-style comment as the brief c@148: # description. If set to NO, the Javadoc-style will behave just like regular Qt- c@148: # style comments (thus requiring an explicit @brief command for a brief c@148: # description.) c@148: # The default value is: NO. c@148: c@148: JAVADOC_AUTOBRIEF = NO c@148: c@148: # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first c@148: # line (until the first dot) of a Qt-style comment as the brief description. If c@148: # set to NO, the Qt-style will behave just like regular Qt-style comments (thus c@148: # requiring an explicit \brief command for a brief description.) c@148: # The default value is: NO. c@148: c@148: QT_AUTOBRIEF = NO c@148: c@148: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a c@148: # multi-line C++ special comment block (i.e. a block of //! or /// comments) as c@148: # a brief description. This used to be the default behavior. The new default is c@148: # to treat a multi-line C++ comment block as a detailed description. Set this c@148: # tag to YES if you prefer the old behavior instead. c@148: # c@148: # Note that setting this tag to YES also means that rational rose comments are c@148: # not recognized any more. c@148: # The default value is: NO. c@148: c@148: MULTILINE_CPP_IS_BRIEF = NO c@148: c@148: # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the c@148: # documentation from any documented member that it re-implements. c@148: # The default value is: YES. c@148: c@148: INHERIT_DOCS = YES c@148: c@148: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a c@148: # new page for each member. If set to NO, the documentation of a member will be c@148: # part of the file/class/namespace that contains it. c@148: # The default value is: NO. c@148: c@148: SEPARATE_MEMBER_PAGES = NO c@148: c@148: # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen c@148: # uses this value to replace tabs by spaces in code fragments. c@148: # Minimum value: 1, maximum value: 16, default value: 4. c@148: c@148: TAB_SIZE = 4 c@148: c@148: # This tag can be used to specify a number of aliases that act as commands in c@148: # the documentation. An alias has the form: c@148: # name=value c@148: # For example adding c@148: # "sideeffect=@par Side Effects:\n" c@148: # will allow you to put the command \sideeffect (or @sideeffect) in the c@148: # documentation, which will result in a user-defined paragraph with heading c@148: # "Side Effects:". You can put \n's in the value part of an alias to insert c@148: # newlines. c@148: c@148: ALIASES = c@148: c@148: # This tag can be used to specify a number of word-keyword mappings (TCL only). c@148: # A mapping has the form "name=value". For example adding "class=itcl::class" c@148: # will allow you to use the command class in the itcl::class meaning. c@148: c@148: TCL_SUBST = c@148: c@148: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources c@148: # only. Doxygen will then generate output that is more tailored for C. For c@148: # instance, some of the names that are used will be different. The list of all c@148: # members will be omitted, etc. c@148: # The default value is: NO. c@148: c@148: OPTIMIZE_OUTPUT_FOR_C = NO c@148: c@148: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or c@148: # Python sources only. Doxygen will then generate output that is more tailored c@148: # for that language. For instance, namespaces will be presented as packages, c@148: # qualified scopes will look different, etc. c@148: # The default value is: NO. c@148: c@148: OPTIMIZE_OUTPUT_JAVA = NO c@148: c@148: # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran c@148: # sources. Doxygen will then generate output that is tailored for Fortran. c@148: # The default value is: NO. c@148: c@148: OPTIMIZE_FOR_FORTRAN = NO c@148: c@148: # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL c@148: # sources. Doxygen will then generate output that is tailored for VHDL. c@148: # The default value is: NO. c@148: c@148: OPTIMIZE_OUTPUT_VHDL = NO c@148: c@148: # Doxygen selects the parser to use depending on the extension of the files it c@148: # parses. With this tag you can assign which parser to use for a given c@148: # extension. Doxygen has a built-in mapping, but you can override or extend it c@148: # using this tag. The format is ext=language, where ext is a file extension, and c@148: # language is one of the parsers supported by doxygen: IDL, Java, Javascript, c@148: # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: c@148: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: c@148: # Fortran. In the later case the parser tries to guess whether the code is fixed c@148: # or free formatted code, this is the default for Fortran type files), VHDL. For c@148: # instance to make doxygen treat .inc files as Fortran files (default is PHP), c@148: # and .f files as C (default is Fortran), use: inc=Fortran f=C. c@148: # c@148: # Note For files without extension you can use no_extension as a placeholder. c@148: # c@148: # Note that for custom extensions you also need to set FILE_PATTERNS otherwise c@148: # the files are not read by doxygen. c@148: c@148: EXTENSION_MAPPING = c@148: c@148: # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments c@148: # according to the Markdown format, which allows for more readable c@148: # documentation. See http://daringfireball.net/projects/markdown/ for details. c@148: # The output of markdown processing is further processed by doxygen, so you can c@148: # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in c@148: # case of backward compatibilities issues. c@148: # The default value is: YES. c@148: c@148: MARKDOWN_SUPPORT = YES c@148: c@148: # When enabled doxygen tries to link words that correspond to documented c@148: # classes, or namespaces to their corresponding documentation. Such a link can c@148: # be prevented in individual cases by by putting a % sign in front of the word c@148: # or globally by setting AUTOLINK_SUPPORT to NO. c@148: # The default value is: YES. c@148: c@148: AUTOLINK_SUPPORT = YES c@148: c@148: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want c@148: # to include (a tag file for) the STL sources as input, then you should set this c@148: # tag to YES in order to let doxygen match functions declarations and c@148: # definitions whose arguments contain STL classes (e.g. func(std::string); c@148: # versus func(std::string) {}). This also make the inheritance and collaboration c@148: # diagrams that involve STL classes more complete and accurate. c@148: # The default value is: NO. c@148: c@148: BUILTIN_STL_SUPPORT = NO c@148: c@148: # If you use Microsoft's C++/CLI language, you should set this option to YES to c@148: # enable parsing support. c@148: # The default value is: NO. c@148: c@148: CPP_CLI_SUPPORT = NO c@148: c@148: # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: c@148: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen c@148: # will parse them like normal C++ but will assume all classes use public instead c@148: # of private inheritance when no explicit protection keyword is present. c@148: # The default value is: NO. c@148: c@148: SIP_SUPPORT = NO c@148: c@148: # For Microsoft's IDL there are propget and propput attributes to indicate c@148: # getter and setter methods for a property. Setting this option to YES will make c@148: # doxygen to replace the get and set methods by a property in the documentation. c@148: # This will only work if the methods are indeed getting or setting a simple c@148: # type. If this is not the case, or you want to show the methods anyway, you c@148: # should set this option to NO. c@148: # The default value is: YES. c@148: c@148: IDL_PROPERTY_SUPPORT = YES c@148: c@148: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC c@148: # tag is set to YES, then doxygen will reuse the documentation of the first c@148: # member in the group (if any) for the other members of the group. By default c@148: # all members of a group must be documented explicitly. c@148: # The default value is: NO. c@148: c@148: DISTRIBUTE_GROUP_DOC = NO c@148: c@148: # Set the SUBGROUPING tag to YES to allow class member groups of the same type c@148: # (for instance a group of public functions) to be put as a subgroup of that c@148: # type (e.g. under the Public Functions section). Set it to NO to prevent c@148: # subgrouping. Alternatively, this can be done per class using the c@148: # \nosubgrouping command. c@148: # The default value is: YES. c@148: c@148: SUBGROUPING = YES c@148: c@148: # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions c@148: # are shown inside the group in which they are included (e.g. using \ingroup) c@148: # instead of on a separate page (for HTML and Man pages) or section (for LaTeX c@148: # and RTF). c@148: # c@148: # Note that this feature does not work in combination with c@148: # SEPARATE_MEMBER_PAGES. c@148: # The default value is: NO. c@148: c@148: INLINE_GROUPED_CLASSES = NO c@148: c@148: # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions c@148: # with only public data fields or simple typedef fields will be shown inline in c@148: # the documentation of the scope in which they are defined (i.e. file, c@148: # namespace, or group documentation), provided this scope is documented. If set c@148: # to NO, structs, classes, and unions are shown on a separate page (for HTML and c@148: # Man pages) or section (for LaTeX and RTF). c@148: # The default value is: NO. c@148: c@148: INLINE_SIMPLE_STRUCTS = NO c@148: c@148: # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or c@148: # enum is documented as struct, union, or enum with the name of the typedef. So c@148: # typedef struct TypeS {} TypeT, will appear in the documentation as a struct c@148: # with name TypeT. When disabled the typedef will appear as a member of a file, c@148: # namespace, or class. And the struct will be named TypeS. This can typically be c@148: # useful for C code in case the coding convention dictates that all compound c@148: # types are typedef'ed and only the typedef is referenced, never the tag name. c@148: # The default value is: NO. c@148: c@148: TYPEDEF_HIDES_STRUCT = NO c@148: c@148: # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This c@148: # cache is used to resolve symbols given their name and scope. Since this can be c@148: # an expensive process and often the same symbol appears multiple times in the c@148: # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small c@148: # doxygen will become slower. If the cache is too large, memory is wasted. The c@148: # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range c@148: # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 c@148: # symbols. At the end of a run doxygen will report the cache usage and suggest c@148: # the optimal cache size from a speed point of view. c@148: # Minimum value: 0, maximum value: 9, default value: 0. c@148: c@148: LOOKUP_CACHE_SIZE = 0 c@148: c@148: #--------------------------------------------------------------------------- c@148: # Build related configuration options c@148: #--------------------------------------------------------------------------- c@148: c@148: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in c@148: # documentation are documented, even if no documentation was available. Private c@148: # class members and static file members will be hidden unless the c@148: # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. c@148: # Note: This will also disable the warnings about undocumented members that are c@148: # normally produced when WARNINGS is set to YES. c@148: # The default value is: NO. c@148: c@148: EXTRACT_ALL = YES c@148: c@148: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will c@148: # be included in the documentation. c@148: # The default value is: NO. c@148: c@148: EXTRACT_PRIVATE = NO c@148: c@148: # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal c@148: # scope will be included in the documentation. c@148: # The default value is: NO. c@148: c@148: EXTRACT_PACKAGE = NO c@148: c@148: # If the EXTRACT_STATIC tag is set to YES all static members of a file will be c@148: # included in the documentation. c@148: # The default value is: NO. c@148: c@148: EXTRACT_STATIC = NO c@148: c@148: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined c@148: # locally in source files will be included in the documentation. If set to NO c@148: # only classes defined in header files are included. Does not have any effect c@148: # for Java sources. c@148: # The default value is: YES. c@148: c@148: EXTRACT_LOCAL_CLASSES = YES c@148: c@148: # This flag is only useful for Objective-C code. When set to YES local methods, c@148: # which are defined in the implementation section but not in the interface are c@148: # included in the documentation. If set to NO only methods in the interface are c@148: # included. c@148: # The default value is: NO. c@148: c@148: EXTRACT_LOCAL_METHODS = NO c@148: c@148: # If this flag is set to YES, the members of anonymous namespaces will be c@148: # extracted and appear in the documentation as a namespace called c@148: # 'anonymous_namespace{file}', where file will be replaced with the base name of c@148: # the file that contains the anonymous namespace. By default anonymous namespace c@148: # are hidden. c@148: # The default value is: NO. c@148: c@148: EXTRACT_ANON_NSPACES = NO c@148: c@148: # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all c@148: # undocumented members inside documented classes or files. If set to NO these c@148: # members will be included in the various overviews, but no documentation c@148: # section is generated. This option has no effect if EXTRACT_ALL is enabled. c@148: # The default value is: NO. c@148: c@148: HIDE_UNDOC_MEMBERS = NO c@148: c@148: # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all c@148: # undocumented classes that are normally visible in the class hierarchy. If set c@148: # to NO these classes will be included in the various overviews. This option has c@148: # no effect if EXTRACT_ALL is enabled. c@148: # The default value is: NO. c@148: c@148: HIDE_UNDOC_CLASSES = NO c@148: c@148: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend c@148: # (class|struct|union) declarations. If set to NO these declarations will be c@148: # included in the documentation. c@148: # The default value is: NO. c@148: c@148: HIDE_FRIEND_COMPOUNDS = NO c@148: c@148: # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any c@148: # documentation blocks found inside the body of a function. If set to NO these c@148: # blocks will be appended to the function's detailed documentation block. c@148: # The default value is: NO. c@148: c@148: HIDE_IN_BODY_DOCS = NO c@148: c@148: # The INTERNAL_DOCS tag determines if documentation that is typed after a c@148: # \internal command is included. If the tag is set to NO then the documentation c@148: # will be excluded. Set it to YES to include the internal documentation. c@148: # The default value is: NO. c@148: c@148: INTERNAL_DOCS = NO c@148: c@148: # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file c@148: # names in lower-case letters. If set to YES upper-case letters are also c@148: # allowed. This is useful if you have classes or files whose names only differ c@148: # in case and if your file system supports case sensitive file names. Windows c@148: # and Mac users are advised to set this option to NO. c@148: # The default value is: system dependent. c@148: c@148: CASE_SENSE_NAMES = YES c@148: c@148: # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with c@148: # their full class and namespace scopes in the documentation. If set to YES the c@148: # scope will be hidden. c@148: # The default value is: NO. c@148: c@148: HIDE_SCOPE_NAMES = NO c@148: c@148: # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of c@148: # the files that are included by a file in the documentation of that file. c@148: # The default value is: YES. c@148: c@148: SHOW_INCLUDE_FILES = YES c@148: c@148: # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each c@148: # grouped member an include statement to the documentation, telling the reader c@148: # which file to include in order to use the member. c@148: # The default value is: NO. c@148: c@148: SHOW_GROUPED_MEMB_INC = NO c@148: c@148: # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include c@148: # files with double quotes in the documentation rather than with sharp brackets. c@148: # The default value is: NO. c@148: c@148: FORCE_LOCAL_INCLUDES = NO c@148: c@148: # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the c@148: # documentation for inline members. c@148: # The default value is: YES. c@148: c@148: INLINE_INFO = YES c@148: c@148: # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the c@148: # (detailed) documentation of file and class members alphabetically by member c@148: # name. If set to NO the members will appear in declaration order. c@148: # The default value is: YES. c@148: c@148: SORT_MEMBER_DOCS = YES c@148: c@148: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief c@148: # descriptions of file, namespace and class members alphabetically by member c@148: # name. If set to NO the members will appear in declaration order. Note that c@148: # this will also influence the order of the classes in the class list. c@148: # The default value is: NO. c@148: c@148: SORT_BRIEF_DOCS = NO c@148: c@148: # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the c@148: # (brief and detailed) documentation of class members so that constructors and c@148: # destructors are listed first. If set to NO the constructors will appear in the c@148: # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. c@148: # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief c@148: # member documentation. c@148: # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting c@148: # detailed member documentation. c@148: # The default value is: NO. c@148: c@148: SORT_MEMBERS_CTORS_1ST = NO c@148: c@148: # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy c@148: # of group names into alphabetical order. If set to NO the group names will c@148: # appear in their defined order. c@148: # The default value is: NO. c@148: c@148: SORT_GROUP_NAMES = NO c@148: c@148: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by c@148: # fully-qualified names, including namespaces. If set to NO, the class list will c@148: # be sorted only by class name, not including the namespace part. c@148: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. c@148: # Note: This option applies only to the class list, not to the alphabetical c@148: # list. c@148: # The default value is: NO. c@148: c@148: SORT_BY_SCOPE_NAME = NO c@148: c@148: # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper c@148: # type resolution of all parameters of a function it will reject a match between c@148: # the prototype and the implementation of a member function even if there is c@148: # only one candidate or it is obvious which candidate to choose by doing a c@148: # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still c@148: # accept a match between prototype and implementation in such cases. c@148: # The default value is: NO. c@148: c@148: STRICT_PROTO_MATCHING = NO c@148: c@148: # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the c@148: # todo list. This list is created by putting \todo commands in the c@148: # documentation. c@148: # The default value is: YES. c@148: c@148: GENERATE_TODOLIST = YES c@148: c@148: # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the c@148: # test list. This list is created by putting \test commands in the c@148: # documentation. c@148: # The default value is: YES. c@148: c@148: GENERATE_TESTLIST = YES c@148: c@148: # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug c@148: # list. This list is created by putting \bug commands in the documentation. c@148: # The default value is: YES. c@148: c@148: GENERATE_BUGLIST = YES c@148: c@148: # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) c@148: # the deprecated list. This list is created by putting \deprecated commands in c@148: # the documentation. c@148: # The default value is: YES. c@148: c@148: GENERATE_DEPRECATEDLIST= YES c@148: c@148: # The ENABLED_SECTIONS tag can be used to enable conditional documentation c@148: # sections, marked by \if ... \endif and \cond c@148: # ... \endcond blocks. c@148: c@148: ENABLED_SECTIONS = c@148: c@148: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the c@148: # initial value of a variable or macro / define can have for it to appear in the c@148: # documentation. If the initializer consists of more lines than specified here c@148: # it will be hidden. Use a value of 0 to hide initializers completely. The c@148: # appearance of the value of individual variables and macros / defines can be c@148: # controlled using \showinitializer or \hideinitializer command in the c@148: # documentation regardless of this setting. c@148: # Minimum value: 0, maximum value: 10000, default value: 30. c@148: c@148: MAX_INITIALIZER_LINES = 30 c@148: c@148: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at c@148: # the bottom of the documentation of classes and structs. If set to YES the list c@148: # will mention the files that were used to generate the documentation. c@148: # The default value is: YES. c@148: c@148: SHOW_USED_FILES = YES c@148: c@148: # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This c@148: # will remove the Files entry from the Quick Index and from the Folder Tree View c@148: # (if specified). c@148: # The default value is: YES. c@148: c@148: SHOW_FILES = YES c@148: c@148: # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces c@148: # page. This will remove the Namespaces entry from the Quick Index and from the c@148: # Folder Tree View (if specified). c@148: # The default value is: YES. c@148: c@148: SHOW_NAMESPACES = YES c@148: c@148: # The FILE_VERSION_FILTER tag can be used to specify a program or script that c@148: # doxygen should invoke to get the current version for each file (typically from c@148: # the version control system). Doxygen will invoke the program by executing (via c@148: # popen()) the command command input-file, where command is the value of the c@148: # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided c@148: # by doxygen. Whatever the program writes to standard output is used as the file c@148: # version. For an example see the documentation. c@148: c@148: FILE_VERSION_FILTER = c@148: c@148: # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed c@148: # by doxygen. The layout file controls the global structure of the generated c@148: # output files in an output format independent way. To create the layout file c@148: # that represents doxygen's defaults, run doxygen with the -l option. You can c@148: # optionally specify a file name after the option, if omitted DoxygenLayout.xml c@148: # will be used as the name of the layout file. c@148: # c@148: # Note that if you run doxygen from a directory containing a file called c@148: # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE c@148: # tag is left empty. c@148: c@148: LAYOUT_FILE = c@148: c@148: # The CITE_BIB_FILES tag can be used to specify one or more bib files containing c@148: # the reference definitions. This must be a list of .bib files. The .bib c@148: # extension is automatically appended if omitted. This requires the bibtex tool c@148: # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. c@148: # For LaTeX the style of the bibliography can be controlled using c@148: # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the c@148: # search path. Do not use file names with spaces, bibtex cannot handle them. See c@148: # also \cite for info how to create references. c@148: c@148: CITE_BIB_FILES = c@148: c@148: #--------------------------------------------------------------------------- c@148: # Configuration options related to warning and progress messages c@148: #--------------------------------------------------------------------------- c@148: c@148: # The QUIET tag can be used to turn on/off the messages that are generated to c@148: # standard output by doxygen. If QUIET is set to YES this implies that the c@148: # messages are off. c@148: # The default value is: NO. c@148: c@148: QUIET = NO c@148: c@148: # The WARNINGS tag can be used to turn on/off the warning messages that are c@148: # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES c@148: # this implies that the warnings are on. c@148: # c@148: # Tip: Turn warnings on while writing the documentation. c@148: # The default value is: YES. c@148: c@148: WARNINGS = YES c@148: c@148: # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate c@148: # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag c@148: # will automatically be disabled. c@148: # The default value is: YES. c@148: c@148: WARN_IF_UNDOCUMENTED = YES c@148: c@148: # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for c@148: # potential errors in the documentation, such as not documenting some parameters c@148: # in a documented function, or documenting parameters that don't exist or using c@148: # markup commands wrongly. c@148: # The default value is: YES. c@148: c@148: WARN_IF_DOC_ERROR = YES c@148: c@148: # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that c@148: # are documented, but have no documentation for their parameters or return c@148: # value. If set to NO doxygen will only warn about wrong or incomplete parameter c@148: # documentation, but not about the absence of documentation. c@148: # The default value is: NO. c@148: c@148: WARN_NO_PARAMDOC = NO c@148: c@148: # The WARN_FORMAT tag determines the format of the warning messages that doxygen c@148: # can produce. The string should contain the $file, $line, and $text tags, which c@148: # will be replaced by the file and line number from which the warning originated c@148: # and the warning text. Optionally the format may contain $version, which will c@148: # be replaced by the version of the file (if it could be obtained via c@148: # FILE_VERSION_FILTER) c@148: # The default value is: $file:$line: $text. c@148: c@148: WARN_FORMAT = "$file:$line: $text" c@148: c@148: # The WARN_LOGFILE tag can be used to specify a file to which warning and error c@148: # messages should be written. If left blank the output is written to standard c@148: # error (stderr). c@148: c@148: WARN_LOGFILE = c@148: c@148: #--------------------------------------------------------------------------- c@148: # Configuration options related to the input files c@148: #--------------------------------------------------------------------------- c@148: c@148: # The INPUT tag is used to specify the files and/or directories that contain c@148: # documented source files. You may enter file names like myfile.cpp or c@148: # directories like /usr/src/myproject. Separate the files or directories with c@148: # spaces. c@148: # Note: If this tag is empty the current directory is searched. c@148: c@148: INPUT = cq src vamp c@148: c@148: # This tag can be used to specify the character encoding of the source files c@148: # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses c@148: # libiconv (or the iconv built into libc) for the transcoding. See the libiconv c@148: # documentation (see: http://www.gnu.org/software/libiconv) for the list of c@148: # possible encodings. c@148: # The default value is: UTF-8. c@148: c@148: INPUT_ENCODING = UTF-8 c@148: c@148: # If the value of the INPUT tag contains directories, you can use the c@148: # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and c@148: # *.h) to filter out the source-files in the directories. If left blank the c@148: # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, c@148: # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, c@148: # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, c@148: # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, c@148: # *.qsf, *.as and *.js. c@148: c@148: FILE_PATTERNS = c@148: c@148: # The RECURSIVE tag can be used to specify whether or not subdirectories should c@148: # be searched for input files as well. c@148: # The default value is: NO. c@148: c@148: RECURSIVE = NO c@148: c@148: # The EXCLUDE tag can be used to specify files and/or directories that should be c@148: # excluded from the INPUT source files. This way you can easily exclude a c@148: # subdirectory from a directory tree whose root is specified with the INPUT tag. c@148: # c@148: # Note that relative paths are relative to the directory from which doxygen is c@148: # run. c@148: c@148: EXCLUDE = c@148: c@148: # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or c@148: # directories that are symbolic links (a Unix file system feature) are excluded c@148: # from the input. c@148: # The default value is: NO. c@148: c@148: EXCLUDE_SYMLINKS = NO c@148: c@148: # If the value of the INPUT tag contains directories, you can use the c@148: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude c@148: # certain files from those directories. c@148: # c@148: # Note that the wildcards are matched against the file with absolute path, so to c@148: # exclude all test directories for example use the pattern */test/* c@148: c@148: EXCLUDE_PATTERNS = c@148: c@148: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names c@148: # (namespaces, classes, functions, etc.) that should be excluded from the c@148: # output. The symbol name can be a fully qualified name, a word, or if the c@148: # wildcard * is used, a substring. Examples: ANamespace, AClass, c@148: # AClass::ANamespace, ANamespace::*Test c@148: # c@148: # Note that the wildcards are matched against the file with absolute path, so to c@148: # exclude all test directories use the pattern */test/* c@148: c@148: EXCLUDE_SYMBOLS = c@148: c@148: # The EXAMPLE_PATH tag can be used to specify one or more files or directories c@148: # that contain example code fragments that are included (see the \include c@148: # command). c@148: c@148: EXAMPLE_PATH = c@148: c@148: # If the value of the EXAMPLE_PATH tag contains directories, you can use the c@148: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and c@148: # *.h) to filter out the source-files in the directories. If left blank all c@148: # files are included. c@148: c@148: EXAMPLE_PATTERNS = c@148: c@148: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be c@148: # searched for input files to be used with the \include or \dontinclude commands c@148: # irrespective of the value of the RECURSIVE tag. c@148: # The default value is: NO. c@148: c@148: EXAMPLE_RECURSIVE = NO c@148: c@148: # The IMAGE_PATH tag can be used to specify one or more files or directories c@148: # that contain images that are to be included in the documentation (see the c@148: # \image command). c@148: c@148: IMAGE_PATH = c@148: c@148: # The INPUT_FILTER tag can be used to specify a program that doxygen should c@148: # invoke to filter for each input file. Doxygen will invoke the filter program c@148: # by executing (via popen()) the command: c@148: # c@148: # c@148: # c@148: # where is the value of the INPUT_FILTER tag, and is the c@148: # name of an input file. Doxygen will then use the output that the filter c@148: # program writes to standard output. If FILTER_PATTERNS is specified, this tag c@148: # will be ignored. c@148: # c@148: # Note that the filter must not add or remove lines; it is applied before the c@148: # code is scanned, but not when the output code is generated. If lines are added c@148: # or removed, the anchors will not be placed correctly. c@148: c@148: INPUT_FILTER = c@148: c@148: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern c@148: # basis. Doxygen will compare the file name with each pattern and apply the c@148: # filter if there is a match. The filters are a list of the form: pattern=filter c@148: # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how c@148: # filters are used. If the FILTER_PATTERNS tag is empty or if none of the c@148: # patterns match the file name, INPUT_FILTER is applied. c@148: c@148: FILTER_PATTERNS = c@148: c@148: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using c@148: # INPUT_FILTER ) will also be used to filter the input files that are used for c@148: # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). c@148: # The default value is: NO. c@148: c@148: FILTER_SOURCE_FILES = NO c@148: c@148: # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file c@148: # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and c@148: # it is also possible to disable source filtering for a specific pattern using c@148: # *.ext= (so without naming a filter). c@148: # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. c@148: c@148: FILTER_SOURCE_PATTERNS = c@148: c@148: # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that c@148: # is part of the input, its contents will be placed on the main page c@148: # (index.html). This can be useful if you have a project on for instance GitHub c@148: # and want to reuse the introduction page also for the doxygen output. c@148: c@148: USE_MDFILE_AS_MAINPAGE = c@148: c@148: #--------------------------------------------------------------------------- c@148: # Configuration options related to source browsing c@148: #--------------------------------------------------------------------------- c@148: c@148: # If the SOURCE_BROWSER tag is set to YES then a list of source files will be c@148: # generated. Documented entities will be cross-referenced with these sources. c@148: # c@148: # Note: To get rid of all source code in the generated output, make sure that c@148: # also VERBATIM_HEADERS is set to NO. c@148: # The default value is: NO. c@148: c@148: SOURCE_BROWSER = NO c@148: c@148: # Setting the INLINE_SOURCES tag to YES will include the body of functions, c@148: # classes and enums directly into the documentation. c@148: # The default value is: NO. c@148: c@148: INLINE_SOURCES = NO c@148: c@148: # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any c@148: # special comment blocks from generated source code fragments. Normal C, C++ and c@148: # Fortran comments will always remain visible. c@148: # The default value is: YES. c@148: c@148: STRIP_CODE_COMMENTS = YES c@148: c@148: # If the REFERENCED_BY_RELATION tag is set to YES then for each documented c@148: # function all documented functions referencing it will be listed. c@148: # The default value is: NO. c@148: c@148: REFERENCED_BY_RELATION = NO c@148: c@148: # If the REFERENCES_RELATION tag is set to YES then for each documented function c@148: # all documented entities called/used by that function will be listed. c@148: # The default value is: NO. c@148: c@148: REFERENCES_RELATION = NO c@148: c@148: # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set c@148: # to YES, then the hyperlinks from functions in REFERENCES_RELATION and c@148: # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will c@148: # link to the documentation. c@148: # The default value is: YES. c@148: c@148: REFERENCES_LINK_SOURCE = YES c@148: c@148: # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the c@148: # source code will show a tooltip with additional information such as prototype, c@148: # brief description and links to the definition and documentation. Since this c@148: # will make the HTML file larger and loading of large files a bit slower, you c@148: # can opt to disable this feature. c@148: # The default value is: YES. c@148: # This tag requires that the tag SOURCE_BROWSER is set to YES. c@148: c@148: SOURCE_TOOLTIPS = YES c@148: c@148: # If the USE_HTAGS tag is set to YES then the references to source code will c@148: # point to the HTML generated by the htags(1) tool instead of doxygen built-in c@148: # source browser. The htags tool is part of GNU's global source tagging system c@148: # (see http://www.gnu.org/software/global/global.html). You will need version c@148: # 4.8.6 or higher. c@148: # c@148: # To use it do the following: c@148: # - Install the latest version of global c@148: # - Enable SOURCE_BROWSER and USE_HTAGS in the config file c@148: # - Make sure the INPUT points to the root of the source tree c@148: # - Run doxygen as normal c@148: # c@148: # Doxygen will invoke htags (and that will in turn invoke gtags), so these c@148: # tools must be available from the command line (i.e. in the search path). c@148: # c@148: # The result: instead of the source browser generated by doxygen, the links to c@148: # source code will now point to the output of htags. c@148: # The default value is: NO. c@148: # This tag requires that the tag SOURCE_BROWSER is set to YES. c@148: c@148: USE_HTAGS = NO c@148: c@148: # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a c@148: # verbatim copy of the header file for each class for which an include is c@148: # specified. Set to NO to disable this. c@148: # See also: Section \class. c@148: # The default value is: YES. c@148: c@148: VERBATIM_HEADERS = YES c@148: c@148: #--------------------------------------------------------------------------- c@148: # Configuration options related to the alphabetical class index c@148: #--------------------------------------------------------------------------- c@148: c@148: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all c@148: # compounds will be generated. Enable this if the project contains a lot of c@148: # classes, structs, unions or interfaces. c@148: # The default value is: YES. c@148: c@148: ALPHABETICAL_INDEX = YES c@148: c@148: # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in c@148: # which the alphabetical index list will be split. c@148: # Minimum value: 1, maximum value: 20, default value: 5. c@148: # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. c@148: c@148: COLS_IN_ALPHA_INDEX = 5 c@148: c@148: # In case all classes in a project start with a common prefix, all classes will c@148: # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag c@148: # can be used to specify a prefix (or a list of prefixes) that should be ignored c@148: # while generating the index headers. c@148: # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. c@148: c@148: IGNORE_PREFIX = c@148: c@148: #--------------------------------------------------------------------------- c@148: # Configuration options related to the HTML output c@148: #--------------------------------------------------------------------------- c@148: c@148: # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output c@148: # The default value is: YES. c@148: c@148: GENERATE_HTML = YES c@148: c@148: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a c@148: # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of c@148: # it. c@148: # The default directory is: html. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_OUTPUT = html c@148: c@148: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each c@148: # generated HTML page (for example: .htm, .php, .asp). c@148: # The default value is: .html. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_FILE_EXTENSION = .html c@148: c@148: # The HTML_HEADER tag can be used to specify a user-defined HTML header file for c@148: # each generated HTML page. If the tag is left blank doxygen will generate a c@148: # standard header. c@148: # c@148: # To get valid HTML the header file that includes any scripts and style sheets c@148: # that doxygen needs, which is dependent on the configuration options used (e.g. c@148: # the setting GENERATE_TREEVIEW). It is highly recommended to start with a c@148: # default header using c@148: # doxygen -w html new_header.html new_footer.html new_stylesheet.css c@148: # YourConfigFile c@148: # and then modify the file new_header.html. See also section "Doxygen usage" c@148: # for information on how to generate the default header that doxygen normally c@148: # uses. c@148: # Note: The header is subject to change so you typically have to regenerate the c@148: # default header when upgrading to a newer version of doxygen. For a description c@148: # of the possible markers and block names see the documentation. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_HEADER = c@148: c@148: # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each c@148: # generated HTML page. If the tag is left blank doxygen will generate a standard c@148: # footer. See HTML_HEADER for more information on how to generate a default c@148: # footer and what special commands can be used inside the footer. See also c@148: # section "Doxygen usage" for information on how to generate the default footer c@148: # that doxygen normally uses. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_FOOTER = c@148: c@148: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style c@148: # sheet that is used by each HTML page. It can be used to fine-tune the look of c@148: # the HTML output. If left blank doxygen will generate a default style sheet. c@148: # See also section "Doxygen usage" for information on how to generate the style c@148: # sheet that doxygen normally uses. c@148: # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as c@148: # it is more robust and this tag (HTML_STYLESHEET) will in the future become c@148: # obsolete. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_STYLESHEET = c@148: c@148: # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- c@148: # defined cascading style sheet that is included after the standard style sheets c@148: # created by doxygen. Using this option one can overrule certain style aspects. c@148: # This is preferred over using HTML_STYLESHEET since it does not replace the c@148: # standard style sheet and is therefor more robust against future updates. c@148: # Doxygen will copy the style sheet file to the output directory. For an example c@148: # see the documentation. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_EXTRA_STYLESHEET = c@148: c@148: # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or c@148: # other source files which should be copied to the HTML output directory. Note c@148: # that these files will be copied to the base HTML output directory. Use the c@148: # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these c@148: # files. In the HTML_STYLESHEET file, use the file name only. Also note that the c@148: # files will be copied as-is; there are no commands or markers available. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_EXTRA_FILES = c@148: c@148: # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen c@148: # will adjust the colors in the stylesheet and background images according to c@148: # this color. Hue is specified as an angle on a colorwheel, see c@148: # http://en.wikipedia.org/wiki/Hue for more information. For instance the value c@148: # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 c@148: # purple, and 360 is red again. c@148: # Minimum value: 0, maximum value: 359, default value: 220. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_COLORSTYLE_HUE = 220 c@148: c@148: # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors c@148: # in the HTML output. For a value of 0 the output will use grayscales only. A c@148: # value of 255 will produce the most vivid colors. c@148: # Minimum value: 0, maximum value: 255, default value: 100. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_COLORSTYLE_SAT = 100 c@148: c@148: # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the c@148: # luminance component of the colors in the HTML output. Values below 100 c@148: # gradually make the output lighter, whereas values above 100 make the output c@148: # darker. The value divided by 100 is the actual gamma applied, so 80 represents c@148: # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not c@148: # change the gamma. c@148: # Minimum value: 40, maximum value: 240, default value: 80. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_COLORSTYLE_GAMMA = 80 c@148: c@148: # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML c@148: # page will contain the date and time when the page was generated. Setting this c@148: # to NO can help when comparing the output of multiple runs. c@148: # The default value is: YES. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_TIMESTAMP = YES c@148: c@148: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML c@148: # documentation will contain sections that can be hidden and shown after the c@148: # page has loaded. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_DYNAMIC_SECTIONS = NO c@148: c@148: # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries c@148: # shown in the various tree structured indices initially; the user can expand c@148: # and collapse entries dynamically later on. Doxygen will expand the tree to c@148: # such a level that at most the specified number of entries are visible (unless c@148: # a fully collapsed tree already exceeds this amount). So setting the number of c@148: # entries 1 will produce a full collapsed tree by default. 0 is a special value c@148: # representing an infinite number of entries and will result in a full expanded c@148: # tree by default. c@148: # Minimum value: 0, maximum value: 9999, default value: 100. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: HTML_INDEX_NUM_ENTRIES = 100 c@148: c@148: # If the GENERATE_DOCSET tag is set to YES, additional index files will be c@148: # generated that can be used as input for Apple's Xcode 3 integrated development c@148: # environment (see: http://developer.apple.com/tools/xcode/), introduced with c@148: # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a c@148: # Makefile in the HTML output directory. Running make will produce the docset in c@148: # that directory and running make install will install the docset in c@148: # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at c@148: # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html c@148: # for more information. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: GENERATE_DOCSET = NO c@148: c@148: # This tag determines the name of the docset feed. A documentation feed provides c@148: # an umbrella under which multiple documentation sets from a single provider c@148: # (such as a company or product suite) can be grouped. c@148: # The default value is: Doxygen generated docs. c@148: # This tag requires that the tag GENERATE_DOCSET is set to YES. c@148: c@148: DOCSET_FEEDNAME = "Doxygen generated docs" c@148: c@148: # This tag specifies a string that should uniquely identify the documentation c@148: # set bundle. This should be a reverse domain-name style string, e.g. c@148: # com.mycompany.MyDocSet. Doxygen will append .docset to the name. c@148: # The default value is: org.doxygen.Project. c@148: # This tag requires that the tag GENERATE_DOCSET is set to YES. c@148: c@148: DOCSET_BUNDLE_ID = org.doxygen.Project c@148: c@148: # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify c@148: # the documentation publisher. This should be a reverse domain-name style c@148: # string, e.g. com.mycompany.MyDocSet.documentation. c@148: # The default value is: org.doxygen.Publisher. c@148: # This tag requires that the tag GENERATE_DOCSET is set to YES. c@148: c@148: DOCSET_PUBLISHER_ID = org.doxygen.Publisher c@148: c@148: # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. c@148: # The default value is: Publisher. c@148: # This tag requires that the tag GENERATE_DOCSET is set to YES. c@148: c@148: DOCSET_PUBLISHER_NAME = Publisher c@148: c@148: # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three c@148: # additional HTML index files: index.hhp, index.hhc, and index.hhk. The c@148: # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop c@148: # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on c@148: # Windows. c@148: # c@148: # The HTML Help Workshop contains a compiler that can convert all HTML output c@148: # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML c@148: # files are now used as the Windows 98 help format, and will replace the old c@148: # Windows help format (.hlp) on all Windows platforms in the future. Compressed c@148: # HTML files also contain an index, a table of contents, and you can search for c@148: # words in the documentation. The HTML workshop also contains a viewer for c@148: # compressed HTML files. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: GENERATE_HTMLHELP = NO c@148: c@148: # The CHM_FILE tag can be used to specify the file name of the resulting .chm c@148: # file. You can add a path in front of the file if the result should not be c@148: # written to the html output directory. c@148: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. c@148: c@148: CHM_FILE = c@148: c@148: # The HHC_LOCATION tag can be used to specify the location (absolute path c@148: # including file name) of the HTML help compiler ( hhc.exe). If non-empty c@148: # doxygen will try to run the HTML help compiler on the generated index.hhp. c@148: # The file has to be specified with full path. c@148: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. c@148: c@148: HHC_LOCATION = c@148: c@148: # The GENERATE_CHI flag controls if a separate .chi index file is generated ( c@148: # YES) or that it should be included in the master .chm file ( NO). c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. c@148: c@148: GENERATE_CHI = NO c@148: c@148: # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) c@148: # and project file content. c@148: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. c@148: c@148: CHM_INDEX_ENCODING = c@148: c@148: # The BINARY_TOC flag controls whether a binary table of contents is generated ( c@148: # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it c@148: # enables the Previous and Next buttons. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. c@148: c@148: BINARY_TOC = NO c@148: c@148: # The TOC_EXPAND flag can be set to YES to add extra items for group members to c@148: # the table of contents of the HTML help documentation and to the tree view. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. c@148: c@148: TOC_EXPAND = NO c@148: c@148: # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and c@148: # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that c@148: # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help c@148: # (.qch) of the generated HTML documentation. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: GENERATE_QHP = NO c@148: c@148: # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify c@148: # the file name of the resulting .qch file. The path specified is relative to c@148: # the HTML output folder. c@148: # This tag requires that the tag GENERATE_QHP is set to YES. c@148: c@148: QCH_FILE = c@148: c@148: # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help c@148: # Project output. For more information please see Qt Help Project / Namespace c@148: # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). c@148: # The default value is: org.doxygen.Project. c@148: # This tag requires that the tag GENERATE_QHP is set to YES. c@148: c@148: QHP_NAMESPACE = org.doxygen.Project c@148: c@148: # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt c@148: # Help Project output. For more information please see Qt Help Project / Virtual c@148: # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- c@148: # folders). c@148: # The default value is: doc. c@148: # This tag requires that the tag GENERATE_QHP is set to YES. c@148: c@148: QHP_VIRTUAL_FOLDER = doc c@148: c@148: # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom c@148: # filter to add. For more information please see Qt Help Project / Custom c@148: # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- c@148: # filters). c@148: # This tag requires that the tag GENERATE_QHP is set to YES. c@148: c@148: QHP_CUST_FILTER_NAME = c@148: c@148: # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the c@148: # custom filter to add. For more information please see Qt Help Project / Custom c@148: # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- c@148: # filters). c@148: # This tag requires that the tag GENERATE_QHP is set to YES. c@148: c@148: QHP_CUST_FILTER_ATTRS = c@148: c@148: # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this c@148: # project's filter section matches. Qt Help Project / Filter Attributes (see: c@148: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). c@148: # This tag requires that the tag GENERATE_QHP is set to YES. c@148: c@148: QHP_SECT_FILTER_ATTRS = c@148: c@148: # The QHG_LOCATION tag can be used to specify the location of Qt's c@148: # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the c@148: # generated .qhp file. c@148: # This tag requires that the tag GENERATE_QHP is set to YES. c@148: c@148: QHG_LOCATION = c@148: c@148: # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be c@148: # generated, together with the HTML files, they form an Eclipse help plugin. To c@148: # install this plugin and make it available under the help contents menu in c@148: # Eclipse, the contents of the directory containing the HTML and XML files needs c@148: # to be copied into the plugins directory of eclipse. The name of the directory c@148: # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. c@148: # After copying Eclipse needs to be restarted before the help appears. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: GENERATE_ECLIPSEHELP = NO c@148: c@148: # A unique identifier for the Eclipse help plugin. When installing the plugin c@148: # the directory name containing the HTML and XML files should also have this c@148: # name. Each documentation set should have its own identifier. c@148: # The default value is: org.doxygen.Project. c@148: # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. c@148: c@148: ECLIPSE_DOC_ID = org.doxygen.Project c@148: c@148: # If you want full control over the layout of the generated HTML pages it might c@148: # be necessary to disable the index and replace it with your own. The c@148: # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top c@148: # of each HTML page. A value of NO enables the index and the value YES disables c@148: # it. Since the tabs in the index contain the same information as the navigation c@148: # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: DISABLE_INDEX = NO c@148: c@148: # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index c@148: # structure should be generated to display hierarchical information. If the tag c@148: # value is set to YES, a side panel will be generated containing a tree-like c@148: # index structure (just like the one that is generated for HTML Help). For this c@148: # to work a browser that supports JavaScript, DHTML, CSS and frames is required c@148: # (i.e. any modern browser). Windows users are probably better off using the c@148: # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can c@148: # further fine-tune the look of the index. As an example, the default style c@148: # sheet generated by doxygen has an example that shows how to put an image at c@148: # the root of the tree instead of the PROJECT_NAME. Since the tree basically has c@148: # the same information as the tab index, you could consider setting c@148: # DISABLE_INDEX to YES when enabling this option. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: GENERATE_TREEVIEW = NO c@148: c@148: # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that c@148: # doxygen will group on one line in the generated HTML documentation. c@148: # c@148: # Note that a value of 0 will completely suppress the enum values from appearing c@148: # in the overview section. c@148: # Minimum value: 0, maximum value: 20, default value: 4. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: ENUM_VALUES_PER_LINE = 4 c@148: c@148: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used c@148: # to set the initial width (in pixels) of the frame in which the tree is shown. c@148: # Minimum value: 0, maximum value: 1500, default value: 250. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: TREEVIEW_WIDTH = 250 c@148: c@148: # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to c@148: # external symbols imported via tag files in a separate window. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: EXT_LINKS_IN_WINDOW = NO c@148: c@148: # Use this tag to change the font size of LaTeX formulas included as images in c@148: # the HTML documentation. When you change the font size after a successful c@148: # doxygen run you need to manually remove any form_*.png images from the HTML c@148: # output directory to force them to be regenerated. c@148: # Minimum value: 8, maximum value: 50, default value: 10. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: FORMULA_FONTSIZE = 10 c@148: c@148: # Use the FORMULA_TRANPARENT tag to determine whether or not the images c@148: # generated for formulas are transparent PNGs. Transparent PNGs are not c@148: # supported properly for IE 6.0, but are supported on all modern browsers. c@148: # c@148: # Note that when changing this option you need to delete any form_*.png files in c@148: # the HTML output directory before the changes have effect. c@148: # The default value is: YES. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: FORMULA_TRANSPARENT = YES c@148: c@148: # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see c@148: # http://www.mathjax.org) which uses client side Javascript for the rendering c@148: # instead of using prerendered bitmaps. Use this if you do not have LaTeX c@148: # installed or if you want to formulas look prettier in the HTML output. When c@148: # enabled you may also need to install MathJax separately and configure the path c@148: # to it using the MATHJAX_RELPATH option. c@148: # The default value is: NO. c@148: # This tag requires that the tag GENERATE_HTML is set to YES. c@148: c@148: USE_MATHJAX = NO c@148: c@148: # When MathJax is enabled you can set the default output format to be used for c@148: # the MathJax output. See the MathJax site (see: c@148: # http://docs.mathjax.org/en/latest/output.html) for more details. c@148: # Possible values are: HTML-CSS (which is slower, but has the best c@148: # compatibility), NativeMML (i.e. MathML) and SVG. c@148: # The default value is: HTML-CSS. c@148: # This tag requires that the tag USE_MATHJAX is set to YES. c@148: c@148: MATHJAX_FORMAT = HTML-CSS c@148: c@148: # When MathJax is enabled you need to specify the location relative to the HTML c@148: # output directory using the MATHJAX_RELPATH option. The destination directory c@148: # should contain the MathJax.js script. For instance, if the mathjax directory c@148: # is located at the same level as the HTML output directory, then c@148: # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax c@148: # Content Delivery Network so you can quickly see the result without installing c@148: # MathJax. However, it is strongly recommended to install a local copy of c@148: # MathJax from http://www.mathjax.org before deployment. c@148: # The default value is: http://cdn.mathjax.org/mathjax/latest. c@148: # This tag requires that the tag USE_MATHJAX is set to YES. c@148: c@148: MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest c@148: c@148: # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax c@148: # extension names that should be enabled during MathJax rendering. For example c@148: # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols c@148: # This tag requires that the tag USE_MATHJAX is set to YES. c@148: c@148: MATHJAX_EXTENSIONS = c@148: c@148: # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces c@148: # of code that will be used on startup of the MathJax code. See the MathJax site c@148: # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an c@148: # example see the documentation. c@148: # This tag requires that the tag USE_MATHJAX is set to YES. c@148: c@148: MATHJAX_CODEFILE = c@148: c@148: # When the SEARCHENGINE tag is enabled doxygen will generate a search box for c@148: # the HTML output. The underlying search engine uses javascript and DHTML and c@148: # should work on any modern browser. Note that when using HTML help c@148: # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) c@148: # there is already a search function so this one should typically be disabled. c@148: # For large projects the javascript based search engine can be slow, then c@148: # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to c@148: # search using the keyboard; to jump to the search box use + S c@148: # (what the is depends on the OS and browser, but it is typically c@148: # , /