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