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