├── .clang-format ├── .clang-tidy ├── .codedocs ├── .gitignore ├── .travis.yml ├── .ycm_extra_conf.py ├── 3rdparty └── catch │ ├── CMakeLists.txt │ ├── catch.hpp │ └── update_catch.sh ├── CMakeLists.txt ├── LICENSE ├── README.md ├── appveyor.yml ├── cmake ├── BuildConfig.json.in ├── Findrapidjson.cmake ├── ProjectGlobalMacros.cmake ├── ProjectTestFunctions.cmake ├── SanitizerBlacklist.txt.in └── run-clang-tidy.py.in ├── codecov.yml ├── docs ├── doxygen │ └── source │ │ ├── doxyhtml.conf │ │ └── doxyxml.conf └── sphinx │ ├── Makefile │ ├── make.bat │ └── source │ ├── conf.py │ ├── index.rst │ └── requirements.txt ├── readthedocs.yml └── src ├── projectlib ├── CMakeLists.txt ├── projectlib │ ├── config.h.cmake │ └── project.h ├── src │ └── project.cc └── test │ ├── CMakeLists.txt │ └── test1.cc ├── projectrun ├── CMakeLists.txt └── src │ └── main.cc └── testlib ├── CMakeLists.txt └── src └── catch_main.cc /.clang-format: -------------------------------------------------------------------------------- 1 | BasedOnStyle: Google 2 | ColumnLimit: 100 3 | Cpp11BracedListStyle: true 4 | IndentWidth: 2 5 | MaxEmptyLinesToKeep: 1 6 | NamespaceIndentation: None 7 | SpaceBeforeAssignmentOperators: true 8 | Standard: Cpp11 9 | UseTab: Never 10 | AllowShortFunctionsOnASingleLine: false 11 | -------------------------------------------------------------------------------- /.clang-tidy: -------------------------------------------------------------------------------- 1 | Checks: "cppcore*" 2 | -------------------------------------------------------------------------------- /.codedocs: -------------------------------------------------------------------------------- 1 | DOXYFILE = docs/doxygen/source/doxyhtml.conf 2 | TAGLINKS = 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | **.pyc 2 | **.pyo 3 | BuildConfig.json 4 | /build/ 5 | /docs/doxygen/build/ 6 | /docs/sphinx/build/ 7 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: c++ 2 | sudo: required 3 | dist: trusty 4 | addons: 5 | apt: 6 | sources: 7 | - ubuntu-toolchain-r-test 8 | - llvm-toolchain-precise-3.8 9 | packages: 10 | - g++-5 11 | - clang-3.8 12 | - binutils 13 | 14 | matrix: 15 | include: 16 | # Linux GCC Builds 17 | - { compiler: gcc, env: C_COMPILER=gcc-5 CXX_COMPILER=g++-5 COMPILER_ID=gcc ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Release' SANITIZER="" } 18 | - { compiler: gcc, env: C_COMPILER=gcc-5 CXX_COMPILER=g++-5 COMPILER_ID=gcc ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Coverage' SANITIZER="" } 19 | - { compiler: gcc, env: C_COMPILER=gcc-5 CXX_COMPILER=g++-5 COMPILER_ID=gcc ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="" } 20 | - { compiler: gcc, env: C_COMPILER=gcc-5 CXX_COMPILER=g++-5 COMPILER_ID=gcc ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="address" } 21 | - { compiler: gcc, env: C_COMPILER=gcc-5 CXX_COMPILER=g++-5 COMPILER_ID=gcc ADDITIONAL_FLAGS="-fuse-ld=gold -fPIC" BUILD_TYPE='Debug' SANITIZER="thread" } 22 | #- { compiler: gcc, env: C_COMPILER=gcc-5 CXX_COMPILER=g++-5 COMPILER_ID=gcc ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="memory" # Not supported 23 | - { compiler: gcc, env: C_COMPILER=gcc-5 CXX_COMPILER=g++-5 COMPILER_ID=gcc ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="undefined" } 24 | 25 | # Linux Clang Builds 26 | - { compiler: clang, env: C_COMPILER=clang-3.8 CXX_COMPILER=clang++-3.8 COMPILER_ID=clang ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Release' SANITIZER="" } 27 | - { compiler: clang, env: C_COMPILER=clang-3.8 CXX_COMPILER=clang++-3.8 COMPILER_ID=clang ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="" } 28 | - { compiler: clang, env: C_COMPILER=clang-3.8 CXX_COMPILER=clang++-3.8 COMPILER_ID=clang ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="address" } 29 | - { compiler: clang, env: C_COMPILER=clang-3.8 CXX_COMPILER=clang++-3.8 COMPILER_ID=clang ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="thread" } 30 | #- { compiler: clang, env: C_COMPILER=clang-3.8 CXX_COMPILER=clang++-3.8 COMPILER_ID=clang ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="memory" } # False positive 31 | - { compiler: clang, env: C_COMPILER=clang-3.8 CXX_COMPILER=clang++-3.8 COMPILER_ID=clang ADDITIONAL_FLAGS="-fuse-ld=gold" BUILD_TYPE='Debug' SANITIZER="undefined" } 32 | 33 | # OSX Clang Builds 34 | - { os: osx, osx_image: xcode8, env: C_COMPILER=clang CXX_COMPILER='clang++' COMPILER_ID=clang ADDITIONAL_FLAGS="" BUILD_TYPE='Release' SANITIZER="" } 35 | - { os: osx, osx_image: xcode8, env: C_COMPILER=clang CXX_COMPILER='clang++' COMPILER_ID=clang ADDITIONAL_FLAGS="" BUILD_TYPE='Debug' SANITIZER="" } 36 | - {os: osx, osx_image: xcode8, env: C_COMPILER=clang CXX_COMPILER='clang++' COMPILER_ID=clang ADDITIONAL_FLAGS="" BUILD_TYPE='Debug' SANITIZER="address" } 37 | - {os: osx, osx_image: xcode8, env: C_COMPILER=clang CXX_COMPILER='clang++' COMPILER_ID=clang ADDITIONAL_FLAGS="" BUILD_TYPE='Debug' SANITIZER="thread" } 38 | #- {os: osx, osx_image: xcode8, env: C_COMPILER=clang CXX_COMPILER='clang++' COMPILER_ID=clang ADDITIONAL_FLAGS="" BUILD_TYPE='Debug' SANITIZER="memory" } # Not supported on osx clang 39 | #- {os: osx, osx_image: xcode8, env: C_COMPILER=clang CXX_COMPILER='clang++' COMPILER_ID=clang ADDITIONAL_FLAGS="" BUILD_TYPE='Debug' SANITIZER="undefined" } # Missing libclang_rt 40 | 41 | install: 42 | - DEPS_DIR="${TRAVIS_BUILD_DIR}/deps" 43 | - mkdir -p ${DEPS_DIR} && cd ${DEPS_DIR} 44 | - | 45 | if [[ "${TRAVIS_OS_NAME}" == "linux" ]]; then 46 | echo 47 | elif [[ "${TRAVIS_OS_NAME}" == "osx" ]]; then 48 | # Seems already installed now 49 | # brew install cmake 50 | cmake --version 51 | fi 52 | 53 | before_script: 54 | - export CC=${C_COMPILER} 55 | - export CXX=${CXX_COMPILER} 56 | - cd ${TRAVIS_BUILD_DIR} 57 | - mkdir -p Build 58 | - cd Build 59 | - cmake --version 60 | - cmake .. -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -DCMAKE_CXX_FLAGS="${ADDITIONAL_FLAGS}" -DPROJECT_BUILD_SANITIZER_TYPE=${SANITIZER} 61 | 62 | script: 63 | - make -j2 64 | - ctest -V 65 | - ./bin/runcppproject 66 | 67 | after_success: 68 | - | 69 | if [[ "${BUILD_TYPE}" == "Coverage" ]]; then 70 | bash <(curl -s https://codecov.io/bash) 71 | fi 72 | -------------------------------------------------------------------------------- /.ycm_extra_conf.py: -------------------------------------------------------------------------------- 1 | # This file is NOT licensed under the GPLv3, which is the license for the rest 2 | # of YouCompleteMe. 3 | # 4 | # Here's the license text for this file: 5 | # 6 | # This is free and unencumbered software released into the public domain. 7 | # 8 | # Anyone is free to copy, modify, publish, use, compile, sell, or 9 | # distribute this software, either in source code form or as a compiled 10 | # binary, for any purpose, commercial or non-commercial, and by any 11 | # means. 12 | # 13 | # In jurisdictions that recognize copyright laws, the author or authors 14 | # of this software dedicate any and all copyright interest in the 15 | # software to the public domain. We make this dedication for the benefit 16 | # of the public at large and to the detriment of our heirs and 17 | # successors. We intend this dedication to be an overt act of 18 | # relinquishment in perpetuity of all present and future rights to this 19 | # software under copyright law. 20 | # 21 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 22 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 23 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 24 | # IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR 25 | # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 26 | # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 27 | # OTHER DEALINGS IN THE SOFTWARE. 28 | # 29 | 30 | import os 31 | import ycm_core 32 | import json 33 | 34 | flags = [ 35 | '-Wall', 36 | '-Wextra', 37 | '-Werror', 38 | '-Wc++98-compat', 39 | '-Wno-long-long', 40 | '-Wno-variadic-macros', 41 | '-fexceptions', 42 | '-DNDEBUG', 43 | '-DUSE_CLANG_COMPLETER', 44 | '-std=c++14', 45 | '-x', 46 | 'c++', 47 | '-isystem', 48 | '../BoostParts', 49 | '-isystem', 50 | '/System/Library/Frameworks/Python.framework/Headers', 51 | '-isystem', 52 | '../llvm/include', 53 | '-isystem', 54 | '../llvm/tools/clang/include', 55 | '-I', 56 | '.', 57 | '-I', 58 | './ClangCompleter', 59 | '-isystem', 60 | './tests/gmock/gtest', 61 | '-isystem', 62 | './tests/gmock/gtest/include', 63 | '-isystem', 64 | './tests/gmock', 65 | '-isystem', 66 | './tests/gmock/include', 67 | ] 68 | 69 | 70 | # Set this to the absolute path to the folder (NOT the file!) containing the 71 | # compile_commands.json file to use that instead of 'flags'. See here for 72 | # more details: http://clang.llvm.org/docs/JSONCompilationDatabase.html 73 | # 74 | # You can get CMake to generate this file for you by adding: 75 | # set( CMAKE_EXPORT_COMPILE_COMMANDS 1 ) 76 | # to your CMakeLists.txt file. 77 | # 78 | # Most projects will NOT need to set this to anything; you can just change the 79 | # 'flags' list of compilation flags. Notice that YCM itself uses that approach. 80 | 81 | def DirectoryOfThisScript(): 82 | return os.path.dirname( os.path.abspath( __file__ ) ) 83 | 84 | compilation_database_folder = '' 85 | with open('%s/BuildConfig.json' % DirectoryOfThisScript()) as build_config_file: 86 | json_data = json.load(build_config_file) 87 | compilation_database_folder = json_data['rtp'].encode('ascii','replace') 88 | 89 | database = None 90 | if os.path.exists( compilation_database_folder ): 91 | database = ycm_core.CompilationDatabase( compilation_database_folder ) 92 | 93 | SOURCE_EXTENSIONS = [ '.cpp', '.cxx', '.cc', '.c', '.m', '.mm' ] 94 | 95 | 96 | 97 | def MakeRelativePathsInFlagsAbsolute( flags, working_directory ): 98 | if not working_directory: 99 | return list( flags ) 100 | new_flags = [] 101 | make_next_absolute = False 102 | path_flags = [ '-isystem', '-I', '-iquote', '--sysroot=' ] 103 | for flag in flags: 104 | new_flag = flag 105 | 106 | if make_next_absolute: 107 | make_next_absolute = False 108 | if not flag.startswith( '/' ): 109 | new_flag = os.path.join( working_directory, flag ) 110 | 111 | for path_flag in path_flags: 112 | if flag == path_flag: 113 | make_next_absolute = True 114 | break 115 | 116 | if flag.startswith( path_flag ): 117 | path = flag[ len( path_flag ): ] 118 | new_flag = path_flag + os.path.join( working_directory, path ) 119 | break 120 | 121 | if new_flag: 122 | new_flags.append( new_flag ) 123 | return new_flags 124 | 125 | 126 | def IsHeaderFile( filename ): 127 | extension = os.path.splitext( filename )[ 1 ] 128 | return extension in [ '.h', '.hxx', '.hpp', '.hh' ] 129 | 130 | 131 | def GetCompilationInfoForFile( filename ): 132 | # The compilation_commands.json file generated by CMake does not have entries 133 | # for header files. So we do our best by asking the db for flags for a 134 | # corresponding source file, if any. If one exists, the flags for that file 135 | # should be good enough. 136 | if IsHeaderFile( filename ): 137 | basename = os.path.splitext( filename )[ 0 ] 138 | for extension in SOURCE_EXTENSIONS: 139 | replacement_file = basename + extension 140 | if os.path.exists( replacement_file ): 141 | compilation_info = database.GetCompilationInfoForFile( 142 | replacement_file ) 143 | if compilation_info.compiler_flags_: 144 | return compilation_info 145 | return None 146 | return database.GetCompilationInfoForFile( filename ) 147 | 148 | 149 | def FlagsForFile( filename, **kwargs ): 150 | if database: 151 | # Bear in mind that compilation_info.compiler_flags_ does NOT return a 152 | # python list, but a "list-like" StringVec object 153 | compilation_info = GetCompilationInfoForFile( filename ) 154 | if not compilation_info: 155 | return None 156 | 157 | final_flags = MakeRelativePathsInFlagsAbsolute( 158 | compilation_info.compiler_flags_, 159 | compilation_info.compiler_working_dir_ ) 160 | 161 | # NOTE: This is just for YouCompleteMe; it's highly likely that your project 162 | # does NOT need to remove the stdlib flag. DO NOT USE THIS IN YOUR 163 | # ycm_extra_conf IF YOU'RE NOT 100% SURE YOU NEED IT. 164 | try: 165 | final_flags.remove( '-stdlib=libc++' ) 166 | except ValueError: 167 | pass 168 | else: 169 | relative_to = DirectoryOfThisScript() 170 | final_flags = MakeRelativePathsInFlagsAbsolute( flags, relative_to ) 171 | 172 | return { 173 | 'flags': final_flags, 174 | 'do_cache': True 175 | } 176 | -------------------------------------------------------------------------------- /3rdparty/catch/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | add_library(catch INTERFACE) 2 | target_include_directories(catch INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}) 3 | -------------------------------------------------------------------------------- /3rdparty/catch/update_catch.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | SCRIPTPATH="$( cd "$(dirname "$0")" ; pwd -P )" 4 | URL="https://raw.githubusercontent.com/philsquared/Catch/master/single_include/catch.hpp" 5 | wget "${URL}" -O "${SCRIPTPATH}/catch.hpp" 6 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # C++ Project template 2 | # 3 | # Proudly bootstrapped by git@github.com:duckie/cpp_project_template.git 4 | # 5 | 6 | # Version guard 7 | cmake_minimum_required (VERSION 3.2) 8 | 9 | # Cmake modules 10 | include(CheckCXXSourceCompiles) 11 | include(CheckCXXCompilerFlag) 12 | list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake") 13 | include(ProjectGlobalMacros) 14 | include(ProjectTestFunctions) 15 | 16 | # Project configuration 17 | project (cppproject) 18 | enable_testing() 19 | set(CMAKE_VERBOSE_MAKEFILE OFF) 20 | 21 | # Check for C++11/14 support 22 | project_check_cpp_version() 23 | 24 | ## Snippets to enforce a C++ version 25 | #if (not CPP14_SUPPORT) 26 | # message(FATAL_ERROR "C++14 support is required.") 27 | #endif() 28 | #if (not CPP11_SUPPORT) 29 | # message(FATAL_ERROR "C++11 support is required.") 30 | #endif() 31 | 32 | # Trace compilation for tools (ex: YouCompleteMe) 33 | set(CMAKE_EXPORT_COMPILE_COMMANDS 1) 34 | configure_file(${PROJECT_SOURCE_DIR}/cmake/BuildConfig.json.in ${PROJECT_SOURCE_DIR}/BuildConfig.json) 35 | 36 | # Tooling - some must be declared before adding other subdirectories 37 | project_enable_coverage_build() 38 | project_enable_sanitizer_build() 39 | project_enable_clang_format() 40 | project_enable_clang_tidy() 41 | project_enable_documentation() 42 | 43 | # Generate configuration 44 | 45 | 46 | ### MANUAL_INCLUDE_DIRS is useful to force ides to find some includes (useless for compilation) ### 47 | ### To be used by editing the cache manually 48 | include_directories(${MANUAL_INCLUDE_DIRS}) 49 | 50 | project_add_3rdparty(catch) 51 | 52 | # By default we put binaries into this directory 53 | set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin) 54 | set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib) 55 | 56 | project_add_module(testlib) 57 | project_add_module(projectlib) 58 | project_add_module(projectrun) 59 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | Copyright (c) 2016 Jean-Bernard Jansen 3 | 4 | Permission is hereby granted, free of charge, to any person obtaining a copy 5 | of this software and associated documentation files (the "Software"), to deal 6 | in the Software without restriction, including without limitation the rights 7 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 | copies of the Software, and to permit persons to whom the Software is 9 | furnished to do so, subject to the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be included in 12 | all copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 20 | THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | C++ project template 2 | ==================== 3 | 4 | [![Travis CI Build Status](https://api.travis-ci.org/duckie/cpp_project_template.svg?branch=master)](https://travis-ci.org/duckie/cpp_project_template) 5 | [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/ik18h87j8fg6s968?svg=true)](https://ci.appveyor.com/project/duckie/cpp-project-template) 6 | [![codecov.io](http://codecov.io/github/duckie/cpp_project_template/coverage.svg?branch=master)](http://codecov.io/github/duckie/cpp_project_template?branch=master) 7 | [![Documentation Status](https://readthedocs.org/projects/cpp-project-template/badge/?version=latest)](http://cpp-project-template.readthedocs.io/en/latest/?badge=latest) 8 | 9 | 10 | 11 | This is a layout to bootstrap a complete C++ project with several modules, test code and various tooling to get on a sane development workflow. The directory layout looks over engineered for so small a source code, but it aims at being able to scale with a lot of files, modules and 3rdparties while avoiding clutter and name conflicts. 12 | 13 | The actual source has three modules: 14 | * *projectlib* is the business code of a library, with public headers and compilation units. The `projectlib` directory name is replicated for public headers to keep consistency with system wide deployment through a package. 15 | * *projectrun* contains only compilation units and is a business executable. 16 | * *testlib* contains only compilation units (yet) and is supposed to hold test code, objects and tools shared by the other modules. 17 | 18 | Non system third parties are supposed to be stored or referenced (either via copy, submodule or _CMake_ external project) in the `3rdparty` directory. System third parties may be referenced to directly with _CMake_ modules. 19 | 20 | Tooling includes: 21 | * Automatic configuration for [YouCompleteMe](https://github.com/Valloric/YouCompleteMe) 22 | * Code coverage with `gcov` and `lcov` 23 | * Code formatting with `clang-format` 24 | * Code checking with `clang-tidy` 25 | * Cloud continuous integration 26 | * Sanitizers builds 27 | * A trick to prefix every test executable with your own command, with arguments if you want (ex: `valgrind --leak-check=full`) without using the strange CMake Dart thing. 28 | * Documentation generation with [Doxygen](http://doxygen.org) and [Sphinx](http://www.sphinx-doc.org)+[Breathe](http://breathe.readthedocs.io). 29 | 30 | This project is distributed under the [MIT license](https://opensource.org/licenses/MIT). 31 | 32 | ### Simple compilation 33 | 34 | ```bash 35 | mkdir build 36 | cd build 37 | cmake ../ 38 | make 39 | ctest 40 | ./bin/runcppproject 41 | ``` 42 | 43 | The cmake output will prompt about detected tools and availabe targets to use them. 44 | 45 | 46 | ### clang-tidy 47 | 48 | To execute `clang-tidy` on every file compiled by the project, from the build dir : 49 | 50 | ```bash 51 | ./run-clang-tidy.py 52 | ``` 53 | 54 | It will execute `clang-tidy` with the same `-I` and `-D` options from your CMake files. Any additional argument passed to the script is forwarded. Example: 55 | 56 | ```bash 57 | ./run-clang-tidy.py -checks=* 58 | ``` 59 | 60 | ### Sanitizer builds 61 | 62 | To make a sanitizer build, customize `cmake/SanitizerBlacklist.txt.in` at your will then 63 | 64 | ```bash 65 | cmake ../ -DPROJECT_BUILD_SANITIZER_TYPE=${sanitizer_type} 66 | ``` 67 | 68 | Where `sanitizer_type` is either `address`, `memory`, `thread` or `undefined`. 69 | 70 | ### Prefixing tests 71 | 72 | A function called `project_add_test` has the exact same signature than the built-in `add_test`. Tests added with it are prefixed before launch with the content of the `PROJECT_TEST_COMMANDS_PREFIX` variable. Example: 73 | 74 | 75 | ```bash 76 | cmake ../ -DPROJECT_TEST_COMMANDS_PREFIX="valgrind --leak-check=full" 77 | ``` 78 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | environment: 2 | matrix: 3 | - config: Debug 4 | - config: RelWithDebInfo 5 | 6 | shallow_clone: true 7 | 8 | # Operating system (build VM template) 9 | os: Visual Studio 2015 10 | 11 | # scripts that are called at very beginning, before repo cloning 12 | init: 13 | 14 | # clone directory 15 | clone_folder: c:\projects\cppproject 16 | 17 | platform: x64 18 | 19 | install: 20 | - set 21 | - echo cmake on AppVeyor 22 | - cmake -version 23 | - call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64 24 | 25 | build_script: 26 | - cd c:\projects\cppproject 27 | - mkdir build 28 | - cd build 29 | - echo %config% 30 | # This will produce lots of LNK4099 warnings which can be ignored. 31 | # Unfortunately they can't be disabled, see 32 | # http://stackoverflow.com/questions/661606/visual-c-how-to-disable-specific-linker-warnings 33 | - cmake -LA -G "Visual Studio 14 Win64" 34 | -DCMAKE_BUILD_TYPE=%config% 35 | .. 36 | - msbuild cppproject.sln /p:Configuration=%config% /toolsversion:14.0 /p:Platform=x64 /p:PlatformToolset=v140 37 | #- cmake .. -LA -G "NMake Makefiles" 38 | #-DCMAKE_BUILD_TYPE=%config% 39 | #- nmake 40 | 41 | test_script: 42 | # "-E testdata-overview" exempts one test we know fails on Appveyor 43 | # because we currently don't have spatialite support. 44 | - ctest --output-on-failure 45 | -C %config% 46 | -E testdata-overview 47 | -------------------------------------------------------------------------------- /cmake/BuildConfig.json.in: -------------------------------------------------------------------------------- 1 | {"rtp":"${PROJECT_BINARY_DIR}"} 2 | -------------------------------------------------------------------------------- /cmake/Findrapidjson.cmake: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2011 Milo Yip (miloyip@gmail.com) 2 | # Copyright (c) 2013 Rafal Jeczalik (rjeczalik@gmail.com) 3 | # Distributed under the MIT License (see license.txt file) 4 | 5 | # ----------------------------------------------------------------------------------- 6 | # 7 | # Finds the rapidjson library 8 | # 9 | # ----------------------------------------------------------------------------------- 10 | # 11 | # Variables used by this module, they can change the default behaviour. 12 | # Those variables need to be either set before calling find_package 13 | # or exported as environment variables before running CMake: 14 | # 15 | # RAPIDJSON_INCLUDEDIR - Set custom include path, useful when rapidjson headers are 16 | # outside system paths 17 | # RAPIDJSON_USE_SSE2 - Configure rapidjson to take advantage of SSE2 capabilities 18 | # RAPIDJSON_USE_SSE42 - Configure rapidjson to take advantage of SSE4.2 capabilities 19 | # 20 | # ----------------------------------------------------------------------------------- 21 | # 22 | # Variables defined by this module: 23 | # 24 | # RAPIDJSON_FOUND - True if rapidjson was found 25 | # RAPIDJSON_INCLUDE_DIRS - Path to rapidjson include directory 26 | # RAPIDJSON_CXX_FLAGS - Extra C++ flags required for compilation with rapidjson 27 | # 28 | # ----------------------------------------------------------------------------------- 29 | # 30 | # Example usage: 31 | # 32 | # set(RAPIDJSON_USE_SSE2 ON) 33 | # set(RAPIDJSON_INCLUDEDIR "/opt/github.com/rjeczalik/rapidjson/include") 34 | # 35 | # find_package(rapidjson REQUIRED) 36 | # 37 | # include_directories("${RAPIDJSON_INCLUDE_DIRS}") 38 | # set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${RAPIDJSON_CXX_FLAGS}") 39 | # add_executable(foo foo.cc) 40 | # 41 | # ----------------------------------------------------------------------------------- 42 | 43 | foreach(opt RAPIDJSON_INCLUDEDIR RAPIDJSON_USE_SSE2 RAPIDJSON_USE_SSE42) 44 | if(${opt} AND DEFINED ENV{${opt}} AND NOT ${opt} STREQUAL "$ENV{${opt}}") 45 | message(WARNING "Conflicting ${opt} values: ignoring environment variable and using CMake cache entry.") 46 | elseif(DEFINED ENV{${opt}} AND NOT ${opt}) 47 | set(${opt} "$ENV{${opt}}") 48 | endif() 49 | endforeach() 50 | 51 | find_path( 52 | RAPIDJSON_INCLUDE_DIRS 53 | NAMES rapidjson/rapidjson.h 54 | PATHS ${RAPIDJSON_INCLUDEDIR} 55 | DOC "Include directory for the rapidjson library." 56 | ) 57 | 58 | mark_as_advanced(RAPIDJSON_INCLUDE_DIRS) 59 | 60 | if(RAPIDJSON_INCLUDE_DIRS) 61 | set(RAPIDJSON_FOUND TRUE) 62 | endif() 63 | 64 | mark_as_advanced(RAPIDJSON_FOUND) 65 | 66 | if(RAPIDJSON_USE_SSE42) 67 | set(RAPIDJSON_CXX_FLAGS "-DRAPIDJSON_SSE42") 68 | if(MSVC) 69 | set(RAPIDJSON_CXX_FLAGS "${RAPIDJSON_CXX_FLAGS} /arch:SSE4.2") 70 | else() 71 | set(RAPIDJSON_CXX_FLAGS "${RAPIDJSON_CXX_FLAGS} -msse4.2") 72 | endif() 73 | else() 74 | if(RAPIDJSON_USE_SSE2) 75 | set(RAPIDJSON_CXX_FLAGS "-DRAPIDJSON_SSE2") 76 | if(MSVC) 77 | set(RAPIDJSON_CXX_FLAGS "${RAPIDJSON_CXX_FLAGS} /arch:SSE2") 78 | else() 79 | set(RAPIDJSON_CXX_FLAGS "${RAPIDJSON_CXX_FLAGS} -msse2") 80 | endif() 81 | endif() 82 | endif() 83 | 84 | mark_as_advanced(RAPIDJSON_CXX_FLAGS) 85 | 86 | if(RAPIDJSON_FOUND) 87 | if(NOT rapidjson_FIND_QUIETLY) 88 | message(STATUS "Found rapidjson header files in ${RAPIDJSON_INCLUDE_DIRS}") 89 | if(DEFINED RAPIDJSON_CXX_FLAGS) 90 | message(STATUS "Found rapidjson C++ extra compilation flags: ${RAPIDJSON_CXX_FLAGS}") 91 | endif() 92 | endif() 93 | elseif(rapidjson_FIND_REQUIRED) 94 | message(FATAL_ERROR "Could not find rapidjson") 95 | else() 96 | message(STATUS "Optional package rapidjson was not found") 97 | endif() 98 | -------------------------------------------------------------------------------- /cmake/ProjectGlobalMacros.cmake: -------------------------------------------------------------------------------- 1 | # Feature detection 2 | find_program(MEMORYCHECK_COMMAND valgrind) 3 | find_program(GCOV_EXE gcov) 4 | find_program(LCOV_EXE lcov) 5 | find_program(GENHTML_EXE genhtml) 6 | find_program(CLANG_FORMAT_EXE clang-format) 7 | find_program(CLANG_TIDY_EXE clang-tidy) 8 | find_package(PythonInterp) 9 | find_program(MAKE_EXE make) 10 | find_program(DOXYGEN_EXE doxygen) 11 | 12 | # Check C++ version 13 | macro(project_check_cpp_version) 14 | if (NOT MSVC) 15 | # Tests for Clang and GCC 16 | check_cxx_compiler_flag(-std=c++1y CPP14_SUPPORT) 17 | if (CPP14_SUPPORT) 18 | set(CPP11_SUPPORT TRUE) 19 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++1y") 20 | message("-- C++14 support found.") 21 | else() 22 | check_cxx_compiler_flag(-std=c++11 CPP11_SUPPORT) 23 | if (CPP11_SUPPORT) 24 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11") 25 | message("-- C++11 support found.") 26 | endif() 27 | endif() 28 | else() 29 | # Tests for MSVC 30 | # Unfortunately, due to various unsupported things in msvc versions, 31 | # this is poor informatiion about actual support 32 | check_cxx_source_compiles("#include \nusing std::integer_sequence;\n int main(){return 0;}" CPP14_SUPPORT) 33 | if (CPP14_SUPPORT) 34 | set(CPP11_SUPPORT TRUE) 35 | message("-- C++14 support found.") 36 | else() 37 | check_cxx_source_compiles("static constexpr int TEST=0;\n int main(){return 0;}" CPP11_SUPPORT) 38 | if (CPP11_SUPPORT) 39 | message("-- C++11 support found.") 40 | endif() 41 | endif () 42 | endif() 43 | endmacro(project_check_cpp_version) 44 | 45 | # Enable memory checks for people using bizarre ctest builds 46 | macro(project_enable_memcheck) 47 | if (NOT MSVC) 48 | set(MEMORYCHECK_COMMAND_OPTIONS "--trace-children=yes --leak-check=full") 49 | set(MEMORYCHECK_SUPPRESSIONS_FILE "${PROJECT_SOURCE_DIR}/.valgrind_suppress.txt") 50 | else() 51 | endif() 52 | endmacro(project_enable_memcheck) 53 | 54 | # Add 3rdparty for main file 55 | macro(project_add_3rdparty name) 56 | add_subdirectory(3rdparty/${name} ${ARGN}) 57 | endmacro(project_add_3rdparty) 58 | 59 | # Add module for main file 60 | macro(project_add_module name) 61 | add_subdirectory(src/${name} ${ARGN}) 62 | endmacro(project_add_module) 63 | 64 | # Enable coverage 65 | macro(project_enable_coverage_build) 66 | if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") 67 | set(CMAKE_CXX_FLAGS_COVERAGE "-g -O0 -Wall --coverage") # -fprofile-arcs -ftest-coverage") 68 | set(CMAKE_C_FLAGS_COVERAGE "-g -O0 -Wall --coverage") # -fprofile-arcs -ftest-coverage") 69 | set(CMAKE_EXE_LINKER_FLAGS_COVERAGE "--coverage") # -fprofile-arcs -ftest-coverage") 70 | set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE "--coverage")# -fprofile-arcs -ftest-coverage") 71 | set(CMAKE_CXX_OUTPUT_EXTENSION_REPLACE 1) 72 | 73 | if ("${CMAKE_BUILD_TYPE}" STREQUAL "Coverage") 74 | # gcov 75 | if (NOT ${GCOV_EXE} STREQUAL GCOV_EXE-NOTFOUND) 76 | file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/coverage/gcov) 77 | message("-- gcov found, coverage reports available through target 'gcov'") 78 | add_custom_target(gcov 79 | COMMAND find ${PROJECT_BINARY_DIR} -type f -name *.gcno -exec ${GCOV_EXE} -pb {} '\;' > ${PROJECT_BINARY_DIR}/coverage/gcov/coverage.info 80 | COMMAND echo "Generated coverage report: " ${PROJECT_BINARY_DIR}/coverage/gcov/coverage.info 81 | WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/coverage/gcov 82 | ) 83 | endif() 84 | 85 | # lcov 86 | if (NOT ${LCOV_EXE} STREQUAL LCOV_EXE-NOTFOUND AND NOT ${GENHTML_EXE} STREQUAL GENHTML_EXE-NOTFOUND) 87 | message("-- lcov and genhtml found, html reports available through target 'lcov'") 88 | file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/coverage/lcov/html) 89 | add_custom_target(lcov 90 | COMMAND lcov --no-external --capture --base-directory ${PROJECT_SOURCE_DIR} --directory ${PROJECT_BINARY_DIR} --output-file coverage.info --rc lcov_branch_coverage=1 91 | COMMAND lcov --remove coverage.info 3rdparty/* src/*/test/* --base-directory ${PROJECT_SOURCE_DIR} --output-file coverage.info --rc lcov_branch_coverage=1 92 | COMMAND genhtml coverage.info --output-directory html --demangle-cpp --rc genhtml_branch_coverage=1 93 | COMMAND echo "HTML report generated in: " ${PROJECT_BINARY_DIR}/coverage/lcov/html 94 | WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/coverage/lcov 95 | ) 96 | endif() 97 | endif() 98 | endif() 99 | endmacro(project_enable_coverage_build) 100 | 101 | # Enable sanitizers builds 102 | macro(project_enable_sanitizer_build) 103 | configure_file(${PROJECT_SOURCE_DIR}/cmake/SanitizerBlacklist.txt.in ${PROJECT_BINARY_DIR}/SanitizerBlacklist.txt) 104 | if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 105 | set(SAN ${PROJECT_BUILD_SANITIZER_TYPE}) 106 | if (NOT ${SAN} STREQUAL "") 107 | if (${SAN} STREQUAL "address" 108 | OR ${SAN} STREQUAL "memory" 109 | OR ${SAN} STREQUAL "thread" 110 | OR ${SAN} STREQUAL "undefined") 111 | set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=${SAN} -fsanitize-blacklist=${PROJECT_BINARY_DIR}/SanitizerBlacklist.txt") 112 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=${SAN} -fsanitize-blacklist=${PROJECT_BINARY_DIR}/SanitizerBlacklist.txt") 113 | else() 114 | message(FATAL_ERROR "Clang sanitizer ${SAN} is unknown.") 115 | endif() 116 | endif() 117 | endif() 118 | if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU") 119 | set(SAN ${PROJECT_BUILD_SANITIZER_TYPE}) 120 | if (NOT ${SAN} STREQUAL "") 121 | if (${SAN} STREQUAL "address" 122 | OR ${SAN} STREQUAL "thread" 123 | OR ${SAN} STREQUAL "undefined") 124 | set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=${SAN}") 125 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=${SAN}") 126 | else() 127 | message(FATAL_ERROR "GCC sanitizer ${SAN} is unknown.") 128 | endif() 129 | endif() 130 | endif() 131 | endmacro(project_enable_sanitizer_build) 132 | 133 | # Format the whole source code with clang-format 134 | macro(project_enable_clang_format) 135 | if (NOT ${CLANG_FORMAT_EXE} STREQUAL "CLANG_FORMAT_EXE-NOTFOUND") 136 | message("-- clang-format found, whole source formatting enabled through 'format' target.") 137 | add_custom_target(format 138 | COMMAND find ./src -type f -regex .*\\.h\\\|.*\\.hpp\\\|.*\\.hxx\\\|.*\\.c\\\|.*\\.cpp\\\|.*\\.cxx\\\|.*\\.cc -exec clang-format -i {} \; 139 | WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} 140 | VERBATIM 141 | ) 142 | endif() 143 | endmacro(project_enable_clang_format) 144 | 145 | 146 | macro(project_enable_clang_tidy) 147 | if (NOT ${CLANG_TIDY_EXE} STREQUAL "CLANG_TIDY_EXE-NOTFOUND") 148 | message("-- clang-tidy found, script 'run-clang-tidy' available in build directory.") 149 | configure_file(${PROJECT_SOURCE_DIR}/cmake/run-clang-tidy.py.in ${PROJECT_BINARY_DIR}/run-clang-tidy.py) 150 | endif() 151 | endmacro(project_enable_clang_tidy) 152 | 153 | # Format the whole source code with clang-format 154 | macro(project_enable_documentation) 155 | add_custom_target(docs) 156 | if(NOT ${DOXYGEN_EXE} STREQUAL "DOXYGEN_EXE-NOTFOUND") 157 | message("-- Doxygen found, targets 'docs-doxygen-html' and 'docs-doxygen-xml' enabled.") 158 | add_custom_target(docs-doxygen-xml 159 | COMMAND ${DOXYGEN_EXE} docs/doxygen/source/doxyxml.conf 160 | WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} 161 | ) 162 | add_custom_target(docs-doxygen-html 163 | COMMAND ${DOXYGEN_EXE} docs/doxygen/source/doxyhtml.conf 164 | WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} 165 | ) 166 | # Dependency to XML will be added by sphinx, not the default 167 | add_dependencies(docs docs-doxygen-html) 168 | 169 | if (PYTHONINTERP_FOUND AND NOT ${MAKE_EXE} STREQUAL "MAKE_EXE-NOTFOUND") 170 | message("-- Python, doxygen and make found, target 'docs-sphinx' enabled.") 171 | add_custom_target(docs-sphinx 172 | DEPENDS docs-doxygen-xml 173 | COMMAND ${MAKE_EXE} html 174 | WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/docs/sphinx 175 | ) 176 | add_dependencies(docs docs-sphinx) 177 | endif() 178 | endif() 179 | endmacro(project_enable_documentation) 180 | -------------------------------------------------------------------------------- /cmake/ProjectTestFunctions.cmake: -------------------------------------------------------------------------------- 1 | # This file provides function to add tests tp ctest 2 | # with additional tooling 3 | 4 | ## 5 | # project_add_test has the same effect as add_test, but with additional effects : 6 | # - It add a prefix before COMMAND if you want one (ex:run valgrind or perf) 7 | # Use the PROJECT_TEST_COMMANDS_PREFIX to add a prefix. PROJECT_TEST_COMMANDS_PREFIX will be parsed 8 | # in such a way that it can be a full command with quoted arguments 9 | # 10 | # It supports both complete syntaxes of add_test transparently 11 | # 12 | separate_arguments(PARSED_PROJECT_TEST_COMMANDS_PREFIX UNIX_COMMAND ${PROJECT_TEST_COMMANDS_PREFIX}) 13 | function(project_add_test test_name) 14 | # Parse command line arguments to support various add_test syntaxes 15 | set(options OPTIONAL FAST) 16 | set(oneValueArgs NAME WORKING_DIRECTORY) 17 | set(multiValueArgs COMMAND CONFIGURATIONS) 18 | cmake_parse_arguments(project_add_test "${options}" "${oneValueArgs}" "${multiValueArgs}" ${test_name} ${ARGN}) 19 | 20 | if ("${project_add_test_NAME}" STREQUAL "") 21 | # This is the short definition 22 | add_test(${test_name} ${PARSED_PROJECT_TEST_COMMANDS_PREFIX} ${ARGN}) 23 | else() 24 | # Classic standard definitiom 25 | add_test(NAME ${project_add_test_NAME} 26 | COMMAND ${PARSED_PROJECT_TEST_COMMANDS_PREFIX} ${project_add_test_COMMAND} 27 | CONFIGURATIONS ${project_add_test_CONFIGURATIONS} 28 | WORKING_DIRECTORY ${project_add_test_WORKING_DIRECTORY} 29 | ) 30 | endif() 31 | endfunction(project_add_test) 32 | -------------------------------------------------------------------------------- /cmake/SanitizerBlacklist.txt.in: -------------------------------------------------------------------------------- 1 | # Ignore issues in std 2 | fun:std::* 3 | # Ignore issues in 3rdparty 4 | src:${PROJECT_SOURCE_DIR}/3rdparty/* 5 | -------------------------------------------------------------------------------- /cmake/run-clang-tidy.py.in: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import os, sys, json, subprocess, signal 4 | 5 | 6 | # Exits on Ctrl + C 7 | def signal_handler(sig,frame): 8 | sys.exit(128 + signal.SIGINT) 9 | signal.signal(signal.SIGINT, signal_handler) 10 | 11 | binary_dir="${PROJECT_BINARY_DIR}" 12 | clang_tidy="${CLANG_TIDY_EXE}" 13 | input_file = binary_dir + "/compile_commands.json" 14 | input_fd = open(input_file) 15 | json_data = json.load(input_fd) 16 | 17 | for compile_command in json_data: 18 | command = [clang_tidy] + sys.argv[1:] 19 | command.append("-p") 20 | command.append(binary_dir) 21 | command.append(compile_command["file"]) 22 | process = subprocess.Popen(command,shell=False) 23 | process.wait() 24 | if process.returncode == 128 + signal.SIGINT: 25 | break 26 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | coverage: 2 | ignore: 3 | - "3rdparty/**/*" 4 | codecov: 5 | ci: 6 | - "!circleci.com" 7 | -------------------------------------------------------------------------------- /docs/doxygen/source/doxyhtml.conf: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.11 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 = "C++ project template" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = docs/doxygen/build 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 = 122 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 | # doxygen will generate a detailed section even if there is only a brief 125 | # description. 126 | # The default value is: NO. 127 | 128 | ALWAYS_DETAILED_SEC = NO 129 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 | # inherited members of a class in the documentation of that class as if those 132 | # members were ordinary class members. Constructors, destructors and assignment 133 | # operators of the base classes will not be shown. 134 | # The default value is: NO. 135 | 136 | INLINE_INHERITED_MEMB = NO 137 | 138 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139 | # before files name in the file list and in the header files. If set to NO the 140 | # shortest path that makes the file name unique will be used 141 | # The default value is: YES. 142 | 143 | FULL_PATH_NAMES = YES 144 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 | # Stripping is only done if one of the specified strings matches the left-hand 147 | # part of the path. The tag can be used to show relative paths in the file list. 148 | # If left blank the directory from which doxygen is run is used as the path to 149 | # strip. 150 | # 151 | # Note that you can specify absolute paths here, but also relative paths, which 152 | # will be relative from the directory where doxygen is started. 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 | 155 | STRIP_FROM_PATH = 156 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 | # path mentioned in the documentation of a class, which tells the reader which 159 | # header file to include in order to use a class. If left blank only the name of 160 | # the header file containing the class definition is used. Otherwise one should 161 | # specify the list of include paths that are normally passed to the compiler 162 | # using the -I flag. 163 | 164 | STRIP_FROM_INC_PATH = 165 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 | # less readable) file names. This can be useful is your file systems doesn't 168 | # support long names like on DOS, Mac, or CD-ROM. 169 | # The default value is: NO. 170 | 171 | SHORT_NAMES = NO 172 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 | # first line (until the first dot) of a Javadoc-style comment as the brief 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 | # style comments (thus requiring an explicit @brief command for a brief 177 | # description.) 178 | # The default value is: NO. 179 | 180 | JAVADOC_AUTOBRIEF = NO 181 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 | # line (until the first dot) of a Qt-style comment as the brief description. If 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 | # requiring an explicit \brief command for a brief description.) 186 | # The default value is: NO. 187 | 188 | QT_AUTOBRIEF = NO 189 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 | # a brief description. This used to be the default behavior. The new default is 193 | # to treat a multi-line C++ comment block as a detailed description. Set this 194 | # tag to YES if you prefer the old behavior instead. 195 | # 196 | # Note that setting this tag to YES also means that rational rose comments are 197 | # not recognized any more. 198 | # The default value is: NO. 199 | 200 | MULTILINE_CPP_IS_BRIEF = NO 201 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 | # documentation from any documented member that it re-implements. 204 | # The default value is: YES. 205 | 206 | INHERIT_DOCS = YES 207 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 209 | # page for each member. If set to NO, the documentation of a member will be part 210 | # of the file/class/namespace that contains it. 211 | # The default value is: NO. 212 | 213 | SEPARATE_MEMBER_PAGES = NO 214 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 | # uses this value to replace tabs by spaces in code fragments. 217 | # Minimum value: 1, maximum value: 16, default value: 4. 218 | 219 | TAB_SIZE = 4 220 | 221 | # This tag can be used to specify a number of aliases that act as commands in 222 | # the documentation. An alias has the form: 223 | # name=value 224 | # For example adding 225 | # "sideeffect=@par Side Effects:\n" 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the 227 | # documentation, which will result in a user-defined paragraph with heading 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert 229 | # newlines. 230 | 231 | ALIASES = 232 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" 235 | # will allow you to use the command class in the itcl::class meaning. 236 | 237 | TCL_SUBST = 238 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 | # only. Doxygen will then generate output that is more tailored for C. For 241 | # instance, some of the names that are used will be different. The list of all 242 | # members will be omitted, etc. 243 | # The default value is: NO. 244 | 245 | OPTIMIZE_OUTPUT_FOR_C = NO 246 | 247 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 | # Python sources only. Doxygen will then generate output that is more tailored 249 | # for that language. For instance, namespaces will be presented as packages, 250 | # qualified scopes will look different, etc. 251 | # The default value is: NO. 252 | 253 | OPTIMIZE_OUTPUT_JAVA = NO 254 | 255 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 | # sources. Doxygen will then generate output that is tailored for Fortran. 257 | # The default value is: NO. 258 | 259 | OPTIMIZE_FOR_FORTRAN = NO 260 | 261 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 | # sources. Doxygen will then generate output that is tailored for VHDL. 263 | # The default value is: NO. 264 | 265 | OPTIMIZE_OUTPUT_VHDL = NO 266 | 267 | # Doxygen selects the parser to use depending on the extension of the files it 268 | # parses. With this tag you can assign which parser to use for a given 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it 270 | # using this tag. The format is ext=language, where ext is a file extension, and 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 | # 279 | # Note: For files without extension you can use no_extension as a placeholder. 280 | # 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 | # the files are not read by doxygen. 283 | 284 | EXTENSION_MAPPING = 285 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 | # according to the Markdown format, which allows for more readable 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 289 | # The output of markdown processing is further processed by doxygen, so you can 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 291 | # case of backward compatibilities issues. 292 | # The default value is: YES. 293 | 294 | MARKDOWN_SUPPORT = YES 295 | 296 | # When enabled doxygen tries to link words that correspond to documented 297 | # classes, or namespaces to their corresponding documentation. Such a link can 298 | # be prevented in individual cases by putting a % sign in front of the word or 299 | # globally by setting AUTOLINK_SUPPORT to NO. 300 | # The default value is: YES. 301 | 302 | AUTOLINK_SUPPORT = YES 303 | 304 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 305 | # to include (a tag file for) the STL sources as input, then you should set this 306 | # tag to YES in order to let doxygen match functions declarations and 307 | # definitions whose arguments contain STL classes (e.g. func(std::string); 308 | # versus func(std::string) {}). This also make the inheritance and collaboration 309 | # diagrams that involve STL classes more complete and accurate. 310 | # The default value is: NO. 311 | 312 | BUILTIN_STL_SUPPORT = NO 313 | 314 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 315 | # enable parsing support. 316 | # The default value is: NO. 317 | 318 | CPP_CLI_SUPPORT = NO 319 | 320 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 321 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 322 | # will parse them like normal C++ but will assume all classes use public instead 323 | # of private inheritance when no explicit protection keyword is present. 324 | # The default value is: NO. 325 | 326 | SIP_SUPPORT = NO 327 | 328 | # For Microsoft's IDL there are propget and propput attributes to indicate 329 | # getter and setter methods for a property. Setting this option to YES will make 330 | # doxygen to replace the get and set methods by a property in the documentation. 331 | # This will only work if the methods are indeed getting or setting a simple 332 | # type. If this is not the case, or you want to show the methods anyway, you 333 | # should set this option to NO. 334 | # The default value is: YES. 335 | 336 | IDL_PROPERTY_SUPPORT = YES 337 | 338 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 339 | # tag is set to YES then doxygen will reuse the documentation of the first 340 | # member in the group (if any) for the other members of the group. By default 341 | # all members of a group must be documented explicitly. 342 | # The default value is: NO. 343 | 344 | DISTRIBUTE_GROUP_DOC = NO 345 | 346 | # If one adds a struct or class to a group and this option is enabled, then also 347 | # any nested class or struct is added to the same group. By default this option 348 | # is disabled and one has to add nested compounds explicitly via \ingroup. 349 | # The default value is: NO. 350 | 351 | GROUP_NESTED_COMPOUNDS = NO 352 | 353 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 354 | # (for instance a group of public functions) to be put as a subgroup of that 355 | # type (e.g. under the Public Functions section). Set it to NO to prevent 356 | # subgrouping. Alternatively, this can be done per class using the 357 | # \nosubgrouping command. 358 | # The default value is: YES. 359 | 360 | SUBGROUPING = YES 361 | 362 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 363 | # are shown inside the group in which they are included (e.g. using \ingroup) 364 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 365 | # and RTF). 366 | # 367 | # Note that this feature does not work in combination with 368 | # SEPARATE_MEMBER_PAGES. 369 | # The default value is: NO. 370 | 371 | INLINE_GROUPED_CLASSES = NO 372 | 373 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 374 | # with only public data fields or simple typedef fields will be shown inline in 375 | # the documentation of the scope in which they are defined (i.e. file, 376 | # namespace, or group documentation), provided this scope is documented. If set 377 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 378 | # Man pages) or section (for LaTeX and RTF). 379 | # The default value is: NO. 380 | 381 | INLINE_SIMPLE_STRUCTS = NO 382 | 383 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 384 | # enum is documented as struct, union, or enum with the name of the typedef. So 385 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 386 | # with name TypeT. When disabled the typedef will appear as a member of a file, 387 | # namespace, or class. And the struct will be named TypeS. This can typically be 388 | # useful for C code in case the coding convention dictates that all compound 389 | # types are typedef'ed and only the typedef is referenced, never the tag name. 390 | # The default value is: NO. 391 | 392 | TYPEDEF_HIDES_STRUCT = NO 393 | 394 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 395 | # cache is used to resolve symbols given their name and scope. Since this can be 396 | # an expensive process and often the same symbol appears multiple times in the 397 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 398 | # doxygen will become slower. If the cache is too large, memory is wasted. The 399 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 400 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 401 | # symbols. At the end of a run doxygen will report the cache usage and suggest 402 | # the optimal cache size from a speed point of view. 403 | # Minimum value: 0, maximum value: 9, default value: 0. 404 | 405 | LOOKUP_CACHE_SIZE = 0 406 | 407 | #--------------------------------------------------------------------------- 408 | # Build related configuration options 409 | #--------------------------------------------------------------------------- 410 | 411 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 412 | # documentation are documented, even if no documentation was available. Private 413 | # class members and static file members will be hidden unless the 414 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 415 | # Note: This will also disable the warnings about undocumented members that are 416 | # normally produced when WARNINGS is set to YES. 417 | # The default value is: NO. 418 | 419 | EXTRACT_ALL = YES 420 | 421 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 422 | # be included in the documentation. 423 | # The default value is: NO. 424 | 425 | EXTRACT_PRIVATE = NO 426 | 427 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 428 | # scope will be included in the documentation. 429 | # The default value is: NO. 430 | 431 | EXTRACT_PACKAGE = NO 432 | 433 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 434 | # included in the documentation. 435 | # The default value is: NO. 436 | 437 | EXTRACT_STATIC = NO 438 | 439 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 440 | # locally in source files will be included in the documentation. If set to NO, 441 | # only classes defined in header files are included. Does not have any effect 442 | # for Java sources. 443 | # The default value is: YES. 444 | 445 | EXTRACT_LOCAL_CLASSES = YES 446 | 447 | # This flag is only useful for Objective-C code. If set to YES, local methods, 448 | # which are defined in the implementation section but not in the interface are 449 | # included in the documentation. If set to NO, only methods in the interface are 450 | # included. 451 | # The default value is: NO. 452 | 453 | EXTRACT_LOCAL_METHODS = NO 454 | 455 | # If this flag is set to YES, the members of anonymous namespaces will be 456 | # extracted and appear in the documentation as a namespace called 457 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 458 | # the file that contains the anonymous namespace. By default anonymous namespace 459 | # are hidden. 460 | # The default value is: NO. 461 | 462 | EXTRACT_ANON_NSPACES = NO 463 | 464 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 465 | # undocumented members inside documented classes or files. If set to NO these 466 | # members will be included in the various overviews, but no documentation 467 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 468 | # The default value is: NO. 469 | 470 | HIDE_UNDOC_MEMBERS = NO 471 | 472 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 473 | # undocumented classes that are normally visible in the class hierarchy. If set 474 | # to NO, these classes will be included in the various overviews. This option 475 | # has no effect if EXTRACT_ALL is enabled. 476 | # The default value is: NO. 477 | 478 | HIDE_UNDOC_CLASSES = NO 479 | 480 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 481 | # (class|struct|union) declarations. If set to NO, these declarations will be 482 | # included in the documentation. 483 | # The default value is: NO. 484 | 485 | HIDE_FRIEND_COMPOUNDS = NO 486 | 487 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 488 | # documentation blocks found inside the body of a function. If set to NO, these 489 | # blocks will be appended to the function's detailed documentation block. 490 | # The default value is: NO. 491 | 492 | HIDE_IN_BODY_DOCS = NO 493 | 494 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 495 | # \internal command is included. If the tag is set to NO then the documentation 496 | # will be excluded. Set it to YES to include the internal documentation. 497 | # The default value is: NO. 498 | 499 | INTERNAL_DOCS = NO 500 | 501 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 502 | # names in lower-case letters. If set to YES, upper-case letters are also 503 | # allowed. This is useful if you have classes or files whose names only differ 504 | # in case and if your file system supports case sensitive file names. Windows 505 | # and Mac users are advised to set this option to NO. 506 | # The default value is: system dependent. 507 | 508 | CASE_SENSE_NAMES = YES 509 | 510 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 511 | # their full class and namespace scopes in the documentation. If set to YES, the 512 | # scope will be hidden. 513 | # The default value is: NO. 514 | 515 | HIDE_SCOPE_NAMES = NO 516 | 517 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 518 | # append additional text to a page's title, such as Class Reference. If set to 519 | # YES the compound reference will be hidden. 520 | # The default value is: NO. 521 | 522 | HIDE_COMPOUND_REFERENCE= NO 523 | 524 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 525 | # the files that are included by a file in the documentation of that file. 526 | # The default value is: YES. 527 | 528 | SHOW_INCLUDE_FILES = YES 529 | 530 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 531 | # grouped member an include statement to the documentation, telling the reader 532 | # which file to include in order to use the member. 533 | # The default value is: NO. 534 | 535 | SHOW_GROUPED_MEMB_INC = NO 536 | 537 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 538 | # files with double quotes in the documentation rather than with sharp brackets. 539 | # The default value is: NO. 540 | 541 | FORCE_LOCAL_INCLUDES = NO 542 | 543 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 544 | # documentation for inline members. 545 | # The default value is: YES. 546 | 547 | INLINE_INFO = YES 548 | 549 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 550 | # (detailed) documentation of file and class members alphabetically by member 551 | # name. If set to NO, the members will appear in declaration order. 552 | # The default value is: YES. 553 | 554 | SORT_MEMBER_DOCS = YES 555 | 556 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 557 | # descriptions of file, namespace and class members alphabetically by member 558 | # name. If set to NO, the members will appear in declaration order. Note that 559 | # this will also influence the order of the classes in the class list. 560 | # The default value is: NO. 561 | 562 | SORT_BRIEF_DOCS = NO 563 | 564 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 565 | # (brief and detailed) documentation of class members so that constructors and 566 | # destructors are listed first. If set to NO the constructors will appear in the 567 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 568 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 569 | # member documentation. 570 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 571 | # detailed member documentation. 572 | # The default value is: NO. 573 | 574 | SORT_MEMBERS_CTORS_1ST = NO 575 | 576 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 577 | # of group names into alphabetical order. If set to NO the group names will 578 | # appear in their defined order. 579 | # The default value is: NO. 580 | 581 | SORT_GROUP_NAMES = NO 582 | 583 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 584 | # fully-qualified names, including namespaces. If set to NO, the class list will 585 | # be sorted only by class name, not including the namespace part. 586 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 587 | # Note: This option applies only to the class list, not to the alphabetical 588 | # list. 589 | # The default value is: NO. 590 | 591 | SORT_BY_SCOPE_NAME = NO 592 | 593 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 594 | # type resolution of all parameters of a function it will reject a match between 595 | # the prototype and the implementation of a member function even if there is 596 | # only one candidate or it is obvious which candidate to choose by doing a 597 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 598 | # accept a match between prototype and implementation in such cases. 599 | # The default value is: NO. 600 | 601 | STRICT_PROTO_MATCHING = NO 602 | 603 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 604 | # list. This list is created by putting \todo commands in the documentation. 605 | # The default value is: YES. 606 | 607 | GENERATE_TODOLIST = YES 608 | 609 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 610 | # list. This list is created by putting \test commands in the documentation. 611 | # The default value is: YES. 612 | 613 | GENERATE_TESTLIST = YES 614 | 615 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 616 | # list. This list is created by putting \bug commands in the documentation. 617 | # The default value is: YES. 618 | 619 | GENERATE_BUGLIST = YES 620 | 621 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 622 | # the deprecated list. This list is created by putting \deprecated commands in 623 | # the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_DEPRECATEDLIST= YES 627 | 628 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 629 | # sections, marked by \if ... \endif and \cond 630 | # ... \endcond blocks. 631 | 632 | ENABLED_SECTIONS = 633 | 634 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 635 | # initial value of a variable or macro / define can have for it to appear in the 636 | # documentation. If the initializer consists of more lines than specified here 637 | # it will be hidden. Use a value of 0 to hide initializers completely. The 638 | # appearance of the value of individual variables and macros / defines can be 639 | # controlled using \showinitializer or \hideinitializer command in the 640 | # documentation regardless of this setting. 641 | # Minimum value: 0, maximum value: 10000, default value: 30. 642 | 643 | MAX_INITIALIZER_LINES = 30 644 | 645 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 646 | # the bottom of the documentation of classes and structs. If set to YES, the 647 | # list will mention the files that were used to generate the documentation. 648 | # The default value is: YES. 649 | 650 | SHOW_USED_FILES = YES 651 | 652 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 653 | # will remove the Files entry from the Quick Index and from the Folder Tree View 654 | # (if specified). 655 | # The default value is: YES. 656 | 657 | SHOW_FILES = YES 658 | 659 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 660 | # page. This will remove the Namespaces entry from the Quick Index and from the 661 | # Folder Tree View (if specified). 662 | # The default value is: YES. 663 | 664 | SHOW_NAMESPACES = YES 665 | 666 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 667 | # doxygen should invoke to get the current version for each file (typically from 668 | # the version control system). Doxygen will invoke the program by executing (via 669 | # popen()) the command command input-file, where command is the value of the 670 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 671 | # by doxygen. Whatever the program writes to standard output is used as the file 672 | # version. For an example see the documentation. 673 | 674 | FILE_VERSION_FILTER = 675 | 676 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 677 | # by doxygen. The layout file controls the global structure of the generated 678 | # output files in an output format independent way. To create the layout file 679 | # that represents doxygen's defaults, run doxygen with the -l option. You can 680 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 681 | # will be used as the name of the layout file. 682 | # 683 | # Note that if you run doxygen from a directory containing a file called 684 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 685 | # tag is left empty. 686 | 687 | LAYOUT_FILE = 688 | 689 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 690 | # the reference definitions. This must be a list of .bib files. The .bib 691 | # extension is automatically appended if omitted. This requires the bibtex tool 692 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 693 | # For LaTeX the style of the bibliography can be controlled using 694 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 695 | # search path. See also \cite for info how to create references. 696 | 697 | CITE_BIB_FILES = 698 | 699 | #--------------------------------------------------------------------------- 700 | # Configuration options related to warning and progress messages 701 | #--------------------------------------------------------------------------- 702 | 703 | # The QUIET tag can be used to turn on/off the messages that are generated to 704 | # standard output by doxygen. If QUIET is set to YES this implies that the 705 | # messages are off. 706 | # The default value is: NO. 707 | 708 | QUIET = NO 709 | 710 | # The WARNINGS tag can be used to turn on/off the warning messages that are 711 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 712 | # this implies that the warnings are on. 713 | # 714 | # Tip: Turn warnings on while writing the documentation. 715 | # The default value is: YES. 716 | 717 | WARNINGS = YES 718 | 719 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 720 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 721 | # will automatically be disabled. 722 | # The default value is: YES. 723 | 724 | WARN_IF_UNDOCUMENTED = YES 725 | 726 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 727 | # potential errors in the documentation, such as not documenting some parameters 728 | # in a documented function, or documenting parameters that don't exist or using 729 | # markup commands wrongly. 730 | # The default value is: YES. 731 | 732 | WARN_IF_DOC_ERROR = YES 733 | 734 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 735 | # are documented, but have no documentation for their parameters or return 736 | # value. If set to NO, doxygen will only warn about wrong or incomplete 737 | # parameter documentation, but not about the absence of documentation. 738 | # The default value is: NO. 739 | 740 | WARN_NO_PARAMDOC = NO 741 | 742 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 743 | # a warning is encountered. 744 | # The default value is: NO. 745 | 746 | WARN_AS_ERROR = NO 747 | 748 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 749 | # can produce. The string should contain the $file, $line, and $text tags, which 750 | # will be replaced by the file and line number from which the warning originated 751 | # and the warning text. Optionally the format may contain $version, which will 752 | # be replaced by the version of the file (if it could be obtained via 753 | # FILE_VERSION_FILTER) 754 | # The default value is: $file:$line: $text. 755 | 756 | WARN_FORMAT = "$file:$line: $text" 757 | 758 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 759 | # messages should be written. If left blank the output is written to standard 760 | # error (stderr). 761 | 762 | WARN_LOGFILE = 763 | 764 | #--------------------------------------------------------------------------- 765 | # Configuration options related to the input files 766 | #--------------------------------------------------------------------------- 767 | 768 | # The INPUT tag is used to specify the files and/or directories that contain 769 | # documented source files. You may enter file names like myfile.cpp or 770 | # directories like /usr/src/myproject. Separate the files or directories with 771 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 772 | # Note: If this tag is empty the current directory is searched. 773 | 774 | INPUT = src 775 | 776 | # This tag can be used to specify the character encoding of the source files 777 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 778 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 779 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 780 | # possible encodings. 781 | # The default value is: UTF-8. 782 | 783 | INPUT_ENCODING = UTF-8 784 | 785 | # If the value of the INPUT tag contains directories, you can use the 786 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 787 | # *.h) to filter out the source-files in the directories. 788 | # 789 | # Note that for custom extensions or not directly supported extensions you also 790 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 791 | # read by doxygen. 792 | # 793 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 794 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 795 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 796 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, 797 | # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 798 | 799 | FILE_PATTERNS = 800 | 801 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 802 | # be searched for input files as well. 803 | # The default value is: NO. 804 | 805 | RECURSIVE = YES 806 | 807 | # The EXCLUDE tag can be used to specify files and/or directories that should be 808 | # excluded from the INPUT source files. This way you can easily exclude a 809 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 810 | # 811 | # Note that relative paths are relative to the directory from which doxygen is 812 | # run. 813 | 814 | EXCLUDE = 815 | 816 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 817 | # directories that are symbolic links (a Unix file system feature) are excluded 818 | # from the input. 819 | # The default value is: NO. 820 | 821 | EXCLUDE_SYMLINKS = NO 822 | 823 | # If the value of the INPUT tag contains directories, you can use the 824 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 825 | # certain files from those directories. 826 | # 827 | # Note that the wildcards are matched against the file with absolute path, so to 828 | # exclude all test directories for example use the pattern */test/* 829 | 830 | EXCLUDE_PATTERNS = 831 | 832 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 833 | # (namespaces, classes, functions, etc.) that should be excluded from the 834 | # output. The symbol name can be a fully qualified name, a word, or if the 835 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 836 | # AClass::ANamespace, ANamespace::*Test 837 | # 838 | # Note that the wildcards are matched against the file with absolute path, so to 839 | # exclude all test directories use the pattern */test/* 840 | 841 | EXCLUDE_SYMBOLS = 842 | 843 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 844 | # that contain example code fragments that are included (see the \include 845 | # command). 846 | 847 | EXAMPLE_PATH = 848 | 849 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 850 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 851 | # *.h) to filter out the source-files in the directories. If left blank all 852 | # files are included. 853 | 854 | EXAMPLE_PATTERNS = 855 | 856 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 857 | # searched for input files to be used with the \include or \dontinclude commands 858 | # irrespective of the value of the RECURSIVE tag. 859 | # The default value is: NO. 860 | 861 | EXAMPLE_RECURSIVE = NO 862 | 863 | # The IMAGE_PATH tag can be used to specify one or more files or directories 864 | # that contain images that are to be included in the documentation (see the 865 | # \image command). 866 | 867 | IMAGE_PATH = 868 | 869 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 870 | # invoke to filter for each input file. Doxygen will invoke the filter program 871 | # by executing (via popen()) the command: 872 | # 873 | # 874 | # 875 | # where is the value of the INPUT_FILTER tag, and is the 876 | # name of an input file. Doxygen will then use the output that the filter 877 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 878 | # will be ignored. 879 | # 880 | # Note that the filter must not add or remove lines; it is applied before the 881 | # code is scanned, but not when the output code is generated. If lines are added 882 | # or removed, the anchors will not be placed correctly. 883 | # 884 | # Note that for custom extensions or not directly supported extensions you also 885 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 886 | # properly processed by doxygen. 887 | 888 | INPUT_FILTER = 889 | 890 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 891 | # basis. Doxygen will compare the file name with each pattern and apply the 892 | # filter if there is a match. The filters are a list of the form: pattern=filter 893 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 894 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 895 | # patterns match the file name, INPUT_FILTER is applied. 896 | # 897 | # Note that for custom extensions or not directly supported extensions you also 898 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 899 | # properly processed by doxygen. 900 | 901 | FILTER_PATTERNS = 902 | 903 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 904 | # INPUT_FILTER) will also be used to filter the input files that are used for 905 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 906 | # The default value is: NO. 907 | 908 | FILTER_SOURCE_FILES = NO 909 | 910 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 911 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 912 | # it is also possible to disable source filtering for a specific pattern using 913 | # *.ext= (so without naming a filter). 914 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 915 | 916 | FILTER_SOURCE_PATTERNS = 917 | 918 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 919 | # is part of the input, its contents will be placed on the main page 920 | # (index.html). This can be useful if you have a project on for instance GitHub 921 | # and want to reuse the introduction page also for the doxygen output. 922 | 923 | USE_MDFILE_AS_MAINPAGE = 924 | 925 | #--------------------------------------------------------------------------- 926 | # Configuration options related to source browsing 927 | #--------------------------------------------------------------------------- 928 | 929 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 930 | # generated. Documented entities will be cross-referenced with these sources. 931 | # 932 | # Note: To get rid of all source code in the generated output, make sure that 933 | # also VERBATIM_HEADERS is set to NO. 934 | # The default value is: NO. 935 | 936 | SOURCE_BROWSER = NO 937 | 938 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 939 | # classes and enums directly into the documentation. 940 | # The default value is: NO. 941 | 942 | INLINE_SOURCES = NO 943 | 944 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 945 | # special comment blocks from generated source code fragments. Normal C, C++ and 946 | # Fortran comments will always remain visible. 947 | # The default value is: YES. 948 | 949 | STRIP_CODE_COMMENTS = YES 950 | 951 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 952 | # function all documented functions referencing it will be listed. 953 | # The default value is: NO. 954 | 955 | REFERENCED_BY_RELATION = NO 956 | 957 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 958 | # all documented entities called/used by that function will be listed. 959 | # The default value is: NO. 960 | 961 | REFERENCES_RELATION = NO 962 | 963 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 964 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 965 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 966 | # link to the documentation. 967 | # The default value is: YES. 968 | 969 | REFERENCES_LINK_SOURCE = YES 970 | 971 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 972 | # source code will show a tooltip with additional information such as prototype, 973 | # brief description and links to the definition and documentation. Since this 974 | # will make the HTML file larger and loading of large files a bit slower, you 975 | # can opt to disable this feature. 976 | # The default value is: YES. 977 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 978 | 979 | SOURCE_TOOLTIPS = YES 980 | 981 | # If the USE_HTAGS tag is set to YES then the references to source code will 982 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 983 | # source browser. The htags tool is part of GNU's global source tagging system 984 | # (see http://www.gnu.org/software/global/global.html). You will need version 985 | # 4.8.6 or higher. 986 | # 987 | # To use it do the following: 988 | # - Install the latest version of global 989 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 990 | # - Make sure the INPUT points to the root of the source tree 991 | # - Run doxygen as normal 992 | # 993 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 994 | # tools must be available from the command line (i.e. in the search path). 995 | # 996 | # The result: instead of the source browser generated by doxygen, the links to 997 | # source code will now point to the output of htags. 998 | # The default value is: NO. 999 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1000 | 1001 | USE_HTAGS = NO 1002 | 1003 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1004 | # verbatim copy of the header file for each class for which an include is 1005 | # specified. Set to NO to disable this. 1006 | # See also: Section \class. 1007 | # The default value is: YES. 1008 | 1009 | VERBATIM_HEADERS = YES 1010 | 1011 | #--------------------------------------------------------------------------- 1012 | # Configuration options related to the alphabetical class index 1013 | #--------------------------------------------------------------------------- 1014 | 1015 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1016 | # compounds will be generated. Enable this if the project contains a lot of 1017 | # classes, structs, unions or interfaces. 1018 | # The default value is: YES. 1019 | 1020 | ALPHABETICAL_INDEX = YES 1021 | 1022 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1023 | # which the alphabetical index list will be split. 1024 | # Minimum value: 1, maximum value: 20, default value: 5. 1025 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1026 | 1027 | COLS_IN_ALPHA_INDEX = 5 1028 | 1029 | # In case all classes in a project start with a common prefix, all classes will 1030 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1031 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1032 | # while generating the index headers. 1033 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1034 | 1035 | IGNORE_PREFIX = 1036 | 1037 | #--------------------------------------------------------------------------- 1038 | # Configuration options related to the HTML output 1039 | #--------------------------------------------------------------------------- 1040 | 1041 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1042 | # The default value is: YES. 1043 | 1044 | GENERATE_HTML = YES 1045 | 1046 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1047 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1048 | # it. 1049 | # The default directory is: html. 1050 | # This tag requires that the tag GENERATE_HTML is set to YES. 1051 | 1052 | HTML_OUTPUT = ./html 1053 | 1054 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1055 | # generated HTML page (for example: .htm, .php, .asp). 1056 | # The default value is: .html. 1057 | # This tag requires that the tag GENERATE_HTML is set to YES. 1058 | 1059 | HTML_FILE_EXTENSION = .html 1060 | 1061 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1062 | # each generated HTML page. If the tag is left blank doxygen will generate a 1063 | # standard header. 1064 | # 1065 | # To get valid HTML the header file that includes any scripts and style sheets 1066 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1067 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1068 | # default header using 1069 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1070 | # YourConfigFile 1071 | # and then modify the file new_header.html. See also section "Doxygen usage" 1072 | # for information on how to generate the default header that doxygen normally 1073 | # uses. 1074 | # Note: The header is subject to change so you typically have to regenerate the 1075 | # default header when upgrading to a newer version of doxygen. For a description 1076 | # of the possible markers and block names see the documentation. 1077 | # This tag requires that the tag GENERATE_HTML is set to YES. 1078 | 1079 | HTML_HEADER = 1080 | 1081 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1082 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1083 | # footer. See HTML_HEADER for more information on how to generate a default 1084 | # footer and what special commands can be used inside the footer. See also 1085 | # section "Doxygen usage" for information on how to generate the default footer 1086 | # that doxygen normally uses. 1087 | # This tag requires that the tag GENERATE_HTML is set to YES. 1088 | 1089 | HTML_FOOTER = 1090 | 1091 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1092 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1093 | # the HTML output. If left blank doxygen will generate a default style sheet. 1094 | # See also section "Doxygen usage" for information on how to generate the style 1095 | # sheet that doxygen normally uses. 1096 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1097 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1098 | # obsolete. 1099 | # This tag requires that the tag GENERATE_HTML is set to YES. 1100 | 1101 | HTML_STYLESHEET = 1102 | 1103 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1104 | # cascading style sheets that are included after the standard style sheets 1105 | # created by doxygen. Using this option one can overrule certain style aspects. 1106 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1107 | # standard style sheet and is therefore more robust against future updates. 1108 | # Doxygen will copy the style sheet files to the output directory. 1109 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1110 | # style sheet in the list overrules the setting of the previous ones in the 1111 | # list). For an example see the documentation. 1112 | # This tag requires that the tag GENERATE_HTML is set to YES. 1113 | 1114 | HTML_EXTRA_STYLESHEET = 1115 | 1116 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1117 | # other source files which should be copied to the HTML output directory. Note 1118 | # that these files will be copied to the base HTML output directory. Use the 1119 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1120 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1121 | # files will be copied as-is; there are no commands or markers available. 1122 | # This tag requires that the tag GENERATE_HTML is set to YES. 1123 | 1124 | HTML_EXTRA_FILES = 1125 | 1126 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1127 | # will adjust the colors in the style sheet and background images according to 1128 | # this color. Hue is specified as an angle on a colorwheel, see 1129 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1130 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1131 | # purple, and 360 is red again. 1132 | # Minimum value: 0, maximum value: 359, default value: 220. 1133 | # This tag requires that the tag GENERATE_HTML is set to YES. 1134 | 1135 | HTML_COLORSTYLE_HUE = 220 1136 | 1137 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1138 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1139 | # value of 255 will produce the most vivid colors. 1140 | # Minimum value: 0, maximum value: 255, default value: 100. 1141 | # This tag requires that the tag GENERATE_HTML is set to YES. 1142 | 1143 | HTML_COLORSTYLE_SAT = 100 1144 | 1145 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1146 | # luminance component of the colors in the HTML output. Values below 100 1147 | # gradually make the output lighter, whereas values above 100 make the output 1148 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1149 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1150 | # change the gamma. 1151 | # Minimum value: 40, maximum value: 240, default value: 80. 1152 | # This tag requires that the tag GENERATE_HTML is set to YES. 1153 | 1154 | HTML_COLORSTYLE_GAMMA = 80 1155 | 1156 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1157 | # page will contain the date and time when the page was generated. Setting this 1158 | # to YES can help to show when doxygen was last run and thus if the 1159 | # documentation is up to date. 1160 | # The default value is: NO. 1161 | # This tag requires that the tag GENERATE_HTML is set to YES. 1162 | 1163 | HTML_TIMESTAMP = NO 1164 | 1165 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1166 | # documentation will contain sections that can be hidden and shown after the 1167 | # page has loaded. 1168 | # The default value is: NO. 1169 | # This tag requires that the tag GENERATE_HTML is set to YES. 1170 | 1171 | HTML_DYNAMIC_SECTIONS = NO 1172 | 1173 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1174 | # shown in the various tree structured indices initially; the user can expand 1175 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1176 | # such a level that at most the specified number of entries are visible (unless 1177 | # a fully collapsed tree already exceeds this amount). So setting the number of 1178 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1179 | # representing an infinite number of entries and will result in a full expanded 1180 | # tree by default. 1181 | # Minimum value: 0, maximum value: 9999, default value: 100. 1182 | # This tag requires that the tag GENERATE_HTML is set to YES. 1183 | 1184 | HTML_INDEX_NUM_ENTRIES = 100 1185 | 1186 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1187 | # generated that can be used as input for Apple's Xcode 3 integrated development 1188 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1189 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1190 | # Makefile in the HTML output directory. Running make will produce the docset in 1191 | # that directory and running make install will install the docset in 1192 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1193 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1194 | # for more information. 1195 | # The default value is: NO. 1196 | # This tag requires that the tag GENERATE_HTML is set to YES. 1197 | 1198 | GENERATE_DOCSET = NO 1199 | 1200 | # This tag determines the name of the docset feed. A documentation feed provides 1201 | # an umbrella under which multiple documentation sets from a single provider 1202 | # (such as a company or product suite) can be grouped. 1203 | # The default value is: Doxygen generated docs. 1204 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1205 | 1206 | DOCSET_FEEDNAME = "Doxygen generated docs" 1207 | 1208 | # This tag specifies a string that should uniquely identify the documentation 1209 | # set bundle. This should be a reverse domain-name style string, e.g. 1210 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1211 | # The default value is: org.doxygen.Project. 1212 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1213 | 1214 | DOCSET_BUNDLE_ID = org.doxygen.Project 1215 | 1216 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1217 | # the documentation publisher. This should be a reverse domain-name style 1218 | # string, e.g. com.mycompany.MyDocSet.documentation. 1219 | # The default value is: org.doxygen.Publisher. 1220 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1221 | 1222 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1223 | 1224 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1225 | # The default value is: Publisher. 1226 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1227 | 1228 | DOCSET_PUBLISHER_NAME = Publisher 1229 | 1230 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1231 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1232 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1233 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1234 | # Windows. 1235 | # 1236 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1237 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1238 | # files are now used as the Windows 98 help format, and will replace the old 1239 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1240 | # HTML files also contain an index, a table of contents, and you can search for 1241 | # words in the documentation. The HTML workshop also contains a viewer for 1242 | # compressed HTML files. 1243 | # The default value is: NO. 1244 | # This tag requires that the tag GENERATE_HTML is set to YES. 1245 | 1246 | GENERATE_HTMLHELP = NO 1247 | 1248 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1249 | # file. You can add a path in front of the file if the result should not be 1250 | # written to the html output directory. 1251 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1252 | 1253 | CHM_FILE = 1254 | 1255 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1256 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1257 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1258 | # The file has to be specified with full path. 1259 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1260 | 1261 | HHC_LOCATION = 1262 | 1263 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1264 | # (YES) or that it should be included in the master .chm file (NO). 1265 | # The default value is: NO. 1266 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1267 | 1268 | GENERATE_CHI = NO 1269 | 1270 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1271 | # and project file content. 1272 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1273 | 1274 | CHM_INDEX_ENCODING = 1275 | 1276 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1277 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1278 | # enables the Previous and Next buttons. 1279 | # The default value is: NO. 1280 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1281 | 1282 | BINARY_TOC = NO 1283 | 1284 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1285 | # the table of contents of the HTML help documentation and to the tree view. 1286 | # The default value is: NO. 1287 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1288 | 1289 | TOC_EXPAND = NO 1290 | 1291 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1292 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1293 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1294 | # (.qch) of the generated HTML documentation. 1295 | # The default value is: NO. 1296 | # This tag requires that the tag GENERATE_HTML is set to YES. 1297 | 1298 | GENERATE_QHP = NO 1299 | 1300 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1301 | # the file name of the resulting .qch file. The path specified is relative to 1302 | # the HTML output folder. 1303 | # This tag requires that the tag GENERATE_QHP is set to YES. 1304 | 1305 | QCH_FILE = 1306 | 1307 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1308 | # Project output. For more information please see Qt Help Project / Namespace 1309 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1310 | # The default value is: org.doxygen.Project. 1311 | # This tag requires that the tag GENERATE_QHP is set to YES. 1312 | 1313 | QHP_NAMESPACE = org.doxygen.Project 1314 | 1315 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1316 | # Help Project output. For more information please see Qt Help Project / Virtual 1317 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1318 | # folders). 1319 | # The default value is: doc. 1320 | # This tag requires that the tag GENERATE_QHP is set to YES. 1321 | 1322 | QHP_VIRTUAL_FOLDER = doc 1323 | 1324 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1325 | # filter to add. For more information please see Qt Help Project / Custom 1326 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1327 | # filters). 1328 | # This tag requires that the tag GENERATE_QHP is set to YES. 1329 | 1330 | QHP_CUST_FILTER_NAME = 1331 | 1332 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1333 | # custom filter to add. For more information please see Qt Help Project / Custom 1334 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1335 | # filters). 1336 | # This tag requires that the tag GENERATE_QHP is set to YES. 1337 | 1338 | QHP_CUST_FILTER_ATTRS = 1339 | 1340 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1341 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1342 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1343 | # This tag requires that the tag GENERATE_QHP is set to YES. 1344 | 1345 | QHP_SECT_FILTER_ATTRS = 1346 | 1347 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1348 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1349 | # generated .qhp file. 1350 | # This tag requires that the tag GENERATE_QHP is set to YES. 1351 | 1352 | QHG_LOCATION = 1353 | 1354 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1355 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1356 | # install this plugin and make it available under the help contents menu in 1357 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1358 | # to be copied into the plugins directory of eclipse. The name of the directory 1359 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1360 | # After copying Eclipse needs to be restarted before the help appears. 1361 | # The default value is: NO. 1362 | # This tag requires that the tag GENERATE_HTML is set to YES. 1363 | 1364 | GENERATE_ECLIPSEHELP = NO 1365 | 1366 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1367 | # the directory name containing the HTML and XML files should also have this 1368 | # name. Each documentation set should have its own identifier. 1369 | # The default value is: org.doxygen.Project. 1370 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1371 | 1372 | ECLIPSE_DOC_ID = org.doxygen.Project 1373 | 1374 | # If you want full control over the layout of the generated HTML pages it might 1375 | # be necessary to disable the index and replace it with your own. The 1376 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1377 | # of each HTML page. A value of NO enables the index and the value YES disables 1378 | # it. Since the tabs in the index contain the same information as the navigation 1379 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1380 | # The default value is: NO. 1381 | # This tag requires that the tag GENERATE_HTML is set to YES. 1382 | 1383 | DISABLE_INDEX = NO 1384 | 1385 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1386 | # structure should be generated to display hierarchical information. If the tag 1387 | # value is set to YES, a side panel will be generated containing a tree-like 1388 | # index structure (just like the one that is generated for HTML Help). For this 1389 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1390 | # (i.e. any modern browser). Windows users are probably better off using the 1391 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1392 | # further fine-tune the look of the index. As an example, the default style 1393 | # sheet generated by doxygen has an example that shows how to put an image at 1394 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1395 | # the same information as the tab index, you could consider setting 1396 | # DISABLE_INDEX to YES when enabling this option. 1397 | # The default value is: NO. 1398 | # This tag requires that the tag GENERATE_HTML is set to YES. 1399 | 1400 | GENERATE_TREEVIEW = NO 1401 | 1402 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1403 | # doxygen will group on one line in the generated HTML documentation. 1404 | # 1405 | # Note that a value of 0 will completely suppress the enum values from appearing 1406 | # in the overview section. 1407 | # Minimum value: 0, maximum value: 20, default value: 4. 1408 | # This tag requires that the tag GENERATE_HTML is set to YES. 1409 | 1410 | ENUM_VALUES_PER_LINE = 4 1411 | 1412 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1413 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1414 | # Minimum value: 0, maximum value: 1500, default value: 250. 1415 | # This tag requires that the tag GENERATE_HTML is set to YES. 1416 | 1417 | TREEVIEW_WIDTH = 250 1418 | 1419 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1420 | # external symbols imported via tag files in a separate window. 1421 | # The default value is: NO. 1422 | # This tag requires that the tag GENERATE_HTML is set to YES. 1423 | 1424 | EXT_LINKS_IN_WINDOW = NO 1425 | 1426 | # Use this tag to change the font size of LaTeX formulas included as images in 1427 | # the HTML documentation. When you change the font size after a successful 1428 | # doxygen run you need to manually remove any form_*.png images from the HTML 1429 | # output directory to force them to be regenerated. 1430 | # Minimum value: 8, maximum value: 50, default value: 10. 1431 | # This tag requires that the tag GENERATE_HTML is set to YES. 1432 | 1433 | FORMULA_FONTSIZE = 10 1434 | 1435 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1436 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1437 | # supported properly for IE 6.0, but are supported on all modern browsers. 1438 | # 1439 | # Note that when changing this option you need to delete any form_*.png files in 1440 | # the HTML output directory before the changes have effect. 1441 | # The default value is: YES. 1442 | # This tag requires that the tag GENERATE_HTML is set to YES. 1443 | 1444 | FORMULA_TRANSPARENT = YES 1445 | 1446 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1447 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1448 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1449 | # installed or if you want to formulas look prettier in the HTML output. When 1450 | # enabled you may also need to install MathJax separately and configure the path 1451 | # to it using the MATHJAX_RELPATH option. 1452 | # The default value is: NO. 1453 | # This tag requires that the tag GENERATE_HTML is set to YES. 1454 | 1455 | USE_MATHJAX = NO 1456 | 1457 | # When MathJax is enabled you can set the default output format to be used for 1458 | # the MathJax output. See the MathJax site (see: 1459 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1460 | # Possible values are: HTML-CSS (which is slower, but has the best 1461 | # compatibility), NativeMML (i.e. MathML) and SVG. 1462 | # The default value is: HTML-CSS. 1463 | # This tag requires that the tag USE_MATHJAX is set to YES. 1464 | 1465 | MATHJAX_FORMAT = HTML-CSS 1466 | 1467 | # When MathJax is enabled you need to specify the location relative to the HTML 1468 | # output directory using the MATHJAX_RELPATH option. The destination directory 1469 | # should contain the MathJax.js script. For instance, if the mathjax directory 1470 | # is located at the same level as the HTML output directory, then 1471 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1472 | # Content Delivery Network so you can quickly see the result without installing 1473 | # MathJax. However, it is strongly recommended to install a local copy of 1474 | # MathJax from http://www.mathjax.org before deployment. 1475 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1476 | # This tag requires that the tag USE_MATHJAX is set to YES. 1477 | 1478 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1479 | 1480 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1481 | # extension names that should be enabled during MathJax rendering. For example 1482 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1483 | # This tag requires that the tag USE_MATHJAX is set to YES. 1484 | 1485 | MATHJAX_EXTENSIONS = 1486 | 1487 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1488 | # of code that will be used on startup of the MathJax code. See the MathJax site 1489 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1490 | # example see the documentation. 1491 | # This tag requires that the tag USE_MATHJAX is set to YES. 1492 | 1493 | MATHJAX_CODEFILE = 1494 | 1495 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1496 | # the HTML output. The underlying search engine uses javascript and DHTML and 1497 | # should work on any modern browser. Note that when using HTML help 1498 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1499 | # there is already a search function so this one should typically be disabled. 1500 | # For large projects the javascript based search engine can be slow, then 1501 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1502 | # search using the keyboard; to jump to the search box use + S 1503 | # (what the is depends on the OS and browser, but it is typically 1504 | # , /