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