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