Warning, /libraries/perceptualcolor/docs/Doxyfile.external is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.9.1 0002 0003 # This file describes the settings to be used by the documentation system 0004 # doxygen (www.doxygen.org) for a project. 0005 # 0006 # All text after a double hash (##) is considered a comment and is placed in 0007 # front of the TAG it is preceding. 0008 # 0009 # All text after a single hash (#) is considered a comment and will be ignored. 0010 # The format is: 0011 # TAG = value [value, ...] 0012 # For lists, items can also be appended using: 0013 # TAG += value [value, ...] 0014 # Values that contain spaces should be placed between quotes (\" \"). 0015 0016 #--------------------------------------------------------------------------- 0017 # Project related configuration options 0018 #--------------------------------------------------------------------------- 0019 0020 # This tag specifies the encoding used for all characters in the configuration 0021 # file that follow. The default is UTF-8 which is also the encoding used for all 0022 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 0023 # iconv built into libc) for the transcoding. See 0024 # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 0025 # The default value is: UTF-8. 0026 0027 DOXYFILE_ENCODING = UTF-8 0028 0029 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 0030 # double-quotes, unless you are using Doxywizard) that should identify the 0031 # project for which the documentation is generated. This name is used in the 0032 # title of most generated pages and in a few other places. 0033 # The default value is: My Project. 0034 0035 PROJECT_NAME = PerceptualColor 0036 0037 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 0038 # could be handy for archiving the generated documentation or if some version 0039 # control system is used. 0040 0041 PROJECT_NUMBER = 0042 0043 # Using the PROJECT_BRIEF tag one can provide an optional one line description 0044 # for a project that appears at the top of each page and should give viewer a 0045 # quick idea about the purpose of the project. Keep the description short. 0046 0047 PROJECT_BRIEF = 0048 0049 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 0050 # in the documentation. The maximum height of the logo should not exceed 55 0051 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 0052 # the logo to the output directory. 0053 0054 PROJECT_LOGO = 0055 0056 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 0057 # into which the generated documentation will be written. If a relative path is 0058 # entered, it will be relative to the location where doxygen was started. If 0059 # left blank the current directory will be used. 0060 0061 OUTPUT_DIRECTORY = docs/publicapi 0062 0063 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 0064 # directories (in 2 levels) under the output directory of each output format and 0065 # will distribute the generated files over these directories. Enabling this 0066 # option can be useful when feeding doxygen a huge amount of source files, where 0067 # putting all generated files in the same directory would otherwise causes 0068 # performance problems for the file system. 0069 # The default value is: NO. 0070 0071 CREATE_SUBDIRS = NO 0072 0073 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 0074 # characters to appear in the names of generated files. If set to NO, non-ASCII 0075 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 0076 # U+3044. 0077 # The default value is: NO. 0078 0079 ALLOW_UNICODE_NAMES = NO 0080 0081 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 0082 # documentation generated by doxygen is written. Doxygen will use this 0083 # information to generate all constant output in the proper language. 0084 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 0085 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 0086 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 0087 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 0088 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 0089 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 0090 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 0091 # Ukrainian and Vietnamese. 0092 # The default value is: English. 0093 0094 OUTPUT_LANGUAGE = English 0095 0096 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 0097 # documentation generated by doxygen is written. Doxygen will use this 0098 # information to generate all generated output in the proper direction. 0099 # Possible values are: None, LTR, RTL and Context. 0100 # The default value is: None. 0101 0102 OUTPUT_TEXT_DIRECTION = None 0103 0104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 0105 # descriptions after the members that are listed in the file and class 0106 # documentation (similar to Javadoc). Set to NO to disable this. 0107 # The default value is: YES. 0108 0109 BRIEF_MEMBER_DESC = YES 0110 0111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 0112 # description of a member or function before the detailed description 0113 # 0114 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 0115 # brief descriptions will be completely suppressed. 0116 # The default value is: YES. 0117 0118 REPEAT_BRIEF = YES 0119 0120 # This tag implements a quasi-intelligent brief description abbreviator that is 0121 # used to form the text in various listings. Each string in this list, if found 0122 # as the leading text of the brief description, will be stripped from the text 0123 # and the result, after processing the whole list, is used as the annotated 0124 # text. Otherwise, the brief description is used as-is. If left blank, the 0125 # following values are used ($name is automatically replaced with the name of 0126 # the entity):The $name class, The $name widget, The $name file, is, provides, 0127 # specifies, contains, represents, a, an and the. 0128 0129 ABBREVIATE_BRIEF = "The $name class" \ 0130 "The $name widget" \ 0131 "The $name file" \ 0132 is \ 0133 provides \ 0134 specifies \ 0135 contains \ 0136 represents \ 0137 a \ 0138 an \ 0139 the 0140 0141 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 0142 # doxygen will generate a detailed section even if there is only a brief 0143 # description. 0144 # The default value is: NO. 0145 0146 ALWAYS_DETAILED_SEC = YES 0147 0148 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 0149 # inherited members of a class in the documentation of that class as if those 0150 # members were ordinary class members. Constructors, destructors and assignment 0151 # operators of the base classes will not be shown. 0152 # The default value is: NO. 0153 0154 INLINE_INHERITED_MEMB = NO 0155 0156 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 0157 # before files name in the file list and in the header files. If set to NO the 0158 # shortest path that makes the file name unique will be used 0159 # The default value is: YES. 0160 0161 FULL_PATH_NAMES = NO 0162 0163 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 0164 # Stripping is only done if one of the specified strings matches the left-hand 0165 # part of the path. The tag can be used to show relative paths in the file list. 0166 # If left blank the directory from which doxygen is run is used as the path to 0167 # strip. 0168 # 0169 # Note that you can specify absolute paths here, but also relative paths, which 0170 # will be relative from the directory where doxygen is started. 0171 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 0172 0173 STRIP_FROM_PATH = 0174 0175 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 0176 # path mentioned in the documentation of a class, which tells the reader which 0177 # header file to include in order to use a class. If left blank only the name of 0178 # the header file containing the class definition is used. Otherwise one should 0179 # specify the list of include paths that are normally passed to the compiler 0180 # using the -I flag. 0181 0182 STRIP_FROM_INC_PATH = 0183 0184 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 0185 # less readable) file names. This can be useful is your file systems doesn't 0186 # support long names like on DOS, Mac, or CD-ROM. 0187 # The default value is: NO. 0188 0189 SHORT_NAMES = NO 0190 0191 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 0192 # first line (until the first dot) of a Javadoc-style comment as the brief 0193 # description. If set to NO, the Javadoc-style will behave just like regular Qt- 0194 # style comments (thus requiring an explicit @brief command for a brief 0195 # description.) 0196 # The default value is: NO. 0197 0198 JAVADOC_AUTOBRIEF = YES 0199 0200 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 0201 # such as 0202 # /*************** 0203 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 0204 # Javadoc-style will behave just like regular comments and it will not be 0205 # interpreted by doxygen. 0206 # The default value is: NO. 0207 0208 JAVADOC_BANNER = NO 0209 0210 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 0211 # line (until the first dot) of a Qt-style comment as the brief description. If 0212 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 0213 # requiring an explicit \brief command for a brief description.) 0214 # The default value is: NO. 0215 0216 QT_AUTOBRIEF = NO 0217 0218 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 0219 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 0220 # a brief description. This used to be the default behavior. The new default is 0221 # to treat a multi-line C++ comment block as a detailed description. Set this 0222 # tag to YES if you prefer the old behavior instead. 0223 # 0224 # Note that setting this tag to YES also means that rational rose comments are 0225 # not recognized any more. 0226 # The default value is: NO. 0227 0228 MULTILINE_CPP_IS_BRIEF = NO 0229 0230 # By default Python docstrings are displayed as preformatted text and doxygen's 0231 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 0232 # doxygen's special commands can be used and the contents of the docstring 0233 # documentation blocks is shown as doxygen documentation. 0234 # The default value is: YES. 0235 0236 PYTHON_DOCSTRING = YES 0237 0238 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 0239 # documentation from any documented member that it re-implements. 0240 # The default value is: YES. 0241 0242 INHERIT_DOCS = YES 0243 0244 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 0245 # page for each member. If set to NO, the documentation of a member will be part 0246 # of the file/class/namespace that contains it. 0247 # The default value is: NO. 0248 0249 SEPARATE_MEMBER_PAGES = NO 0250 0251 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 0252 # uses this value to replace tabs by spaces in code fragments. 0253 # Minimum value: 1, maximum value: 16, default value: 4. 0254 0255 TAB_SIZE = 4 0256 0257 # This tag can be used to specify a number of aliases that act as commands in 0258 # the documentation. An alias has the form: 0259 # name=value 0260 # For example adding 0261 # "sideeffect=@par Side Effects:\n" 0262 # will allow you to put the command \sideeffect (or @sideeffect) in the 0263 # documentation, which will result in a user-defined paragraph with heading 0264 # "Side Effects:". You can put \n's in the value part of an alias to insert 0265 # newlines (in the resulting output). You can put ^^ in the value part of an 0266 # alias to insert a newline as if a physical newline was in the original file. 0267 # When you need a literal { or } or , in the value part of an alias you have to 0268 # escape them by means of a backslash (\), this can lead to conflicts with the 0269 # commands \{ and \} for these it is advised to use the version @{ and @} or use 0270 # a double escape (\\{ and \\}) 0271 0272 ALIASES = 0273 0274 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 0275 # only. Doxygen will then generate output that is more tailored for C. For 0276 # instance, some of the names that are used will be different. The list of all 0277 # members will be omitted, etc. 0278 # The default value is: NO. 0279 0280 OPTIMIZE_OUTPUT_FOR_C = NO 0281 0282 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 0283 # Python sources only. Doxygen will then generate output that is more tailored 0284 # for that language. For instance, namespaces will be presented as packages, 0285 # qualified scopes will look different, etc. 0286 # The default value is: NO. 0287 0288 OPTIMIZE_OUTPUT_JAVA = NO 0289 0290 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 0291 # sources. Doxygen will then generate output that is tailored for Fortran. 0292 # The default value is: NO. 0293 0294 OPTIMIZE_FOR_FORTRAN = NO 0295 0296 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 0297 # sources. Doxygen will then generate output that is tailored for VHDL. 0298 # The default value is: NO. 0299 0300 OPTIMIZE_OUTPUT_VHDL = NO 0301 0302 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 0303 # sources only. Doxygen will then generate output that is more tailored for that 0304 # language. For instance, namespaces will be presented as modules, types will be 0305 # separated into more groups, etc. 0306 # The default value is: NO. 0307 0308 OPTIMIZE_OUTPUT_SLICE = NO 0309 0310 # Doxygen selects the parser to use depending on the extension of the files it 0311 # parses. With this tag you can assign which parser to use for a given 0312 # extension. Doxygen has a built-in mapping, but you can override or extend it 0313 # using this tag. The format is ext=language, where ext is a file extension, and 0314 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 0315 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, 0316 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 0317 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 0318 # tries to guess whether the code is fixed or free formatted code, this is the 0319 # default for Fortran type files). For instance to make doxygen treat .inc files 0320 # as Fortran files (default is PHP), and .f files as C (default is Fortran), 0321 # use: inc=Fortran f=C. 0322 # 0323 # Note: For files without extension you can use no_extension as a placeholder. 0324 # 0325 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 0326 # the files are not read by doxygen. When specifying no_extension you should add 0327 # * to the FILE_PATTERNS. 0328 # 0329 # Note see also the list of default file extension mappings. 0330 0331 EXTENSION_MAPPING = qml=C++ 0332 0333 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 0334 # according to the Markdown format, which allows for more readable 0335 # documentation. See https://daringfireball.net/projects/markdown/ for details. 0336 # The output of markdown processing is further processed by doxygen, so you can 0337 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 0338 # case of backward compatibilities issues. 0339 # The default value is: YES. 0340 0341 MARKDOWN_SUPPORT = YES 0342 0343 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 0344 # to that level are automatically included in the table of contents, even if 0345 # they do not have an id attribute. 0346 # Note: This feature currently applies only to Markdown headings. 0347 # Minimum value: 0, maximum value: 99, default value: 5. 0348 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 0349 0350 TOC_INCLUDE_HEADINGS = 5 0351 0352 # When enabled doxygen tries to link words that correspond to documented 0353 # classes, or namespaces to their corresponding documentation. Such a link can 0354 # be prevented in individual cases by putting a % sign in front of the word or 0355 # globally by setting AUTOLINK_SUPPORT to NO. 0356 # The default value is: YES. 0357 0358 AUTOLINK_SUPPORT = YES 0359 0360 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 0361 # to include (a tag file for) the STL sources as input, then you should set this 0362 # tag to YES in order to let doxygen match functions declarations and 0363 # definitions whose arguments contain STL classes (e.g. func(std::string); 0364 # versus func(std::string) {}). This also make the inheritance and collaboration 0365 # diagrams that involve STL classes more complete and accurate. 0366 # The default value is: NO. 0367 0368 BUILTIN_STL_SUPPORT = NO 0369 0370 # If you use Microsoft's C++/CLI language, you should set this option to YES to 0371 # enable parsing support. 0372 # The default value is: NO. 0373 0374 CPP_CLI_SUPPORT = NO 0375 0376 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 0377 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 0378 # will parse them like normal C++ but will assume all classes use public instead 0379 # of private inheritance when no explicit protection keyword is present. 0380 # The default value is: NO. 0381 0382 SIP_SUPPORT = NO 0383 0384 # For Microsoft's IDL there are propget and propput attributes to indicate 0385 # getter and setter methods for a property. Setting this option to YES will make 0386 # doxygen to replace the get and set methods by a property in the documentation. 0387 # This will only work if the methods are indeed getting or setting a simple 0388 # type. If this is not the case, or you want to show the methods anyway, you 0389 # should set this option to NO. 0390 # The default value is: YES. 0391 0392 IDL_PROPERTY_SUPPORT = YES 0393 0394 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 0395 # tag is set to YES then doxygen will reuse the documentation of the first 0396 # member in the group (if any) for the other members of the group. By default 0397 # all members of a group must be documented explicitly. 0398 # The default value is: NO. 0399 0400 DISTRIBUTE_GROUP_DOC = NO 0401 0402 # If one adds a struct or class to a group and this option is enabled, then also 0403 # any nested class or struct is added to the same group. By default this option 0404 # is disabled and one has to add nested compounds explicitly via \ingroup. 0405 # The default value is: NO. 0406 0407 GROUP_NESTED_COMPOUNDS = NO 0408 0409 # Set the SUBGROUPING tag to YES to allow class member groups of the same type 0410 # (for instance a group of public functions) to be put as a subgroup of that 0411 # type (e.g. under the Public Functions section). Set it to NO to prevent 0412 # subgrouping. Alternatively, this can be done per class using the 0413 # \nosubgrouping command. 0414 # The default value is: YES. 0415 0416 SUBGROUPING = YES 0417 0418 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 0419 # are shown inside the group in which they are included (e.g. using \ingroup) 0420 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 0421 # and RTF). 0422 # 0423 # Note that this feature does not work in combination with 0424 # SEPARATE_MEMBER_PAGES. 0425 # The default value is: NO. 0426 0427 INLINE_GROUPED_CLASSES = NO 0428 0429 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 0430 # with only public data fields or simple typedef fields will be shown inline in 0431 # the documentation of the scope in which they are defined (i.e. file, 0432 # namespace, or group documentation), provided this scope is documented. If set 0433 # to NO, structs, classes, and unions are shown on a separate page (for HTML and 0434 # Man pages) or section (for LaTeX and RTF). 0435 # The default value is: NO. 0436 0437 INLINE_SIMPLE_STRUCTS = NO 0438 0439 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 0440 # enum is documented as struct, union, or enum with the name of the typedef. So 0441 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 0442 # with name TypeT. When disabled the typedef will appear as a member of a file, 0443 # namespace, or class. And the struct will be named TypeS. This can typically be 0444 # useful for C code in case the coding convention dictates that all compound 0445 # types are typedef'ed and only the typedef is referenced, never the tag name. 0446 # The default value is: NO. 0447 0448 TYPEDEF_HIDES_STRUCT = NO 0449 0450 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 0451 # cache is used to resolve symbols given their name and scope. Since this can be 0452 # an expensive process and often the same symbol appears multiple times in the 0453 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 0454 # doxygen will become slower. If the cache is too large, memory is wasted. The 0455 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 0456 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 0457 # symbols. At the end of a run doxygen will report the cache usage and suggest 0458 # the optimal cache size from a speed point of view. 0459 # Minimum value: 0, maximum value: 9, default value: 0. 0460 0461 LOOKUP_CACHE_SIZE = 0 0462 0463 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use 0464 # during processing. When set to 0 doxygen will based this on the number of 0465 # cores available in the system. You can set it explicitly to a value larger 0466 # than 0 to get more control over the balance between CPU load and processing 0467 # speed. At this moment only the input processing can be done using multiple 0468 # threads. Since this is still an experimental feature the default is set to 1, 0469 # which efficively disables parallel processing. Please report any issues you 0470 # encounter. Generating dot graphs in parallel is controlled by the 0471 # DOT_NUM_THREADS setting. 0472 # Minimum value: 0, maximum value: 32, default value: 1. 0473 0474 NUM_PROC_THREADS = 1 0475 0476 #--------------------------------------------------------------------------- 0477 # Build related configuration options 0478 #--------------------------------------------------------------------------- 0479 0480 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 0481 # documentation are documented, even if no documentation was available. Private 0482 # class members and static file members will be hidden unless the 0483 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 0484 # Note: This will also disable the warnings about undocumented members that are 0485 # normally produced when WARNINGS is set to YES. 0486 # The default value is: NO. 0487 0488 EXTRACT_ALL = NO 0489 0490 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 0491 # be included in the documentation. 0492 # The default value is: NO. 0493 0494 EXTRACT_PRIVATE = NO 0495 0496 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 0497 # methods of a class will be included in the documentation. 0498 # The default value is: NO. 0499 0500 EXTRACT_PRIV_VIRTUAL = NO 0501 0502 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 0503 # scope will be included in the documentation. 0504 # The default value is: NO. 0505 0506 EXTRACT_PACKAGE = NO 0507 0508 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 0509 # included in the documentation. 0510 # The default value is: NO. 0511 0512 EXTRACT_STATIC = YES 0513 0514 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 0515 # locally in source files will be included in the documentation. If set to NO, 0516 # only classes defined in header files are included. Does not have any effect 0517 # for Java sources. 0518 # The default value is: YES. 0519 0520 EXTRACT_LOCAL_CLASSES = NO 0521 0522 # This flag is only useful for Objective-C code. If set to YES, local methods, 0523 # which are defined in the implementation section but not in the interface are 0524 # included in the documentation. If set to NO, only methods in the interface are 0525 # included. 0526 # The default value is: NO. 0527 0528 EXTRACT_LOCAL_METHODS = NO 0529 0530 # If this flag is set to YES, the members of anonymous namespaces will be 0531 # extracted and appear in the documentation as a namespace called 0532 # 'anonymous_namespace{file}', where file will be replaced with the base name of 0533 # the file that contains the anonymous namespace. By default anonymous namespace 0534 # are hidden. 0535 # The default value is: NO. 0536 0537 EXTRACT_ANON_NSPACES = NO 0538 0539 # If this flag is set to YES, the name of an unnamed parameter in a declaration 0540 # will be determined by the corresponding definition. By default unnamed 0541 # parameters remain unnamed in the output. 0542 # The default value is: YES. 0543 0544 RESOLVE_UNNAMED_PARAMS = YES 0545 0546 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 0547 # undocumented members inside documented classes or files. If set to NO these 0548 # members will be included in the various overviews, but no documentation 0549 # section is generated. This option has no effect if EXTRACT_ALL is enabled. 0550 # The default value is: NO. 0551 0552 HIDE_UNDOC_MEMBERS = YES 0553 0554 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 0555 # undocumented classes that are normally visible in the class hierarchy. If set 0556 # to NO, these classes will be included in the various overviews. This option 0557 # has no effect if EXTRACT_ALL is enabled. 0558 # The default value is: NO. 0559 0560 HIDE_UNDOC_CLASSES = YES 0561 0562 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 0563 # declarations. If set to NO, these declarations will be included in the 0564 # documentation. 0565 # The default value is: NO. 0566 0567 HIDE_FRIEND_COMPOUNDS = YES 0568 0569 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 0570 # documentation blocks found inside the body of a function. If set to NO, these 0571 # blocks will be appended to the function's detailed documentation block. 0572 # The default value is: NO. 0573 0574 HIDE_IN_BODY_DOCS = NO 0575 0576 # The INTERNAL_DOCS tag determines if documentation that is typed after a 0577 # \internal command is included. If the tag is set to NO then the documentation 0578 # will be excluded. Set it to YES to include the internal documentation. 0579 # The default value is: NO. 0580 0581 INTERNAL_DOCS = NO 0582 0583 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 0584 # able to match the capabilities of the underlying filesystem. In case the 0585 # filesystem is case sensitive (i.e. it supports files in the same directory 0586 # whose names only differ in casing), the option must be set to YES to properly 0587 # deal with such files in case they appear in the input. For filesystems that 0588 # are not case sensitive the option should be be set to NO to properly deal with 0589 # output files written for symbols that only differ in casing, such as for two 0590 # classes, one named CLASS and the other named Class, and to also support 0591 # references to files without having to specify the exact matching casing. On 0592 # Windows (including Cygwin) and MacOS, users should typically set this option 0593 # to NO, whereas on Linux or other Unix flavors it should typically be set to 0594 # YES. 0595 # The default value is: system dependent. 0596 0597 CASE_SENSE_NAMES = YES 0598 0599 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 0600 # their full class and namespace scopes in the documentation. If set to YES, the 0601 # scope will be hidden. 0602 # The default value is: NO. 0603 0604 HIDE_SCOPE_NAMES = NO 0605 0606 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 0607 # append additional text to a page's title, such as Class Reference. If set to 0608 # YES the compound reference will be hidden. 0609 # The default value is: NO. 0610 0611 HIDE_COMPOUND_REFERENCE= NO 0612 0613 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 0614 # the files that are included by a file in the documentation of that file. 0615 # The default value is: YES. 0616 0617 SHOW_INCLUDE_FILES = YES 0618 0619 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 0620 # grouped member an include statement to the documentation, telling the reader 0621 # which file to include in order to use the member. 0622 # The default value is: NO. 0623 0624 SHOW_GROUPED_MEMB_INC = NO 0625 0626 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 0627 # files with double quotes in the documentation rather than with sharp brackets. 0628 # The default value is: NO. 0629 0630 FORCE_LOCAL_INCLUDES = NO 0631 0632 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 0633 # documentation for inline members. 0634 # The default value is: YES. 0635 0636 INLINE_INFO = YES 0637 0638 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 0639 # (detailed) documentation of file and class members alphabetically by member 0640 # name. If set to NO, the members will appear in declaration order. 0641 # The default value is: YES. 0642 0643 SORT_MEMBER_DOCS = YES 0644 0645 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 0646 # descriptions of file, namespace and class members alphabetically by member 0647 # name. If set to NO, the members will appear in declaration order. Note that 0648 # this will also influence the order of the classes in the class list. 0649 # The default value is: NO. 0650 0651 SORT_BRIEF_DOCS = YES 0652 0653 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 0654 # (brief and detailed) documentation of class members so that constructors and 0655 # destructors are listed first. If set to NO the constructors will appear in the 0656 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 0657 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 0658 # member documentation. 0659 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 0660 # detailed member documentation. 0661 # The default value is: NO. 0662 0663 SORT_MEMBERS_CTORS_1ST = YES 0664 0665 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 0666 # of group names into alphabetical order. If set to NO the group names will 0667 # appear in their defined order. 0668 # The default value is: NO. 0669 0670 SORT_GROUP_NAMES = NO 0671 0672 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 0673 # fully-qualified names, including namespaces. If set to NO, the class list will 0674 # be sorted only by class name, not including the namespace part. 0675 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 0676 # Note: This option applies only to the class list, not to the alphabetical 0677 # list. 0678 # The default value is: NO. 0679 0680 SORT_BY_SCOPE_NAME = NO 0681 0682 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 0683 # type resolution of all parameters of a function it will reject a match between 0684 # the prototype and the implementation of a member function even if there is 0685 # only one candidate or it is obvious which candidate to choose by doing a 0686 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 0687 # accept a match between prototype and implementation in such cases. 0688 # The default value is: NO. 0689 0690 STRICT_PROTO_MATCHING = YES 0691 0692 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 0693 # list. This list is created by putting \todo commands in the documentation. 0694 # The default value is: YES. 0695 0696 GENERATE_TODOLIST = YES 0697 0698 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 0699 # list. This list is created by putting \test commands in the documentation. 0700 # The default value is: YES. 0701 0702 GENERATE_TESTLIST = NO 0703 0704 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 0705 # list. This list is created by putting \bug commands in the documentation. 0706 # The default value is: YES. 0707 0708 GENERATE_BUGLIST = YES 0709 0710 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 0711 # the deprecated list. This list is created by putting \deprecated commands in 0712 # the documentation. 0713 # The default value is: YES. 0714 0715 GENERATE_DEPRECATEDLIST= YES 0716 0717 # The ENABLED_SECTIONS tag can be used to enable conditional documentation 0718 # sections, marked by \if <section_label> ... \endif and \cond <section_label> 0719 # ... \endcond blocks. 0720 0721 ENABLED_SECTIONS = 0722 0723 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 0724 # initial value of a variable or macro / define can have for it to appear in the 0725 # documentation. If the initializer consists of more lines than specified here 0726 # it will be hidden. Use a value of 0 to hide initializers completely. The 0727 # appearance of the value of individual variables and macros / defines can be 0728 # controlled using \showinitializer or \hideinitializer command in the 0729 # documentation regardless of this setting. 0730 # Minimum value: 0, maximum value: 10000, default value: 30. 0731 0732 MAX_INITIALIZER_LINES = 30 0733 0734 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 0735 # the bottom of the documentation of classes and structs. If set to YES, the 0736 # list will mention the files that were used to generate the documentation. 0737 # The default value is: YES. 0738 0739 SHOW_USED_FILES = YES 0740 0741 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 0742 # will remove the Files entry from the Quick Index and from the Folder Tree View 0743 # (if specified). 0744 # The default value is: YES. 0745 0746 SHOW_FILES = YES 0747 0748 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 0749 # page. This will remove the Namespaces entry from the Quick Index and from the 0750 # Folder Tree View (if specified). 0751 # The default value is: YES. 0752 0753 SHOW_NAMESPACES = YES 0754 0755 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 0756 # doxygen should invoke to get the current version for each file (typically from 0757 # the version control system). Doxygen will invoke the program by executing (via 0758 # popen()) the command command input-file, where command is the value of the 0759 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 0760 # by doxygen. Whatever the program writes to standard output is used as the file 0761 # version. For an example see the documentation. 0762 0763 FILE_VERSION_FILTER = 0764 0765 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 0766 # by doxygen. The layout file controls the global structure of the generated 0767 # output files in an output format independent way. To create the layout file 0768 # that represents doxygen's defaults, run doxygen with the -l option. You can 0769 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 0770 # will be used as the name of the layout file. 0771 # 0772 # Note that if you run doxygen from a directory containing a file called 0773 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 0774 # tag is left empty. 0775 0776 LAYOUT_FILE = 0777 0778 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 0779 # the reference definitions. This must be a list of .bib files. The .bib 0780 # extension is automatically appended if omitted. This requires the bibtex tool 0781 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 0782 # For LaTeX the style of the bibliography can be controlled using 0783 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 0784 # search path. See also \cite for info how to create references. 0785 0786 CITE_BIB_FILES = 0787 0788 #--------------------------------------------------------------------------- 0789 # Configuration options related to warning and progress messages 0790 #--------------------------------------------------------------------------- 0791 0792 # The QUIET tag can be used to turn on/off the messages that are generated to 0793 # standard output by doxygen. If QUIET is set to YES this implies that the 0794 # messages are off. 0795 # The default value is: NO. 0796 0797 QUIET = YES 0798 0799 # The WARNINGS tag can be used to turn on/off the warning messages that are 0800 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 0801 # this implies that the warnings are on. 0802 # 0803 # Tip: Turn warnings on while writing the documentation. 0804 # The default value is: YES. 0805 0806 WARNINGS = YES 0807 0808 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 0809 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 0810 # will automatically be disabled. 0811 # The default value is: YES. 0812 0813 WARN_IF_UNDOCUMENTED = YES 0814 0815 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 0816 # potential errors in the documentation, such as not documenting some parameters 0817 # in a documented function, or documenting parameters that don't exist or using 0818 # markup commands wrongly. 0819 # The default value is: YES. 0820 0821 WARN_IF_DOC_ERROR = YES 0822 0823 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 0824 # are documented, but have no documentation for their parameters or return 0825 # value. If set to NO, doxygen will only warn about wrong or incomplete 0826 # parameter documentation, but not about the absence of documentation. If 0827 # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 0828 # The default value is: NO. 0829 0830 WARN_NO_PARAMDOC = YES 0831 0832 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 0833 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 0834 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 0835 # at the end of the doxygen process doxygen will return with a non-zero status. 0836 # Possible values are: NO, YES and FAIL_ON_WARNINGS. 0837 # The default value is: NO. 0838 0839 WARN_AS_ERROR = NO 0840 0841 # The WARN_FORMAT tag determines the format of the warning messages that doxygen 0842 # can produce. The string should contain the $file, $line, and $text tags, which 0843 # will be replaced by the file and line number from which the warning originated 0844 # and the warning text. Optionally the format may contain $version, which will 0845 # be replaced by the version of the file (if it could be obtained via 0846 # FILE_VERSION_FILTER) 0847 # The default value is: $file:$line: $text. 0848 0849 WARN_FORMAT = "$file:$line: $text" 0850 0851 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 0852 # messages should be written. If left blank the output is written to standard 0853 # error (stderr). 0854 0855 WARN_LOGFILE = 0856 0857 #--------------------------------------------------------------------------- 0858 # Configuration options related to the input files 0859 #--------------------------------------------------------------------------- 0860 0861 # The INPUT tag is used to specify the files and/or directories that contain 0862 # documented source files. You may enter file names like myfile.cpp or 0863 # directories like /usr/src/myproject. Separate the files or directories with 0864 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 0865 # Note: If this tag is empty the current directory is searched. 0866 0867 INPUT = src \ 0868 README.md 0869 0870 # This tag can be used to specify the character encoding of the source files 0871 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 0872 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 0873 # documentation (see: 0874 # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 0875 # The default value is: UTF-8. 0876 0877 INPUT_ENCODING = UTF-8 0878 0879 # If the value of the INPUT tag contains directories, you can use the 0880 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 0881 # *.h) to filter out the source-files in the directories. 0882 # 0883 # Note that for custom extensions or not directly supported extensions you also 0884 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 0885 # read by doxygen. 0886 # 0887 # Note the list of default checked file patterns might differ from the list of 0888 # default file extension mappings. 0889 # 0890 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 0891 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 0892 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 0893 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), 0894 # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, 0895 # *.ucf, *.qsf and *.ice. 0896 0897 FILE_PATTERNS = *.h \ 0898 *.cpp \ 0899 *.cc \ 0900 *.hpp \ 0901 *.dox \ 0902 *.c++ \ 0903 *.cxx \ 0904 *.mm \ 0905 *.h++ \ 0906 *.hh \ 0907 *.qml \ 0908 *.md 0909 0910 # The RECURSIVE tag can be used to specify whether or not subdirectories should 0911 # be searched for input files as well. 0912 # The default value is: NO. 0913 0914 RECURSIVE = YES 0915 0916 # The EXCLUDE tag can be used to specify files and/or directories that should be 0917 # excluded from the INPUT source files. This way you can easily exclude a 0918 # subdirectory from a directory tree whose root is specified with the INPUT tag. 0919 # 0920 # Note that relative paths are relative to the directory from which doxygen is 0921 # run. 0922 0923 EXCLUDE = 0924 0925 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 0926 # directories that are symbolic links (a Unix file system feature) are excluded 0927 # from the input. 0928 # The default value is: NO. 0929 0930 EXCLUDE_SYMLINKS = NO 0931 0932 # If the value of the INPUT tag contains directories, you can use the 0933 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 0934 # certain files from those directories. 0935 # 0936 # Note that the wildcards are matched against the file with absolute path, so to 0937 # exclude all test directories for example use the pattern */test/* 0938 0939 EXCLUDE_PATTERNS = 0940 0941 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 0942 # (namespaces, classes, functions, etc.) that should be excluded from the 0943 # output. The symbol name can be a fully qualified name, a word, or if the 0944 # wildcard * is used, a substring. Examples: ANamespace, AClass, 0945 # AClass::ANamespace, ANamespace::*Test 0946 # 0947 # Note that the wildcards are matched against the file with absolute path, so to 0948 # exclude all test directories use the pattern */test/* 0949 0950 EXCLUDE_SYMBOLS = iterator \ 0951 const_iterator 0952 0953 # The EXAMPLE_PATH tag can be used to specify one or more files or directories 0954 # that contain example code fragments that are included (see the \include 0955 # command). 0956 0957 EXAMPLE_PATH = src \ 0958 autotests \ 0959 examples 0960 0961 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 0962 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 0963 # *.h) to filter out the source-files in the directories. If left blank all 0964 # files are included. 0965 0966 EXAMPLE_PATTERNS = * 0967 0968 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 0969 # searched for input files to be used with the \include or \dontinclude commands 0970 # irrespective of the value of the RECURSIVE tag. 0971 # The default value is: NO. 0972 0973 EXAMPLE_RECURSIVE = NO 0974 0975 # The IMAGE_PATH tag can be used to specify one or more files or directories 0976 # that contain images that are to be included in the documentation (see the 0977 # \image command). 0978 0979 IMAGE_PATH = docs/pics 0980 0981 # The INPUT_FILTER tag can be used to specify a program that doxygen should 0982 # invoke to filter for each input file. Doxygen will invoke the filter program 0983 # by executing (via popen()) the command: 0984 # 0985 # <filter> <input-file> 0986 # 0987 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 0988 # name of an input file. Doxygen will then use the output that the filter 0989 # program writes to standard output. If FILTER_PATTERNS is specified, this tag 0990 # will be ignored. 0991 # 0992 # Note that the filter must not add or remove lines; it is applied before the 0993 # code is scanned, but not when the output code is generated. If lines are added 0994 # or removed, the anchors will not be placed correctly. 0995 # 0996 # Note that for custom extensions or not directly supported extensions you also 0997 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 0998 # properly processed by doxygen. 0999 1000 INPUT_FILTER = 1001 1002 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1003 # basis. Doxygen will compare the file name with each pattern and apply the 1004 # filter if there is a match. The filters are a list of the form: pattern=filter 1005 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1006 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1007 # patterns match the file name, INPUT_FILTER is applied. 1008 # 1009 # Note that for custom extensions or not directly supported extensions you also 1010 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1011 # properly processed by doxygen. 1012 1013 FILTER_PATTERNS = *.qml=doxyqml 1014 1015 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1016 # INPUT_FILTER) will also be used to filter the input files that are used for 1017 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1018 # The default value is: NO. 1019 1020 FILTER_SOURCE_FILES = NO 1021 1022 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1023 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1024 # it is also possible to disable source filtering for a specific pattern using 1025 # *.ext= (so without naming a filter). 1026 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1027 1028 FILTER_SOURCE_PATTERNS = 1029 1030 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1031 # is part of the input, its contents will be placed on the main page 1032 # (index.html). This can be useful if you have a project on for instance GitHub 1033 # and want to reuse the introduction page also for the doxygen output. 1034 1035 USE_MDFILE_AS_MAINPAGE = README.md 1036 1037 #--------------------------------------------------------------------------- 1038 # Configuration options related to source browsing 1039 #--------------------------------------------------------------------------- 1040 1041 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1042 # generated. Documented entities will be cross-referenced with these sources. 1043 # 1044 # Note: To get rid of all source code in the generated output, make sure that 1045 # also VERBATIM_HEADERS is set to NO. 1046 # The default value is: NO. 1047 1048 SOURCE_BROWSER = YES 1049 1050 # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1051 # classes and enums directly into the documentation. 1052 # The default value is: NO. 1053 1054 INLINE_SOURCES = NO 1055 1056 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1057 # special comment blocks from generated source code fragments. Normal C, C++ and 1058 # Fortran comments will always remain visible. 1059 # The default value is: YES. 1060 1061 STRIP_CODE_COMMENTS = NO 1062 1063 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1064 # entity all documented functions referencing it will be listed. 1065 # The default value is: NO. 1066 1067 REFERENCED_BY_RELATION = NO 1068 1069 # If the REFERENCES_RELATION tag is set to YES then for each documented function 1070 # all documented entities called/used by that function will be listed. 1071 # The default value is: NO. 1072 1073 REFERENCES_RELATION = NO 1074 1075 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1076 # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1077 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1078 # link to the documentation. 1079 # The default value is: YES. 1080 1081 REFERENCES_LINK_SOURCE = YES 1082 1083 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1084 # source code will show a tooltip with additional information such as prototype, 1085 # brief description and links to the definition and documentation. Since this 1086 # will make the HTML file larger and loading of large files a bit slower, you 1087 # can opt to disable this feature. 1088 # The default value is: YES. 1089 # This tag requires that the tag SOURCE_BROWSER is set to YES. 1090 1091 SOURCE_TOOLTIPS = YES 1092 1093 # If the USE_HTAGS tag is set to YES then the references to source code will 1094 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1095 # source browser. The htags tool is part of GNU's global source tagging system 1096 # (see https://www.gnu.org/software/global/global.html). You will need version 1097 # 4.8.6 or higher. 1098 # 1099 # To use it do the following: 1100 # - Install the latest version of global 1101 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1102 # - Make sure the INPUT points to the root of the source tree 1103 # - Run doxygen as normal 1104 # 1105 # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1106 # tools must be available from the command line (i.e. in the search path). 1107 # 1108 # The result: instead of the source browser generated by doxygen, the links to 1109 # source code will now point to the output of htags. 1110 # The default value is: NO. 1111 # This tag requires that the tag SOURCE_BROWSER is set to YES. 1112 1113 USE_HTAGS = NO 1114 1115 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1116 # verbatim copy of the header file for each class for which an include is 1117 # specified. Set to NO to disable this. 1118 # See also: Section \class. 1119 # The default value is: YES. 1120 1121 VERBATIM_HEADERS = NO 1122 1123 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1124 # clang parser (see: 1125 # http://clang.llvm.org/) for more accurate parsing at the cost of reduced 1126 # performance. This can be particularly helpful with template rich C++ code for 1127 # which doxygen's built-in parser lacks the necessary type information. 1128 # Note: The availability of this option depends on whether or not doxygen was 1129 # generated with the -Duse_libclang=ON option for CMake. 1130 # The default value is: NO. 1131 1132 CLANG_ASSISTED_PARSING = NO 1133 1134 # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to 1135 # YES then doxygen will add the directory of each input to the include path. 1136 # The default value is: YES. 1137 1138 CLANG_ADD_INC_PATHS = YES 1139 1140 # If clang assisted parsing is enabled you can provide the compiler with command 1141 # line options that you would normally use when invoking the compiler. Note that 1142 # the include paths will already be set by doxygen for the files and directories 1143 # specified with INPUT and INCLUDE_PATH. 1144 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1145 1146 CLANG_OPTIONS = 1147 1148 # If clang assisted parsing is enabled you can provide the clang parser with the 1149 # path to the directory containing a file called compile_commands.json. This 1150 # file is the compilation database (see: 1151 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the 1152 # options used when the source files were built. This is equivalent to 1153 # specifying the -p option to a clang tool, such as clang-check. These options 1154 # will then be passed to the parser. Any options specified with CLANG_OPTIONS 1155 # will be added as well. 1156 # Note: The availability of this option depends on whether or not doxygen was 1157 # generated with the -Duse_libclang=ON option for CMake. 1158 1159 CLANG_DATABASE_PATH = 1160 1161 #--------------------------------------------------------------------------- 1162 # Configuration options related to the alphabetical class index 1163 #--------------------------------------------------------------------------- 1164 1165 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1166 # compounds will be generated. Enable this if the project contains a lot of 1167 # classes, structs, unions or interfaces. 1168 # The default value is: YES. 1169 1170 ALPHABETICAL_INDEX = YES 1171 1172 # In case all classes in a project start with a common prefix, all classes will 1173 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1174 # can be used to specify a prefix (or a list of prefixes) that should be ignored 1175 # while generating the index headers. 1176 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1177 1178 IGNORE_PREFIX = K 1179 1180 #--------------------------------------------------------------------------- 1181 # Configuration options related to the HTML output 1182 #--------------------------------------------------------------------------- 1183 1184 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1185 # The default value is: YES. 1186 1187 GENERATE_HTML = YES 1188 1189 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1190 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1191 # it. 1192 # The default directory is: html. 1193 # This tag requires that the tag GENERATE_HTML is set to YES. 1194 1195 HTML_OUTPUT = html 1196 1197 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1198 # generated HTML page (for example: .htm, .php, .asp). 1199 # The default value is: .html. 1200 # This tag requires that the tag GENERATE_HTML is set to YES. 1201 1202 HTML_FILE_EXTENSION = .html 1203 1204 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1205 # each generated HTML page. If the tag is left blank doxygen will generate a 1206 # standard header. 1207 # 1208 # To get valid HTML the header file that includes any scripts and style sheets 1209 # that doxygen needs, which is dependent on the configuration options used (e.g. 1210 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1211 # default header using 1212 # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1213 # YourConfigFile 1214 # and then modify the file new_header.html. See also section "Doxygen usage" 1215 # for information on how to generate the default header that doxygen normally 1216 # uses. 1217 # Note: The header is subject to change so you typically have to regenerate the 1218 # default header when upgrading to a newer version of doxygen. For a description 1219 # of the possible markers and block names see the documentation. 1220 # This tag requires that the tag GENERATE_HTML is set to YES. 1221 1222 HTML_HEADER = 1223 1224 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1225 # generated HTML page. If the tag is left blank doxygen will generate a standard 1226 # footer. See HTML_HEADER for more information on how to generate a default 1227 # footer and what special commands can be used inside the footer. See also 1228 # section "Doxygen usage" for information on how to generate the default footer 1229 # that doxygen normally uses. 1230 # This tag requires that the tag GENERATE_HTML is set to YES. 1231 1232 HTML_FOOTER = 1233 1234 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1235 # sheet that is used by each HTML page. It can be used to fine-tune the look of 1236 # the HTML output. If left blank doxygen will generate a default style sheet. 1237 # See also section "Doxygen usage" for information on how to generate the style 1238 # sheet that doxygen normally uses. 1239 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1240 # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1241 # obsolete. 1242 # This tag requires that the tag GENERATE_HTML is set to YES. 1243 1244 HTML_STYLESHEET = 1245 1246 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1247 # cascading style sheets that are included after the standard style sheets 1248 # created by doxygen. Using this option one can overrule certain style aspects. 1249 # This is preferred over using HTML_STYLESHEET since it does not replace the 1250 # standard style sheet and is therefore more robust against future updates. 1251 # Doxygen will copy the style sheet files to the output directory. 1252 # Note: The order of the extra style sheet files is of importance (e.g. the last 1253 # style sheet in the list overrules the setting of the previous ones in the 1254 # list). For an example see the documentation. 1255 # This tag requires that the tag GENERATE_HTML is set to YES. 1256 1257 HTML_EXTRA_STYLESHEET = 1258 1259 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1260 # other source files which should be copied to the HTML output directory. Note 1261 # that these files will be copied to the base HTML output directory. Use the 1262 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1263 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1264 # files will be copied as-is; there are no commands or markers available. 1265 # This tag requires that the tag GENERATE_HTML is set to YES. 1266 1267 HTML_EXTRA_FILES = 1268 1269 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1270 # will adjust the colors in the style sheet and background images according to 1271 # this color. Hue is specified as an angle on a colorwheel, see 1272 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1273 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1274 # purple, and 360 is red again. 1275 # Minimum value: 0, maximum value: 359, default value: 220. 1276 # This tag requires that the tag GENERATE_HTML is set to YES. 1277 1278 HTML_COLORSTYLE_HUE = 220 1279 1280 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1281 # in the HTML output. For a value of 0 the output will use grayscales only. A 1282 # value of 255 will produce the most vivid colors. 1283 # Minimum value: 0, maximum value: 255, default value: 100. 1284 # This tag requires that the tag GENERATE_HTML is set to YES. 1285 1286 HTML_COLORSTYLE_SAT = 100 1287 1288 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1289 # luminance component of the colors in the HTML output. Values below 100 1290 # gradually make the output lighter, whereas values above 100 make the output 1291 # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1292 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1293 # change the gamma. 1294 # Minimum value: 40, maximum value: 240, default value: 80. 1295 # This tag requires that the tag GENERATE_HTML is set to YES. 1296 1297 HTML_COLORSTYLE_GAMMA = 80 1298 1299 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1300 # page will contain the date and time when the page was generated. Setting this 1301 # to YES can help to show when doxygen was last run and thus if the 1302 # documentation is up to date. 1303 # The default value is: NO. 1304 # This tag requires that the tag GENERATE_HTML is set to YES. 1305 1306 HTML_TIMESTAMP = NO 1307 1308 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1309 # documentation will contain a main index with vertical navigation menus that 1310 # are dynamically created via JavaScript. If disabled, the navigation index will 1311 # consists of multiple levels of tabs that are statically embedded in every HTML 1312 # page. Disable this option to support browsers that do not have JavaScript, 1313 # like the Qt help browser. 1314 # The default value is: YES. 1315 # This tag requires that the tag GENERATE_HTML is set to YES. 1316 1317 HTML_DYNAMIC_MENUS = YES 1318 1319 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1320 # documentation will contain sections that can be hidden and shown after the 1321 # page has loaded. 1322 # The default value is: NO. 1323 # This tag requires that the tag GENERATE_HTML is set to YES. 1324 1325 HTML_DYNAMIC_SECTIONS = NO 1326 1327 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1328 # shown in the various tree structured indices initially; the user can expand 1329 # and collapse entries dynamically later on. Doxygen will expand the tree to 1330 # such a level that at most the specified number of entries are visible (unless 1331 # a fully collapsed tree already exceeds this amount). So setting the number of 1332 # entries 1 will produce a full collapsed tree by default. 0 is a special value 1333 # representing an infinite number of entries and will result in a full expanded 1334 # tree by default. 1335 # Minimum value: 0, maximum value: 9999, default value: 100. 1336 # This tag requires that the tag GENERATE_HTML is set to YES. 1337 1338 HTML_INDEX_NUM_ENTRIES = 100 1339 1340 # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1341 # generated that can be used as input for Apple's Xcode 3 integrated development 1342 # environment (see: 1343 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1344 # create a documentation set, doxygen will generate a Makefile in the HTML 1345 # output directory. Running make will produce the docset in that directory and 1346 # running make install will install the docset in 1347 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1348 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1349 # genXcode/_index.html for more information. 1350 # The default value is: NO. 1351 # This tag requires that the tag GENERATE_HTML is set to YES. 1352 1353 GENERATE_DOCSET = NO 1354 1355 # This tag determines the name of the docset feed. A documentation feed provides 1356 # an umbrella under which multiple documentation sets from a single provider 1357 # (such as a company or product suite) can be grouped. 1358 # The default value is: Doxygen generated docs. 1359 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1360 1361 DOCSET_FEEDNAME = "Doxygen generated docs" 1362 1363 # This tag specifies a string that should uniquely identify the documentation 1364 # set bundle. This should be a reverse domain-name style string, e.g. 1365 # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1366 # The default value is: org.doxygen.Project. 1367 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1368 1369 DOCSET_BUNDLE_ID = org.doxygen.Project 1370 1371 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1372 # the documentation publisher. This should be a reverse domain-name style 1373 # string, e.g. com.mycompany.MyDocSet.documentation. 1374 # The default value is: org.doxygen.Publisher. 1375 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1376 1377 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1378 1379 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1380 # The default value is: Publisher. 1381 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1382 1383 DOCSET_PUBLISHER_NAME = Publisher 1384 1385 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1386 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1387 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1388 # (see: 1389 # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. 1390 # 1391 # The HTML Help Workshop contains a compiler that can convert all HTML output 1392 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1393 # files are now used as the Windows 98 help format, and will replace the old 1394 # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1395 # HTML files also contain an index, a table of contents, and you can search for 1396 # words in the documentation. The HTML workshop also contains a viewer for 1397 # compressed HTML files. 1398 # The default value is: NO. 1399 # This tag requires that the tag GENERATE_HTML is set to YES. 1400 1401 GENERATE_HTMLHELP = NO 1402 1403 # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1404 # file. You can add a path in front of the file if the result should not be 1405 # written to the html output directory. 1406 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1407 1408 CHM_FILE = 1409 1410 # The HHC_LOCATION tag can be used to specify the location (absolute path 1411 # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1412 # doxygen will try to run the HTML help compiler on the generated index.hhp. 1413 # The file has to be specified with full path. 1414 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1415 1416 HHC_LOCATION = 1417 1418 # The GENERATE_CHI flag controls if a separate .chi index file is generated 1419 # (YES) or that it should be included in the main .chm file (NO). 1420 # The default value is: NO. 1421 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1422 1423 GENERATE_CHI = NO 1424 1425 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1426 # and project file content. 1427 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1428 1429 CHM_INDEX_ENCODING = 1430 1431 # The BINARY_TOC flag controls whether a binary table of contents is generated 1432 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1433 # enables the Previous and Next buttons. 1434 # The default value is: NO. 1435 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1436 1437 BINARY_TOC = NO 1438 1439 # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1440 # the table of contents of the HTML help documentation and to the tree view. 1441 # The default value is: NO. 1442 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1443 1444 TOC_EXPAND = NO 1445 1446 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1447 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1448 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1449 # (.qch) of the generated HTML documentation. 1450 # The default value is: NO. 1451 # This tag requires that the tag GENERATE_HTML is set to YES. 1452 1453 GENERATE_QHP = NO 1454 1455 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1456 # the file name of the resulting .qch file. The path specified is relative to 1457 # the HTML output folder. 1458 # This tag requires that the tag GENERATE_QHP is set to YES. 1459 1460 QCH_FILE = 1461 1462 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1463 # Project output. For more information please see Qt Help Project / Namespace 1464 # (see: 1465 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1466 # The default value is: org.doxygen.Project. 1467 # This tag requires that the tag GENERATE_QHP is set to YES. 1468 1469 QHP_NAMESPACE = org.doxygen.Project 1470 1471 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1472 # Help Project output. For more information please see Qt Help Project / Virtual 1473 # Folders (see: 1474 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1475 # The default value is: doc. 1476 # This tag requires that the tag GENERATE_QHP is set to YES. 1477 1478 QHP_VIRTUAL_FOLDER = doc 1479 1480 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1481 # filter to add. For more information please see Qt Help Project / Custom 1482 # Filters (see: 1483 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1484 # This tag requires that the tag GENERATE_QHP is set to YES. 1485 1486 QHP_CUST_FILTER_NAME = 1487 1488 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1489 # custom filter to add. For more information please see Qt Help Project / Custom 1490 # Filters (see: 1491 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1492 # This tag requires that the tag GENERATE_QHP is set to YES. 1493 1494 QHP_CUST_FILTER_ATTRS = 1495 1496 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1497 # project's filter section matches. Qt Help Project / Filter Attributes (see: 1498 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1499 # This tag requires that the tag GENERATE_QHP is set to YES. 1500 1501 QHP_SECT_FILTER_ATTRS = 1502 1503 # The QHG_LOCATION tag can be used to specify the location (absolute path 1504 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1505 # run qhelpgenerator on the generated .qhp file. 1506 # This tag requires that the tag GENERATE_QHP is set to YES. 1507 1508 QHG_LOCATION = 1509 1510 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1511 # generated, together with the HTML files, they form an Eclipse help plugin. To 1512 # install this plugin and make it available under the help contents menu in 1513 # Eclipse, the contents of the directory containing the HTML and XML files needs 1514 # to be copied into the plugins directory of eclipse. The name of the directory 1515 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1516 # After copying Eclipse needs to be restarted before the help appears. 1517 # The default value is: NO. 1518 # This tag requires that the tag GENERATE_HTML is set to YES. 1519 1520 GENERATE_ECLIPSEHELP = NO 1521 1522 # A unique identifier for the Eclipse help plugin. When installing the plugin 1523 # the directory name containing the HTML and XML files should also have this 1524 # name. Each documentation set should have its own identifier. 1525 # The default value is: org.doxygen.Project. 1526 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1527 1528 ECLIPSE_DOC_ID = org.doxygen.Project 1529 1530 # If you want full control over the layout of the generated HTML pages it might 1531 # be necessary to disable the index and replace it with your own. The 1532 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1533 # of each HTML page. A value of NO enables the index and the value YES disables 1534 # it. Since the tabs in the index contain the same information as the navigation 1535 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1536 # The default value is: NO. 1537 # This tag requires that the tag GENERATE_HTML is set to YES. 1538 1539 DISABLE_INDEX = YES 1540 1541 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1542 # structure should be generated to display hierarchical information. If the tag 1543 # value is set to YES, a side panel will be generated containing a tree-like 1544 # index structure (just like the one that is generated for HTML Help). For this 1545 # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1546 # (i.e. any modern browser). Windows users are probably better off using the 1547 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1548 # further fine-tune the look of the index. As an example, the default style 1549 # sheet generated by doxygen has an example that shows how to put an image at 1550 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1551 # the same information as the tab index, you could consider setting 1552 # DISABLE_INDEX to YES when enabling this option. 1553 # The default value is: NO. 1554 # This tag requires that the tag GENERATE_HTML is set to YES. 1555 1556 GENERATE_TREEVIEW = YES 1557 1558 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1559 # doxygen will group on one line in the generated HTML documentation. 1560 # 1561 # Note that a value of 0 will completely suppress the enum values from appearing 1562 # in the overview section. 1563 # Minimum value: 0, maximum value: 20, default value: 4. 1564 # This tag requires that the tag GENERATE_HTML is set to YES. 1565 1566 ENUM_VALUES_PER_LINE = 4 1567 1568 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1569 # to set the initial width (in pixels) of the frame in which the tree is shown. 1570 # Minimum value: 0, maximum value: 1500, default value: 250. 1571 # This tag requires that the tag GENERATE_HTML is set to YES. 1572 1573 TREEVIEW_WIDTH = 250 1574 1575 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1576 # external symbols imported via tag files in a separate window. 1577 # The default value is: NO. 1578 # This tag requires that the tag GENERATE_HTML is set to YES. 1579 1580 EXT_LINKS_IN_WINDOW = NO 1581 1582 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1583 # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1584 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1585 # the HTML output. These images will generally look nicer at scaled resolutions. 1586 # Possible values are: png (the default) and svg (looks nicer but requires the 1587 # pdf2svg or inkscape tool). 1588 # The default value is: png. 1589 # This tag requires that the tag GENERATE_HTML is set to YES. 1590 1591 HTML_FORMULA_FORMAT = png 1592 1593 # Use this tag to change the font size of LaTeX formulas included as images in 1594 # the HTML documentation. When you change the font size after a successful 1595 # doxygen run you need to manually remove any form_*.png images from the HTML 1596 # output directory to force them to be regenerated. 1597 # Minimum value: 8, maximum value: 50, default value: 10. 1598 # This tag requires that the tag GENERATE_HTML is set to YES. 1599 1600 FORMULA_FONTSIZE = 10 1601 1602 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1603 # generated for formulas are transparent PNGs. Transparent PNGs are not 1604 # supported properly for IE 6.0, but are supported on all modern browsers. 1605 # 1606 # Note that when changing this option you need to delete any form_*.png files in 1607 # the HTML output directory before the changes have effect. 1608 # The default value is: YES. 1609 # This tag requires that the tag GENERATE_HTML is set to YES. 1610 1611 FORMULA_TRANSPARENT = YES 1612 1613 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1614 # to create new LaTeX commands to be used in formulas as building blocks. See 1615 # the section "Including formulas" for details. 1616 1617 FORMULA_MACROFILE = 1618 1619 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1620 # https://www.mathjax.org) which uses client side JavaScript for the rendering 1621 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1622 # installed or if you want to formulas look prettier in the HTML output. When 1623 # enabled you may also need to install MathJax separately and configure the path 1624 # to it using the MATHJAX_RELPATH option. 1625 # The default value is: NO. 1626 # This tag requires that the tag GENERATE_HTML is set to YES. 1627 1628 USE_MATHJAX = YES 1629 1630 # When MathJax is enabled you can set the default output format to be used for 1631 # the MathJax output. See the MathJax site (see: 1632 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. 1633 # Possible values are: HTML-CSS (which is slower, but has the best 1634 # compatibility), NativeMML (i.e. MathML) and SVG. 1635 # The default value is: HTML-CSS. 1636 # This tag requires that the tag USE_MATHJAX is set to YES. 1637 1638 MATHJAX_FORMAT = HTML-CSS 1639 1640 # When MathJax is enabled you need to specify the location relative to the HTML 1641 # output directory using the MATHJAX_RELPATH option. The destination directory 1642 # should contain the MathJax.js script. For instance, if the mathjax directory 1643 # is located at the same level as the HTML output directory, then 1644 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1645 # Content Delivery Network so you can quickly see the result without installing 1646 # MathJax. However, it is strongly recommended to install a local copy of 1647 # MathJax from https://www.mathjax.org before deployment. 1648 # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. 1649 # This tag requires that the tag USE_MATHJAX is set to YES. 1650 1651 MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 1652 1653 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1654 # extension names that should be enabled during MathJax rendering. For example 1655 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1656 # This tag requires that the tag USE_MATHJAX is set to YES. 1657 1658 MATHJAX_EXTENSIONS = 1659 1660 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1661 # of code that will be used on startup of the MathJax code. See the MathJax site 1662 # (see: 1663 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1664 # example see the documentation. 1665 # This tag requires that the tag USE_MATHJAX is set to YES. 1666 1667 MATHJAX_CODEFILE = 1668 1669 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1670 # the HTML output. The underlying search engine uses javascript and DHTML and 1671 # should work on any modern browser. Note that when using HTML help 1672 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1673 # there is already a search function so this one should typically be disabled. 1674 # For large projects the javascript based search engine can be slow, then 1675 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1676 # search using the keyboard; to jump to the search box use <access key> + S 1677 # (what the <access key> is depends on the OS and browser, but it is typically 1678 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1679 # key> to jump into the search results window, the results can be navigated 1680 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1681 # the search. The filter options can be selected when the cursor is inside the 1682 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1683 # to select a filter and <Enter> or <escape> to activate or cancel the filter 1684 # option. 1685 # The default value is: YES. 1686 # This tag requires that the tag GENERATE_HTML is set to YES. 1687 1688 SEARCHENGINE = YES 1689 1690 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1691 # implemented using a web server instead of a web client using JavaScript. There 1692 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1693 # setting. When disabled, doxygen will generate a PHP script for searching and 1694 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1695 # and searching needs to be provided by external tools. See the section 1696 # "External Indexing and Searching" for details. 1697 # The default value is: NO. 1698 # This tag requires that the tag SEARCHENGINE is set to YES. 1699 1700 SERVER_BASED_SEARCH = NO 1701 1702 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1703 # script for searching. Instead the search results are written to an XML file 1704 # which needs to be processed by an external indexer. Doxygen will invoke an 1705 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1706 # search results. 1707 # 1708 # Doxygen ships with an example indexer (doxyindexer) and search engine 1709 # (doxysearch.cgi) which are based on the open source search engine library 1710 # Xapian (see: 1711 # https://xapian.org/). 1712 # 1713 # See the section "External Indexing and Searching" for details. 1714 # The default value is: NO. 1715 # This tag requires that the tag SEARCHENGINE is set to YES. 1716 1717 EXTERNAL_SEARCH = NO 1718 1719 # The SEARCHENGINE_URL should point to a search engine hosted by a web server 1720 # which will return the search results when EXTERNAL_SEARCH is enabled. 1721 # 1722 # Doxygen ships with an example indexer (doxyindexer) and search engine 1723 # (doxysearch.cgi) which are based on the open source search engine library 1724 # Xapian (see: 1725 # https://xapian.org/). See the section "External Indexing and Searching" for 1726 # details. 1727 # This tag requires that the tag SEARCHENGINE is set to YES. 1728 1729 SEARCHENGINE_URL = 1730 1731 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1732 # search data is written to a file for indexing by an external tool. With the 1733 # SEARCHDATA_FILE tag the name of this file can be specified. 1734 # The default file is: searchdata.xml. 1735 # This tag requires that the tag SEARCHENGINE is set to YES. 1736 1737 SEARCHDATA_FILE = searchdata.xml 1738 1739 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1740 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1741 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1742 # projects and redirect the results back to the right project. 1743 # This tag requires that the tag SEARCHENGINE is set to YES. 1744 1745 EXTERNAL_SEARCH_ID = 1746 1747 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1748 # projects other than the one defined by this configuration file, but that are 1749 # all added to the same external search index. Each project needs to have a 1750 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1751 # to a relative location where the documentation can be found. The format is: 1752 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1753 # This tag requires that the tag SEARCHENGINE is set to YES. 1754 1755 EXTRA_SEARCH_MAPPINGS = 1756 1757 #--------------------------------------------------------------------------- 1758 # Configuration options related to the LaTeX output 1759 #--------------------------------------------------------------------------- 1760 1761 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1762 # The default value is: YES. 1763 1764 GENERATE_LATEX = NO 1765 1766 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1767 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1768 # it. 1769 # The default directory is: latex. 1770 # This tag requires that the tag GENERATE_LATEX is set to YES. 1771 1772 LATEX_OUTPUT = latex 1773 1774 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1775 # invoked. 1776 # 1777 # Note that when not enabling USE_PDFLATEX the default is latex when enabling 1778 # USE_PDFLATEX the default is pdflatex and when in the later case latex is 1779 # chosen this is overwritten by pdflatex. For specific output languages the 1780 # default can have been set differently, this depends on the implementation of 1781 # the output language. 1782 # This tag requires that the tag GENERATE_LATEX is set to YES. 1783 1784 LATEX_CMD_NAME = 1785 1786 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1787 # index for LaTeX. 1788 # Note: This tag is used in the Makefile / make.bat. 1789 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file 1790 # (.tex). 1791 # The default file is: makeindex. 1792 # This tag requires that the tag GENERATE_LATEX is set to YES. 1793 1794 MAKEINDEX_CMD_NAME = makeindex 1795 1796 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to 1797 # generate index for LaTeX. In case there is no backslash (\) as first character 1798 # it will be automatically added in the LaTeX code. 1799 # Note: This tag is used in the generated output file (.tex). 1800 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. 1801 # The default value is: makeindex. 1802 # This tag requires that the tag GENERATE_LATEX is set to YES. 1803 1804 LATEX_MAKEINDEX_CMD = makeindex 1805 1806 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1807 # documents. This may be useful for small projects and may help to save some 1808 # trees in general. 1809 # The default value is: NO. 1810 # This tag requires that the tag GENERATE_LATEX is set to YES. 1811 1812 COMPACT_LATEX = NO 1813 1814 # The PAPER_TYPE tag can be used to set the paper type that is used by the 1815 # printer. 1816 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1817 # 14 inches) and executive (7.25 x 10.5 inches). 1818 # The default value is: a4. 1819 # This tag requires that the tag GENERATE_LATEX is set to YES. 1820 1821 PAPER_TYPE = a4 1822 1823 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1824 # that should be included in the LaTeX output. The package can be specified just 1825 # by its name or with the correct syntax as to be used with the LaTeX 1826 # \usepackage command. To get the times font for instance you can specify : 1827 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1828 # To use the option intlimits with the amsmath package you can specify: 1829 # EXTRA_PACKAGES=[intlimits]{amsmath} 1830 # If left blank no extra packages will be included. 1831 # This tag requires that the tag GENERATE_LATEX is set to YES. 1832 1833 EXTRA_PACKAGES = 1834 1835 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1836 # generated LaTeX document. The header should contain everything until the first 1837 # chapter. If it is left blank doxygen will generate a standard header. See 1838 # section "Doxygen usage" for information on how to let doxygen write the 1839 # default header to a separate file. 1840 # 1841 # Note: Only use a user-defined header if you know what you are doing! The 1842 # following commands have a special meaning inside the header: $title, 1843 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1844 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1845 # string, for the replacement values of the other commands the user is referred 1846 # to HTML_HEADER. 1847 # This tag requires that the tag GENERATE_LATEX is set to YES. 1848 1849 LATEX_HEADER = 1850 1851 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1852 # generated LaTeX document. The footer should contain everything after the last 1853 # chapter. If it is left blank doxygen will generate a standard footer. See 1854 # LATEX_HEADER for more information on how to generate a default footer and what 1855 # special commands can be used inside the footer. 1856 # 1857 # Note: Only use a user-defined footer if you know what you are doing! 1858 # This tag requires that the tag GENERATE_LATEX is set to YES. 1859 1860 LATEX_FOOTER = 1861 1862 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1863 # LaTeX style sheets that are included after the standard style sheets created 1864 # by doxygen. Using this option one can overrule certain style aspects. Doxygen 1865 # will copy the style sheet files to the output directory. 1866 # Note: The order of the extra style sheet files is of importance (e.g. the last 1867 # style sheet in the list overrules the setting of the previous ones in the 1868 # list). 1869 # This tag requires that the tag GENERATE_LATEX is set to YES. 1870 1871 LATEX_EXTRA_STYLESHEET = 1872 1873 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1874 # other source files which should be copied to the LATEX_OUTPUT output 1875 # directory. Note that the files will be copied as-is; there are no commands or 1876 # markers available. 1877 # This tag requires that the tag GENERATE_LATEX is set to YES. 1878 1879 LATEX_EXTRA_FILES = 1880 1881 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1882 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1883 # contain links (just like the HTML output) instead of page references. This 1884 # makes the output suitable for online browsing using a PDF viewer. 1885 # The default value is: YES. 1886 # This tag requires that the tag GENERATE_LATEX is set to YES. 1887 1888 PDF_HYPERLINKS = YES 1889 1890 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as 1891 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX 1892 # files. Set this option to YES, to get a higher quality PDF documentation. 1893 # 1894 # See also section LATEX_CMD_NAME for selecting the engine. 1895 # The default value is: YES. 1896 # This tag requires that the tag GENERATE_LATEX is set to YES. 1897 1898 USE_PDFLATEX = YES 1899 1900 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1901 # command to the generated LaTeX files. This will instruct LaTeX to keep running 1902 # if errors occur, instead of asking the user for help. This option is also used 1903 # when generating formulas in HTML. 1904 # The default value is: NO. 1905 # This tag requires that the tag GENERATE_LATEX is set to YES. 1906 1907 LATEX_BATCHMODE = NO 1908 1909 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1910 # index chapters (such as File Index, Compound Index, etc.) in the output. 1911 # The default value is: NO. 1912 # This tag requires that the tag GENERATE_LATEX is set to YES. 1913 1914 LATEX_HIDE_INDICES = NO 1915 1916 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1917 # code with syntax highlighting in the LaTeX output. 1918 # 1919 # Note that which sources are shown also depends on other settings such as 1920 # SOURCE_BROWSER. 1921 # The default value is: NO. 1922 # This tag requires that the tag GENERATE_LATEX is set to YES. 1923 1924 LATEX_SOURCE_CODE = NO 1925 1926 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1927 # bibliography, e.g. plainnat, or ieeetr. See 1928 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1929 # The default value is: plain. 1930 # This tag requires that the tag GENERATE_LATEX is set to YES. 1931 1932 LATEX_BIB_STYLE = plain 1933 1934 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 1935 # page will contain the date and time when the page was generated. Setting this 1936 # to NO can help when comparing the output of multiple runs. 1937 # The default value is: NO. 1938 # This tag requires that the tag GENERATE_LATEX is set to YES. 1939 1940 LATEX_TIMESTAMP = NO 1941 1942 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) 1943 # path from which the emoji images will be read. If a relative path is entered, 1944 # it will be relative to the LATEX_OUTPUT directory. If left blank the 1945 # LATEX_OUTPUT directory will be used. 1946 # This tag requires that the tag GENERATE_LATEX is set to YES. 1947 1948 LATEX_EMOJI_DIRECTORY = 1949 1950 #--------------------------------------------------------------------------- 1951 # Configuration options related to the RTF output 1952 #--------------------------------------------------------------------------- 1953 1954 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1955 # RTF output is optimized for Word 97 and may not look too pretty with other RTF 1956 # readers/editors. 1957 # The default value is: NO. 1958 1959 GENERATE_RTF = NO 1960 1961 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1962 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1963 # it. 1964 # The default directory is: rtf. 1965 # This tag requires that the tag GENERATE_RTF is set to YES. 1966 1967 RTF_OUTPUT = rtf 1968 1969 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 1970 # documents. This may be useful for small projects and may help to save some 1971 # trees in general. 1972 # The default value is: NO. 1973 # This tag requires that the tag GENERATE_RTF is set to YES. 1974 1975 COMPACT_RTF = NO 1976 1977 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1978 # contain hyperlink fields. The RTF file will contain links (just like the HTML 1979 # output) instead of page references. This makes the output suitable for online 1980 # browsing using Word or some other Word compatible readers that support those 1981 # fields. 1982 # 1983 # Note: WordPad (write) and others do not support links. 1984 # The default value is: NO. 1985 # This tag requires that the tag GENERATE_RTF is set to YES. 1986 1987 RTF_HYPERLINKS = NO 1988 1989 # Load stylesheet definitions from file. Syntax is similar to doxygen's 1990 # configuration file, i.e. a series of assignments. You only have to provide 1991 # replacements, missing definitions are set to their default value. 1992 # 1993 # See also section "Doxygen usage" for information on how to generate the 1994 # default style sheet that doxygen normally uses. 1995 # This tag requires that the tag GENERATE_RTF is set to YES. 1996 1997 RTF_STYLESHEET_FILE = 1998 1999 # Set optional variables used in the generation of an RTF document. Syntax is 2000 # similar to doxygen's configuration file. A template extensions file can be 2001 # generated using doxygen -e rtf extensionFile. 2002 # This tag requires that the tag GENERATE_RTF is set to YES. 2003 2004 RTF_EXTENSIONS_FILE = 2005 2006 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 2007 # with syntax highlighting in the RTF output. 2008 # 2009 # Note that which sources are shown also depends on other settings such as 2010 # SOURCE_BROWSER. 2011 # The default value is: NO. 2012 # This tag requires that the tag GENERATE_RTF is set to YES. 2013 2014 RTF_SOURCE_CODE = NO 2015 2016 #--------------------------------------------------------------------------- 2017 # Configuration options related to the man page output 2018 #--------------------------------------------------------------------------- 2019 2020 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 2021 # classes and files. 2022 # The default value is: NO. 2023 2024 GENERATE_MAN = NO 2025 2026 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 2027 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2028 # it. A directory man3 will be created inside the directory specified by 2029 # MAN_OUTPUT. 2030 # The default directory is: man. 2031 # This tag requires that the tag GENERATE_MAN is set to YES. 2032 2033 MAN_OUTPUT = man 2034 2035 # The MAN_EXTENSION tag determines the extension that is added to the generated 2036 # man pages. In case the manual section does not start with a number, the number 2037 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 2038 # optional. 2039 # The default value is: .3. 2040 # This tag requires that the tag GENERATE_MAN is set to YES. 2041 2042 MAN_EXTENSION = .3 2043 2044 # The MAN_SUBDIR tag determines the name of the directory created within 2045 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 2046 # MAN_EXTENSION with the initial . removed. 2047 # This tag requires that the tag GENERATE_MAN is set to YES. 2048 2049 MAN_SUBDIR = 2050 2051 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 2052 # will generate one additional man file for each entity documented in the real 2053 # man page(s). These additional files only source the real man page, but without 2054 # them the man command would be unable to find the correct page. 2055 # The default value is: NO. 2056 # This tag requires that the tag GENERATE_MAN is set to YES. 2057 2058 MAN_LINKS = YES 2059 2060 #--------------------------------------------------------------------------- 2061 # Configuration options related to the XML output 2062 #--------------------------------------------------------------------------- 2063 2064 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 2065 # captures the structure of the code including all documentation. 2066 # The default value is: NO. 2067 2068 GENERATE_XML = NO 2069 2070 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 2071 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2072 # it. 2073 # The default directory is: xml. 2074 # This tag requires that the tag GENERATE_XML is set to YES. 2075 2076 XML_OUTPUT = xml 2077 2078 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 2079 # listings (including syntax highlighting and cross-referencing information) to 2080 # the XML output. Note that enabling this will significantly increase the size 2081 # of the XML output. 2082 # The default value is: YES. 2083 # This tag requires that the tag GENERATE_XML is set to YES. 2084 2085 XML_PROGRAMLISTING = YES 2086 2087 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include 2088 # namespace members in file scope as well, matching the HTML output. 2089 # The default value is: NO. 2090 # This tag requires that the tag GENERATE_XML is set to YES. 2091 2092 XML_NS_MEMB_FILE_SCOPE = NO 2093 2094 #--------------------------------------------------------------------------- 2095 # Configuration options related to the DOCBOOK output 2096 #--------------------------------------------------------------------------- 2097 2098 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 2099 # that can be used to generate PDF. 2100 # The default value is: NO. 2101 2102 GENERATE_DOCBOOK = NO 2103 2104 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 2105 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 2106 # front of it. 2107 # The default directory is: docbook. 2108 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 2109 2110 DOCBOOK_OUTPUT = docbook 2111 2112 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 2113 # program listings (including syntax highlighting and cross-referencing 2114 # information) to the DOCBOOK output. Note that enabling this will significantly 2115 # increase the size of the DOCBOOK output. 2116 # The default value is: NO. 2117 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 2118 2119 DOCBOOK_PROGRAMLISTING = NO 2120 2121 #--------------------------------------------------------------------------- 2122 # Configuration options for the AutoGen Definitions output 2123 #--------------------------------------------------------------------------- 2124 2125 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 2126 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures 2127 # the structure of the code including all documentation. Note that this feature 2128 # is still experimental and incomplete at the moment. 2129 # The default value is: NO. 2130 2131 GENERATE_AUTOGEN_DEF = NO 2132 2133 #--------------------------------------------------------------------------- 2134 # Configuration options related to the Perl module output 2135 #--------------------------------------------------------------------------- 2136 2137 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 2138 # file that captures the structure of the code including all documentation. 2139 # 2140 # Note that this feature is still experimental and incomplete at the moment. 2141 # The default value is: NO. 2142 2143 GENERATE_PERLMOD = NO 2144 2145 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 2146 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 2147 # output from the Perl module output. 2148 # The default value is: NO. 2149 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 2150 2151 PERLMOD_LATEX = NO 2152 2153 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 2154 # formatted so it can be parsed by a human reader. This is useful if you want to 2155 # understand what is going on. On the other hand, if this tag is set to NO, the 2156 # size of the Perl module output will be much smaller and Perl will parse it 2157 # just the same. 2158 # The default value is: YES. 2159 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 2160 2161 PERLMOD_PRETTY = YES 2162 2163 # The names of the make variables in the generated doxyrules.make file are 2164 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 2165 # so different doxyrules.make files included by the same Makefile don't 2166 # overwrite each other's variables. 2167 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 2168 2169 PERLMOD_MAKEVAR_PREFIX = 2170 2171 #--------------------------------------------------------------------------- 2172 # Configuration options related to the preprocessor 2173 #--------------------------------------------------------------------------- 2174 2175 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 2176 # C-preprocessor directives found in the sources and include files. 2177 # The default value is: YES. 2178 2179 ENABLE_PREPROCESSING = YES 2180 2181 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2182 # in the source code. If set to NO, only conditional compilation will be 2183 # performed. Macro expansion can be done in a controlled way by setting 2184 # EXPAND_ONLY_PREDEF to YES. 2185 # The default value is: NO. 2186 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2187 2188 MACRO_EXPANSION = YES 2189 2190 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 2191 # the macro expansion is limited to the macros specified with the PREDEFINED and 2192 # EXPAND_AS_DEFINED tags. 2193 # The default value is: NO. 2194 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2195 2196 EXPAND_ONLY_PREDEF = YES 2197 2198 # If the SEARCH_INCLUDES tag is set to YES, the include files in the 2199 # INCLUDE_PATH will be searched if a #include is found. 2200 # The default value is: YES. 2201 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2202 2203 SEARCH_INCLUDES = YES 2204 2205 # The INCLUDE_PATH tag can be used to specify one or more directories that 2206 # contain include files that are not input files but should be processed by the 2207 # preprocessor. 2208 # This tag requires that the tag SEARCH_INCLUDES is set to YES. 2209 2210 INCLUDE_PATH = 2211 2212 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2213 # patterns (like *.h and *.hpp) to filter out the header-files in the 2214 # directories. If left blank, the patterns specified with FILE_PATTERNS will be 2215 # used. 2216 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2217 2218 INCLUDE_FILE_PATTERNS = 2219 2220 # The PREDEFINED tag can be used to specify one or more macro names that are 2221 # defined before the preprocessor is started (similar to the -D option of e.g. 2222 # gcc). The argument of the tag is a list of macros of the form: name or 2223 # name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2224 # is assumed. To prevent a macro definition from being undefined via #undef or 2225 # recursively expanded use the := operator instead of the = operator. 2226 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2227 2228 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \ 2229 K_DOXYGEN \ 2230 Q_SLOTS=slots \ 2231 Q_SIGNALS=signals \ 2232 Q_DECL_CONSTEXPR=constexpr \ 2233 Q_DECL_FINAL=final \ 2234 "Q_DECL_EQ_DEFAULT= = default" \ 2235 "Q_DECL_EQ_DELETE= = delete" \ 2236 Q_DECL_NULLPTR=nullptr \ 2237 Q_DECL_OVERRIDE=override \ 2238 Q_DECL_HIDDEN= \ 2239 Q_REQUIRED_RESULT= \ 2240 "Q_DECLARE_FLAGS(Flags, Enum)=typedef QFlags<Enum> Flags;" 2241 2242 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2243 # tag can be used to specify a list of macro names that should be expanded. The 2244 # macro definition that is found in the sources will be used. Use the PREDEFINED 2245 # tag if you want to use a different macro definition that overrules the 2246 # definition found in the source code. 2247 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2248 2249 EXPAND_AS_DEFINED = 2250 2251 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2252 # remove all references to function-like macros that are alone on a line, have 2253 # an all uppercase name, and do not end with a semicolon. Such function macros 2254 # are typically used for boiler-plate code, and will confuse the parser if not 2255 # removed. 2256 # The default value is: YES. 2257 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2258 2259 SKIP_FUNCTION_MACROS = YES 2260 2261 #--------------------------------------------------------------------------- 2262 # Configuration options related to external references 2263 #--------------------------------------------------------------------------- 2264 2265 # The TAGFILES tag can be used to specify one or more tag files. For each tag 2266 # file the location of the external documentation should be added. The format of 2267 # a tag file without this location is as follows: 2268 # TAGFILES = file1 file2 ... 2269 # Adding location for the tag files is done as follows: 2270 # TAGFILES = file1=loc1 "file2 = loc2" ... 2271 # where loc1 and loc2 can be relative or absolute paths or URLs. See the 2272 # section "Linking to external documentation" for more information about the use 2273 # of tag files. 2274 # Note: Each tag file must have a unique name (where the name does NOT include 2275 # the path). If a tag file is not located in the directory in which doxygen is 2276 # run, you must also specify the path to the tagfile here. 2277 2278 TAGFILES = 2279 2280 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2281 # tag file that is based on the input files it reads. See section "Linking to 2282 # external documentation" for more information about the usage of tag files. 2283 2284 GENERATE_TAGFILE = 2285 2286 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2287 # the class index. If set to NO, only the inherited external classes will be 2288 # listed. 2289 # The default value is: NO. 2290 2291 ALLEXTERNALS = NO 2292 2293 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2294 # in the modules index. If set to NO, only the current project's groups will be 2295 # listed. 2296 # The default value is: YES. 2297 2298 EXTERNAL_GROUPS = NO 2299 2300 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2301 # the related pages index. If set to NO, only the current project's pages will 2302 # be listed. 2303 # The default value is: YES. 2304 2305 EXTERNAL_PAGES = YES 2306 2307 #--------------------------------------------------------------------------- 2308 # Configuration options related to the dot tool 2309 #--------------------------------------------------------------------------- 2310 2311 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2312 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2313 # NO turns the diagrams off. Note that this option also works with HAVE_DOT 2314 # disabled, but it is recommended to install and use dot, since it yields more 2315 # powerful graphs. 2316 # The default value is: YES. 2317 2318 CLASS_DIAGRAMS = YES 2319 2320 # You can include diagrams made with dia in doxygen documentation. Doxygen will 2321 # then run dia to produce the diagram and insert it in the documentation. The 2322 # DIA_PATH tag allows you to specify the directory where the dia binary resides. 2323 # If left empty dia is assumed to be found in the default search path. 2324 2325 DIA_PATH = 2326 2327 # If set to YES the inheritance and collaboration graphs will hide inheritance 2328 # and usage relations if the target is undocumented or is not a class. 2329 # The default value is: YES. 2330 2331 HIDE_UNDOC_RELATIONS = NO 2332 2333 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2334 # available from the path. This tool is part of Graphviz (see: 2335 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2336 # Bell Labs. The other options in this section have no effect if this option is 2337 # set to NO 2338 # The default value is: YES. 2339 2340 HAVE_DOT = YES 2341 2342 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2343 # to run in parallel. When set to 0 doxygen will base this on the number of 2344 # processors available in the system. You can set it explicitly to a value 2345 # larger than 0 to get control over the balance between CPU load and processing 2346 # speed. 2347 # Minimum value: 0, maximum value: 32, default value: 0. 2348 # This tag requires that the tag HAVE_DOT is set to YES. 2349 2350 DOT_NUM_THREADS = 0 2351 2352 # When you want a differently looking font in the dot files that doxygen 2353 # generates you can specify the font name using DOT_FONTNAME. You need to make 2354 # sure dot is able to find the font, which can be done by putting it in a 2355 # standard location or by setting the DOTFONTPATH environment variable or by 2356 # setting DOT_FONTPATH to the directory containing the font. 2357 # The default value is: Helvetica. 2358 # This tag requires that the tag HAVE_DOT is set to YES. 2359 2360 DOT_FONTNAME = Helvetica 2361 2362 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2363 # dot graphs. 2364 # Minimum value: 4, maximum value: 24, default value: 10. 2365 # This tag requires that the tag HAVE_DOT is set to YES. 2366 2367 DOT_FONTSIZE = 10 2368 2369 # By default doxygen will tell dot to use the default font as specified with 2370 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2371 # the path where dot can find it using this tag. 2372 # This tag requires that the tag HAVE_DOT is set to YES. 2373 2374 DOT_FONTPATH = 2375 2376 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2377 # each documented class showing the direct and indirect inheritance relations. 2378 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2379 # The default value is: YES. 2380 # This tag requires that the tag HAVE_DOT is set to YES. 2381 2382 CLASS_GRAPH = YES 2383 2384 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2385 # graph for each documented class showing the direct and indirect implementation 2386 # dependencies (inheritance, containment, and class references variables) of the 2387 # class with other documented classes. 2388 # The default value is: YES. 2389 # This tag requires that the tag HAVE_DOT is set to YES. 2390 2391 COLLABORATION_GRAPH = NO 2392 2393 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2394 # groups, showing the direct groups dependencies. 2395 # The default value is: YES. 2396 # This tag requires that the tag HAVE_DOT is set to YES. 2397 2398 GROUP_GRAPHS = YES 2399 2400 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2401 # collaboration diagrams in a style similar to the OMG's Unified Modeling 2402 # Language. 2403 # The default value is: NO. 2404 # This tag requires that the tag HAVE_DOT is set to YES. 2405 2406 UML_LOOK = NO 2407 2408 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2409 # class node. If there are many fields or methods and many nodes the graph may 2410 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2411 # number of items for each type to make the size more manageable. Set this to 0 2412 # for no limit. Note that the threshold may be exceeded by 50% before the limit 2413 # is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2414 # but if the number exceeds 15, the total amount of fields shown is limited to 2415 # 10. 2416 # Minimum value: 0, maximum value: 100, default value: 10. 2417 # This tag requires that the tag UML_LOOK is set to YES. 2418 2419 UML_LIMIT_NUM_FIELDS = 10 2420 2421 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and 2422 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS 2423 # tag is set to YES, doxygen will add type and arguments for attributes and 2424 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen 2425 # will not generate fields with class member information in the UML graphs. The 2426 # class diagrams will look similar to the default class diagrams but using UML 2427 # notation for the relationships. 2428 # Possible values are: NO, YES and NONE. 2429 # The default value is: NO. 2430 # This tag requires that the tag UML_LOOK is set to YES. 2431 2432 DOT_UML_DETAILS = NO 2433 2434 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters 2435 # to display on a single line. If the actual line length exceeds this threshold 2436 # significantly it will wrapped across multiple lines. Some heuristics are apply 2437 # to avoid ugly line breaks. 2438 # Minimum value: 0, maximum value: 1000, default value: 17. 2439 # This tag requires that the tag HAVE_DOT is set to YES. 2440 2441 DOT_WRAP_THRESHOLD = 17 2442 2443 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2444 # collaboration graphs will show the relations between templates and their 2445 # instances. 2446 # The default value is: NO. 2447 # This tag requires that the tag HAVE_DOT is set to YES. 2448 2449 TEMPLATE_RELATIONS = YES 2450 2451 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2452 # YES then doxygen will generate a graph for each documented file showing the 2453 # direct and indirect include dependencies of the file with other documented 2454 # files. 2455 # The default value is: YES. 2456 # This tag requires that the tag HAVE_DOT is set to YES. 2457 2458 INCLUDE_GRAPH = YES 2459 2460 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2461 # set to YES then doxygen will generate a graph for each documented file showing 2462 # the direct and indirect include dependencies of the file with other documented 2463 # files. 2464 # The default value is: YES. 2465 # This tag requires that the tag HAVE_DOT is set to YES. 2466 2467 INCLUDED_BY_GRAPH = NO 2468 2469 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2470 # dependency graph for every global function or class method. 2471 # 2472 # Note that enabling this option will significantly increase the time of a run. 2473 # So in most cases it will be better to enable call graphs for selected 2474 # functions only using the \callgraph command. Disabling a call graph can be 2475 # accomplished by means of the command \hidecallgraph. 2476 # The default value is: NO. 2477 # This tag requires that the tag HAVE_DOT is set to YES. 2478 2479 CALL_GRAPH = NO 2480 2481 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2482 # dependency graph for every global function or class method. 2483 # 2484 # Note that enabling this option will significantly increase the time of a run. 2485 # So in most cases it will be better to enable caller graphs for selected 2486 # functions only using the \callergraph command. Disabling a caller graph can be 2487 # accomplished by means of the command \hidecallergraph. 2488 # The default value is: NO. 2489 # This tag requires that the tag HAVE_DOT is set to YES. 2490 2491 CALLER_GRAPH = NO 2492 2493 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2494 # hierarchy of all classes instead of a textual one. 2495 # The default value is: YES. 2496 # This tag requires that the tag HAVE_DOT is set to YES. 2497 2498 GRAPHICAL_HIERARCHY = YES 2499 2500 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2501 # dependencies a directory has on other directories in a graphical way. The 2502 # dependency relations are determined by the #include relations between the 2503 # files in the directories. 2504 # The default value is: YES. 2505 # This tag requires that the tag HAVE_DOT is set to YES. 2506 2507 DIRECTORY_GRAPH = YES 2508 2509 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2510 # generated by dot. For an explanation of the image formats see the section 2511 # output formats in the documentation of the dot tool (Graphviz (see: 2512 # http://www.graphviz.org/)). 2513 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2514 # to make the SVG files visible in IE 9+ (other browsers do not have this 2515 # requirement). 2516 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, 2517 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, 2518 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, 2519 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2520 # png:gdiplus:gdiplus. 2521 # The default value is: png. 2522 # This tag requires that the tag HAVE_DOT is set to YES. 2523 2524 DOT_IMAGE_FORMAT = png 2525 2526 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2527 # enable generation of interactive SVG images that allow zooming and panning. 2528 # 2529 # Note that this requires a modern browser other than Internet Explorer. Tested 2530 # and working are Firefox, Chrome, Safari, and Opera. 2531 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2532 # the SVG files visible. Older versions of IE do not have SVG support. 2533 # The default value is: NO. 2534 # This tag requires that the tag HAVE_DOT is set to YES. 2535 2536 INTERACTIVE_SVG = NO 2537 2538 # The DOT_PATH tag can be used to specify the path where the dot tool can be 2539 # found. If left blank, it is assumed the dot tool can be found in the path. 2540 # This tag requires that the tag HAVE_DOT is set to YES. 2541 2542 DOT_PATH = 2543 2544 # The DOTFILE_DIRS tag can be used to specify one or more directories that 2545 # contain dot files that are included in the documentation (see the \dotfile 2546 # command). 2547 # This tag requires that the tag HAVE_DOT is set to YES. 2548 2549 DOTFILE_DIRS = 2550 2551 # The MSCFILE_DIRS tag can be used to specify one or more directories that 2552 # contain msc files that are included in the documentation (see the \mscfile 2553 # command). 2554 2555 MSCFILE_DIRS = 2556 2557 # The DIAFILE_DIRS tag can be used to specify one or more directories that 2558 # contain dia files that are included in the documentation (see the \diafile 2559 # command). 2560 2561 DIAFILE_DIRS = 2562 2563 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2564 # path where java can find the plantuml.jar file. If left blank, it is assumed 2565 # PlantUML is not used or called during a preprocessing step. Doxygen will 2566 # generate a warning when it encounters a \startuml command in this case and 2567 # will not generate output for the diagram. 2568 2569 PLANTUML_JAR_PATH = 2570 2571 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2572 # configuration file for plantuml. 2573 2574 PLANTUML_CFG_FILE = 2575 2576 # When using plantuml, the specified paths are searched for files specified by 2577 # the !include statement in a plantuml block. 2578 2579 PLANTUML_INCLUDE_PATH = 2580 2581 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2582 # that will be shown in the graph. If the number of nodes in a graph becomes 2583 # larger than this value, doxygen will truncate the graph, which is visualized 2584 # by representing a node as a red box. Note that doxygen if the number of direct 2585 # children of the root node in a graph is already larger than 2586 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2587 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2588 # Minimum value: 0, maximum value: 10000, default value: 50. 2589 # This tag requires that the tag HAVE_DOT is set to YES. 2590 2591 DOT_GRAPH_MAX_NODES = 50 2592 2593 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2594 # generated by dot. A depth value of 3 means that only nodes reachable from the 2595 # root by following a path via at most 3 edges will be shown. Nodes that lay 2596 # further from the root node will be omitted. Note that setting this option to 1 2597 # or 2 may greatly reduce the computation time needed for large code bases. Also 2598 # note that the size of a graph can be further restricted by 2599 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2600 # Minimum value: 0, maximum value: 1000, default value: 0. 2601 # This tag requires that the tag HAVE_DOT is set to YES. 2602 2603 MAX_DOT_GRAPH_DEPTH = 0 2604 2605 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2606 # background. This is disabled by default, because dot on Windows does not seem 2607 # to support this out of the box. 2608 # 2609 # Warning: Depending on the platform used, enabling this option may lead to 2610 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2611 # read). 2612 # The default value is: NO. 2613 # This tag requires that the tag HAVE_DOT is set to YES. 2614 2615 DOT_TRANSPARENT = NO 2616 2617 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2618 # files in one run (i.e. multiple -o and -T options on the command line). This 2619 # makes dot run faster, but since only newer versions of dot (>1.8.10) support 2620 # this, this feature is disabled by default. 2621 # The default value is: NO. 2622 # This tag requires that the tag HAVE_DOT is set to YES. 2623 2624 DOT_MULTI_TARGETS = NO 2625 2626 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2627 # explaining the meaning of the various boxes and arrows in the dot generated 2628 # graphs. 2629 # The default value is: YES. 2630 # This tag requires that the tag HAVE_DOT is set to YES. 2631 2632 GENERATE_LEGEND = YES 2633 2634 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate 2635 # files that are used to generate the various graphs. 2636 # 2637 # Note: This setting is not only used for dot files but also for msc and 2638 # plantuml temporary files. 2639 # The default value is: YES. 2640 2641 DOT_CLEANUP = YES