├── .travis.yml ├── Doxyfile ├── LICENSE ├── Readme.md ├── examples ├── bandwidthExample │ └── bandwidthExample.ino ├── dataProcessing │ └── dataProcessing.ino ├── motionInterrupt │ └── motionInterrupt.ino ├── offsetCancellation │ └── offsetCancellation.ino ├── powerControl │ └── powerControl.ino ├── rawData │ └── rawData.ino ├── scaleExample │ └── scaleExample.ino └── sleepExample │ └── sleepExample.ino ├── keywords.txt ├── library.properties └── src ├── MPU9255.cpp ├── MPU9255.h ├── MPU9255_Communication.cpp ├── MPU9255_Data.cpp ├── MPU9255_Interrupts.cpp └── MPU9255_PowerControl.cpp /.travis.yml: -------------------------------------------------------------------------------- 1 | language: c 2 | 3 | notifications: 4 | email: false 5 | 6 | before_install: 7 | - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16" 8 | - sleep 3 9 | - export DISPLAY=:1.0 10 | - wget http://downloads.arduino.cc/arduino-1.8.5-linux64.tar.xz 11 | - tar xf arduino-1.8.5-linux64.tar.xz 12 | - sudo mv arduino-1.8.5 /usr/local/share/arduino 13 | - sudo ln -s /usr/local/share/arduino/arduino /usr/local/bin/arduino 14 | 15 | install: 16 | - ln -s $PWD /usr/local/share/arduino/libraries/MPU9255-Arduino-Librar 17 | 18 | addons: 19 | apt: 20 | packages: 21 | - doxygen 22 | 23 | script: 24 | - arduino --verify --board arduino:avr:uno $PWD/examples/dataProcessing/dataProcessing.ino 25 | - arduino --verify --board arduino:avr:uno $PWD/examples/rawData/rawData.ino 26 | - arduino --verify --board arduino:avr:uno $PWD/examples/scaleExample/scaleExample.ino 27 | - arduino --verify --board arduino:avr:uno $PWD/examples/powerControl/powerControl.ino 28 | - arduino --verify --board arduino:avr:uno $PWD/examples/sleepExample/sleepExample.ino 29 | - arduino --verify --board arduino:avr:uno $PWD/examples/bandwidthExample/bandwidthExample.ino 30 | - arduino --verify --board arduino:avr:uno $PWD/examples/motionInterrupt/motionInterrupt.ino 31 | - arduino --verify --board arduino:avr:uno $PWD/examples/offsetCancellation/offsetCancellation.ino 32 | - doxygen Doxyfile 33 | 34 | deploy: 35 | provider: pages 36 | skip_cleanup: true 37 | local_dir: html 38 | github_token: $GH_REPO_TOKEN 39 | on: 40 | branch: master 41 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.15 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the configuration 21 | # file that follow. The default is UTF-8 which is also the encoding used for all 22 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 23 | # iconv built into libc) for the transcoding. See 24 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "MPU9255" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = "MPU9255 Arduino Library" 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | 72 | USE_MDFILE_AS_MAINPAGE = YES 73 | 74 | CREATE_SUBDIRS = NO 75 | 76 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 77 | # characters to appear in the names of generated files. If set to NO, non-ASCII 78 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 79 | # U+3044. 80 | # The default value is: NO. 81 | 82 | ALLOW_UNICODE_NAMES = NO 83 | 84 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 85 | # documentation generated by doxygen is written. Doxygen will use this 86 | # information to generate all constant output in the proper language. 87 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 88 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 89 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 90 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 91 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 92 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 93 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 94 | # Ukrainian and Vietnamese. 95 | # The default value is: English. 96 | 97 | OUTPUT_LANGUAGE = English 98 | 99 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 100 | # documentation generated by doxygen is written. Doxygen will use this 101 | # information to generate all generated output in the proper direction. 102 | # Possible values are: None, LTR, RTL and Context. 103 | # The default value is: None. 104 | 105 | OUTPUT_TEXT_DIRECTION = None 106 | 107 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 108 | # descriptions after the members that are listed in the file and class 109 | # documentation (similar to Javadoc). Set to NO to disable this. 110 | # The default value is: YES. 111 | 112 | BRIEF_MEMBER_DESC = YES 113 | 114 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 115 | # description of a member or function before the detailed description 116 | # 117 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 118 | # brief descriptions will be completely suppressed. 119 | # The default value is: YES. 120 | 121 | REPEAT_BRIEF = YES 122 | 123 | # This tag implements a quasi-intelligent brief description abbreviator that is 124 | # used to form the text in various listings. Each string in this list, if found 125 | # as the leading text of the brief description, will be stripped from the text 126 | # and the result, after processing the whole list, is used as the annotated 127 | # text. Otherwise, the brief description is used as-is. If left blank, the 128 | # following values are used ($name is automatically replaced with the name of 129 | # the entity):The $name class, The $name widget, The $name file, is, provides, 130 | # specifies, contains, represents, a, an and the. 131 | 132 | ABBREVIATE_BRIEF = "The $name class" \ 133 | "The $name widget" \ 134 | "The $name file" \ 135 | is \ 136 | provides \ 137 | specifies \ 138 | contains \ 139 | represents \ 140 | a \ 141 | an \ 142 | the 143 | 144 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 145 | # doxygen will generate a detailed section even if there is only a brief 146 | # description. 147 | # The default value is: NO. 148 | 149 | ALWAYS_DETAILED_SEC = NO 150 | 151 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 152 | # inherited members of a class in the documentation of that class as if those 153 | # members were ordinary class members. Constructors, destructors and assignment 154 | # operators of the base classes will not be shown. 155 | # The default value is: NO. 156 | 157 | INLINE_INHERITED_MEMB = NO 158 | 159 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 160 | # before files name in the file list and in the header files. If set to NO the 161 | # shortest path that makes the file name unique will be used 162 | # The default value is: YES. 163 | 164 | FULL_PATH_NAMES = YES 165 | 166 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 167 | # Stripping is only done if one of the specified strings matches the left-hand 168 | # part of the path. The tag can be used to show relative paths in the file list. 169 | # If left blank the directory from which doxygen is run is used as the path to 170 | # strip. 171 | # 172 | # Note that you can specify absolute paths here, but also relative paths, which 173 | # will be relative from the directory where doxygen is started. 174 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 175 | 176 | STRIP_FROM_PATH = 177 | 178 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 179 | # path mentioned in the documentation of a class, which tells the reader which 180 | # header file to include in order to use a class. If left blank only the name of 181 | # the header file containing the class definition is used. Otherwise one should 182 | # specify the list of include paths that are normally passed to the compiler 183 | # using the -I flag. 184 | 185 | STRIP_FROM_INC_PATH = 186 | 187 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 188 | # less readable) file names. This can be useful is your file systems doesn't 189 | # support long names like on DOS, Mac, or CD-ROM. 190 | # The default value is: NO. 191 | 192 | SHORT_NAMES = NO 193 | 194 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 195 | # first line (until the first dot) of a Javadoc-style comment as the brief 196 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 197 | # style comments (thus requiring an explicit @brief command for a brief 198 | # description.) 199 | # The default value is: NO. 200 | 201 | JAVADOC_AUTOBRIEF = NO 202 | 203 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 204 | # line (until the first dot) of a Qt-style comment as the brief description. If 205 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 206 | # requiring an explicit \brief command for a brief description.) 207 | # The default value is: NO. 208 | 209 | QT_AUTOBRIEF = NO 210 | 211 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 212 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 213 | # a brief description. This used to be the default behavior. The new default is 214 | # to treat a multi-line C++ comment block as a detailed description. Set this 215 | # tag to YES if you prefer the old behavior instead. 216 | # 217 | # Note that setting this tag to YES also means that rational rose comments are 218 | # not recognized any more. 219 | # The default value is: NO. 220 | 221 | MULTILINE_CPP_IS_BRIEF = NO 222 | 223 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 224 | # documentation from any documented member that it re-implements. 225 | # The default value is: YES. 226 | 227 | INHERIT_DOCS = YES 228 | 229 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 230 | # page for each member. If set to NO, the documentation of a member will be part 231 | # of the file/class/namespace that contains it. 232 | # The default value is: NO. 233 | 234 | SEPARATE_MEMBER_PAGES = NO 235 | 236 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 237 | # uses this value to replace tabs by spaces in code fragments. 238 | # Minimum value: 1, maximum value: 16, default value: 4. 239 | 240 | TAB_SIZE = 4 241 | 242 | # This tag can be used to specify a number of aliases that act as commands in 243 | # the documentation. An alias has the form: 244 | # name=value 245 | # For example adding 246 | # "sideeffect=@par Side Effects:\n" 247 | # will allow you to put the command \sideeffect (or @sideeffect) in the 248 | # documentation, which will result in a user-defined paragraph with heading 249 | # "Side Effects:". You can put \n's in the value part of an alias to insert 250 | # newlines (in the resulting output). You can put ^^ in the value part of an 251 | # alias to insert a newline as if a physical newline was in the original file. 252 | # When you need a literal { or } or , in the value part of an alias you have to 253 | # escape them by means of a backslash (\), this can lead to conflicts with the 254 | # commands \{ and \} for these it is advised to use the version @{ and @} or use 255 | # a double escape (\\{ and \\}) 256 | 257 | ALIASES = 258 | 259 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 260 | # A mapping has the form "name=value". For example adding "class=itcl::class" 261 | # will allow you to use the command class in the itcl::class meaning. 262 | 263 | TCL_SUBST = 264 | 265 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 266 | # only. Doxygen will then generate output that is more tailored for C. For 267 | # instance, some of the names that are used will be different. The list of all 268 | # members will be omitted, etc. 269 | # The default value is: NO. 270 | 271 | OPTIMIZE_OUTPUT_FOR_C = NO 272 | 273 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 274 | # Python sources only. Doxygen will then generate output that is more tailored 275 | # for that language. For instance, namespaces will be presented as packages, 276 | # qualified scopes will look different, etc. 277 | # The default value is: NO. 278 | 279 | OPTIMIZE_OUTPUT_JAVA = YES 280 | 281 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 282 | # sources. Doxygen will then generate output that is tailored for Fortran. 283 | # The default value is: NO. 284 | 285 | OPTIMIZE_FOR_FORTRAN = NO 286 | 287 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 288 | # sources. Doxygen will then generate output that is tailored for VHDL. 289 | # The default value is: NO. 290 | 291 | OPTIMIZE_OUTPUT_VHDL = NO 292 | 293 | # Doxygen selects the parser to use depending on the extension of the files it 294 | # parses. With this tag you can assign which parser to use for a given 295 | # extension. Doxygen has a built-in mapping, but you can override or extend it 296 | # using this tag. The format is ext=language, where ext is a file extension, and 297 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 298 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Fortran 299 | # (fixed format Fortran: FortranFixed, free formatted Fortran: FortranFree, 300 | # unknown formatted Fortran: Fortran. In the later case the parser tries to 301 | # guess whether the code is fixed or free formatted code, this is the default 302 | # for Fortran type files), VHDL, tcl. For instance to make doxygen treat .inc 303 | # files as Fortran files (default is PHP), and .f files as C (default is 304 | # Fortran), use: inc=Fortran f=C. 305 | # 306 | # Note: For files without extension you can use no_extension as a placeholder. 307 | # 308 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 309 | # the files are not read by doxygen. 310 | 311 | EXTENSION_MAPPING = 312 | 313 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 314 | # according to the Markdown format, which allows for more readable 315 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 316 | # The output of markdown processing is further processed by doxygen, so you can 317 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 318 | # case of backward compatibilities issues. 319 | # The default value is: YES. 320 | 321 | MARKDOWN_SUPPORT = YES 322 | 323 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 324 | # to that level are automatically included in the table of contents, even if 325 | # they do not have an id attribute. 326 | # Note: This feature currently applies only to Markdown headings. 327 | # Minimum value: 0, maximum value: 99, default value: 0. 328 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 329 | 330 | TOC_INCLUDE_HEADINGS = 0 331 | 332 | # When enabled doxygen tries to link words that correspond to documented 333 | # classes, or namespaces to their corresponding documentation. Such a link can 334 | # be prevented in individual cases by putting a % sign in front of the word or 335 | # globally by setting AUTOLINK_SUPPORT to NO. 336 | # The default value is: YES. 337 | 338 | AUTOLINK_SUPPORT = YES 339 | 340 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 341 | # to include (a tag file for) the STL sources as input, then you should set this 342 | # tag to YES in order to let doxygen match functions declarations and 343 | # definitions whose arguments contain STL classes (e.g. func(std::string); 344 | # versus func(std::string) {}). This also make the inheritance and collaboration 345 | # diagrams that involve STL classes more complete and accurate. 346 | # The default value is: NO. 347 | 348 | BUILTIN_STL_SUPPORT = NO 349 | 350 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 351 | # enable parsing support. 352 | # The default value is: NO. 353 | 354 | CPP_CLI_SUPPORT = NO 355 | 356 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 357 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 358 | # will parse them like normal C++ but will assume all classes use public instead 359 | # of private inheritance when no explicit protection keyword is present. 360 | # The default value is: NO. 361 | 362 | SIP_SUPPORT = NO 363 | 364 | # For Microsoft's IDL there are propget and propput attributes to indicate 365 | # getter and setter methods for a property. Setting this option to YES will make 366 | # doxygen to replace the get and set methods by a property in the documentation. 367 | # This will only work if the methods are indeed getting or setting a simple 368 | # type. If this is not the case, or you want to show the methods anyway, you 369 | # should set this option to NO. 370 | # The default value is: YES. 371 | 372 | IDL_PROPERTY_SUPPORT = YES 373 | 374 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 375 | # tag is set to YES then doxygen will reuse the documentation of the first 376 | # member in the group (if any) for the other members of the group. By default 377 | # all members of a group must be documented explicitly. 378 | # The default value is: NO. 379 | 380 | DISTRIBUTE_GROUP_DOC = NO 381 | 382 | # If one adds a struct or class to a group and this option is enabled, then also 383 | # any nested class or struct is added to the same group. By default this option 384 | # is disabled and one has to add nested compounds explicitly via \ingroup. 385 | # The default value is: NO. 386 | 387 | GROUP_NESTED_COMPOUNDS = NO 388 | 389 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 390 | # (for instance a group of public functions) to be put as a subgroup of that 391 | # type (e.g. under the Public Functions section). Set it to NO to prevent 392 | # subgrouping. Alternatively, this can be done per class using the 393 | # \nosubgrouping command. 394 | # The default value is: YES. 395 | 396 | SUBGROUPING = YES 397 | 398 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 399 | # are shown inside the group in which they are included (e.g. using \ingroup) 400 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 401 | # and RTF). 402 | # 403 | # Note that this feature does not work in combination with 404 | # SEPARATE_MEMBER_PAGES. 405 | # The default value is: NO. 406 | 407 | INLINE_GROUPED_CLASSES = NO 408 | 409 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 410 | # with only public data fields or simple typedef fields will be shown inline in 411 | # the documentation of the scope in which they are defined (i.e. file, 412 | # namespace, or group documentation), provided this scope is documented. If set 413 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 414 | # Man pages) or section (for LaTeX and RTF). 415 | # The default value is: NO. 416 | 417 | INLINE_SIMPLE_STRUCTS = NO 418 | 419 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 420 | # enum is documented as struct, union, or enum with the name of the typedef. So 421 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 422 | # with name TypeT. When disabled the typedef will appear as a member of a file, 423 | # namespace, or class. And the struct will be named TypeS. This can typically be 424 | # useful for C code in case the coding convention dictates that all compound 425 | # types are typedef'ed and only the typedef is referenced, never the tag name. 426 | # The default value is: NO. 427 | 428 | TYPEDEF_HIDES_STRUCT = NO 429 | 430 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 431 | # cache is used to resolve symbols given their name and scope. Since this can be 432 | # an expensive process and often the same symbol appears multiple times in the 433 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 434 | # doxygen will become slower. If the cache is too large, memory is wasted. The 435 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 436 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 437 | # symbols. At the end of a run doxygen will report the cache usage and suggest 438 | # the optimal cache size from a speed point of view. 439 | # Minimum value: 0, maximum value: 9, default value: 0. 440 | 441 | LOOKUP_CACHE_SIZE = 0 442 | 443 | #--------------------------------------------------------------------------- 444 | # Build related configuration options 445 | #--------------------------------------------------------------------------- 446 | 447 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 448 | # documentation are documented, even if no documentation was available. Private 449 | # class members and static file members will be hidden unless the 450 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 451 | # Note: This will also disable the warnings about undocumented members that are 452 | # normally produced when WARNINGS is set to YES. 453 | # The default value is: NO. 454 | 455 | EXTRACT_ALL = NO 456 | 457 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 458 | # be included in the documentation. 459 | # The default value is: NO. 460 | 461 | EXTRACT_PRIVATE = NO 462 | 463 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 464 | # scope will be included in the documentation. 465 | # The default value is: NO. 466 | 467 | EXTRACT_PACKAGE = NO 468 | 469 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 470 | # included in the documentation. 471 | # The default value is: NO. 472 | 473 | EXTRACT_STATIC = NO 474 | 475 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 476 | # locally in source files will be included in the documentation. If set to NO, 477 | # only classes defined in header files are included. Does not have any effect 478 | # for Java sources. 479 | # The default value is: YES. 480 | 481 | EXTRACT_LOCAL_CLASSES = YES 482 | 483 | # This flag is only useful for Objective-C code. If set to YES, local methods, 484 | # which are defined in the implementation section but not in the interface are 485 | # included in the documentation. If set to NO, only methods in the interface are 486 | # included. 487 | # The default value is: NO. 488 | 489 | EXTRACT_LOCAL_METHODS = NO 490 | 491 | # If this flag is set to YES, the members of anonymous namespaces will be 492 | # extracted and appear in the documentation as a namespace called 493 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 494 | # the file that contains the anonymous namespace. By default anonymous namespace 495 | # are hidden. 496 | # The default value is: NO. 497 | 498 | EXTRACT_ANON_NSPACES = NO 499 | 500 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 501 | # undocumented members inside documented classes or files. If set to NO these 502 | # members will be included in the various overviews, but no documentation 503 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 504 | # The default value is: NO. 505 | 506 | HIDE_UNDOC_MEMBERS = NO 507 | 508 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 509 | # undocumented classes that are normally visible in the class hierarchy. If set 510 | # to NO, these classes will be included in the various overviews. This option 511 | # has no effect if EXTRACT_ALL is enabled. 512 | # The default value is: NO. 513 | 514 | HIDE_UNDOC_CLASSES = NO 515 | 516 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 517 | # (class|struct|union) declarations. If set to NO, these declarations will be 518 | # included in the documentation. 519 | # The default value is: NO. 520 | 521 | HIDE_FRIEND_COMPOUNDS = NO 522 | 523 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 524 | # documentation blocks found inside the body of a function. If set to NO, these 525 | # blocks will be appended to the function's detailed documentation block. 526 | # The default value is: NO. 527 | 528 | HIDE_IN_BODY_DOCS = NO 529 | 530 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 531 | # \internal command is included. If the tag is set to NO then the documentation 532 | # will be excluded. Set it to YES to include the internal documentation. 533 | # The default value is: NO. 534 | 535 | INTERNAL_DOCS = NO 536 | 537 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 538 | # names in lower-case letters. If set to YES, upper-case letters are also 539 | # allowed. This is useful if you have classes or files whose names only differ 540 | # in case and if your file system supports case sensitive file names. Windows 541 | # and Mac users are advised to set this option to NO. 542 | # The default value is: system dependent. 543 | 544 | CASE_SENSE_NAMES = YES 545 | 546 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 547 | # their full class and namespace scopes in the documentation. If set to YES, the 548 | # scope will be hidden. 549 | # The default value is: NO. 550 | 551 | HIDE_SCOPE_NAMES = NO 552 | 553 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 554 | # append additional text to a page's title, such as Class Reference. If set to 555 | # YES the compound reference will be hidden. 556 | # The default value is: NO. 557 | 558 | HIDE_COMPOUND_REFERENCE= NO 559 | 560 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 561 | # the files that are included by a file in the documentation of that file. 562 | # The default value is: YES. 563 | 564 | SHOW_INCLUDE_FILES = YES 565 | 566 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 567 | # grouped member an include statement to the documentation, telling the reader 568 | # which file to include in order to use the member. 569 | # The default value is: NO. 570 | 571 | SHOW_GROUPED_MEMB_INC = NO 572 | 573 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 574 | # files with double quotes in the documentation rather than with sharp brackets. 575 | # The default value is: NO. 576 | 577 | FORCE_LOCAL_INCLUDES = NO 578 | 579 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 580 | # documentation for inline members. 581 | # The default value is: YES. 582 | 583 | INLINE_INFO = YES 584 | 585 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 586 | # (detailed) documentation of file and class members alphabetically by member 587 | # name. If set to NO, the members will appear in declaration order. 588 | # The default value is: YES. 589 | 590 | SORT_MEMBER_DOCS = YES 591 | 592 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 593 | # descriptions of file, namespace and class members alphabetically by member 594 | # name. If set to NO, the members will appear in declaration order. Note that 595 | # this will also influence the order of the classes in the class list. 596 | # The default value is: NO. 597 | 598 | SORT_BRIEF_DOCS = NO 599 | 600 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 601 | # (brief and detailed) documentation of class members so that constructors and 602 | # destructors are listed first. If set to NO the constructors will appear in the 603 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 604 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 605 | # member documentation. 606 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 607 | # detailed member documentation. 608 | # The default value is: NO. 609 | 610 | SORT_MEMBERS_CTORS_1ST = NO 611 | 612 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 613 | # of group names into alphabetical order. If set to NO the group names will 614 | # appear in their defined order. 615 | # The default value is: NO. 616 | 617 | SORT_GROUP_NAMES = NO 618 | 619 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 620 | # fully-qualified names, including namespaces. If set to NO, the class list will 621 | # be sorted only by class name, not including the namespace part. 622 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 623 | # Note: This option applies only to the class list, not to the alphabetical 624 | # list. 625 | # The default value is: NO. 626 | 627 | SORT_BY_SCOPE_NAME = NO 628 | 629 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 630 | # type resolution of all parameters of a function it will reject a match between 631 | # the prototype and the implementation of a member function even if there is 632 | # only one candidate or it is obvious which candidate to choose by doing a 633 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 634 | # accept a match between prototype and implementation in such cases. 635 | # The default value is: NO. 636 | 637 | STRICT_PROTO_MATCHING = NO 638 | 639 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 640 | # list. This list is created by putting \todo commands in the documentation. 641 | # The default value is: YES. 642 | 643 | GENERATE_TODOLIST = YES 644 | 645 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 646 | # list. This list is created by putting \test commands in the documentation. 647 | # The default value is: YES. 648 | 649 | GENERATE_TESTLIST = YES 650 | 651 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 652 | # list. This list is created by putting \bug commands in the documentation. 653 | # The default value is: YES. 654 | 655 | GENERATE_BUGLIST = YES 656 | 657 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 658 | # the deprecated list. This list is created by putting \deprecated commands in 659 | # the documentation. 660 | # The default value is: YES. 661 | 662 | GENERATE_DEPRECATEDLIST= YES 663 | 664 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 665 | # sections, marked by \if ... \endif and \cond 666 | # ... \endcond blocks. 667 | 668 | ENABLED_SECTIONS = 669 | 670 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 671 | # initial value of a variable or macro / define can have for it to appear in the 672 | # documentation. If the initializer consists of more lines than specified here 673 | # it will be hidden. Use a value of 0 to hide initializers completely. The 674 | # appearance of the value of individual variables and macros / defines can be 675 | # controlled using \showinitializer or \hideinitializer command in the 676 | # documentation regardless of this setting. 677 | # Minimum value: 0, maximum value: 10000, default value: 30. 678 | 679 | MAX_INITIALIZER_LINES = 30 680 | 681 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 682 | # the bottom of the documentation of classes and structs. If set to YES, the 683 | # list will mention the files that were used to generate the documentation. 684 | # The default value is: YES. 685 | 686 | SHOW_USED_FILES = YES 687 | 688 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 689 | # will remove the Files entry from the Quick Index and from the Folder Tree View 690 | # (if specified). 691 | # The default value is: YES. 692 | 693 | SHOW_FILES = YES 694 | 695 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 696 | # page. This will remove the Namespaces entry from the Quick Index and from the 697 | # Folder Tree View (if specified). 698 | # The default value is: YES. 699 | 700 | SHOW_NAMESPACES = YES 701 | 702 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 703 | # doxygen should invoke to get the current version for each file (typically from 704 | # the version control system). Doxygen will invoke the program by executing (via 705 | # popen()) the command command input-file, where command is the value of the 706 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 707 | # by doxygen. Whatever the program writes to standard output is used as the file 708 | # version. For an example see the documentation. 709 | 710 | FILE_VERSION_FILTER = 711 | 712 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 713 | # by doxygen. The layout file controls the global structure of the generated 714 | # output files in an output format independent way. To create the layout file 715 | # that represents doxygen's defaults, run doxygen with the -l option. You can 716 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 717 | # will be used as the name of the layout file. 718 | # 719 | # Note that if you run doxygen from a directory containing a file called 720 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 721 | # tag is left empty. 722 | 723 | LAYOUT_FILE = 724 | 725 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 726 | # the reference definitions. This must be a list of .bib files. The .bib 727 | # extension is automatically appended if omitted. This requires the bibtex tool 728 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 729 | # For LaTeX the style of the bibliography can be controlled using 730 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 731 | # search path. See also \cite for info how to create references. 732 | 733 | CITE_BIB_FILES = 734 | 735 | #--------------------------------------------------------------------------- 736 | # Configuration options related to warning and progress messages 737 | #--------------------------------------------------------------------------- 738 | 739 | # The QUIET tag can be used to turn on/off the messages that are generated to 740 | # standard output by doxygen. If QUIET is set to YES this implies that the 741 | # messages are off. 742 | # The default value is: NO. 743 | 744 | QUIET = NO 745 | 746 | # The WARNINGS tag can be used to turn on/off the warning messages that are 747 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 748 | # this implies that the warnings are on. 749 | # 750 | # Tip: Turn warnings on while writing the documentation. 751 | # The default value is: YES. 752 | 753 | WARNINGS = YES 754 | 755 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 756 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 757 | # will automatically be disabled. 758 | # The default value is: YES. 759 | 760 | WARN_IF_UNDOCUMENTED = YES 761 | 762 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 763 | # potential errors in the documentation, such as not documenting some parameters 764 | # in a documented function, or documenting parameters that don't exist or using 765 | # markup commands wrongly. 766 | # The default value is: YES. 767 | 768 | WARN_IF_DOC_ERROR = YES 769 | 770 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 771 | # are documented, but have no documentation for their parameters or return 772 | # value. If set to NO, doxygen will only warn about wrong or incomplete 773 | # parameter documentation, but not about the absence of documentation. If 774 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 775 | # The default value is: NO. 776 | 777 | WARN_NO_PARAMDOC = NO 778 | 779 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 780 | # a warning is encountered. 781 | # The default value is: NO. 782 | 783 | WARN_AS_ERROR = NO 784 | 785 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 786 | # can produce. The string should contain the $file, $line, and $text tags, which 787 | # will be replaced by the file and line number from which the warning originated 788 | # and the warning text. Optionally the format may contain $version, which will 789 | # be replaced by the version of the file (if it could be obtained via 790 | # FILE_VERSION_FILTER) 791 | # The default value is: $file:$line: $text. 792 | 793 | WARN_FORMAT = "$file:$line: $text" 794 | 795 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 796 | # messages should be written. If left blank the output is written to standard 797 | # error (stderr). 798 | 799 | WARN_LOGFILE = 800 | 801 | #--------------------------------------------------------------------------- 802 | # Configuration options related to the input files 803 | #--------------------------------------------------------------------------- 804 | 805 | # The INPUT tag is used to specify the files and/or directories that contain 806 | # documented source files. You may enter file names like myfile.cpp or 807 | # directories like /usr/src/myproject. Separate the files or directories with 808 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 809 | # Note: If this tag is empty the current directory is searched. 810 | 811 | INPUT = $(TRAVIS_BUILD_DIR) 812 | 813 | # This tag can be used to specify the character encoding of the source files 814 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 815 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 816 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of 817 | # possible encodings. 818 | # The default value is: UTF-8. 819 | 820 | INPUT_ENCODING = UTF-8 821 | 822 | # If the value of the INPUT tag contains directories, you can use the 823 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 824 | # *.h) to filter out the source-files in the directories. 825 | # 826 | # Note that for custom extensions or not directly supported extensions you also 827 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 828 | # read by doxygen. 829 | # 830 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 831 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 832 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 833 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 834 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 835 | 836 | FILE_PATTERNS = *.c \ 837 | *.cc \ 838 | *.cxx \ 839 | *.cpp \ 840 | *.c++ \ 841 | *.java \ 842 | *.ii \ 843 | *.ixx \ 844 | *.ipp \ 845 | *.i++ \ 846 | *.inl \ 847 | *.idl \ 848 | *.ddl \ 849 | *.odl \ 850 | *.h \ 851 | *.hh \ 852 | *.hxx \ 853 | *.hpp \ 854 | *.h++ \ 855 | *.cs \ 856 | *.d \ 857 | *.php \ 858 | *.php4 \ 859 | *.php5 \ 860 | *.phtml \ 861 | *.inc \ 862 | *.m \ 863 | *.markdown \ 864 | *.md \ 865 | *.mm \ 866 | *.dox \ 867 | *.py \ 868 | *.pyw \ 869 | *.f90 \ 870 | *.f95 \ 871 | *.f03 \ 872 | *.f08 \ 873 | *.f \ 874 | *.for \ 875 | *.tcl \ 876 | *.vhd \ 877 | *.vhdl \ 878 | *.ucf \ 879 | *.qsf 880 | 881 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 882 | # be searched for input files as well. 883 | # The default value is: NO. 884 | 885 | RECURSIVE = YES 886 | 887 | # The EXCLUDE tag can be used to specify files and/or directories that should be 888 | # excluded from the INPUT source files. This way you can easily exclude a 889 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 890 | # 891 | # Note that relative paths are relative to the directory from which doxygen is 892 | # run. 893 | 894 | EXCLUDE = 895 | 896 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 897 | # directories that are symbolic links (a Unix file system feature) are excluded 898 | # from the input. 899 | # The default value is: NO. 900 | 901 | EXCLUDE_SYMLINKS = NO 902 | 903 | # If the value of the INPUT tag contains directories, you can use the 904 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 905 | # certain files from those directories. 906 | # 907 | # Note that the wildcards are matched against the file with absolute path, so to 908 | # exclude all test directories for example use the pattern */test/* 909 | 910 | EXCLUDE_PATTERNS = 911 | 912 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 913 | # (namespaces, classes, functions, etc.) that should be excluded from the 914 | # output. The symbol name can be a fully qualified name, a word, or if the 915 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 916 | # AClass::ANamespace, ANamespace::*Test 917 | # 918 | # Note that the wildcards are matched against the file with absolute path, so to 919 | # exclude all test directories use the pattern */test/* 920 | 921 | EXCLUDE_SYMBOLS = 922 | 923 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 924 | # that contain example code fragments that are included (see the \include 925 | # command). 926 | 927 | EXAMPLE_PATH = 928 | 929 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 930 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 931 | # *.h) to filter out the source-files in the directories. If left blank all 932 | # files are included. 933 | 934 | EXAMPLE_PATTERNS = * 935 | 936 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 937 | # searched for input files to be used with the \include or \dontinclude commands 938 | # irrespective of the value of the RECURSIVE tag. 939 | # The default value is: NO. 940 | 941 | EXAMPLE_RECURSIVE = NO 942 | 943 | # The IMAGE_PATH tag can be used to specify one or more files or directories 944 | # that contain images that are to be included in the documentation (see the 945 | # \image command). 946 | 947 | IMAGE_PATH = 948 | 949 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 950 | # invoke to filter for each input file. Doxygen will invoke the filter program 951 | # by executing (via popen()) the command: 952 | # 953 | # 954 | # 955 | # where is the value of the INPUT_FILTER tag, and is the 956 | # name of an input file. Doxygen will then use the output that the filter 957 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 958 | # will be ignored. 959 | # 960 | # Note that the filter must not add or remove lines; it is applied before the 961 | # code is scanned, but not when the output code is generated. If lines are added 962 | # or removed, the anchors will not be placed correctly. 963 | # 964 | # Note that for custom extensions or not directly supported extensions you also 965 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 966 | # properly processed by doxygen. 967 | 968 | INPUT_FILTER = 969 | 970 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 971 | # basis. Doxygen will compare the file name with each pattern and apply the 972 | # filter if there is a match. The filters are a list of the form: pattern=filter 973 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 974 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 975 | # patterns match the file name, INPUT_FILTER is applied. 976 | # 977 | # Note that for custom extensions or not directly supported extensions you also 978 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 979 | # properly processed by doxygen. 980 | 981 | FILTER_PATTERNS = 982 | 983 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 984 | # INPUT_FILTER) will also be used to filter the input files that are used for 985 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 986 | # The default value is: NO. 987 | 988 | FILTER_SOURCE_FILES = NO 989 | 990 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 991 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 992 | # it is also possible to disable source filtering for a specific pattern using 993 | # *.ext= (so without naming a filter). 994 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 995 | 996 | FILTER_SOURCE_PATTERNS = 997 | 998 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 999 | # is part of the input, its contents will be placed on the main page 1000 | # (index.html). This can be useful if you have a project on for instance GitHub 1001 | # and want to reuse the introduction page also for the doxygen output. 1002 | 1003 | USE_MDFILE_AS_MAINPAGE = "README.md" 1004 | 1005 | #--------------------------------------------------------------------------- 1006 | # Configuration options related to source browsing 1007 | #--------------------------------------------------------------------------- 1008 | 1009 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1010 | # generated. Documented entities will be cross-referenced with these sources. 1011 | # 1012 | # Note: To get rid of all source code in the generated output, make sure that 1013 | # also VERBATIM_HEADERS is set to NO. 1014 | # The default value is: NO. 1015 | 1016 | SOURCE_BROWSER = YES 1017 | 1018 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1019 | # classes and enums directly into the documentation. 1020 | # The default value is: NO. 1021 | 1022 | INLINE_SOURCES = NO 1023 | 1024 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1025 | # special comment blocks from generated source code fragments. Normal C, C++ and 1026 | # Fortran comments will always remain visible. 1027 | # The default value is: YES. 1028 | 1029 | STRIP_CODE_COMMENTS = YES 1030 | 1031 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1032 | # entity all documented functions referencing it will be listed. 1033 | # The default value is: NO. 1034 | 1035 | REFERENCED_BY_RELATION = NO 1036 | 1037 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1038 | # all documented entities called/used by that function will be listed. 1039 | # The default value is: NO. 1040 | 1041 | REFERENCES_RELATION = NO 1042 | 1043 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1044 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1045 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1046 | # link to the documentation. 1047 | # The default value is: YES. 1048 | 1049 | REFERENCES_LINK_SOURCE = YES 1050 | 1051 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1052 | # source code will show a tooltip with additional information such as prototype, 1053 | # brief description and links to the definition and documentation. Since this 1054 | # will make the HTML file larger and loading of large files a bit slower, you 1055 | # can opt to disable this feature. 1056 | # The default value is: YES. 1057 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1058 | 1059 | SOURCE_TOOLTIPS = YES 1060 | 1061 | # If the USE_HTAGS tag is set to YES then the references to source code will 1062 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1063 | # source browser. The htags tool is part of GNU's global source tagging system 1064 | # (see https://www.gnu.org/software/global/global.html). You will need version 1065 | # 4.8.6 or higher. 1066 | # 1067 | # To use it do the following: 1068 | # - Install the latest version of global 1069 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1070 | # - Make sure the INPUT points to the root of the source tree 1071 | # - Run doxygen as normal 1072 | # 1073 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1074 | # tools must be available from the command line (i.e. in the search path). 1075 | # 1076 | # The result: instead of the source browser generated by doxygen, the links to 1077 | # source code will now point to the output of htags. 1078 | # The default value is: NO. 1079 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1080 | 1081 | USE_HTAGS = NO 1082 | 1083 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1084 | # verbatim copy of the header file for each class for which an include is 1085 | # specified. Set to NO to disable this. 1086 | # See also: Section \class. 1087 | # The default value is: YES. 1088 | 1089 | VERBATIM_HEADERS = YES 1090 | 1091 | #--------------------------------------------------------------------------- 1092 | # Configuration options related to the alphabetical class index 1093 | #--------------------------------------------------------------------------- 1094 | 1095 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1096 | # compounds will be generated. Enable this if the project contains a lot of 1097 | # classes, structs, unions or interfaces. 1098 | # The default value is: YES. 1099 | 1100 | ALPHABETICAL_INDEX = YES 1101 | 1102 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1103 | # which the alphabetical index list will be split. 1104 | # Minimum value: 1, maximum value: 20, default value: 5. 1105 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1106 | 1107 | COLS_IN_ALPHA_INDEX = 5 1108 | 1109 | # In case all classes in a project start with a common prefix, all classes will 1110 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1111 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1112 | # while generating the index headers. 1113 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1114 | 1115 | IGNORE_PREFIX = 1116 | 1117 | #--------------------------------------------------------------------------- 1118 | # Configuration options related to the HTML output 1119 | #--------------------------------------------------------------------------- 1120 | 1121 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1122 | # The default value is: YES. 1123 | 1124 | GENERATE_HTML = YES 1125 | 1126 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1127 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1128 | # it. 1129 | # The default directory is: html. 1130 | # This tag requires that the tag GENERATE_HTML is set to YES. 1131 | 1132 | HTML_OUTPUT = html 1133 | 1134 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1135 | # generated HTML page (for example: .htm, .php, .asp). 1136 | # The default value is: .html. 1137 | # This tag requires that the tag GENERATE_HTML is set to YES. 1138 | 1139 | HTML_FILE_EXTENSION = .html 1140 | 1141 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1142 | # each generated HTML page. If the tag is left blank doxygen will generate a 1143 | # standard header. 1144 | # 1145 | # To get valid HTML the header file that includes any scripts and style sheets 1146 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1147 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1148 | # default header using 1149 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1150 | # YourConfigFile 1151 | # and then modify the file new_header.html. See also section "Doxygen usage" 1152 | # for information on how to generate the default header that doxygen normally 1153 | # uses. 1154 | # Note: The header is subject to change so you typically have to regenerate the 1155 | # default header when upgrading to a newer version of doxygen. For a description 1156 | # of the possible markers and block names see the documentation. 1157 | # This tag requires that the tag GENERATE_HTML is set to YES. 1158 | 1159 | HTML_HEADER = 1160 | 1161 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1162 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1163 | # footer. See HTML_HEADER for more information on how to generate a default 1164 | # footer and what special commands can be used inside the footer. See also 1165 | # section "Doxygen usage" for information on how to generate the default footer 1166 | # that doxygen normally uses. 1167 | # This tag requires that the tag GENERATE_HTML is set to YES. 1168 | 1169 | HTML_FOOTER = 1170 | 1171 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1172 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1173 | # the HTML output. If left blank doxygen will generate a default style sheet. 1174 | # See also section "Doxygen usage" for information on how to generate the style 1175 | # sheet that doxygen normally uses. 1176 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1177 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1178 | # obsolete. 1179 | # This tag requires that the tag GENERATE_HTML is set to YES. 1180 | 1181 | HTML_STYLESHEET = 1182 | 1183 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1184 | # cascading style sheets that are included after the standard style sheets 1185 | # created by doxygen. Using this option one can overrule certain style aspects. 1186 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1187 | # standard style sheet and is therefore more robust against future updates. 1188 | # Doxygen will copy the style sheet files to the output directory. 1189 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1190 | # style sheet in the list overrules the setting of the previous ones in the 1191 | # list). For an example see the documentation. 1192 | # This tag requires that the tag GENERATE_HTML is set to YES. 1193 | 1194 | HTML_EXTRA_STYLESHEET = 1195 | 1196 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1197 | # other source files which should be copied to the HTML output directory. Note 1198 | # that these files will be copied to the base HTML output directory. Use the 1199 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1200 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1201 | # files will be copied as-is; there are no commands or markers available. 1202 | # This tag requires that the tag GENERATE_HTML is set to YES. 1203 | 1204 | HTML_EXTRA_FILES = 1205 | 1206 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1207 | # will adjust the colors in the style sheet and background images according to 1208 | # this color. Hue is specified as an angle on a colorwheel, see 1209 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1210 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1211 | # purple, and 360 is red again. 1212 | # Minimum value: 0, maximum value: 359, default value: 220. 1213 | # This tag requires that the tag GENERATE_HTML is set to YES. 1214 | 1215 | HTML_COLORSTYLE_HUE = 220 1216 | 1217 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1218 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1219 | # value of 255 will produce the most vivid colors. 1220 | # Minimum value: 0, maximum value: 255, default value: 100. 1221 | # This tag requires that the tag GENERATE_HTML is set to YES. 1222 | 1223 | HTML_COLORSTYLE_SAT = 100 1224 | 1225 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1226 | # luminance component of the colors in the HTML output. Values below 100 1227 | # gradually make the output lighter, whereas values above 100 make the output 1228 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1229 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1230 | # change the gamma. 1231 | # Minimum value: 40, maximum value: 240, default value: 80. 1232 | # This tag requires that the tag GENERATE_HTML is set to YES. 1233 | 1234 | HTML_COLORSTYLE_GAMMA = 80 1235 | 1236 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1237 | # page will contain the date and time when the page was generated. Setting this 1238 | # to YES can help to show when doxygen was last run and thus if the 1239 | # documentation is up to date. 1240 | # The default value is: NO. 1241 | # This tag requires that the tag GENERATE_HTML is set to YES. 1242 | 1243 | HTML_TIMESTAMP = NO 1244 | 1245 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1246 | # documentation will contain a main index with vertical navigation menus that 1247 | # are dynamically created via Javascript. If disabled, the navigation index will 1248 | # consists of multiple levels of tabs that are statically embedded in every HTML 1249 | # page. Disable this option to support browsers that do not have Javascript, 1250 | # like the Qt help browser. 1251 | # The default value is: YES. 1252 | # This tag requires that the tag GENERATE_HTML is set to YES. 1253 | 1254 | HTML_DYNAMIC_MENUS = YES 1255 | 1256 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1257 | # documentation will contain sections that can be hidden and shown after the 1258 | # page has loaded. 1259 | # The default value is: NO. 1260 | # This tag requires that the tag GENERATE_HTML is set to YES. 1261 | 1262 | HTML_DYNAMIC_SECTIONS = NO 1263 | 1264 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1265 | # shown in the various tree structured indices initially; the user can expand 1266 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1267 | # such a level that at most the specified number of entries are visible (unless 1268 | # a fully collapsed tree already exceeds this amount). So setting the number of 1269 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1270 | # representing an infinite number of entries and will result in a full expanded 1271 | # tree by default. 1272 | # Minimum value: 0, maximum value: 9999, default value: 100. 1273 | # This tag requires that the tag GENERATE_HTML is set to YES. 1274 | 1275 | HTML_INDEX_NUM_ENTRIES = 100 1276 | 1277 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1278 | # generated that can be used as input for Apple's Xcode 3 integrated development 1279 | # environment (see: https://developer.apple.com/xcode/), introduced with OSX 1280 | # 10.5 (Leopard). To create a documentation set, doxygen will generate a 1281 | # Makefile in the HTML output directory. Running make will produce the docset in 1282 | # that directory and running make install will install the docset in 1283 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1284 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1285 | # genXcode/_index.html for more information. 1286 | # The default value is: NO. 1287 | # This tag requires that the tag GENERATE_HTML is set to YES. 1288 | 1289 | GENERATE_DOCSET = NO 1290 | 1291 | # This tag determines the name of the docset feed. A documentation feed provides 1292 | # an umbrella under which multiple documentation sets from a single provider 1293 | # (such as a company or product suite) can be grouped. 1294 | # The default value is: Doxygen generated docs. 1295 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1296 | 1297 | DOCSET_FEEDNAME = "Doxygen generated docs" 1298 | 1299 | # This tag specifies a string that should uniquely identify the documentation 1300 | # set bundle. This should be a reverse domain-name style string, e.g. 1301 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1302 | # The default value is: org.doxygen.Project. 1303 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1304 | 1305 | DOCSET_BUNDLE_ID = org.doxygen.Project 1306 | 1307 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1308 | # the documentation publisher. This should be a reverse domain-name style 1309 | # string, e.g. com.mycompany.MyDocSet.documentation. 1310 | # The default value is: org.doxygen.Publisher. 1311 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1312 | 1313 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1314 | 1315 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1316 | # The default value is: Publisher. 1317 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1318 | 1319 | DOCSET_PUBLISHER_NAME = Publisher 1320 | 1321 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1322 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1323 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1324 | # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1325 | # Windows. 1326 | # 1327 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1328 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1329 | # files are now used as the Windows 98 help format, and will replace the old 1330 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1331 | # HTML files also contain an index, a table of contents, and you can search for 1332 | # words in the documentation. The HTML workshop also contains a viewer for 1333 | # compressed HTML files. 1334 | # The default value is: NO. 1335 | # This tag requires that the tag GENERATE_HTML is set to YES. 1336 | 1337 | GENERATE_HTMLHELP = NO 1338 | 1339 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1340 | # file. You can add a path in front of the file if the result should not be 1341 | # written to the html output directory. 1342 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1343 | 1344 | CHM_FILE = 1345 | 1346 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1347 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1348 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1349 | # The file has to be specified with full path. 1350 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1351 | 1352 | HHC_LOCATION = 1353 | 1354 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1355 | # (YES) or that it should be included in the master .chm file (NO). 1356 | # The default value is: NO. 1357 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1358 | 1359 | GENERATE_CHI = NO 1360 | 1361 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1362 | # and project file content. 1363 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1364 | 1365 | CHM_INDEX_ENCODING = 1366 | 1367 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1368 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1369 | # enables the Previous and Next buttons. 1370 | # The default value is: NO. 1371 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1372 | 1373 | BINARY_TOC = NO 1374 | 1375 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1376 | # the table of contents of the HTML help documentation and to the tree view. 1377 | # The default value is: NO. 1378 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1379 | 1380 | TOC_EXPAND = NO 1381 | 1382 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1383 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1384 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1385 | # (.qch) of the generated HTML documentation. 1386 | # The default value is: NO. 1387 | # This tag requires that the tag GENERATE_HTML is set to YES. 1388 | 1389 | GENERATE_QHP = NO 1390 | 1391 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1392 | # the file name of the resulting .qch file. The path specified is relative to 1393 | # the HTML output folder. 1394 | # This tag requires that the tag GENERATE_QHP is set to YES. 1395 | 1396 | QCH_FILE = 1397 | 1398 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1399 | # Project output. For more information please see Qt Help Project / Namespace 1400 | # (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1401 | # The default value is: org.doxygen.Project. 1402 | # This tag requires that the tag GENERATE_QHP is set to YES. 1403 | 1404 | QHP_NAMESPACE = org.doxygen.Project 1405 | 1406 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1407 | # Help Project output. For more information please see Qt Help Project / Virtual 1408 | # Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- 1409 | # folders). 1410 | # The default value is: doc. 1411 | # This tag requires that the tag GENERATE_QHP is set to YES. 1412 | 1413 | QHP_VIRTUAL_FOLDER = doc 1414 | 1415 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1416 | # filter to add. For more information please see Qt Help Project / Custom 1417 | # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- 1418 | # filters). 1419 | # This tag requires that the tag GENERATE_QHP is set to YES. 1420 | 1421 | QHP_CUST_FILTER_NAME = 1422 | 1423 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1424 | # custom filter to add. For more information please see Qt Help Project / Custom 1425 | # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- 1426 | # filters). 1427 | # This tag requires that the tag GENERATE_QHP is set to YES. 1428 | 1429 | QHP_CUST_FILTER_ATTRS = 1430 | 1431 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1432 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1433 | # http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1434 | # This tag requires that the tag GENERATE_QHP is set to YES. 1435 | 1436 | QHP_SECT_FILTER_ATTRS = 1437 | 1438 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1439 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1440 | # generated .qhp file. 1441 | # This tag requires that the tag GENERATE_QHP is set to YES. 1442 | 1443 | QHG_LOCATION = 1444 | 1445 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1446 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1447 | # install this plugin and make it available under the help contents menu in 1448 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1449 | # to be copied into the plugins directory of eclipse. The name of the directory 1450 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1451 | # After copying Eclipse needs to be restarted before the help appears. 1452 | # The default value is: NO. 1453 | # This tag requires that the tag GENERATE_HTML is set to YES. 1454 | 1455 | GENERATE_ECLIPSEHELP = NO 1456 | 1457 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1458 | # the directory name containing the HTML and XML files should also have this 1459 | # name. Each documentation set should have its own identifier. 1460 | # The default value is: org.doxygen.Project. 1461 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1462 | 1463 | ECLIPSE_DOC_ID = org.doxygen.Project 1464 | 1465 | # If you want full control over the layout of the generated HTML pages it might 1466 | # be necessary to disable the index and replace it with your own. The 1467 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1468 | # of each HTML page. A value of NO enables the index and the value YES disables 1469 | # it. Since the tabs in the index contain the same information as the navigation 1470 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1471 | # The default value is: NO. 1472 | # This tag requires that the tag GENERATE_HTML is set to YES. 1473 | 1474 | DISABLE_INDEX = NO 1475 | 1476 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1477 | # structure should be generated to display hierarchical information. If the tag 1478 | # value is set to YES, a side panel will be generated containing a tree-like 1479 | # index structure (just like the one that is generated for HTML Help). For this 1480 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1481 | # (i.e. any modern browser). Windows users are probably better off using the 1482 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1483 | # further fine-tune the look of the index. As an example, the default style 1484 | # sheet generated by doxygen has an example that shows how to put an image at 1485 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1486 | # the same information as the tab index, you could consider setting 1487 | # DISABLE_INDEX to YES when enabling this option. 1488 | # The default value is: NO. 1489 | # This tag requires that the tag GENERATE_HTML is set to YES. 1490 | 1491 | GENERATE_TREEVIEW = NO 1492 | 1493 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1494 | # doxygen will group on one line in the generated HTML documentation. 1495 | # 1496 | # Note that a value of 0 will completely suppress the enum values from appearing 1497 | # in the overview section. 1498 | # Minimum value: 0, maximum value: 20, default value: 4. 1499 | # This tag requires that the tag GENERATE_HTML is set to YES. 1500 | 1501 | ENUM_VALUES_PER_LINE = 4 1502 | 1503 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1504 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1505 | # Minimum value: 0, maximum value: 1500, default value: 250. 1506 | # This tag requires that the tag GENERATE_HTML is set to YES. 1507 | 1508 | TREEVIEW_WIDTH = 250 1509 | 1510 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1511 | # external symbols imported via tag files in a separate window. 1512 | # The default value is: NO. 1513 | # This tag requires that the tag GENERATE_HTML is set to YES. 1514 | 1515 | EXT_LINKS_IN_WINDOW = NO 1516 | 1517 | # Use this tag to change the font size of LaTeX formulas included as images in 1518 | # the HTML documentation. When you change the font size after a successful 1519 | # doxygen run you need to manually remove any form_*.png images from the HTML 1520 | # output directory to force them to be regenerated. 1521 | # Minimum value: 8, maximum value: 50, default value: 10. 1522 | # This tag requires that the tag GENERATE_HTML is set to YES. 1523 | 1524 | FORMULA_FONTSIZE = 10 1525 | 1526 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1527 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1528 | # supported properly for IE 6.0, but are supported on all modern browsers. 1529 | # 1530 | # Note that when changing this option you need to delete any form_*.png files in 1531 | # the HTML output directory before the changes have effect. 1532 | # The default value is: YES. 1533 | # This tag requires that the tag GENERATE_HTML is set to YES. 1534 | 1535 | FORMULA_TRANSPARENT = YES 1536 | 1537 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1538 | # https://www.mathjax.org) which uses client side Javascript for the rendering 1539 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1540 | # installed or if you want to formulas look prettier in the HTML output. When 1541 | # enabled you may also need to install MathJax separately and configure the path 1542 | # to it using the MATHJAX_RELPATH option. 1543 | # The default value is: NO. 1544 | # This tag requires that the tag GENERATE_HTML is set to YES. 1545 | 1546 | USE_MATHJAX = NO 1547 | 1548 | # When MathJax is enabled you can set the default output format to be used for 1549 | # the MathJax output. See the MathJax site (see: 1550 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1551 | # Possible values are: HTML-CSS (which is slower, but has the best 1552 | # compatibility), NativeMML (i.e. MathML) and SVG. 1553 | # The default value is: HTML-CSS. 1554 | # This tag requires that the tag USE_MATHJAX is set to YES. 1555 | 1556 | MATHJAX_FORMAT = HTML-CSS 1557 | 1558 | # When MathJax is enabled you need to specify the location relative to the HTML 1559 | # output directory using the MATHJAX_RELPATH option. The destination directory 1560 | # should contain the MathJax.js script. For instance, if the mathjax directory 1561 | # is located at the same level as the HTML output directory, then 1562 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1563 | # Content Delivery Network so you can quickly see the result without installing 1564 | # MathJax. However, it is strongly recommended to install a local copy of 1565 | # MathJax from https://www.mathjax.org before deployment. 1566 | # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. 1567 | # This tag requires that the tag USE_MATHJAX is set to YES. 1568 | 1569 | MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ 1570 | 1571 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1572 | # extension names that should be enabled during MathJax rendering. For example 1573 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1574 | # This tag requires that the tag USE_MATHJAX is set to YES. 1575 | 1576 | MATHJAX_EXTENSIONS = 1577 | 1578 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1579 | # of code that will be used on startup of the MathJax code. See the MathJax site 1580 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1581 | # example see the documentation. 1582 | # This tag requires that the tag USE_MATHJAX is set to YES. 1583 | 1584 | MATHJAX_CODEFILE = 1585 | 1586 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1587 | # the HTML output. The underlying search engine uses javascript and DHTML and 1588 | # should work on any modern browser. Note that when using HTML help 1589 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1590 | # there is already a search function so this one should typically be disabled. 1591 | # For large projects the javascript based search engine can be slow, then 1592 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1593 | # search using the keyboard; to jump to the search box use + S 1594 | # (what the is depends on the OS and browser, but it is typically 1595 | # , /