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