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