├── tests ├── main.cpp ├── dummy.cpp └── CMakeLists.txt ├── cmake ├── Doctest.cmake ├── Colors.cmake ├── Misc.cmake ├── Documentation.cmake ├── ConfigSafeGuards.cmake ├── Warnings.cmake ├── CodeCoverage.cmake └── LTO.cmake ├── .gitignore ├── src └── example.cpp ├── include ├── example.h └── exampleConfig.h.in ├── setup.sh ├── appveyor.yml ├── app └── main.cpp ├── .github └── workflows │ └── ci.yml ├── LICENSE ├── .travis.yml ├── CMakeLists.txt ├── README.md └── Doxyfile.in /tests/main.cpp: -------------------------------------------------------------------------------- 1 | #define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN 2 | #include "doctest/doctest.h" 3 | 4 | // This is all that is needed to compile a test-runner executable. 5 | // More tests can be added here, or in a new tests/*.cpp file. 6 | -------------------------------------------------------------------------------- /tests/dummy.cpp: -------------------------------------------------------------------------------- 1 | #include "doctest/doctest.h" 2 | #include "example.h" 3 | 4 | // Tests that don't naturally fit in the headers/.cpp files directly 5 | // can be placed in a tests/*.cpp file. Integration tests are a good example. 6 | 7 | TEST_CASE("complicated integration tests could be here") 8 | { 9 | Dummy d; 10 | CHECK(d.doSomething() == true); 11 | } 12 | -------------------------------------------------------------------------------- /cmake/Doctest.cmake: -------------------------------------------------------------------------------- 1 | if(ENABLE_DOCTESTS) 2 | add_definitions(-DENABLE_DOCTEST_IN_LIBRARY) 3 | include(FetchContent) 4 | FetchContent_Declare( 5 | DocTest 6 | GIT_REPOSITORY "https://github.com/onqtam/doctest" 7 | GIT_TAG "b7c21ec5ceeadb4951b00396fc1e4642dd347e5f" 8 | ) 9 | 10 | FetchContent_MakeAvailable(DocTest) 11 | include_directories(${DOCTEST_INCLUDE_DIR}) 12 | endif() 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Compiled Object files 5 | *.slo 6 | *.lo 7 | *.o 8 | *.obj 9 | 10 | # Precompiled Headers 11 | *.gch 12 | *.pch 13 | 14 | # Compiled Dynamic libraries 15 | *.so 16 | *.dylib 17 | *.dll 18 | 19 | # Fortran module files 20 | *.mod 21 | *.smod 22 | 23 | # Compiled Static libraries 24 | *.lai 25 | *.la 26 | *.a 27 | *.lib 28 | 29 | # Executables 30 | *.exe 31 | *.out 32 | *.app 33 | *.x 34 | 35 | # Build directory 36 | build/ 37 | -------------------------------------------------------------------------------- /src/example.cpp: -------------------------------------------------------------------------------- 1 | #include "example.h" 2 | 3 | Dummy::Dummy() { 4 | 5 | } 6 | 7 | bool Dummy::doSomething() { 8 | // Do silly things, using some C++17 features to enforce C++17 builds only. 9 | constexpr int digits[2] = {0, 1}; 10 | auto [zero, one] = digits; 11 | return zero + one; 12 | } 13 | 14 | 15 | #ifdef ENABLE_DOCTEST_IN_LIBRARY 16 | #include "doctest/doctest.h" 17 | TEST_CASE("we can have tests written here, to test impl. details") 18 | { 19 | CHECK(true); 20 | } 21 | #endif 22 | -------------------------------------------------------------------------------- /include/example.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | /** 4 | * This is a dummy class to demonstrate features of the boiler plate. 5 | */ 6 | class Dummy { 7 | public: 8 | 9 | /** 10 | * Default constructor for Dummy (does nothing). 11 | */ 12 | Dummy(); 13 | /** 14 | * Returns a bool. 15 | * @return Always True. 16 | */ 17 | bool doSomething(); 18 | }; 19 | 20 | 21 | #ifdef ENABLE_DOCTEST_IN_LIBRARY 22 | #include "doctest/doctest.h" 23 | TEST_CASE("we can have tests in headers if we want") 24 | { 25 | Dummy d; 26 | CHECK(d.doSomething() == true); 27 | } 28 | #endif 29 | -------------------------------------------------------------------------------- /setup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Revert to first commit, add and commit everything as single commit. 4 | git reset $(git commit-tree HEAD^{tree} -m "Boiler plate for C++ project added") 5 | 6 | name=$(git config user.name) 7 | email=$(git config user.email) 8 | 9 | # If this script is called with an argument, use that as the amended author 10 | # EX: ./setup.sh "Author Name " 11 | if [[ "$1" ]]; then 12 | git commit --amend --author="$1" 13 | else 14 | git commit --amend --author="$name <$email>" 15 | fi 16 | 17 | # Remove the remote (you probably want your own instead). 18 | git remote remove origin 19 | -------------------------------------------------------------------------------- /include/exampleConfig.h.in: -------------------------------------------------------------------------------- 1 | /* 2 | * This file contains definitions made in CMakeLists.txt 3 | * that we want available in the source code. 4 | * In the source code, include "exampleConfig.h" (no .in suffix). 5 | * This header file will be generated, and filled with the 6 | * right definition values. Change the namings as you wish, 7 | * but make sure they match up with whats in CMakeLists.txt. 8 | */ 9 | #define PROJECT_VERSION_MAJOR @PROJECT_VERSION_MAJOR@ 10 | #define PROJECT_VERSION_MINOR @PROJECT_VERSION_MINOR@ 11 | #define PROJECT_VERSION_PATCH @PROJECT_VERSION_PATCH@ 12 | #define PROJECT_VERSION_TWEAK @PROJECT_VERSION_TWEAK@ 13 | -------------------------------------------------------------------------------- /cmake/Colors.cmake: -------------------------------------------------------------------------------- 1 | IF(NOT WIN32) 2 | string(ASCII 27 Esc) 3 | set(ColorReset "${Esc}[m") 4 | set(ColorBold "${Esc}[1m") 5 | set(Red "${Esc}[31m") 6 | set(Green "${Esc}[32m") 7 | set(Yellow "${Esc}[33m") 8 | set(Blue "${Esc}[34m") 9 | set(Magenta "${Esc}[35m") 10 | set(Cyan "${Esc}[36m") 11 | set(White "${Esc}[37m") 12 | set(BoldRed "${Esc}[1;31m") 13 | set(BoldGreen "${Esc}[1;32m") 14 | set(BoldYellow "${Esc}[1;33m") 15 | set(BoldBlue "${Esc}[1;34m") 16 | set(BoldMagenta "${Esc}[1;35m") 17 | set(BoldCyan "${Esc}[1;36m") 18 | set(BoldWhite "${Esc}[1;37m") 19 | ENDIF() 20 | -------------------------------------------------------------------------------- /cmake/Misc.cmake: -------------------------------------------------------------------------------- 1 | # -------------------------------------------------------------------------------- 2 | # Misc (no change needed). 3 | # -------------------------------------------------------------------------------- 4 | # Have CMake parse the config file, generating the config header, with 5 | # correct definitions. Here only used to make version number available to 6 | # the source code. Include "exampleConfig.h" (no .in suffix) in the source. 7 | configure_file ( 8 | "${PROJECT_SOURCE_DIR}/include/exampleConfig.h.in" 9 | "${PROJECT_BINARY_DIR}/exampleConfig.h" 10 | ) 11 | # add the binary tree to the search path for include files 12 | # so that we will find exampleConfig.h 13 | include_directories("${PROJECT_BINARY_DIR}") 14 | 15 | # Ask CMake to output a compile_commands.json file for use with things like Vim YCM. 16 | set(CMAKE_EXPORT_COMPILE_COMMANDS 1) 17 | -------------------------------------------------------------------------------- /cmake/Documentation.cmake: -------------------------------------------------------------------------------- 1 | # -------------------------------------------------------------------------------- 2 | # Documentation (no change needed). 3 | # -------------------------------------------------------------------------------- 4 | # Add a make target 'doc' to generate API documentation with Doxygen. 5 | # You should set options to your liking in the file 'Doxyfile.in'. 6 | find_package(Doxygen) 7 | if(DOXYGEN_FOUND) 8 | configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) 9 | add_custom_target(doc 10 | ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile &> doxygen.log 11 | WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} 12 | COMMENT "${BoldMagenta}Generating API documentation with Doxygen (open ./html/index.html to view).${ColourReset}" VERBATIM 13 | ) 14 | endif(DOXYGEN_FOUND) 15 | 16 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | #---------------------------------# 2 | # environment configuration # 3 | #---------------------------------# 4 | 5 | # Build worker image (VM template) 6 | image: Visual Studio 2017 7 | 8 | clone_depth: 3 9 | 10 | platform: 11 | - Win32 12 | - x64 13 | 14 | configuration: 15 | - Debug 16 | - Release 17 | 18 | # environment: 19 | # matrix: 20 | # - TOOLSET: v140 21 | 22 | matrix: 23 | fast_finish: false 24 | 25 | # scripts that are called at very beginning, before repo cloning 26 | init: 27 | - cmd: cmake --version 28 | - cmd: msbuild /version 29 | 30 | before_build: 31 | - cmake . -Bbuild -A%PLATFORM% -DCMAKE_BUILD_TYPE=%configuration% 32 | 33 | build: 34 | project: build/CPP_BOILERPLATE.sln 35 | parallel: true 36 | verbosity: minimal 37 | 38 | test_script: 39 | - cd build 40 | - set CTEST_OUTPUT_ON_FAILURE=1 41 | - ctest -C %configuration% 42 | - cd .. 43 | -------------------------------------------------------------------------------- /cmake/ConfigSafeGuards.cmake: -------------------------------------------------------------------------------- 1 | # guard against in-source builds 2 | if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR}) 3 | message(FATAL_ERROR "In-source builds not allowed. Please make a new directory (called a build directory) and run CMake from there.") 4 | endif() 5 | 6 | # guard against bad build-type strings 7 | if (NOT CMAKE_BUILD_TYPE) 8 | message(STATUS "No build type selected, default to Debug") 9 | set(CMAKE_BUILD_TYPE "Debug") 10 | endif() 11 | 12 | string(TOLOWER "${CMAKE_BUILD_TYPE}" cmake_build_type_tolower) 13 | string(TOUPPER "${CMAKE_BUILD_TYPE}" cmake_build_type_toupper) 14 | if( NOT cmake_build_type_tolower STREQUAL "debug" 15 | AND NOT cmake_build_type_tolower STREQUAL "release" 16 | AND NOT cmake_build_type_tolower STREQUAL "profile" 17 | AND NOT cmake_build_type_tolower STREQUAL "relwithdebinfo" 18 | AND NOT cmake_build_type_tolower STREQUAL "coverage") 19 | message(FATAL_ERROR "Unknown build type \"${CMAKE_BUILD_TYPE}\". Allowed values are Debug, Coverage, Release, Profile, RelWithDebInfo (case-insensitive).") 20 | endif() 21 | -------------------------------------------------------------------------------- /app/main.cpp: -------------------------------------------------------------------------------- 1 | // Executables must have the following defined if the library contains 2 | // doctest definitions. For builds with this disabled, e.g. code shipped to 3 | // users, this can be left out. 4 | #ifdef ENABLE_DOCTEST_IN_LIBRARY 5 | #define DOCTEST_CONFIG_IMPLEMENT 6 | #include "doctest/doctest.h" 7 | #endif 8 | 9 | #include 10 | #include 11 | 12 | #include "exampleConfig.h" 13 | #include "example.h" 14 | 15 | /* 16 | * Simple main program that demontrates how access 17 | * CMake definitions (here the version number) from source code. 18 | */ 19 | int main() { 20 | std::cout << "C++ Boiler Plate v" 21 | << PROJECT_VERSION_MAJOR 22 | << "." 23 | << PROJECT_VERSION_MINOR 24 | << "." 25 | << PROJECT_VERSION_PATCH 26 | << "." 27 | << PROJECT_VERSION_TWEAK 28 | << std::endl; 29 | std::system("cat ../LICENSE"); 30 | 31 | // Bring in the dummy class from the example source, 32 | // just to show that it is accessible from main.cpp. 33 | Dummy d = Dummy(); 34 | return d.doSomething() ? 0 : -1; 35 | } 36 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | pull_request: 6 | 7 | jobs: 8 | build-and-test: 9 | 10 | name: ${{ matrix.toolchain }} 11 | runs-on: ${{ matrix.os }} 12 | 13 | strategy: 14 | matrix: 15 | toolchain: 16 | - linux-gcc 17 | - macos-clang 18 | - windows-msvc 19 | 20 | configuration: 21 | - Debug 22 | 23 | include: 24 | - toolchain: linux-gcc 25 | os: ubuntu-latest 26 | compiler: gcc 27 | 28 | - toolchain: macos-clang 29 | os: macos-latest 30 | compiler: clang 31 | 32 | - toolchain: windows-msvc 33 | os: windows-latest 34 | compiler: msvc 35 | 36 | steps: 37 | - name: Checkout Code 38 | uses: actions/checkout@v2 39 | 40 | - name: Configure (${{ matrix.configuration }}) 41 | run: cmake -S . -Bbuild -DCMAKE_BUILD_TYPE=${{ matrix.configuration }} 42 | 43 | - name: Build with ${{ matrix.compiler }} 44 | run: cmake --build build --config ${{ matrix.configuration }} 45 | 46 | - name: Test 47 | working-directory: build 48 | env: 49 | CTEST_OUTPUT_ON_FAILURE: 1 50 | run: ctest -C ${{ matrix.configuration }} 51 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This is free and unencumbered software released into the public domain. 2 | 3 | Anyone is free to copy, modify, publish, use, compile, sell, or 4 | distribute this software, either in source code form or as a compiled 5 | binary, for any purpose, commercial or non-commercial, and by any 6 | means. 7 | 8 | In jurisdictions that recognize copyright laws, the author or authors 9 | of this software dedicate any and all copyright interest in the 10 | software to the public domain. We make this dedication for the benefit 11 | of the public at large and to the detriment of our heirs and 12 | successors. We intend this dedication to be an overt act of 13 | relinquishment in perpetuity of all present and future rights to this 14 | software under copyright law. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 19 | IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR 20 | OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 21 | ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 22 | OTHER DEALINGS IN THE SOFTWARE. 23 | 24 | For more information, please refer to 25 | -------------------------------------------------------------------------------- /tests/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.14) 2 | 3 | # List all files containing tests. (Change as needed) 4 | set(TESTFILES # All .cpp files in tests/ 5 | main.cpp 6 | dummy.cpp 7 | ) 8 | 9 | set(TEST_MAIN unit_tests) # Default name for test executable (change if you wish). 10 | set(TEST_RUNNER_PARAMS "") # Any arguemnts to feed the test runner (change as needed). 11 | 12 | # -------------------------------------------------------------------------------- 13 | # Make Tests (no change needed). 14 | # -------------------------------------------------------------------------------- 15 | add_executable(${TEST_MAIN} ${TESTFILES}) 16 | target_link_libraries(${TEST_MAIN} PRIVATE ${LIBRARY_NAME} doctest) 17 | set_target_properties(${TEST_MAIN} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}) 18 | target_set_warnings(${TEST_MAIN} ENABLE ALL AS_ERROR ALL DISABLE Annoying) # Set warnings (if needed). 19 | 20 | set_target_properties(${TEST_MAIN} PROPERTIES 21 | CXX_STANDARD 17 22 | CXX_STANDARD_REQUIRED YES 23 | CXX_EXTENSIONS NO 24 | ) 25 | 26 | add_test( 27 | # Use some per-module/project prefix so that it is easier to run only tests for this module 28 | NAME ${LIBRARY_NAME}.${TEST_MAIN} 29 | COMMAND ${TEST_MAIN} ${TEST_RUNNER_PARAMS}) 30 | 31 | # Adds a 'coverage' target. 32 | include(CodeCoverage) 33 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: cpp 2 | dist: xenial 3 | notifications: 4 | email: false 5 | 6 | # Define builds on mulitple OS/compiler combinations. 7 | # Feel free to add/remove entries from this list. 8 | matrix: 9 | include: 10 | - os: linux 11 | addons: 12 | apt: 13 | sources: 14 | - ubuntu-toolchain-r-test 15 | packages: 16 | - lcov 17 | - g++-7 18 | env: 19 | - MATRIX_EVAL="CXX_COMPILER=g++-7; sudo update-alternatives --install /usr/bin/gcov gcov /usr/bin/gcov-7 90" 20 | 21 | - os: osx 22 | osx_image: xcode10.1 23 | addons: 24 | homebrew: 25 | packages: 26 | - lcov 27 | update: true 28 | 29 | env: 30 | - MATRIX_EVAL="CXX_COMPILER=clang++" 31 | 32 | 33 | before_install: 34 | - eval "${MATRIX_EVAL}" 35 | - PARENTDIR=$(pwd) 36 | - mkdir $PARENTDIR/build 37 | 38 | install: 39 | - cd $PARENTDIR/build 40 | - cmake $PARENTDIR -DCMAKE_BUILD_TYPE=Coverage -DCMAKE_CXX_COMPILER=$CXX_COMPILER 41 | - make 42 | 43 | script: 44 | - make coverage 45 | 46 | after_success: 47 | - cd $PARENTDIR/build 48 | - lcov --list coverage_out.info.cleaned # Show test report in travis log. 49 | # Install coverals gem for uploading coverage to coveralls. 50 | - gem install coveralls-lcov 51 | - coveralls-lcov coverage_out.info.cleaned # uploads to coveralls 52 | - bash <(curl -s https://codecov.io/bash) -f coverage_out.info.cleaned || echo "Codecov did not collect coverage reports" 53 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # This file specifies how the project should be built, using CMake. 2 | # If you are unfamiliar with CMake, don't worry about all the details. 3 | # The sections you might want to edit are marked as such, and 4 | # the comments should hopefully make most of it clear. 5 | # 6 | # For many purposes, you may not need to change anything about this file. 7 | 8 | cmake_minimum_required(VERSION 3.14) 9 | 10 | # Set project name, version and laguages here. (change as needed) 11 | # Version numbers are available by including "exampleConfig.h" in 12 | # the source. See exampleConfig.h.in for some more details. 13 | project(CPP_BOILERPLATE VERSION 1.2.3.4 LANGUAGES CXX) 14 | 15 | 16 | # Options: Things you can set via commandline options to cmake (e.g. -DENABLE_LTO=[ON|OFF]) 17 | option(ENABLE_WARNINGS_SETTINGS "Allow target_set_warnings to add flags and defines. 18 | Set this to OFF if you want to provide your own warning parameters." ON) 19 | option(ENABLE_LTO "Enable link time optimization" ON) 20 | option(ENABLE_DOCTESTS "Include tests in the library. Setting this to OFF will remove all doctest related code. 21 | Tests in tests/*.cpp will still be enabled." ON) 22 | 23 | # Include stuff. No change needed. 24 | set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/") 25 | include(ConfigSafeGuards) 26 | include(Colors) 27 | include(CTest) 28 | include(Doctest) 29 | include(Documentation) 30 | include(LTO) 31 | include(Misc) 32 | include(Warnings) 33 | 34 | # Check for LTO support. 35 | find_lto(CXX) 36 | 37 | # -------------------------------------------------------------------------------- 38 | # Locate files (change as needed). 39 | # -------------------------------------------------------------------------------- 40 | set(SOURCES # All .cpp files in src/ 41 | src/example.cpp 42 | ) 43 | set(TESTFILES # All .cpp files in tests/ 44 | tests/main.cpp 45 | ) 46 | set(LIBRARY_NAME engine) # Default name for the library built from src/*.cpp (change if you wish) 47 | 48 | # -------------------------------------------------------------------------------- 49 | # Build! (Change as needed) 50 | # -------------------------------------------------------------------------------- 51 | # Compile all sources into a library. 52 | add_library(${LIBRARY_NAME} OBJECT ${SOURCES}) 53 | 54 | # Lib needs its header files, and users of the library must also see these (PUBLIC). (No change needed) 55 | target_include_directories(${LIBRARY_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include) 56 | 57 | # There's also (probably) doctests within the library, so we need to see this as well. 58 | target_link_libraries(${LIBRARY_NAME} PUBLIC doctest) 59 | 60 | # Set the compile options you want (change as needed). 61 | target_set_warnings(${LIBRARY_NAME} ENABLE ALL AS_ERROR ALL DISABLE Annoying) 62 | # target_compile_options(${LIBRARY_NAME} ... ) # For setting manually. 63 | 64 | # Add an executable for the file app/main.cpp. 65 | # If you add more executables, copy these lines accordingly. 66 | add_executable(main app/main.cpp) # Name of exec. and location of file. 67 | target_link_libraries(main PRIVATE ${LIBRARY_NAME}) # Link the executable to library (if it uses it). 68 | target_set_warnings(main ENABLE ALL AS_ERROR ALL DISABLE Annoying) # Set warnings (if needed). 69 | target_enable_lto(main optimized) # enable link-time-optimization if available for non-debug configurations 70 | 71 | # Set the properties you require, e.g. what C++ standard to use. Here applied to library and main (change as needed). 72 | set_target_properties( 73 | ${LIBRARY_NAME} main 74 | PROPERTIES 75 | CXX_STANDARD 17 76 | CXX_STANDARD_REQUIRED YES 77 | CXX_EXTENSIONS NO 78 | ) 79 | 80 | # Set up tests (see tests/CMakeLists.txt). 81 | add_subdirectory(tests) 82 | -------------------------------------------------------------------------------- /cmake/Warnings.cmake: -------------------------------------------------------------------------------- 1 | # MIT License 2 | 3 | # Copyright (c) 2017 Lectem 4 | 5 | # Permission is hereby granted, free of charge, to any person obtaining a copy 6 | # of this software and associated documentation files (the "Software"), to deal 7 | # in the Software without restriction, including without limitation the rights 8 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | # copies of the Software, and to permit persons to whom the Software is 10 | # furnished to do so, subject to the following conditions: 11 | 12 | # The above copyright notice and this permission notice shall be included in all 13 | # copies or substantial portions of the Software. 14 | 15 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | # SOFTWARE. 22 | 23 | 24 | function(target_set_warnings) 25 | if(NOT ENABLE_WARNINGS_SETTINGS) 26 | return() 27 | endif() 28 | if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC") 29 | set(WMSVC TRUE) 30 | elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") 31 | set(WGCC TRUE) 32 | elseif ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 33 | set(WCLANG TRUE) 34 | endif() 35 | set(multiValueArgs ENABLE DISABLE AS_ERROR) 36 | cmake_parse_arguments(this "" "" "${multiValueArgs}" ${ARGN}) 37 | list(FIND this_ENABLE "ALL" enable_all) 38 | list(FIND this_DISABLE "ALL" disable_all) 39 | list(FIND this_AS_ERROR "ALL" as_error_all) 40 | if(NOT ${enable_all} EQUAL -1) 41 | if(WMSVC) 42 | # Not all the warnings, but WAll is unusable when using libraries 43 | # Unless you'd like to support MSVC in the code with pragmas, this is probably the best option 44 | list(APPEND WarningFlags "/W4") 45 | elseif(WGCC) 46 | list(APPEND WarningFlags "-Wall" "-Wextra" "-Wpedantic") 47 | elseif(WCLANG) 48 | list(APPEND WarningFlags "-Wall" "-Weverything" "-Wpedantic") 49 | endif() 50 | elseif(NOT ${disable_all} EQUAL -1) 51 | set(SystemIncludes TRUE) # Treat includes as if coming from system 52 | if(WMSVC) 53 | list(APPEND WarningFlags "/w" "/W0") 54 | elseif(WGCC OR WCLANG) 55 | list(APPEND WarningFlags "-w") 56 | endif() 57 | endif() 58 | 59 | list(FIND this_DISABLE "Annoying" disable_annoying) 60 | if(NOT ${disable_annoying} EQUAL -1) 61 | if(WMSVC) 62 | # bounds-checked functions require to set __STDC_WANT_LIB_EXT1__ which we usually don't need/want 63 | list(APPEND WarningDefinitions -D_CRT_SECURE_NO_WARNINGS) 64 | # disable C4514 C4710 C4711... Those are useless to add most of the time 65 | #list(APPEND WarningFlags "/wd4514" "/wd4710" "/wd4711") 66 | #list(APPEND WarningFlags "/wd4365") #signed/unsigned mismatch 67 | #list(APPEND WarningFlags "/wd4668") # is not defined as a preprocessor macro, replacing with '0' for 68 | elseif(WGCC OR WCLANG) 69 | list(APPEND WarningFlags -Wno-switch-enum) 70 | if(WCLANG) 71 | list(APPEND WarningFlags -Wno-unknown-warning-option -Wno-padded -Wno-undef -Wno-reserved-id-macro -fcomment-block-commands=test,retval) 72 | if(NOT CMAKE_CXX_STANDARD EQUAL 98) 73 | list(APPEND WarningFlags -Wno-c++98-compat -Wno-c++98-compat-pedantic) 74 | endif() 75 | if ("${CMAKE_CXX_SIMULATE_ID}" STREQUAL "MSVC") # clang-cl has some VCC flags by default that it will not recognize... 76 | list(APPEND WarningFlags -Wno-unused-command-line-argument) 77 | endif() 78 | endif(WCLANG) 79 | endif() 80 | endif() 81 | 82 | if(NOT ${as_error_all} EQUAL -1) 83 | if(WMSVC) 84 | list(APPEND WarningFlags "/WX") 85 | elseif(WGCC OR WCLANG) 86 | list(APPEND WarningFlags "-Werror") 87 | endif() 88 | endif() 89 | foreach(target IN LISTS this_UNPARSED_ARGUMENTS) 90 | if(WarningFlags) 91 | target_compile_options(${target} PRIVATE ${WarningFlags}) 92 | endif() 93 | if(WarningDefinitions) 94 | target_compile_definitions(${target} PRIVATE ${WarningDefinitions}) 95 | endif() 96 | if(SystemIncludes) 97 | set_target_properties(${target} PROPERTIES 98 | INTERFACE_SYSTEM_INCLUDE_DIRECTORIES $) 99 | endif() 100 | endforeach() 101 | endfunction(target_set_warnings) 102 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) 2 | [![Build Status](https://travis-ci.org/bsamseth/cpp-project.svg?branch=master)](https://travis-ci.org/bsamseth/cpp-project) 3 | [![Build status](https://ci.appveyor.com/api/projects/status/g9bh9kjl6ocvsvse/branch/master?svg=true)](https://ci.appveyor.com/project/bsamseth/cpp-project/branch/master) 4 | [![Coverage Status](https://coveralls.io/repos/github/bsamseth/cpp-project/badge.svg?branch=master)](https://coveralls.io/github/bsamseth/cpp-project?branch=master) 5 | [![codecov](https://codecov.io/gh/bsamseth/cpp-project/branch/master/graph/badge.svg)](https://codecov.io/gh/bsamseth/cpp-project) 6 | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/eb004322b0d146239a57eb242078e179)](https://www.codacy.com/app/bsamseth/cpp-project?utm_source=github.com&utm_medium=referral&utm_content=bsamseth/cpp-project&utm_campaign=Badge_Grade) 7 | [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/bsamseth/cpp-project.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bsamseth/cpp-project/context:cpp) 8 | [![Total alerts](https://img.shields.io/lgtm/alerts/g/bsamseth/cpp-project.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bsamseth/cpp-project/alerts/) 9 | [![license](https://img.shields.io/badge/license-Unlicense-blue.svg)](https://github.com/bsamseth/cpp-project/blob/master/LICENSE) 10 | [![Lines of Code](https://tokei.rs/b1/github/bsamseth/cpp-project)](https://github.com/Aaronepower/tokei) 11 | [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/bsamseth/cpp-project.svg)](http://isitmaintained.com/project/bsamseth/cpp-project "Average time to resolve an issue") 12 | [![Percentage of issues still open](http://isitmaintained.com/badge/open/bsamseth/cpp-project.svg)](http://isitmaintained.com/project/bsamseth/cpp-project "Percentage of issues still open") 13 | 14 | # Boiler plate for C++ projects 15 | 16 | This is a boiler plate for C++ projects. What you get: 17 | 18 | - Sources, headers and mains separated in distinct folders 19 | - Use of modern [CMake](https://cmake.org/) for much easier compiling 20 | - Setup for tests using [doctest](https://github.com/onqtam/doctest) 21 | - Continuous testing with [Travis-CI](https://travis-ci.org/), [Appveyor](https://www.appveyor.com) and [GitHub Actions](https://github.com/features/actions), with support for C++17. 22 | - Code coverage reports, including automatic upload to [Coveralls.io](https://coveralls.io/) and/or [Codecov.io](https://codecov.io) 23 | - Code documentation with [Doxygen](http://www.stack.nl/~dimitri/doxygen/) 24 | 25 | ![Demo of usage](https://i.imgur.com/foymVfy.gif) 26 | 27 | ## Structure 28 | ``` text 29 | . 30 | ├── CMakeLists.txt 31 | ├── app 32 | │   └── main.cpp 33 | ├── include 34 | │   ├── example.h 35 | │   └── exampleConfig.h.in 36 | ├── src 37 | │   └── example.cpp 38 | └── tests 39 | ├── dummy.cpp 40 | └── main.cpp 41 | ``` 42 | 43 | Sources go in [src/](src/), header files in [include/](include/), main programs in [app/](app), and 44 | tests go in [tests/](tests/) (compiled to `unit_tests` by default). 45 | 46 | If you add a new executable, say `app/hello.cpp`, you only need to add the following two lines to [CMakeLists.txt](CMakeLists.txt): 47 | 48 | ```cmake 49 | add_executable(main app/main.cpp) # Name of exec. and location of file. 50 | target_link_libraries(main PRIVATE ${LIBRARY_NAME}) # Link the executable to lib built from src/*.cpp (if it uses it). 51 | ``` 52 | 53 | You can find the example source code that builds the `main` executable in [app/main.cpp](app/main.cpp) under the `Build` section in [CMakeLists.txt](CMakeLists.txt). 54 | If the executable you made does not use the library in [src/](src), then only the first line is needed. 55 | 56 | 57 | 58 | ## Building 59 | 60 | Build by making a build directory (i.e. `build/`), run `cmake` in that dir, and then use `make` to build the desired target. 61 | 62 | Example: 63 | 64 | ```bash 65 | mkdir build && cd build 66 | cmake .. -DCMAKE_BUILD_TYPE=[Debug | Coverage | Release] 67 | make 68 | ./main 69 | make test # Makes and runs the tests. 70 | make coverage # Generate a coverage report. 71 | make doc # Generate html documentation. 72 | ``` 73 | 74 | ## .gitignore 75 | 76 | The [.gitignore](.gitignore) file is a copy of the [Github C++.gitignore file](https://github.com/github/gitignore/blob/master/C%2B%2B.gitignore), 77 | with the addition of ignoring the build directory (`build/`). 78 | 79 | ## Services 80 | 81 | If the repository is activated with Travis-CI, then unit tests will be built and executed on each commit. 82 | The same is true if the repository is activated with Appveyor. 83 | 84 | If the repository is activated with Coveralls/Codecov, then deployment to Travis will also calculate code coverage and 85 | upload this to Coveralls.io and/or Codecov.io 86 | 87 | ## Setup 88 | 89 | ### Using the GitHub template 90 | Click the `Use this template` button to make a new repository from this template. 91 | 92 | ### From command line 93 | When starting a new project, you probably don't want the history of this repository. To start fresh you can use 94 | the [setup script](setup.sh) as follows: 95 | ```bash 96 | git clone https://github.com/bsamseth/cpp-project # Or use ssh-link if you like. 97 | cd cpp-project 98 | bash setup.sh 99 | ``` 100 | The result is a fresh Git repository with one commit adding all files from the boiler plate. 101 | -------------------------------------------------------------------------------- /cmake/CodeCoverage.cmake: -------------------------------------------------------------------------------- 1 | # 2012-01-31, Lars Bilke 2 | # - Enable Code Coverage 3 | # 4 | # 2013-09-17, Joakim Söderberg 5 | # - Added support for Clang. 6 | # - Some additional usage instructions. 7 | # 8 | # 2018-03-31, Bendik Samseth 9 | # - Relax debug output. 10 | # - Keep a copy of the coverage output for later use. 11 | # - Updated coverage exclude patterns. 12 | # 13 | # 2018-01-03, HenryRLee 14 | # - Allow for *Clang compiler names, not just Clang. 15 | # 16 | # 2018-01-03, Bendik Samseth 17 | # - Only check compiler compatibility if in a coverage build. 18 | 19 | # USAGE: 20 | # 21 | # 0. (Mac only) If you use Xcode 5.1 make sure to patch geninfo as described here: 22 | # http://stackoverflow.com/a/22404544/80480 23 | # 24 | # 1. Copy this file into your cmake modules path. 25 | # 26 | # 2. Add the following line to your CMakeLists.txt: 27 | # include(CodeCoverage) 28 | # 29 | # 3. Set compiler flags to turn off optimization and enable coverage: 30 | # set(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") 31 | # set(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") 32 | # 33 | # 3. Use the function setup_target_for_coverage to create a custom make target 34 | # which runs your test executable and produces a lcov code coverage report: 35 | # Example: 36 | # setup_target_for_coverage( 37 | # my_coverage_target # Name for custom target. 38 | # test_driver # Name of the test driver executable that runs the tests. 39 | # # NOTE! This should always have a ZERO as exit code 40 | # # otherwise the coverage generation will not complete. 41 | # coverage # Name of output directory. 42 | # ) 43 | # 44 | # 4. Build a Debug build: 45 | # cmake -DCMAKE_BUILD_TYPE=Debug .. 46 | # make 47 | # make my_coverage_target 48 | 49 | # Param _targetname The name of new the custom make target 50 | # Param _testrunner The name of the target which runs the tests. 51 | # MUST return ZERO always, even on errors. 52 | # If not, no coverage report will be created! 53 | # Param _outputname lcov output is generated as _outputname.info 54 | # HTML report is generated in _outputname/index.html 55 | # Optional fourth parameter is passed as arguments to _testrunner 56 | # Pass them in list form, e.g.: "-j;2" for -j 2 57 | function(setup_target_for_coverage _targetname _testrunner _outputname) 58 | 59 | if(NOT LCOV_PATH) 60 | message(FATAL_ERROR "lcov not found! Aborting...") 61 | endif() # NOT LCOV_PATH 62 | 63 | if(NOT GENHTML_PATH) 64 | message(FATAL_ERROR "genhtml not found! Aborting...") 65 | endif() # NOT GENHTML_PATH 66 | 67 | # Setup target 68 | add_custom_target(${_targetname} 69 | 70 | # Cleanup lcov 71 | ${LCOV_PATH} --directory . --zerocounters 72 | 73 | # Run tests 74 | COMMAND ${_testrunner} ${ARGV3} 75 | 76 | # Capturing lcov counters and generating report 77 | COMMAND ${LCOV_PATH} --directory . --capture --output-file ${_outputname}.info 78 | 79 | COMMAND ${LCOV_PATH} --remove ${_outputname}.info '*/tests/*' '/usr/*' '*/external/*' '*/3rd/*' '/Applications/*' --output-file ${_outputname}.info.cleaned 80 | COMMAND ${GENHTML_PATH} -o ${_outputname} ${_outputname}.info.cleaned 81 | COMMAND ${LCOV_PATH} --list ${_outputname}.info.cleaned 82 | 83 | WORKING_DIRECTORY ${CMAKE_BINARY_DIR} 84 | COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report." 85 | ) 86 | 87 | # Show info where to find the report 88 | add_custom_command(TARGET ${_targetname} POST_BUILD 89 | COMMAND ; 90 | COMMENT "${BoldMagenta}Open ./${_outputname}/index.html in your browser to view the coverage report.${ColourReset}" 91 | ) 92 | 93 | endfunction() # setup_target_for_coverage 94 | 95 | 96 | string(TOLOWER "${CMAKE_BUILD_TYPE}" cmake_build_type_tolower) 97 | if (cmake_build_type_tolower STREQUAL "coverage") 98 | 99 | 100 | # Check prereqs 101 | find_program(GCOV_PATH gcov) 102 | find_program(LCOV_PATH lcov) 103 | find_program(GENHTML_PATH genhtml) 104 | find_program(GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/tests) 105 | 106 | if(NOT GCOV_PATH) 107 | message(FATAL_ERROR "gcov not found! Aborting...") 108 | endif() # NOT GCOV_PATH 109 | 110 | if(NOT CMAKE_COMPILER_IS_GNUCXX) 111 | if(NOT "${CMAKE_CXX_COMPILER_ID}" MATCHES ".*Clang") 112 | message(FATAL_ERROR "Compiler is not GNU gcc or Clang! Aborting...") 113 | endif() 114 | endif() # NOT CMAKE_COMPILER_IS_GNUCXX 115 | 116 | SET(CMAKE_CXX_FLAGS_COVERAGE 117 | "-g -O0 -fprofile-arcs -ftest-coverage" 118 | CACHE STRING "Flags used by the C++ compiler during coverage builds." 119 | FORCE ) 120 | SET(CMAKE_C_FLAGS_COVERAGE 121 | "-g -O0 -fprofile-arcs -ftest-coverage" 122 | CACHE STRING "Flags used by the C compiler during coverage builds." 123 | FORCE ) 124 | SET(CMAKE_EXE_LINKER_FLAGS_COVERAGE 125 | "" 126 | CACHE STRING "Flags used for linking binaries during coverage builds." 127 | FORCE ) 128 | SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE 129 | "" 130 | CACHE STRING "Flags used by the shared libraries linker during coverage builds." 131 | FORCE ) 132 | mark_as_advanced( 133 | CMAKE_CXX_FLAGS_COVERAGE 134 | CMAKE_C_FLAGS_COVERAGE 135 | CMAKE_EXE_LINKER_FLAGS_COVERAGE 136 | CMAKE_SHARED_LINKER_FLAGS_COVERAGE ) 137 | 138 | 139 | # If unwanted files are included in the coverage reports, you can 140 | # adjust the exclude patterns on line 83. 141 | setup_target_for_coverage( 142 | coverage # Name for custom target. 143 | ${TEST_MAIN} # Name of the test driver executable that runs the tests. 144 | # NOTE! This should always have a ZERO as exit code 145 | # otherwise the coverage generation will not complete. 146 | coverage_out # Name of output directory. 147 | ) 148 | else() 149 | add_custom_target(coverage 150 | COMMAND echo "${Red}Code coverage only available in coverage builds." 151 | COMMAND echo "${Green}Make a new build directory and rerun cmake with -DCMAKE_BUILD_TYPE=Coverage to enable this target.${ColorReset}" 152 | ) 153 | endif() 154 | 155 | -------------------------------------------------------------------------------- /cmake/LTO.cmake: -------------------------------------------------------------------------------- 1 | # Usage : 2 | # 3 | # Variable : ENABLE_LTO | Enable or disable LTO support for this build 4 | # 5 | # find_lto(lang) 6 | # - lang is C or CXX (the language to test LTO for) 7 | # - call it after project() so that the compiler is already detected 8 | # 9 | # This will check for LTO support and create a target_enable_lto(target [debug,optimized,general]) macro. 10 | # The 2nd parameter has the same meaning as in target_link_libraries, and is used to enable LTO only for those build configurations 11 | # 'debug' is by default the Debug configuration, and 'optimized' all the other configurations 12 | # 13 | # if ENABLE_LTO is set to false, an empty macro will be generated 14 | # 15 | # Then to enable LTO for your target use 16 | # 17 | # target_enable_lto(mytarget general) 18 | # 19 | # It is however recommended to use it only for non debug builds the following way : 20 | # 21 | # target_enable_lto(mytarget optimized) 22 | # 23 | # Note : For CMake versions < 3.9, target_link_library is used in it's non plain version. 24 | # You will need to specify PUBLIC/PRIVATE/INTERFACE to all your other target_link_library calls for the target 25 | # 26 | # WARNING for cmake versions older than 3.9 : 27 | # This module will override CMAKE_AR CMAKE_RANLIB and CMAKE_NM by the gcc versions if found when building with gcc 28 | 29 | 30 | # License: 31 | # 32 | # Copyright (C) 2016 Lectem 33 | # 34 | # Permission is hereby granted, free of charge, to any person 35 | # obtaining a copy of this software and associated documentation files 36 | # (the 'Software') deal in the Software without restriction, 37 | # including without limitation the rights to use, copy, modify, merge, 38 | # publish, distribute, sublicense, and/or sell copies of the Software, 39 | # and to permit persons to whom the Software is furnished to do so, 40 | # subject to the following conditions: 41 | # 42 | # The above copyright notice and this permission notice shall be 43 | # included in all copies or substantial portions of the Software. 44 | # 45 | # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, 46 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 47 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 48 | # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 49 | # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 50 | # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 51 | # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 52 | # SOFTWARE. 53 | 54 | 55 | macro(find_lto lang) 56 | if(ENABLE_LTO AND NOT LTO_${lang}_CHECKED) 57 | 58 | #LTO support was added for clang/gcc in 3.9 59 | if(${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION} VERSION_LESS 3.9) 60 | cmake_policy(SET CMP0054 NEW) 61 | message(STATUS "Checking for LTO Compatibility") 62 | # Since GCC 4.9 we need to use gcc-ar / gcc-ranlib / gcc-nm 63 | if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") 64 | if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND NOT CMAKE_GCC_AR OR NOT CMAKE_GCC_RANLIB OR NOT CMAKE_GCC_NM) 65 | find_program(CMAKE_GCC_AR NAMES 66 | "${_CMAKE_TOOLCHAIN_PREFIX}gcc-ar" 67 | "${_CMAKE_TOOLCHAIN_PREFIX}gcc-ar-${_version}" 68 | DOC "gcc provided wrapper for ar which adds the --plugin option" 69 | ) 70 | find_program(CMAKE_GCC_RANLIB NAMES 71 | "${_CMAKE_TOOLCHAIN_PREFIX}gcc-ranlib" 72 | "${_CMAKE_TOOLCHAIN_PREFIX}gcc-ranlib-${_version}" 73 | DOC "gcc provided wrapper for ranlib which adds the --plugin option" 74 | ) 75 | # Not needed, but at least stay coherent 76 | find_program(CMAKE_GCC_NM NAMES 77 | "${_CMAKE_TOOLCHAIN_PREFIX}gcc-nm" 78 | "${_CMAKE_TOOLCHAIN_PREFIX}gcc-nm-${_version}" 79 | DOC "gcc provided wrapper for nm which adds the --plugin option" 80 | ) 81 | mark_as_advanced(CMAKE_GCC_AR CMAKE_GCC_RANLIB CMAKE_GCC_NM) 82 | set(CMAKE_LTO_AR ${CMAKE_GCC_AR}) 83 | set(CMAKE_LTO_RANLIB ${CMAKE_GCC_RANLIB}) 84 | set(CMAKE_LTO_NM ${CMAKE_GCC_NM}) 85 | endif() 86 | if("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 87 | set(CMAKE_LTO_AR ${CMAKE_AR}) 88 | set(CMAKE_LTO_RANLIB ${CMAKE_RANLIB}) 89 | set(CMAKE_LTO_NM ${CMAKE_NM}) 90 | endif() 91 | 92 | if(CMAKE_LTO_AR AND CMAKE_LTO_RANLIB) 93 | set(__lto_flags -flto) 94 | 95 | if(NOT CMAKE_${lang}_COMPILER_VERSION VERSION_LESS 4.7) 96 | list(APPEND __lto_flags -fno-fat-lto-objects) 97 | endif() 98 | 99 | if(NOT DEFINED CMAKE_${lang}_PASSED_LTO_TEST) 100 | set(__output_dir "${CMAKE_PLATFORM_INFO_DIR}/LtoTest1${lang}") 101 | file(MAKE_DIRECTORY "${__output_dir}") 102 | set(__output_base "${__output_dir}/lto-test-${lang}") 103 | 104 | execute_process( 105 | COMMAND ${CMAKE_COMMAND} -E echo "void foo() {}" 106 | COMMAND ${CMAKE_${lang}_COMPILER} ${__lto_flags} -c -xc - 107 | -o "${__output_base}.o" 108 | RESULT_VARIABLE __result 109 | ERROR_QUIET 110 | OUTPUT_QUIET 111 | ) 112 | 113 | if("${__result}" STREQUAL "0") 114 | execute_process( 115 | COMMAND ${CMAKE_LTO_AR} cr "${__output_base}.a" "${__output_base}.o" 116 | RESULT_VARIABLE __result 117 | ERROR_QUIET 118 | OUTPUT_QUIET 119 | ) 120 | endif() 121 | 122 | if("${__result}" STREQUAL "0") 123 | execute_process( 124 | COMMAND ${CMAKE_LTO_RANLIB} "${__output_base}.a" 125 | RESULT_VARIABLE __result 126 | ERROR_QUIET 127 | OUTPUT_QUIET 128 | ) 129 | endif() 130 | 131 | if("${__result}" STREQUAL "0") 132 | execute_process( 133 | COMMAND ${CMAKE_COMMAND} -E echo "void foo(); int main() {foo();}" 134 | COMMAND ${CMAKE_${lang}_COMPILER} ${__lto_flags} -xc - 135 | -x none "${__output_base}.a" -o "${__output_base}" 136 | RESULT_VARIABLE __result 137 | ERROR_QUIET 138 | OUTPUT_QUIET 139 | ) 140 | endif() 141 | 142 | if("${__result}" STREQUAL "0") 143 | set(__lto_found TRUE) 144 | endif() 145 | 146 | set(CMAKE_${lang}_PASSED_LTO_TEST 147 | ${__lto_found} CACHE INTERNAL 148 | "If the compiler passed a simple LTO test compile") 149 | endif() 150 | if(CMAKE_${lang}_PASSED_LTO_TEST) 151 | message(STATUS "Checking for LTO Compatibility - works") 152 | set(LTO_${lang}_SUPPORT TRUE CACHE BOOL "Do we have LTO support ?") 153 | set(LTO_COMPILE_FLAGS -flto CACHE STRING "Link Time Optimization compile flags") 154 | set(LTO_LINK_FLAGS -flto CACHE STRING "Link Time Optimization link flags") 155 | else() 156 | message(STATUS "Checking for LTO Compatibility - not working") 157 | endif() 158 | 159 | endif() 160 | elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang") 161 | message(STATUS "Checking for LTO Compatibility - works (assumed for clang)") 162 | set(LTO_${lang}_SUPPORT TRUE CACHE BOOL "Do we have LTO support ?") 163 | set(LTO_COMPILE_FLAGS -flto CACHE STRING "Link Time Optimization compile flags") 164 | set(LTO_LINK_FLAGS -flto CACHE STRING "Link Time Optimization link flags") 165 | elseif(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC") 166 | message(STATUS "Checking for LTO Compatibility - works") 167 | set(LTO_${lang}_SUPPORT TRUE CACHE BOOL "Do we have LTO support ?") 168 | set(LTO_COMPILE_FLAGS /GL CACHE STRING "Link Time Optimization compile flags") 169 | set(LTO_LINK_FLAGS -LTCG:INCREMENTAL CACHE STRING "Link Time Optimization link flags") 170 | else() 171 | message(STATUS "Checking for LTO Compatibility - compiler not handled by module") 172 | endif() 173 | mark_as_advanced(LTO_${lang}_SUPPORT LTO_COMPILE_FLAGS LTO_LINK_FLAGS) 174 | 175 | 176 | set(LTO_${lang}_CHECKED TRUE CACHE INTERNAL "" ) 177 | 178 | if(CMAKE_GCC_AR AND CMAKE_GCC_RANLIB AND CMAKE_GCC_NM) 179 | # THIS IS HACKY BUT THERE IS NO OTHER SOLUTION ATM 180 | set(CMAKE_AR ${CMAKE_GCC_AR} CACHE FILEPATH "Forcing gcc-ar instead of ar" FORCE) 181 | set(CMAKE_NM ${CMAKE_GCC_NM} CACHE FILEPATH "Forcing gcc-nm instead of nm" FORCE) 182 | set(CMAKE_RANLIB ${CMAKE_GCC_RANLIB} CACHE FILEPATH "Forcing gcc-ranlib instead of ranlib" FORCE) 183 | endif() 184 | endif(${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION} VERSION_LESS 3.9) 185 | endif(ENABLE_LTO AND NOT LTO_${lang}_CHECKED) 186 | 187 | 188 | if(ENABLE_LTO) 189 | #Special case for cmake older than 3.9, using a library for gcc/clang, but could setup the flags directly. 190 | #Taking advantage of the [debug,optimized] parameter of target_link_libraries 191 | if(${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION} VERSION_LESS 3.9) 192 | if(LTO_${lang}_SUPPORT) 193 | if(NOT TARGET __enable_lto_tgt) 194 | add_library(__enable_lto_tgt INTERFACE) 195 | endif() 196 | target_compile_options(__enable_lto_tgt INTERFACE ${LTO_COMPILE_FLAGS}) 197 | #this might not work for all platforms... in which case we'll have to set the link flags on the target directly 198 | target_link_libraries(__enable_lto_tgt INTERFACE ${LTO_LINK_FLAGS} ) 199 | macro(target_enable_lto _target _build_configuration) 200 | if(${_build_configuration} STREQUAL "optimized" OR ${_build_configuration} STREQUAL "debug" ) 201 | target_link_libraries(${_target} PRIVATE ${_build_configuration} __enable_lto_tgt) 202 | else() 203 | target_link_libraries(${_target} PRIVATE __enable_lto_tgt) 204 | endif() 205 | endmacro() 206 | else() 207 | #In old cmake versions, we can set INTERPROCEDURAL_OPTIMIZATION even if not supported by the compiler 208 | #So if we didn't detect it, let cmake give it a try 209 | set(__IPO_SUPPORTED TRUE) 210 | endif() 211 | else() 212 | cmake_policy(SET CMP0069 NEW) 213 | include(CheckIPOSupported) 214 | # Optional IPO. Do not use IPO if it's not supported by compiler. 215 | check_ipo_supported(RESULT __IPO_SUPPORTED OUTPUT output) 216 | if(NOT __IPO_SUPPORTED) 217 | message(STATUS "IPO is not supported or broken.") 218 | else() 219 | message(STATUS "IPO is supported") 220 | endif() 221 | endif() 222 | if(__IPO_SUPPORTED) 223 | macro(target_enable_lto _target _build_configuration) 224 | if(NOT ${_build_configuration} STREQUAL "debug" ) 225 | #enable for all configurations 226 | set_target_properties(${_target} PROPERTIES INTERPROCEDURAL_OPTIMIZATION TRUE) 227 | endif() 228 | if(${_build_configuration} STREQUAL "optimized" ) 229 | #blacklist debug configurations 230 | set(__enable_debug_lto FALSE) 231 | else() 232 | #enable only for debug configurations 233 | set(__enable_debug_lto TRUE) 234 | endif() 235 | get_property(DEBUG_CONFIGURATIONS GLOBAL PROPERTY DEBUG_CONFIGURATIONS) 236 | if(NOT DEBUG_CONFIGURATIONS) 237 | set(DEBUG_CONFIGURATIONS DEBUG) # This is what is done by CMAKE internally... since DEBUG_CONFIGURATIONS is empty by default 238 | endif() 239 | foreach(config IN LISTS DEBUG_CONFIGURATIONS) 240 | set_target_properties(${_target} PROPERTIES INTERPROCEDURAL_OPTIMIZATION_${config} ${__enable_debug_lto}) 241 | endforeach() 242 | endmacro() 243 | endif() 244 | endif() 245 | if(NOT COMMAND target_enable_lto) 246 | macro(target_enable_lto _target _build_configuration) 247 | endmacro() 248 | endif() 249 | endmacro() 250 | -------------------------------------------------------------------------------- /Doxyfile.in: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.12 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++ Boiler Plate" 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 = 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 = NO 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 = NO 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 = @CMAKE_CURRENT_SOURCE_DIR@/README.md 775 | INPUT += @CMAKE_CURRENT_SOURCE_DIR@/include/ @CMAKE_CURRENT_SOURCE_DIR@/src 776 | 777 | 778 | FILE_PATTERNS += *.md *.markdown 779 | 780 | # This tag can be used to specify the character encoding of the source files 781 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 782 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 783 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 784 | # possible encodings. 785 | # The default value is: UTF-8. 786 | 787 | INPUT_ENCODING = UTF-8 788 | 789 | # If the value of the INPUT tag contains directories, you can use the 790 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 791 | # *.h) to filter out the source-files in the directories. 792 | # 793 | # Note that for custom extensions or not directly supported extensions you also 794 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 795 | # read by doxygen. 796 | # 797 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 798 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 799 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 800 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, 801 | # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 802 | 803 | FILE_PATTERNS = 804 | 805 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 806 | # be searched for input files as well. 807 | # The default value is: NO. 808 | 809 | RECURSIVE = NO 810 | 811 | # The EXCLUDE tag can be used to specify files and/or directories that should be 812 | # excluded from the INPUT source files. This way you can easily exclude a 813 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 814 | # 815 | # Note that relative paths are relative to the directory from which doxygen is 816 | # run. 817 | 818 | EXCLUDE = 819 | 820 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 821 | # directories that are symbolic links (a Unix file system feature) are excluded 822 | # from the input. 823 | # The default value is: NO. 824 | 825 | EXCLUDE_SYMLINKS = NO 826 | 827 | # If the value of the INPUT tag contains directories, you can use the 828 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 829 | # certain files from those directories. 830 | # 831 | # Note that the wildcards are matched against the file with absolute path, so to 832 | # exclude all test directories for example use the pattern */test/* 833 | 834 | EXCLUDE_PATTERNS = 835 | 836 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 837 | # (namespaces, classes, functions, etc.) that should be excluded from the 838 | # output. The symbol name can be a fully qualified name, a word, or if the 839 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 840 | # AClass::ANamespace, ANamespace::*Test 841 | # 842 | # Note that the wildcards are matched against the file with absolute path, so to 843 | # exclude all test directories use the pattern */test/* 844 | 845 | EXCLUDE_SYMBOLS = 846 | 847 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 848 | # that contain example code fragments that are included (see the \include 849 | # command). 850 | 851 | EXAMPLE_PATH = 852 | 853 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 854 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 855 | # *.h) to filter out the source-files in the directories. If left blank all 856 | # files are included. 857 | 858 | EXAMPLE_PATTERNS = 859 | 860 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 861 | # searched for input files to be used with the \include or \dontinclude commands 862 | # irrespective of the value of the RECURSIVE tag. 863 | # The default value is: NO. 864 | 865 | EXAMPLE_RECURSIVE = NO 866 | 867 | # The IMAGE_PATH tag can be used to specify one or more files or directories 868 | # that contain images that are to be included in the documentation (see the 869 | # \image command). 870 | 871 | IMAGE_PATH = 872 | 873 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 874 | # invoke to filter for each input file. Doxygen will invoke the filter program 875 | # by executing (via popen()) the command: 876 | # 877 | # 878 | # 879 | # where is the value of the INPUT_FILTER tag, and is the 880 | # name of an input file. Doxygen will then use the output that the filter 881 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 882 | # will be ignored. 883 | # 884 | # Note that the filter must not add or remove lines; it is applied before the 885 | # code is scanned, but not when the output code is generated. If lines are added 886 | # or removed, the anchors will not be placed correctly. 887 | # 888 | # Note that for custom extensions or not directly supported extensions you also 889 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 890 | # properly processed by doxygen. 891 | 892 | INPUT_FILTER = 893 | 894 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 895 | # basis. Doxygen will compare the file name with each pattern and apply the 896 | # filter if there is a match. The filters are a list of the form: pattern=filter 897 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 898 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 899 | # patterns match the file name, INPUT_FILTER is applied. 900 | # 901 | # Note that for custom extensions or not directly supported extensions you also 902 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 903 | # properly processed by doxygen. 904 | 905 | FILTER_PATTERNS = 906 | 907 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 908 | # INPUT_FILTER) will also be used to filter the input files that are used for 909 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 910 | # The default value is: NO. 911 | 912 | FILTER_SOURCE_FILES = NO 913 | 914 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 915 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 916 | # it is also possible to disable source filtering for a specific pattern using 917 | # *.ext= (so without naming a filter). 918 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 919 | 920 | FILTER_SOURCE_PATTERNS = 921 | 922 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 923 | # is part of the input, its contents will be placed on the main page 924 | # (index.html). This can be useful if you have a project on for instance GitHub 925 | # and want to reuse the introduction page also for the doxygen output. 926 | 927 | USE_MDFILE_AS_MAINPAGE = @CMAKE_CURRENT_SOURCE_DIR@/README.md 928 | 929 | 930 | #--------------------------------------------------------------------------- 931 | # Configuration options related to source browsing 932 | #--------------------------------------------------------------------------- 933 | 934 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 935 | # generated. Documented entities will be cross-referenced with these sources. 936 | # 937 | # Note: To get rid of all source code in the generated output, make sure that 938 | # also VERBATIM_HEADERS is set to NO. 939 | # The default value is: NO. 940 | 941 | SOURCE_BROWSER = NO 942 | 943 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 944 | # classes and enums directly into the documentation. 945 | # The default value is: NO. 946 | 947 | INLINE_SOURCES = NO 948 | 949 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 950 | # special comment blocks from generated source code fragments. Normal C, C++ and 951 | # Fortran comments will always remain visible. 952 | # The default value is: YES. 953 | 954 | STRIP_CODE_COMMENTS = YES 955 | 956 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 957 | # function all documented functions referencing it will be listed. 958 | # The default value is: NO. 959 | 960 | REFERENCED_BY_RELATION = NO 961 | 962 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 963 | # all documented entities called/used by that function will be listed. 964 | # The default value is: NO. 965 | 966 | REFERENCES_RELATION = NO 967 | 968 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 969 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 970 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 971 | # link to the documentation. 972 | # The default value is: YES. 973 | 974 | REFERENCES_LINK_SOURCE = YES 975 | 976 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 977 | # source code will show a tooltip with additional information such as prototype, 978 | # brief description and links to the definition and documentation. Since this 979 | # will make the HTML file larger and loading of large files a bit slower, you 980 | # can opt to disable this feature. 981 | # The default value is: YES. 982 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 983 | 984 | SOURCE_TOOLTIPS = YES 985 | 986 | # If the USE_HTAGS tag is set to YES then the references to source code will 987 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 988 | # source browser. The htags tool is part of GNU's global source tagging system 989 | # (see http://www.gnu.org/software/global/global.html). You will need version 990 | # 4.8.6 or higher. 991 | # 992 | # To use it do the following: 993 | # - Install the latest version of global 994 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 995 | # - Make sure the INPUT points to the root of the source tree 996 | # - Run doxygen as normal 997 | # 998 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 999 | # tools must be available from the command line (i.e. in the search path). 1000 | # 1001 | # The result: instead of the source browser generated by doxygen, the links to 1002 | # source code will now point to the output of htags. 1003 | # The default value is: NO. 1004 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1005 | 1006 | USE_HTAGS = NO 1007 | 1008 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1009 | # verbatim copy of the header file for each class for which an include is 1010 | # specified. Set to NO to disable this. 1011 | # See also: Section \class. 1012 | # The default value is: YES. 1013 | 1014 | VERBATIM_HEADERS = YES 1015 | 1016 | #--------------------------------------------------------------------------- 1017 | # Configuration options related to the alphabetical class index 1018 | #--------------------------------------------------------------------------- 1019 | 1020 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1021 | # compounds will be generated. Enable this if the project contains a lot of 1022 | # classes, structs, unions or interfaces. 1023 | # The default value is: YES. 1024 | 1025 | ALPHABETICAL_INDEX = YES 1026 | 1027 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1028 | # which the alphabetical index list will be split. 1029 | # Minimum value: 1, maximum value: 20, default value: 5. 1030 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1031 | 1032 | COLS_IN_ALPHA_INDEX = 5 1033 | 1034 | # In case all classes in a project start with a common prefix, all classes will 1035 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1036 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1037 | # while generating the index headers. 1038 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1039 | 1040 | IGNORE_PREFIX = 1041 | 1042 | #--------------------------------------------------------------------------- 1043 | # Configuration options related to the HTML output 1044 | #--------------------------------------------------------------------------- 1045 | 1046 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1047 | # The default value is: YES. 1048 | 1049 | GENERATE_HTML = YES 1050 | 1051 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1052 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1053 | # it. 1054 | # The default directory is: html. 1055 | # This tag requires that the tag GENERATE_HTML is set to YES. 1056 | 1057 | HTML_OUTPUT = html 1058 | 1059 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1060 | # generated HTML page (for example: .htm, .php, .asp). 1061 | # The default value is: .html. 1062 | # This tag requires that the tag GENERATE_HTML is set to YES. 1063 | 1064 | HTML_FILE_EXTENSION = .html 1065 | 1066 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1067 | # each generated HTML page. If the tag is left blank doxygen will generate a 1068 | # standard header. 1069 | # 1070 | # To get valid HTML the header file that includes any scripts and style sheets 1071 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1072 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1073 | # default header using 1074 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1075 | # YourConfigFile 1076 | # and then modify the file new_header.html. See also section "Doxygen usage" 1077 | # for information on how to generate the default header that doxygen normally 1078 | # uses. 1079 | # Note: The header is subject to change so you typically have to regenerate the 1080 | # default header when upgrading to a newer version of doxygen. For a description 1081 | # of the possible markers and block names see the documentation. 1082 | # This tag requires that the tag GENERATE_HTML is set to YES. 1083 | 1084 | HTML_HEADER = 1085 | 1086 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1087 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1088 | # footer. See HTML_HEADER for more information on how to generate a default 1089 | # footer and what special commands can be used inside the footer. See also 1090 | # section "Doxygen usage" for information on how to generate the default footer 1091 | # that doxygen normally uses. 1092 | # This tag requires that the tag GENERATE_HTML is set to YES. 1093 | 1094 | HTML_FOOTER = 1095 | 1096 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1097 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1098 | # the HTML output. If left blank doxygen will generate a default style sheet. 1099 | # See also section "Doxygen usage" for information on how to generate the style 1100 | # sheet that doxygen normally uses. 1101 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1102 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1103 | # obsolete. 1104 | # This tag requires that the tag GENERATE_HTML is set to YES. 1105 | 1106 | HTML_STYLESHEET = 1107 | 1108 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1109 | # cascading style sheets that are included after the standard style sheets 1110 | # created by doxygen. Using this option one can overrule certain style aspects. 1111 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1112 | # standard style sheet and is therefore more robust against future updates. 1113 | # Doxygen will copy the style sheet files to the output directory. 1114 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1115 | # style sheet in the list overrules the setting of the previous ones in the 1116 | # list). For an example see the documentation. 1117 | # This tag requires that the tag GENERATE_HTML is set to YES. 1118 | 1119 | HTML_EXTRA_STYLESHEET = 1120 | 1121 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1122 | # other source files which should be copied to the HTML output directory. Note 1123 | # that these files will be copied to the base HTML output directory. Use the 1124 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1125 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1126 | # files will be copied as-is; there are no commands or markers available. 1127 | # This tag requires that the tag GENERATE_HTML is set to YES. 1128 | 1129 | HTML_EXTRA_FILES = 1130 | 1131 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1132 | # will adjust the colors in the style sheet and background images according to 1133 | # this color. Hue is specified as an angle on a colorwheel, see 1134 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1135 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1136 | # purple, and 360 is red again. 1137 | # Minimum value: 0, maximum value: 359, default value: 220. 1138 | # This tag requires that the tag GENERATE_HTML is set to YES. 1139 | 1140 | HTML_COLORSTYLE_HUE = 220 1141 | 1142 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1143 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1144 | # value of 255 will produce the most vivid colors. 1145 | # Minimum value: 0, maximum value: 255, default value: 100. 1146 | # This tag requires that the tag GENERATE_HTML is set to YES. 1147 | 1148 | HTML_COLORSTYLE_SAT = 100 1149 | 1150 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1151 | # luminance component of the colors in the HTML output. Values below 100 1152 | # gradually make the output lighter, whereas values above 100 make the output 1153 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1154 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1155 | # change the gamma. 1156 | # Minimum value: 40, maximum value: 240, default value: 80. 1157 | # This tag requires that the tag GENERATE_HTML is set to YES. 1158 | 1159 | HTML_COLORSTYLE_GAMMA = 80 1160 | 1161 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1162 | # page will contain the date and time when the page was generated. Setting this 1163 | # to YES can help to show when doxygen was last run and thus if the 1164 | # documentation is up to date. 1165 | # The default value is: NO. 1166 | # This tag requires that the tag GENERATE_HTML is set to YES. 1167 | 1168 | HTML_TIMESTAMP = NO 1169 | 1170 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1171 | # documentation will contain sections that can be hidden and shown after the 1172 | # page has loaded. 1173 | # The default value is: NO. 1174 | # This tag requires that the tag GENERATE_HTML is set to YES. 1175 | 1176 | HTML_DYNAMIC_SECTIONS = NO 1177 | 1178 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1179 | # shown in the various tree structured indices initially; the user can expand 1180 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1181 | # such a level that at most the specified number of entries are visible (unless 1182 | # a fully collapsed tree already exceeds this amount). So setting the number of 1183 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1184 | # representing an infinite number of entries and will result in a full expanded 1185 | # tree by default. 1186 | # Minimum value: 0, maximum value: 9999, default value: 100. 1187 | # This tag requires that the tag GENERATE_HTML is set to YES. 1188 | 1189 | HTML_INDEX_NUM_ENTRIES = 100 1190 | 1191 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1192 | # generated that can be used as input for Apple's Xcode 3 integrated development 1193 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1194 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1195 | # Makefile in the HTML output directory. Running make will produce the docset in 1196 | # that directory and running make install will install the docset in 1197 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1198 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1199 | # for more information. 1200 | # The default value is: NO. 1201 | # This tag requires that the tag GENERATE_HTML is set to YES. 1202 | 1203 | GENERATE_DOCSET = NO 1204 | 1205 | # This tag determines the name of the docset feed. A documentation feed provides 1206 | # an umbrella under which multiple documentation sets from a single provider 1207 | # (such as a company or product suite) can be grouped. 1208 | # The default value is: Doxygen generated docs. 1209 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1210 | 1211 | DOCSET_FEEDNAME = "Doxygen generated docs" 1212 | 1213 | # This tag specifies a string that should uniquely identify the documentation 1214 | # set bundle. This should be a reverse domain-name style string, e.g. 1215 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1216 | # The default value is: org.doxygen.Project. 1217 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1218 | 1219 | DOCSET_BUNDLE_ID = org.doxygen.Project 1220 | 1221 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1222 | # the documentation publisher. This should be a reverse domain-name style 1223 | # string, e.g. com.mycompany.MyDocSet.documentation. 1224 | # The default value is: org.doxygen.Publisher. 1225 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1226 | 1227 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1228 | 1229 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1230 | # The default value is: Publisher. 1231 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1232 | 1233 | DOCSET_PUBLISHER_NAME = Publisher 1234 | 1235 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1236 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1237 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1238 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1239 | # Windows. 1240 | # 1241 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1242 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1243 | # files are now used as the Windows 98 help format, and will replace the old 1244 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1245 | # HTML files also contain an index, a table of contents, and you can search for 1246 | # words in the documentation. The HTML workshop also contains a viewer for 1247 | # compressed HTML files. 1248 | # The default value is: NO. 1249 | # This tag requires that the tag GENERATE_HTML is set to YES. 1250 | 1251 | GENERATE_HTMLHELP = NO 1252 | 1253 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1254 | # file. You can add a path in front of the file if the result should not be 1255 | # written to the html output directory. 1256 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1257 | 1258 | CHM_FILE = 1259 | 1260 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1261 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1262 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1263 | # The file has to be specified with full path. 1264 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1265 | 1266 | HHC_LOCATION = 1267 | 1268 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1269 | # (YES) or that it should be included in the master .chm file (NO). 1270 | # The default value is: NO. 1271 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1272 | 1273 | GENERATE_CHI = NO 1274 | 1275 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1276 | # and project file content. 1277 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1278 | 1279 | CHM_INDEX_ENCODING = 1280 | 1281 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1282 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1283 | # enables the Previous and Next buttons. 1284 | # The default value is: NO. 1285 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1286 | 1287 | BINARY_TOC = NO 1288 | 1289 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1290 | # the table of contents of the HTML help documentation and to the tree view. 1291 | # The default value is: NO. 1292 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1293 | 1294 | TOC_EXPAND = NO 1295 | 1296 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1297 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1298 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1299 | # (.qch) of the generated HTML documentation. 1300 | # The default value is: NO. 1301 | # This tag requires that the tag GENERATE_HTML is set to YES. 1302 | 1303 | GENERATE_QHP = NO 1304 | 1305 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1306 | # the file name of the resulting .qch file. The path specified is relative to 1307 | # the HTML output folder. 1308 | # This tag requires that the tag GENERATE_QHP is set to YES. 1309 | 1310 | QCH_FILE = 1311 | 1312 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1313 | # Project output. For more information please see Qt Help Project / Namespace 1314 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1315 | # The default value is: org.doxygen.Project. 1316 | # This tag requires that the tag GENERATE_QHP is set to YES. 1317 | 1318 | QHP_NAMESPACE = org.doxygen.Project 1319 | 1320 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1321 | # Help Project output. For more information please see Qt Help Project / Virtual 1322 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1323 | # folders). 1324 | # The default value is: doc. 1325 | # This tag requires that the tag GENERATE_QHP is set to YES. 1326 | 1327 | QHP_VIRTUAL_FOLDER = doc 1328 | 1329 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1330 | # filter to add. For more information please see Qt Help Project / Custom 1331 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1332 | # filters). 1333 | # This tag requires that the tag GENERATE_QHP is set to YES. 1334 | 1335 | QHP_CUST_FILTER_NAME = 1336 | 1337 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1338 | # custom filter to add. For more information please see Qt Help Project / Custom 1339 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1340 | # filters). 1341 | # This tag requires that the tag GENERATE_QHP is set to YES. 1342 | 1343 | QHP_CUST_FILTER_ATTRS = 1344 | 1345 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1346 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1347 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1348 | # This tag requires that the tag GENERATE_QHP is set to YES. 1349 | 1350 | QHP_SECT_FILTER_ATTRS = 1351 | 1352 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1353 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1354 | # generated .qhp file. 1355 | # This tag requires that the tag GENERATE_QHP is set to YES. 1356 | 1357 | QHG_LOCATION = 1358 | 1359 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1360 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1361 | # install this plugin and make it available under the help contents menu in 1362 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1363 | # to be copied into the plugins directory of eclipse. The name of the directory 1364 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1365 | # After copying Eclipse needs to be restarted before the help appears. 1366 | # The default value is: NO. 1367 | # This tag requires that the tag GENERATE_HTML is set to YES. 1368 | 1369 | GENERATE_ECLIPSEHELP = NO 1370 | 1371 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1372 | # the directory name containing the HTML and XML files should also have this 1373 | # name. Each documentation set should have its own identifier. 1374 | # The default value is: org.doxygen.Project. 1375 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1376 | 1377 | ECLIPSE_DOC_ID = org.doxygen.Project 1378 | 1379 | # If you want full control over the layout of the generated HTML pages it might 1380 | # be necessary to disable the index and replace it with your own. The 1381 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1382 | # of each HTML page. A value of NO enables the index and the value YES disables 1383 | # it. Since the tabs in the index contain the same information as the navigation 1384 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1385 | # The default value is: NO. 1386 | # This tag requires that the tag GENERATE_HTML is set to YES. 1387 | 1388 | DISABLE_INDEX = NO 1389 | 1390 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1391 | # structure should be generated to display hierarchical information. If the tag 1392 | # value is set to YES, a side panel will be generated containing a tree-like 1393 | # index structure (just like the one that is generated for HTML Help). For this 1394 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1395 | # (i.e. any modern browser). Windows users are probably better off using the 1396 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1397 | # further fine-tune the look of the index. As an example, the default style 1398 | # sheet generated by doxygen has an example that shows how to put an image at 1399 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1400 | # the same information as the tab index, you could consider setting 1401 | # DISABLE_INDEX to YES when enabling this option. 1402 | # The default value is: NO. 1403 | # This tag requires that the tag GENERATE_HTML is set to YES. 1404 | 1405 | GENERATE_TREEVIEW = NO 1406 | 1407 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1408 | # doxygen will group on one line in the generated HTML documentation. 1409 | # 1410 | # Note that a value of 0 will completely suppress the enum values from appearing 1411 | # in the overview section. 1412 | # Minimum value: 0, maximum value: 20, default value: 4. 1413 | # This tag requires that the tag GENERATE_HTML is set to YES. 1414 | 1415 | ENUM_VALUES_PER_LINE = 4 1416 | 1417 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1418 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1419 | # Minimum value: 0, maximum value: 1500, default value: 250. 1420 | # This tag requires that the tag GENERATE_HTML is set to YES. 1421 | 1422 | TREEVIEW_WIDTH = 250 1423 | 1424 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1425 | # external symbols imported via tag files in a separate window. 1426 | # The default value is: NO. 1427 | # This tag requires that the tag GENERATE_HTML is set to YES. 1428 | 1429 | EXT_LINKS_IN_WINDOW = NO 1430 | 1431 | # Use this tag to change the font size of LaTeX formulas included as images in 1432 | # the HTML documentation. When you change the font size after a successful 1433 | # doxygen run you need to manually remove any form_*.png images from the HTML 1434 | # output directory to force them to be regenerated. 1435 | # Minimum value: 8, maximum value: 50, default value: 10. 1436 | # This tag requires that the tag GENERATE_HTML is set to YES. 1437 | 1438 | FORMULA_FONTSIZE = 10 1439 | 1440 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1441 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1442 | # supported properly for IE 6.0, but are supported on all modern browsers. 1443 | # 1444 | # Note that when changing this option you need to delete any form_*.png files in 1445 | # the HTML output directory before the changes have effect. 1446 | # The default value is: YES. 1447 | # This tag requires that the tag GENERATE_HTML is set to YES. 1448 | 1449 | FORMULA_TRANSPARENT = YES 1450 | 1451 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1452 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1453 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1454 | # installed or if you want to formulas look prettier in the HTML output. When 1455 | # enabled you may also need to install MathJax separately and configure the path 1456 | # to it using the MATHJAX_RELPATH option. 1457 | # The default value is: NO. 1458 | # This tag requires that the tag GENERATE_HTML is set to YES. 1459 | 1460 | USE_MATHJAX = NO 1461 | 1462 | # When MathJax is enabled you can set the default output format to be used for 1463 | # the MathJax output. See the MathJax site (see: 1464 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1465 | # Possible values are: HTML-CSS (which is slower, but has the best 1466 | # compatibility), NativeMML (i.e. MathML) and SVG. 1467 | # The default value is: HTML-CSS. 1468 | # This tag requires that the tag USE_MATHJAX is set to YES. 1469 | 1470 | MATHJAX_FORMAT = HTML-CSS 1471 | 1472 | # When MathJax is enabled you need to specify the location relative to the HTML 1473 | # output directory using the MATHJAX_RELPATH option. The destination directory 1474 | # should contain the MathJax.js script. For instance, if the mathjax directory 1475 | # is located at the same level as the HTML output directory, then 1476 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1477 | # Content Delivery Network so you can quickly see the result without installing 1478 | # MathJax. However, it is strongly recommended to install a local copy of 1479 | # MathJax from http://www.mathjax.org before deployment. 1480 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1481 | # This tag requires that the tag USE_MATHJAX is set to YES. 1482 | 1483 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1484 | 1485 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1486 | # extension names that should be enabled during MathJax rendering. For example 1487 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1488 | # This tag requires that the tag USE_MATHJAX is set to YES. 1489 | 1490 | MATHJAX_EXTENSIONS = 1491 | 1492 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1493 | # of code that will be used on startup of the MathJax code. See the MathJax site 1494 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1495 | # example see the documentation. 1496 | # This tag requires that the tag USE_MATHJAX is set to YES. 1497 | 1498 | MATHJAX_CODEFILE = 1499 | 1500 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1501 | # the HTML output. The underlying search engine uses javascript and DHTML and 1502 | # should work on any modern browser. Note that when using HTML help 1503 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1504 | # there is already a search function so this one should typically be disabled. 1505 | # For large projects the javascript based search engine can be slow, then 1506 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1507 | # search using the keyboard; to jump to the search box use + S 1508 | # (what the is depends on the OS and browser, but it is typically 1509 | # , /