├── .gitignore ├── CMakeLists.txt ├── README.md ├── docs ├── Doxyfile ├── TINY编译器词法语法规则.doc ├── 编译原理实验要求.doc ├── 词法分析思路.pptx └── 语法分析思路.pptx ├── sample ├── err_diff_type_assign.txt ├── err_diff_var_add.txt ├── err_if_then_assign_else_assign_end.txt ├── err_no_assign_symbol.txt ├── err_not_int_var_mul.txt ├── err_var_no_declare.txt ├── error_var_declaration.txt ├── experiment1_test1_in.txt ├── experiment1_test1_out.txt ├── experiment1_test2_in.txt ├── experiment1_test2_out.txt ├── experiment2_test1_in.txt ├── experiment2_test1_out.txt ├── experiment2_test2_in.txt ├── experiment2_test2_out.txt ├── function_def_list.txt ├── if_if_end_end.txt ├── if_then_assign_else_assign_end.txt ├── read.txt ├── repeat_until.txt ├── var_declaration.txt ├── while_do_end.txt ├── while_do_if_end_end.txt └── write.txt ├── src ├── CMakeLists.txt ├── data_type_copy.cpp_copy ├── data_type_copy.h_copy ├── data_types.cpp ├── data_types.h ├── grammar_analysis.cpp ├── grammar_analysis.h ├── lexical_analysis.cpp ├── lexical_analysis.h ├── main.cpp ├── to_four_element_exp.cpp └── to_four_element_exp.h ├── tests ├── CMakeLists.txt ├── common.cpp ├── common.h ├── test_example.cpp ├── test_generate_four_element_exp.cpp ├── test_generate_grammer_tree.cpp ├── test_generate_sym_table.cpp ├── test_grammar_error.cpp └── test_lexical_analysis.cpp └── third_lib └── .gitkeep /.gitignore: -------------------------------------------------------------------------------- 1 | # Builds 2 | build/ 3 | 4 | # third_lib like google 5 | third_lib/googletest 6 | 7 | # Jet Brains 8 | .idea/ 9 | cmake-build-debug/ 10 | 11 | # doc tmp file 12 | docs/~*.doc 13 | docs/~*.pptx -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.9) 2 | project(tiny_compiler_cpp11) 3 | 4 | set(CMAKE_CXX_STANDARD 11) 5 | 6 | set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 7 | set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) 8 | set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) 9 | 10 | add_subdirectory(src) 11 | add_subdirectory(tests) 12 | 13 | # 编译时如果找不到google库,自动去github下载到 项目根目录/third_lib/googletest 14 | set(GOOGLETEST_DIR ${CMAKE_SOURCE_DIR}/third_lib/googletest) 15 | if (NOT EXISTS ${GOOGLETEST_DIR}) 16 | find_package(Git REQUIRED) 17 | execute_process( 18 | COMMAND ${GIT_EXECUTABLE} clone https://github.com/google/googletest ${GOOGLETEST_DIR} 19 | ) 20 | endif () 21 | add_subdirectory(third_lib/googletest) 22 | 23 | # Doxygen 构建(本人尚未使用,先空置) 24 | option(BUILD_DOC "Build Documentation" ON) 25 | find_package(Doxygen) 26 | if (DOXYGEN_FOUND) 27 | set(BUILD_DOC_DIR ${CMAKE_SOURCE_DIR}/build/docs) 28 | if (NOT EXISTS ${BUILD_DOC_DIR}) 29 | file(MAKE_DIRECTORY ${BUILD_DOC_DIR}) 30 | endif () 31 | 32 | set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile) 33 | set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) 34 | configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY) 35 | 36 | message("Doxygen buld started") 37 | add_custom_target(Doxygen ALL 38 | COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT} 39 | WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} 40 | COMMENT "Generating API documentation with Doxygen" 41 | VERBATIM) 42 | else (DOXYGEN_FOUND) 43 | message("Doxygen needs to be installed to generate the documentation.") 44 | endif (DOXYGEN_FOUND) 45 | 46 | 47 | # 附上个人经常使用的配置 48 | ## 加上boost编译 49 | # find_package(Boost 1.58.0 COMPONENTS system filesystem REQUIRED) 50 | # include_directories(${Boost_INCLUDE_DIRS}) 51 | # target_link_libraries(可执行文件名 ${Boost_LIBRARIES}) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Tiny+ 编译器部分实现 2 | ## todo: 3 | - [x] 词法分析 4 | - [x] 语法分析(递归下降语法分析) 5 | - [x] 语义分析(生成语法树的同时进行语义分析) 6 | - [x] 中间代码生成 7 | - [x] 支持`if-stmt | repeat-stmt | assign-stmt | read-stmt | write-stmt | while-stmt` 8 | - [ ] 支持`function-def`,`function-call` 9 | - [ ] 使用[高效的预测分析技术](https://blog.csdn.net/jzyhywxz/article/details/78404558)生成语法树 10 | - [ ] 中间代码优化 11 | - [ ] 符号表跟随作用域变化(tiny变量没有作用域) 12 | - [ ] 词法检测遇到错误直接结束检测, 增加错误跳过 13 | 14 | 15 | ## 目录结构 16 | ``` 17 | ├─docs : 文档均来自老师的实验资料 18 | │ Doxyfile 19 | │ TINY编译器词法语法规则.doc 20 | │ 编译原理实验要求.doc 21 | │ 词法分析思路.pptx 22 | │ 语法分析思路.pptx 23 | │ 24 | ├─sample : 测试样本, 其中`experiment*`是实验数据,但是生成中间代码(`experiment2_test*`)的输出并不相同 25 | │ 26 | ├─src : 源文件 27 | │ CMakeLists.txt 28 | │ data_types.cpp 29 | │ data_types.h : 数据类型定义 30 | │ grammar_analysis.cpp 31 | │ grammar_analysis.h : 语法分析 32 | │ lexical_analysis.cpp 33 | │ lexical_analysis.h : 词法分析 34 | │ main.cpp : 入口(未实现), 所有测试均在单元测试中 35 | │ to_four_element_exp.cpp 36 | │ to_four_element_exp.h : 生成中间代码 37 | │ 38 | ├─tests 39 | │ CMakeLists.txt 40 | │ common.cpp 41 | │ common.h : 测试共用函数定义 42 | │ test_example.cpp 43 | │ test_generate_four_element_exp.cpp : 测试生成中间代码, 直接输出结果 44 | │ test_generate_grammer_tree.cpp : 测试生成语法树 45 | │ test_generate_sym_table.cpp : 测试生成符号表 46 | │ test_grammar_error.cpp : 测试语法错误 47 | │ test_lexical_analysis.cpp : 测试词法分析 48 | │ 49 | └─third_lib : 第三方库`googletest` 50 | ``` 51 | ## 一) 词法分析 52 | * 问题: 53 | * `{abc er` 缺少右闭合怎么处理? 直接默认一整行错误,并跳过该行分析 54 | * `abc ef}` 缺少左闭合怎么处理? 直接默认一整行错误,并跳过该行分析 55 | * 换行符的处理 56 | ```cpp 57 | //c++ 字符串包含换行符 58 | std::string str = "a" 59 | "b"; 60 | std::string str2 = "a\n\a"; 61 | ``` 62 | 目前我在字符串状态下,匹配到了`\n`会认为是失败的. 63 | 64 | ## 语法分析 65 | * 问题: 66 | * read/write语句后面带`;` 67 | * assign语句后面不带`;` 68 | 69 | ## 中间代码生成 70 | * 思路: 71 | 72 | 从语法树根节点开始扫描, 根据节点类型+文法进行递归生成. 对于 73 | `if-stmt | repeat-stmt | assign-stmt | while-stmt` 等需要跳转的,需要先生成 74 | 末端标签并传入供跳转 75 | 76 | ## 参考链接: 77 | ps: 实验所需要的可以直接参考`doc`下的文档 78 | * [【编译原理】语法分析（二）- CSDN博客](https://blog.csdn.net/jzyhywxz/article/details/78404558) 79 | * [FIRST集与FOLLOW集 - CSDN博客](https://blog.csdn.net/IT_DREAM_ER/article/details/53419667) 80 | * [编译原理 消除左递归](https://blog.csdn.net/liyun123gx/article/details/19924993) -------------------------------------------------------------------------------- /docs/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.13 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 = "MyProject" 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 = 0.0.0 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 = "MyProject 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 = @CMAKE_CURRENT_BINARY_DIR@/../build/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 = 2 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. 240 | 241 | ALIASES = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = NO 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note: For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307 | # to that level are automatically included in the table of contents, even if 308 | # they do not have an id attribute. 309 | # Note: This feature currently applies only to Markdown headings. 310 | # Minimum value: 0, maximum value: 99, default value: 0. 311 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312 | 313 | TOC_INCLUDE_HEADINGS = 0 314 | 315 | # When enabled doxygen tries to link words that correspond to documented 316 | # classes, or namespaces to their corresponding documentation. Such a link can 317 | # be prevented in individual cases by putting a % sign in front of the word or 318 | # globally by setting AUTOLINK_SUPPORT to NO. 319 | # The default value is: YES. 320 | 321 | AUTOLINK_SUPPORT = YES 322 | 323 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324 | # to include (a tag file for) the STL sources as input, then you should set this 325 | # tag to YES in order to let doxygen match functions declarations and 326 | # definitions whose arguments contain STL classes (e.g. func(std::string); 327 | # versus func(std::string) {}). This also make the inheritance and collaboration 328 | # diagrams that involve STL classes more complete and accurate. 329 | # The default value is: NO. 330 | 331 | BUILTIN_STL_SUPPORT = NO 332 | 333 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 334 | # enable parsing support. 335 | # The default value is: NO. 336 | 337 | CPP_CLI_SUPPORT = NO 338 | 339 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341 | # will parse them like normal C++ but will assume all classes use public instead 342 | # of private inheritance when no explicit protection keyword is present. 343 | # The default value is: NO. 344 | 345 | SIP_SUPPORT = NO 346 | 347 | # For Microsoft's IDL there are propget and propput attributes to indicate 348 | # getter and setter methods for a property. Setting this option to YES will make 349 | # doxygen to replace the get and set methods by a property in the documentation. 350 | # This will only work if the methods are indeed getting or setting a simple 351 | # type. If this is not the case, or you want to show the methods anyway, you 352 | # should set this option to NO. 353 | # The default value is: YES. 354 | 355 | IDL_PROPERTY_SUPPORT = YES 356 | 357 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358 | # tag is set to YES then doxygen will reuse the documentation of the first 359 | # member in the group (if any) for the other members of the group. By default 360 | # all members of a group must be documented explicitly. 361 | # The default value is: NO. 362 | 363 | DISTRIBUTE_GROUP_DOC = NO 364 | 365 | # If one adds a struct or class to a group and this option is enabled, then also 366 | # any nested class or struct is added to the same group. By default this option 367 | # is disabled and one has to add nested compounds explicitly via \ingroup. 368 | # The default value is: NO. 369 | 370 | GROUP_NESTED_COMPOUNDS = NO 371 | 372 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 373 | # (for instance a group of public functions) to be put as a subgroup of that 374 | # type (e.g. under the Public Functions section). Set it to NO to prevent 375 | # subgrouping. Alternatively, this can be done per class using the 376 | # \nosubgrouping command. 377 | # The default value is: YES. 378 | 379 | SUBGROUPING = YES 380 | 381 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382 | # are shown inside the group in which they are included (e.g. using \ingroup) 383 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384 | # and RTF). 385 | # 386 | # Note that this feature does not work in combination with 387 | # SEPARATE_MEMBER_PAGES. 388 | # The default value is: NO. 389 | 390 | INLINE_GROUPED_CLASSES = NO 391 | 392 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393 | # with only public data fields or simple typedef fields will be shown inline in 394 | # the documentation of the scope in which they are defined (i.e. file, 395 | # namespace, or group documentation), provided this scope is documented. If set 396 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 397 | # Man pages) or section (for LaTeX and RTF). 398 | # The default value is: NO. 399 | 400 | INLINE_SIMPLE_STRUCTS = NO 401 | 402 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403 | # enum is documented as struct, union, or enum with the name of the typedef. So 404 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405 | # with name TypeT. When disabled the typedef will appear as a member of a file, 406 | # namespace, or class. And the struct will be named TypeS. This can typically be 407 | # useful for C code in case the coding convention dictates that all compound 408 | # types are typedef'ed and only the typedef is referenced, never the tag name. 409 | # The default value is: NO. 410 | 411 | TYPEDEF_HIDES_STRUCT = NO 412 | 413 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414 | # cache is used to resolve symbols given their name and scope. Since this can be 415 | # an expensive process and often the same symbol appears multiple times in the 416 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417 | # doxygen will become slower. If the cache is too large, memory is wasted. The 418 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420 | # symbols. At the end of a run doxygen will report the cache usage and suggest 421 | # the optimal cache size from a speed point of view. 422 | # Minimum value: 0, maximum value: 9, default value: 0. 423 | 424 | LOOKUP_CACHE_SIZE = 0 425 | 426 | #--------------------------------------------------------------------------- 427 | # Build related configuration options 428 | #--------------------------------------------------------------------------- 429 | 430 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431 | # documentation are documented, even if no documentation was available. Private 432 | # class members and static file members will be hidden unless the 433 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434 | # Note: This will also disable the warnings about undocumented members that are 435 | # normally produced when WARNINGS is set to YES. 436 | # The default value is: NO. 437 | 438 | EXTRACT_ALL = NO 439 | 440 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441 | # be included in the documentation. 442 | # The default value is: NO. 443 | 444 | EXTRACT_PRIVATE = NO 445 | 446 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447 | # scope will be included in the documentation. 448 | # The default value is: NO. 449 | 450 | EXTRACT_PACKAGE = NO 451 | 452 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453 | # included in the documentation. 454 | # The default value is: NO. 455 | 456 | EXTRACT_STATIC = NO 457 | 458 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459 | # locally in source files will be included in the documentation. If set to NO, 460 | # only classes defined in header files are included. Does not have any effect 461 | # for Java sources. 462 | # The default value is: YES. 463 | 464 | EXTRACT_LOCAL_CLASSES = YES 465 | 466 | # This flag is only useful for Objective-C code. If set to YES, local methods, 467 | # which are defined in the implementation section but not in the interface are 468 | # included in the documentation. If set to NO, only methods in the interface are 469 | # included. 470 | # The default value is: NO. 471 | 472 | EXTRACT_LOCAL_METHODS = NO 473 | 474 | # If this flag is set to YES, the members of anonymous namespaces will be 475 | # extracted and appear in the documentation as a namespace called 476 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 477 | # the file that contains the anonymous namespace. By default anonymous namespace 478 | # are hidden. 479 | # The default value is: NO. 480 | 481 | EXTRACT_ANON_NSPACES = NO 482 | 483 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484 | # undocumented members inside documented classes or files. If set to NO these 485 | # members will be included in the various overviews, but no documentation 486 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 487 | # The default value is: NO. 488 | 489 | HIDE_UNDOC_MEMBERS = NO 490 | 491 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492 | # undocumented classes that are normally visible in the class hierarchy. If set 493 | # to NO, these classes will be included in the various overviews. This option 494 | # has no effect if EXTRACT_ALL is enabled. 495 | # The default value is: NO. 496 | 497 | HIDE_UNDOC_CLASSES = NO 498 | 499 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500 | # (class|struct|union) declarations. If set to NO, these declarations will be 501 | # included in the documentation. 502 | # The default value is: NO. 503 | 504 | HIDE_FRIEND_COMPOUNDS = NO 505 | 506 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507 | # documentation blocks found inside the body of a function. If set to NO, these 508 | # blocks will be appended to the function's detailed documentation block. 509 | # The default value is: NO. 510 | 511 | HIDE_IN_BODY_DOCS = NO 512 | 513 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 514 | # \internal command is included. If the tag is set to NO then the documentation 515 | # will be excluded. Set it to YES to include the internal documentation. 516 | # The default value is: NO. 517 | 518 | INTERNAL_DOCS = NO 519 | 520 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521 | # names in lower-case letters. If set to YES, upper-case letters are also 522 | # allowed. This is useful if you have classes or files whose names only differ 523 | # in case and if your file system supports case sensitive file names. Windows 524 | # and Mac users are advised to set this option to NO. 525 | # The default value is: system dependent. 526 | 527 | CASE_SENSE_NAMES = NO 528 | 529 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530 | # their full class and namespace scopes in the documentation. If set to YES, the 531 | # scope will be hidden. 532 | # The default value is: NO. 533 | 534 | HIDE_SCOPE_NAMES = NO 535 | 536 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537 | # append additional text to a page's title, such as Class Reference. If set to 538 | # YES the compound reference will be hidden. 539 | # The default value is: NO. 540 | 541 | HIDE_COMPOUND_REFERENCE= NO 542 | 543 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544 | # the files that are included by a file in the documentation of that file. 545 | # The default value is: YES. 546 | 547 | SHOW_INCLUDE_FILES = YES 548 | 549 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550 | # grouped member an include statement to the documentation, telling the reader 551 | # which file to include in order to use the member. 552 | # The default value is: NO. 553 | 554 | SHOW_GROUPED_MEMB_INC = NO 555 | 556 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557 | # files with double quotes in the documentation rather than with sharp brackets. 558 | # The default value is: NO. 559 | 560 | FORCE_LOCAL_INCLUDES = NO 561 | 562 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563 | # documentation for inline members. 564 | # The default value is: YES. 565 | 566 | INLINE_INFO = YES 567 | 568 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569 | # (detailed) documentation of file and class members alphabetically by member 570 | # name. If set to NO, the members will appear in declaration order. 571 | # The default value is: YES. 572 | 573 | SORT_MEMBER_DOCS = YES 574 | 575 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576 | # descriptions of file, namespace and class members alphabetically by member 577 | # name. If set to NO, the members will appear in declaration order. Note that 578 | # this will also influence the order of the classes in the class list. 579 | # The default value is: NO. 580 | 581 | SORT_BRIEF_DOCS = NO 582 | 583 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584 | # (brief and detailed) documentation of class members so that constructors and 585 | # destructors are listed first. If set to NO the constructors will appear in the 586 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588 | # member documentation. 589 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590 | # detailed member documentation. 591 | # The default value is: NO. 592 | 593 | SORT_MEMBERS_CTORS_1ST = NO 594 | 595 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596 | # of group names into alphabetical order. If set to NO the group names will 597 | # appear in their defined order. 598 | # The default value is: NO. 599 | 600 | SORT_GROUP_NAMES = NO 601 | 602 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603 | # fully-qualified names, including namespaces. If set to NO, the class list will 604 | # be sorted only by class name, not including the namespace part. 605 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606 | # Note: This option applies only to the class list, not to the alphabetical 607 | # list. 608 | # The default value is: NO. 609 | 610 | SORT_BY_SCOPE_NAME = NO 611 | 612 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613 | # type resolution of all parameters of a function it will reject a match between 614 | # the prototype and the implementation of a member function even if there is 615 | # only one candidate or it is obvious which candidate to choose by doing a 616 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617 | # accept a match between prototype and implementation in such cases. 618 | # The default value is: NO. 619 | 620 | STRICT_PROTO_MATCHING = NO 621 | 622 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623 | # list. This list is created by putting \todo commands in the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_TODOLIST = YES 627 | 628 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629 | # list. This list is created by putting \test commands in the documentation. 630 | # The default value is: YES. 631 | 632 | GENERATE_TESTLIST = YES 633 | 634 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635 | # list. This list is created by putting \bug commands in the documentation. 636 | # The default value is: YES. 637 | 638 | GENERATE_BUGLIST = YES 639 | 640 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641 | # the deprecated list. This list is created by putting \deprecated commands in 642 | # the documentation. 643 | # The default value is: YES. 644 | 645 | GENERATE_DEPRECATEDLIST= YES 646 | 647 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 648 | # sections, marked by \if ... \endif and \cond 649 | # ... \endcond blocks. 650 | 651 | ENABLED_SECTIONS = 652 | 653 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654 | # initial value of a variable or macro / define can have for it to appear in the 655 | # documentation. If the initializer consists of more lines than specified here 656 | # it will be hidden. Use a value of 0 to hide initializers completely. The 657 | # appearance of the value of individual variables and macros / defines can be 658 | # controlled using \showinitializer or \hideinitializer command in the 659 | # documentation regardless of this setting. 660 | # Minimum value: 0, maximum value: 10000, default value: 30. 661 | 662 | MAX_INITIALIZER_LINES = 30 663 | 664 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665 | # the bottom of the documentation of classes and structs. If set to YES, the 666 | # list will mention the files that were used to generate the documentation. 667 | # The default value is: YES. 668 | 669 | SHOW_USED_FILES = YES 670 | 671 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672 | # will remove the Files entry from the Quick Index and from the Folder Tree View 673 | # (if specified). 674 | # The default value is: YES. 675 | 676 | SHOW_FILES = YES 677 | 678 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679 | # page. This will remove the Namespaces entry from the Quick Index and from the 680 | # Folder Tree View (if specified). 681 | # The default value is: YES. 682 | 683 | SHOW_NAMESPACES = YES 684 | 685 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 686 | # doxygen should invoke to get the current version for each file (typically from 687 | # the version control system). Doxygen will invoke the program by executing (via 688 | # popen()) the command command input-file, where command is the value of the 689 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690 | # by doxygen. Whatever the program writes to standard output is used as the file 691 | # version. For an example see the documentation. 692 | 693 | FILE_VERSION_FILTER = 694 | 695 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696 | # by doxygen. The layout file controls the global structure of the generated 697 | # output files in an output format independent way. To create the layout file 698 | # that represents doxygen's defaults, run doxygen with the -l option. You can 699 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 700 | # will be used as the name of the layout file. 701 | # 702 | # Note that if you run doxygen from a directory containing a file called 703 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704 | # tag is left empty. 705 | 706 | LAYOUT_FILE = 707 | 708 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709 | # the reference definitions. This must be a list of .bib files. The .bib 710 | # extension is automatically appended if omitted. This requires the bibtex tool 711 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712 | # For LaTeX the style of the bibliography can be controlled using 713 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714 | # search path. See also \cite for info how to create references. 715 | 716 | CITE_BIB_FILES = 717 | 718 | #--------------------------------------------------------------------------- 719 | # Configuration options related to warning and progress messages 720 | #--------------------------------------------------------------------------- 721 | 722 | # The QUIET tag can be used to turn on/off the messages that are generated to 723 | # standard output by doxygen. If QUIET is set to YES this implies that the 724 | # messages are off. 725 | # The default value is: NO. 726 | 727 | QUIET = NO 728 | 729 | # The WARNINGS tag can be used to turn on/off the warning messages that are 730 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731 | # this implies that the warnings are on. 732 | # 733 | # Tip: Turn warnings on while writing the documentation. 734 | # The default value is: YES. 735 | 736 | WARNINGS = YES 737 | 738 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740 | # will automatically be disabled. 741 | # The default value is: YES. 742 | 743 | WARN_IF_UNDOCUMENTED = YES 744 | 745 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746 | # potential errors in the documentation, such as not documenting some parameters 747 | # in a documented function, or documenting parameters that don't exist or using 748 | # markup commands wrongly. 749 | # The default value is: YES. 750 | 751 | WARN_IF_DOC_ERROR = YES 752 | 753 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754 | # are documented, but have no documentation for their parameters or return 755 | # value. If set to NO, doxygen will only warn about wrong or incomplete 756 | # parameter documentation, but not about the absence of documentation. 757 | # The default value is: NO. 758 | 759 | WARN_NO_PARAMDOC = NO 760 | 761 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762 | # a warning is encountered. 763 | # The default value is: NO. 764 | 765 | WARN_AS_ERROR = NO 766 | 767 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 768 | # can produce. The string should contain the $file, $line, and $text tags, which 769 | # will be replaced by the file and line number from which the warning originated 770 | # and the warning text. Optionally the format may contain $version, which will 771 | # be replaced by the version of the file (if it could be obtained via 772 | # FILE_VERSION_FILTER) 773 | # The default value is: $file:$line: $text. 774 | 775 | WARN_FORMAT = "$file:$line: $text" 776 | 777 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 778 | # messages should be written. If left blank the output is written to standard 779 | # error (stderr). 780 | 781 | WARN_LOGFILE = 782 | 783 | #--------------------------------------------------------------------------- 784 | # Configuration options related to the input files 785 | #--------------------------------------------------------------------------- 786 | 787 | # The INPUT tag is used to specify the files and/or directories that contain 788 | # documented source files. You may enter file names like myfile.cpp or 789 | # directories like /usr/src/myproject. Separate the files or directories with 790 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791 | # Note: If this tag is empty the current directory is searched. 792 | 793 | INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/ @CMAKE_CURRENT_SOURCE_DIR@/docs 794 | 795 | # This tag can be used to specify the character encoding of the source files 796 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 797 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 798 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 799 | # possible encodings. 800 | # The default value is: UTF-8. 801 | 802 | INPUT_ENCODING = UTF-8 803 | 804 | # If the value of the INPUT tag contains directories, you can use the 805 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 806 | # *.h) to filter out the source-files in the directories. 807 | # 808 | # Note that for custom extensions or not directly supported extensions you also 809 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 810 | # read by doxygen. 811 | # 812 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 813 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 814 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 815 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 816 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 817 | 818 | FILE_PATTERNS = *.c \ 819 | *.cc \ 820 | *.cxx \ 821 | *.cpp \ 822 | *.c++ \ 823 | *.java \ 824 | *.ii \ 825 | *.ixx \ 826 | *.ipp \ 827 | *.i++ \ 828 | *.inl \ 829 | *.idl \ 830 | *.ddl \ 831 | *.odl \ 832 | *.h \ 833 | *.hh \ 834 | *.hxx \ 835 | *.hpp \ 836 | *.h++ \ 837 | *.cs \ 838 | *.d \ 839 | *.php \ 840 | *.php4 \ 841 | *.php5 \ 842 | *.phtml \ 843 | *.inc \ 844 | *.m \ 845 | *.markdown \ 846 | *.md \ 847 | *.mm \ 848 | *.dox \ 849 | *.py \ 850 | *.pyw \ 851 | *.f90 \ 852 | *.f95 \ 853 | *.f03 \ 854 | *.f08 \ 855 | *.f \ 856 | *.for \ 857 | *.tcl \ 858 | *.vhd \ 859 | *.vhdl \ 860 | *.ucf \ 861 | *.qsf 862 | 863 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 864 | # be searched for input files as well. 865 | # The default value is: NO. 866 | 867 | RECURSIVE = NO 868 | 869 | # The EXCLUDE tag can be used to specify files and/or directories that should be 870 | # excluded from the INPUT source files. This way you can easily exclude a 871 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 872 | # 873 | # Note that relative paths are relative to the directory from which doxygen is 874 | # run. 875 | 876 | EXCLUDE = 877 | 878 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 879 | # directories that are symbolic links (a Unix file system feature) are excluded 880 | # from the input. 881 | # The default value is: NO. 882 | 883 | EXCLUDE_SYMLINKS = NO 884 | 885 | # If the value of the INPUT tag contains directories, you can use the 886 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 887 | # certain files from those directories. 888 | # 889 | # Note that the wildcards are matched against the file with absolute path, so to 890 | # exclude all test directories for example use the pattern */test/* 891 | 892 | EXCLUDE_PATTERNS = 893 | 894 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 895 | # (namespaces, classes, functions, etc.) that should be excluded from the 896 | # output. The symbol name can be a fully qualified name, a word, or if the 897 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 898 | # AClass::ANamespace, ANamespace::*Test 899 | # 900 | # Note that the wildcards are matched against the file with absolute path, so to 901 | # exclude all test directories use the pattern */test/* 902 | 903 | EXCLUDE_SYMBOLS = 904 | 905 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 906 | # that contain example code fragments that are included (see the \include 907 | # command). 908 | 909 | EXAMPLE_PATH = 910 | 911 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 912 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 913 | # *.h) to filter out the source-files in the directories. If left blank all 914 | # files are included. 915 | 916 | EXAMPLE_PATTERNS = * 917 | 918 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 919 | # searched for input files to be used with the \include or \dontinclude commands 920 | # irrespective of the value of the RECURSIVE tag. 921 | # The default value is: NO. 922 | 923 | EXAMPLE_RECURSIVE = NO 924 | 925 | # The IMAGE_PATH tag can be used to specify one or more files or directories 926 | # that contain images that are to be included in the documentation (see the 927 | # \image command). 928 | 929 | IMAGE_PATH = 930 | 931 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 932 | # invoke to filter for each input file. Doxygen will invoke the filter program 933 | # by executing (via popen()) the command: 934 | # 935 | # 936 | # 937 | # where is the value of the INPUT_FILTER tag, and is the 938 | # name of an input file. Doxygen will then use the output that the filter 939 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 940 | # will be ignored. 941 | # 942 | # Note that the filter must not add or remove lines; it is applied before the 943 | # code is scanned, but not when the output code is generated. If lines are added 944 | # or removed, the anchors will not be placed correctly. 945 | # 946 | # Note that for custom extensions or not directly supported extensions you also 947 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 948 | # properly processed by doxygen. 949 | 950 | INPUT_FILTER = 951 | 952 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 953 | # basis. Doxygen will compare the file name with each pattern and apply the 954 | # filter if there is a match. The filters are a list of the form: pattern=filter 955 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 956 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 957 | # patterns match the file name, INPUT_FILTER is applied. 958 | # 959 | # Note that for custom extensions or not directly supported extensions you also 960 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 961 | # properly processed by doxygen. 962 | 963 | FILTER_PATTERNS = 964 | 965 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 966 | # INPUT_FILTER) will also be used to filter the input files that are used for 967 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 968 | # The default value is: NO. 969 | 970 | FILTER_SOURCE_FILES = NO 971 | 972 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 973 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 974 | # it is also possible to disable source filtering for a specific pattern using 975 | # *.ext= (so without naming a filter). 976 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 977 | 978 | FILTER_SOURCE_PATTERNS = 979 | 980 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 981 | # is part of the input, its contents will be placed on the main page 982 | # (index.html). This can be useful if you have a project on for instance GitHub 983 | # and want to reuse the introduction page also for the doxygen output. 984 | 985 | USE_MDFILE_AS_MAINPAGE = 986 | 987 | #--------------------------------------------------------------------------- 988 | # Configuration options related to source browsing 989 | #--------------------------------------------------------------------------- 990 | 991 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 992 | # generated. Documented entities will be cross-referenced with these sources. 993 | # 994 | # Note: To get rid of all source code in the generated output, make sure that 995 | # also VERBATIM_HEADERS is set to NO. 996 | # The default value is: NO. 997 | 998 | SOURCE_BROWSER = NO 999 | 1000 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1001 | # classes and enums directly into the documentation. 1002 | # The default value is: NO. 1003 | 1004 | INLINE_SOURCES = NO 1005 | 1006 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1007 | # special comment blocks from generated source code fragments. Normal C, C++ and 1008 | # Fortran comments will always remain visible. 1009 | # The default value is: YES. 1010 | 1011 | STRIP_CODE_COMMENTS = YES 1012 | 1013 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1014 | # function all documented functions referencing it will be listed. 1015 | # The default value is: NO. 1016 | 1017 | REFERENCED_BY_RELATION = NO 1018 | 1019 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1020 | # all documented entities called/used by that function will be listed. 1021 | # The default value is: NO. 1022 | 1023 | REFERENCES_RELATION = NO 1024 | 1025 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1026 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1027 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1028 | # link to the documentation. 1029 | # The default value is: YES. 1030 | 1031 | REFERENCES_LINK_SOURCE = YES 1032 | 1033 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1034 | # source code will show a tooltip with additional information such as prototype, 1035 | # brief description and links to the definition and documentation. Since this 1036 | # will make the HTML file larger and loading of large files a bit slower, you 1037 | # can opt to disable this feature. 1038 | # The default value is: YES. 1039 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1040 | 1041 | SOURCE_TOOLTIPS = YES 1042 | 1043 | # If the USE_HTAGS tag is set to YES then the references to source code will 1044 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1045 | # source browser. The htags tool is part of GNU's global source tagging system 1046 | # (see http://www.gnu.org/software/global/global.html). You will need version 1047 | # 4.8.6 or higher. 1048 | # 1049 | # To use it do the following: 1050 | # - Install the latest version of global 1051 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1052 | # - Make sure the INPUT points to the root of the source tree 1053 | # - Run doxygen as normal 1054 | # 1055 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1056 | # tools must be available from the command line (i.e. in the search path). 1057 | # 1058 | # The result: instead of the source browser generated by doxygen, the links to 1059 | # source code will now point to the output of htags. 1060 | # The default value is: NO. 1061 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1062 | 1063 | USE_HTAGS = NO 1064 | 1065 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1066 | # verbatim copy of the header file for each class for which an include is 1067 | # specified. Set to NO to disable this. 1068 | # See also: Section \class. 1069 | # The default value is: YES. 1070 | 1071 | VERBATIM_HEADERS = YES 1072 | 1073 | #--------------------------------------------------------------------------- 1074 | # Configuration options related to the alphabetical class index 1075 | #--------------------------------------------------------------------------- 1076 | 1077 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1078 | # compounds will be generated. Enable this if the project contains a lot of 1079 | # classes, structs, unions or interfaces. 1080 | # The default value is: YES. 1081 | 1082 | ALPHABETICAL_INDEX = YES 1083 | 1084 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1085 | # which the alphabetical index list will be split. 1086 | # Minimum value: 1, maximum value: 20, default value: 5. 1087 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1088 | 1089 | COLS_IN_ALPHA_INDEX = 5 1090 | 1091 | # In case all classes in a project start with a common prefix, all classes will 1092 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1093 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1094 | # while generating the index headers. 1095 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1096 | 1097 | IGNORE_PREFIX = 1098 | 1099 | #--------------------------------------------------------------------------- 1100 | # Configuration options related to the HTML output 1101 | #--------------------------------------------------------------------------- 1102 | 1103 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1104 | # The default value is: YES. 1105 | 1106 | GENERATE_HTML = YES 1107 | 1108 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1109 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1110 | # it. 1111 | # The default directory is: html. 1112 | # This tag requires that the tag GENERATE_HTML is set to YES. 1113 | 1114 | HTML_OUTPUT = html 1115 | 1116 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1117 | # generated HTML page (for example: .htm, .php, .asp). 1118 | # The default value is: .html. 1119 | # This tag requires that the tag GENERATE_HTML is set to YES. 1120 | 1121 | HTML_FILE_EXTENSION = .html 1122 | 1123 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1124 | # each generated HTML page. If the tag is left blank doxygen will generate a 1125 | # standard header. 1126 | # 1127 | # To get valid HTML the header file that includes any scripts and style sheets 1128 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1129 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1130 | # default header using 1131 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1132 | # YourConfigFile 1133 | # and then modify the file new_header.html. See also section "Doxygen usage" 1134 | # for information on how to generate the default header that doxygen normally 1135 | # uses. 1136 | # Note: The header is subject to change so you typically have to regenerate the 1137 | # default header when upgrading to a newer version of doxygen. For a description 1138 | # of the possible markers and block names see the documentation. 1139 | # This tag requires that the tag GENERATE_HTML is set to YES. 1140 | 1141 | HTML_HEADER = 1142 | 1143 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1144 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1145 | # footer. See HTML_HEADER for more information on how to generate a default 1146 | # footer and what special commands can be used inside the footer. See also 1147 | # section "Doxygen usage" for information on how to generate the default footer 1148 | # that doxygen normally uses. 1149 | # This tag requires that the tag GENERATE_HTML is set to YES. 1150 | 1151 | HTML_FOOTER = 1152 | 1153 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1154 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1155 | # the HTML output. If left blank doxygen will generate a default style sheet. 1156 | # See also section "Doxygen usage" for information on how to generate the style 1157 | # sheet that doxygen normally uses. 1158 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1159 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1160 | # obsolete. 1161 | # This tag requires that the tag GENERATE_HTML is set to YES. 1162 | 1163 | HTML_STYLESHEET = 1164 | 1165 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1166 | # cascading style sheets that are included after the standard style sheets 1167 | # created by doxygen. Using this option one can overrule certain style aspects. 1168 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1169 | # standard style sheet and is therefore more robust against future updates. 1170 | # Doxygen will copy the style sheet files to the output directory. 1171 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1172 | # style sheet in the list overrules the setting of the previous ones in the 1173 | # list). For an example see the documentation. 1174 | # This tag requires that the tag GENERATE_HTML is set to YES. 1175 | 1176 | HTML_EXTRA_STYLESHEET = 1177 | 1178 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1179 | # other source files which should be copied to the HTML output directory. Note 1180 | # that these files will be copied to the base HTML output directory. Use the 1181 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1182 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1183 | # files will be copied as-is; there are no commands or markers available. 1184 | # This tag requires that the tag GENERATE_HTML is set to YES. 1185 | 1186 | HTML_EXTRA_FILES = 1187 | 1188 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1189 | # will adjust the colors in the style sheet and background images according to 1190 | # this color. Hue is specified as an angle on a colorwheel, see 1191 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1192 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1193 | # purple, and 360 is red again. 1194 | # Minimum value: 0, maximum value: 359, default value: 220. 1195 | # This tag requires that the tag GENERATE_HTML is set to YES. 1196 | 1197 | HTML_COLORSTYLE_HUE = 220 1198 | 1199 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1200 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1201 | # value of 255 will produce the most vivid colors. 1202 | # Minimum value: 0, maximum value: 255, default value: 100. 1203 | # This tag requires that the tag GENERATE_HTML is set to YES. 1204 | 1205 | HTML_COLORSTYLE_SAT = 100 1206 | 1207 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1208 | # luminance component of the colors in the HTML output. Values below 100 1209 | # gradually make the output lighter, whereas values above 100 make the output 1210 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1211 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1212 | # change the gamma. 1213 | # Minimum value: 40, maximum value: 240, default value: 80. 1214 | # This tag requires that the tag GENERATE_HTML is set to YES. 1215 | 1216 | HTML_COLORSTYLE_GAMMA = 80 1217 | 1218 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1219 | # page will contain the date and time when the page was generated. Setting this 1220 | # to YES can help to show when doxygen was last run and thus if the 1221 | # documentation is up to date. 1222 | # The default value is: NO. 1223 | # This tag requires that the tag GENERATE_HTML is set to YES. 1224 | 1225 | HTML_TIMESTAMP = NO 1226 | 1227 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1228 | # documentation will contain sections that can be hidden and shown after the 1229 | # page has loaded. 1230 | # The default value is: NO. 1231 | # This tag requires that the tag GENERATE_HTML is set to YES. 1232 | 1233 | HTML_DYNAMIC_SECTIONS = NO 1234 | 1235 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1236 | # shown in the various tree structured indices initially; the user can expand 1237 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1238 | # such a level that at most the specified number of entries are visible (unless 1239 | # a fully collapsed tree already exceeds this amount). So setting the number of 1240 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1241 | # representing an infinite number of entries and will result in a full expanded 1242 | # tree by default. 1243 | # Minimum value: 0, maximum value: 9999, default value: 100. 1244 | # This tag requires that the tag GENERATE_HTML is set to YES. 1245 | 1246 | HTML_INDEX_NUM_ENTRIES = 100 1247 | 1248 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1249 | # generated that can be used as input for Apple's Xcode 3 integrated development 1250 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1251 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1252 | # Makefile in the HTML output directory. Running make will produce the docset in 1253 | # that directory and running make install will install the docset in 1254 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1255 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1256 | # for more information. 1257 | # The default value is: NO. 1258 | # This tag requires that the tag GENERATE_HTML is set to YES. 1259 | 1260 | GENERATE_DOCSET = NO 1261 | 1262 | # This tag determines the name of the docset feed. A documentation feed provides 1263 | # an umbrella under which multiple documentation sets from a single provider 1264 | # (such as a company or product suite) can be grouped. 1265 | # The default value is: Doxygen generated docs. 1266 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1267 | 1268 | DOCSET_FEEDNAME = "Doxygen generated docs" 1269 | 1270 | # This tag specifies a string that should uniquely identify the documentation 1271 | # set bundle. This should be a reverse domain-name style string, e.g. 1272 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1273 | # The default value is: org.doxygen.Project. 1274 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1275 | 1276 | DOCSET_BUNDLE_ID = org.doxygen.Project 1277 | 1278 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1279 | # the documentation publisher. This should be a reverse domain-name style 1280 | # string, e.g. com.mycompany.MyDocSet.documentation. 1281 | # The default value is: org.doxygen.Publisher. 1282 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1283 | 1284 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1285 | 1286 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1287 | # The default value is: Publisher. 1288 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1289 | 1290 | DOCSET_PUBLISHER_NAME = Publisher 1291 | 1292 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1293 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1294 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1295 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1296 | # Windows. 1297 | # 1298 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1299 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1300 | # files are now used as the Windows 98 help format, and will replace the old 1301 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1302 | # HTML files also contain an index, a table of contents, and you can search for 1303 | # words in the documentation. The HTML workshop also contains a viewer for 1304 | # compressed HTML files. 1305 | # The default value is: NO. 1306 | # This tag requires that the tag GENERATE_HTML is set to YES. 1307 | 1308 | GENERATE_HTMLHELP = NO 1309 | 1310 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1311 | # file. You can add a path in front of the file if the result should not be 1312 | # written to the html output directory. 1313 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1314 | 1315 | CHM_FILE = 1316 | 1317 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1318 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1319 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1320 | # The file has to be specified with full path. 1321 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1322 | 1323 | HHC_LOCATION = 1324 | 1325 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1326 | # (YES) or that it should be included in the master .chm file (NO). 1327 | # The default value is: NO. 1328 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1329 | 1330 | GENERATE_CHI = NO 1331 | 1332 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1333 | # and project file content. 1334 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1335 | 1336 | CHM_INDEX_ENCODING = 1337 | 1338 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1339 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1340 | # enables the Previous and Next buttons. 1341 | # The default value is: NO. 1342 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1343 | 1344 | BINARY_TOC = NO 1345 | 1346 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1347 | # the table of contents of the HTML help documentation and to the tree view. 1348 | # The default value is: NO. 1349 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1350 | 1351 | TOC_EXPAND = NO 1352 | 1353 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1354 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1355 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1356 | # (.qch) of the generated HTML documentation. 1357 | # The default value is: NO. 1358 | # This tag requires that the tag GENERATE_HTML is set to YES. 1359 | 1360 | GENERATE_QHP = NO 1361 | 1362 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1363 | # the file name of the resulting .qch file. The path specified is relative to 1364 | # the HTML output folder. 1365 | # This tag requires that the tag GENERATE_QHP is set to YES. 1366 | 1367 | QCH_FILE = 1368 | 1369 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1370 | # Project output. For more information please see Qt Help Project / Namespace 1371 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1372 | # The default value is: org.doxygen.Project. 1373 | # This tag requires that the tag GENERATE_QHP is set to YES. 1374 | 1375 | QHP_NAMESPACE = org.doxygen.Project 1376 | 1377 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1378 | # Help Project output. For more information please see Qt Help Project / Virtual 1379 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1380 | # folders). 1381 | # The default value is: doc. 1382 | # This tag requires that the tag GENERATE_QHP is set to YES. 1383 | 1384 | QHP_VIRTUAL_FOLDER = doc 1385 | 1386 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1387 | # filter to add. For more information please see Qt Help Project / Custom 1388 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1389 | # filters). 1390 | # This tag requires that the tag GENERATE_QHP is set to YES. 1391 | 1392 | QHP_CUST_FILTER_NAME = 1393 | 1394 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1395 | # custom filter to add. For more information please see Qt Help Project / Custom 1396 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1397 | # filters). 1398 | # This tag requires that the tag GENERATE_QHP is set to YES. 1399 | 1400 | QHP_CUST_FILTER_ATTRS = 1401 | 1402 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1403 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1404 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1405 | # This tag requires that the tag GENERATE_QHP is set to YES. 1406 | 1407 | QHP_SECT_FILTER_ATTRS = 1408 | 1409 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1410 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1411 | # generated .qhp file. 1412 | # This tag requires that the tag GENERATE_QHP is set to YES. 1413 | 1414 | QHG_LOCATION = 1415 | 1416 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1417 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1418 | # install this plugin and make it available under the help contents menu in 1419 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1420 | # to be copied into the plugins directory of eclipse. The name of the directory 1421 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1422 | # After copying Eclipse needs to be restarted before the help appears. 1423 | # The default value is: NO. 1424 | # This tag requires that the tag GENERATE_HTML is set to YES. 1425 | 1426 | GENERATE_ECLIPSEHELP = NO 1427 | 1428 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1429 | # the directory name containing the HTML and XML files should also have this 1430 | # name. Each documentation set should have its own identifier. 1431 | # The default value is: org.doxygen.Project. 1432 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1433 | 1434 | ECLIPSE_DOC_ID = org.doxygen.Project 1435 | 1436 | # If you want full control over the layout of the generated HTML pages it might 1437 | # be necessary to disable the index and replace it with your own. The 1438 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1439 | # of each HTML page. A value of NO enables the index and the value YES disables 1440 | # it. Since the tabs in the index contain the same information as the navigation 1441 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1442 | # The default value is: NO. 1443 | # This tag requires that the tag GENERATE_HTML is set to YES. 1444 | 1445 | DISABLE_INDEX = NO 1446 | 1447 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1448 | # structure should be generated to display hierarchical information. If the tag 1449 | # value is set to YES, a side panel will be generated containing a tree-like 1450 | # index structure (just like the one that is generated for HTML Help). For this 1451 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1452 | # (i.e. any modern browser). Windows users are probably better off using the 1453 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1454 | # further fine-tune the look of the index. As an example, the default style 1455 | # sheet generated by doxygen has an example that shows how to put an image at 1456 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1457 | # the same information as the tab index, you could consider setting 1458 | # DISABLE_INDEX to YES when enabling this option. 1459 | # The default value is: NO. 1460 | # This tag requires that the tag GENERATE_HTML is set to YES. 1461 | 1462 | GENERATE_TREEVIEW = NO 1463 | 1464 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1465 | # doxygen will group on one line in the generated HTML documentation. 1466 | # 1467 | # Note that a value of 0 will completely suppress the enum values from appearing 1468 | # in the overview section. 1469 | # Minimum value: 0, maximum value: 20, default value: 4. 1470 | # This tag requires that the tag GENERATE_HTML is set to YES. 1471 | 1472 | ENUM_VALUES_PER_LINE = 4 1473 | 1474 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1475 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1476 | # Minimum value: 0, maximum value: 1500, default value: 250. 1477 | # This tag requires that the tag GENERATE_HTML is set to YES. 1478 | 1479 | TREEVIEW_WIDTH = 250 1480 | 1481 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1482 | # external symbols imported via tag files in a separate window. 1483 | # The default value is: NO. 1484 | # This tag requires that the tag GENERATE_HTML is set to YES. 1485 | 1486 | EXT_LINKS_IN_WINDOW = NO 1487 | 1488 | # Use this tag to change the font size of LaTeX formulas included as images in 1489 | # the HTML documentation. When you change the font size after a successful 1490 | # doxygen run you need to manually remove any form_*.png images from the HTML 1491 | # output directory to force them to be regenerated. 1492 | # Minimum value: 8, maximum value: 50, default value: 10. 1493 | # This tag requires that the tag GENERATE_HTML is set to YES. 1494 | 1495 | FORMULA_FONTSIZE = 10 1496 | 1497 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1498 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1499 | # supported properly for IE 6.0, but are supported on all modern browsers. 1500 | # 1501 | # Note that when changing this option you need to delete any form_*.png files in 1502 | # the HTML output directory before the changes have effect. 1503 | # The default value is: YES. 1504 | # This tag requires that the tag GENERATE_HTML is set to YES. 1505 | 1506 | FORMULA_TRANSPARENT = YES 1507 | 1508 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1509 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1510 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1511 | # installed or if you want to formulas look prettier in the HTML output. When 1512 | # enabled you may also need to install MathJax separately and configure the path 1513 | # to it using the MATHJAX_RELPATH option. 1514 | # The default value is: NO. 1515 | # This tag requires that the tag GENERATE_HTML is set to YES. 1516 | 1517 | USE_MATHJAX = NO 1518 | 1519 | # When MathJax is enabled you can set the default output format to be used for 1520 | # the MathJax output. See the MathJax site (see: 1521 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1522 | # Possible values are: HTML-CSS (which is slower, but has the best 1523 | # compatibility), NativeMML (i.e. MathML) and SVG. 1524 | # The default value is: HTML-CSS. 1525 | # This tag requires that the tag USE_MATHJAX is set to YES. 1526 | 1527 | MATHJAX_FORMAT = HTML-CSS 1528 | 1529 | # When MathJax is enabled you need to specify the location relative to the HTML 1530 | # output directory using the MATHJAX_RELPATH option. The destination directory 1531 | # should contain the MathJax.js script. For instance, if the mathjax directory 1532 | # is located at the same level as the HTML output directory, then 1533 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1534 | # Content Delivery Network so you can quickly see the result without installing 1535 | # MathJax. However, it is strongly recommended to install a local copy of 1536 | # MathJax from http://www.mathjax.org before deployment. 1537 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1538 | # This tag requires that the tag USE_MATHJAX is set to YES. 1539 | 1540 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1541 | 1542 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1543 | # extension names that should be enabled during MathJax rendering. For example 1544 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1545 | # This tag requires that the tag USE_MATHJAX is set to YES. 1546 | 1547 | MATHJAX_EXTENSIONS = 1548 | 1549 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1550 | # of code that will be used on startup of the MathJax code. See the MathJax site 1551 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1552 | # example see the documentation. 1553 | # This tag requires that the tag USE_MATHJAX is set to YES. 1554 | 1555 | MATHJAX_CODEFILE = 1556 | 1557 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1558 | # the HTML output. The underlying search engine uses javascript and DHTML and 1559 | # should work on any modern browser. Note that when using HTML help 1560 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1561 | # there is already a search function so this one should typically be disabled. 1562 | # For large projects the javascript based search engine can be slow, then 1563 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1564 | # search using the keyboard; to jump to the search box use + S 1565 | # (what the is depends on the OS and browser, but it is typically 1566 | # , /