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