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