├── acceptance ├── tests │ └── fake.rb ├── Rakefile └── Gemfile ├── lib ├── namespaces.dox.in ├── tests │ ├── main.cc │ ├── test.cc.in │ └── CMakeLists.txt ├── project.hpp.in ├── project.cc.in ├── version.h.in ├── CMakeLists.txt └── Doxyfile.in ├── locales ├── CMakeLists.txt ├── cpp-project-template.pot └── fr.po ├── .gitignore ├── docker ├── README.md └── Dockerfile ├── CONTRIBUTING.md ├── MAINTAINERS ├── LICENSE ├── CHANGELOG.md ├── .travis.yml ├── exe ├── CMakeLists.txt └── driver.cc.in ├── README.md ├── appveyor.yml └── CMakeLists.txt /acceptance/tests/fake.rb: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /lib/namespaces.dox.in: -------------------------------------------------------------------------------- 1 | /** 2 | * The root namespace for @PROJECT_NAME@. 3 | */ 4 | namespace @PROJECT_NAME_LOWER@ { 5 | 6 | } 7 | -------------------------------------------------------------------------------- /lib/tests/main.cc: -------------------------------------------------------------------------------- 1 | #define CATCH_CONFIG_RUNNER 2 | #include 3 | 4 | int main(int argc, char **argv) 5 | { 6 | return Catch::Session().run(argc, argv); 7 | } 8 | 9 | -------------------------------------------------------------------------------- /acceptance/Rakefile: -------------------------------------------------------------------------------- 1 | require 'rake/clean' 2 | 3 | desc 'Run acceptance tests' 4 | task :acceptance do 5 | # TODO: create your real acceptance tests and update this 6 | system("beaker --tests tests/fake.rb") 7 | end 8 | -------------------------------------------------------------------------------- /locales/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | gettext_templates(${CMAKE_CURRENT_SOURCE_DIR} ${ALL_SOURCES}) 2 | gettext_compile(${CMAKE_CURRENT_SOURCE_DIR} share/locale) 3 | SET_DIRECTORY_PROPERTIES(PROPERTIES CLEAN_NO_CUSTOM TRUE) 4 | export_var(GETTEXT_ENABLED) -------------------------------------------------------------------------------- /lib/tests/test.cc.in: -------------------------------------------------------------------------------- 1 | #include 2 | #include <@PROJECT_NAME@/version.h> 3 | #include <@PROJECT_NAME@/@PROJECT_NAME@.hpp> 4 | 5 | SCENARIO("version() returns the version") { 6 | REQUIRE(@PROJECT_NAME_LOWER@::version() == @PROJECT_NAME_UPPER@_VERSION_WITH_COMMIT); 7 | } 8 | -------------------------------------------------------------------------------- /lib/project.hpp.in: -------------------------------------------------------------------------------- 1 | /** 2 | * @file 3 | * Declares a utility for retrieving the library version. 4 | */ 5 | #pragma once 6 | 7 | #include 8 | #include "export.h" 9 | 10 | namespace @PROJECT_NAME_LOWER@ { 11 | 12 | /** 13 | * Query the library version. 14 | * @return A version string with \.\.\ 15 | */ 16 | std::string LIB@PROJECT_NAME_UPPER@_EXPORT version(); 17 | 18 | } // namespace @PROJECT_NAME_LOWER@ 19 | -------------------------------------------------------------------------------- /lib/project.cc.in: -------------------------------------------------------------------------------- 1 | #include <@PROJECT_NAME@/version.h> 2 | #include <@PROJECT_NAME@/@PROJECT_NAME@.hpp> 3 | 4 | #include 5 | 6 | namespace @PROJECT_NAME_LOWER@ { 7 | 8 | using namespace std; 9 | 10 | string version() 11 | { 12 | LOG_DEBUG("@PROJECT_NAME@ version is {1}", @PROJECT_NAME_UPPER@_VERSION_WITH_COMMIT); 13 | return @PROJECT_NAME_UPPER@_VERSION_WITH_COMMIT; 14 | } 15 | 16 | } // @PROJECT_NAME_LOWER@ 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Misc files 2 | *.swp 3 | .DS_Store 4 | Gemfile.local 5 | Gemfile.lock 6 | 7 | # Generated files 8 | /exe/cpp-project-template.cc 9 | /lib/inc/cpp-project-template/cpp-project-template.hpp 10 | /lib/inc/*/export.h 11 | /lib/inc/*/version.h 12 | /lib/src/cpp-project-template.cc 13 | /lib/tests/cpp-project-template.cc 14 | /lib/Doxyfile 15 | /lib/html/ 16 | /lib/docs/ 17 | /*debug*/ 18 | /*release*/ 19 | /.idea/ 20 | /*build*/ 21 | acceptance/.bundle/ 22 | acceptance/vendor/ 23 | acceptance/junit/ 24 | acceptance/log/ 25 | -------------------------------------------------------------------------------- /docker/README.md: -------------------------------------------------------------------------------- 1 | # Build Containers 2 | 3 | Docker container images for building C++ projects are hosted publicly on Google Container Registry at gcr.io/cpp-projects/cpp-ci. They can be pulled via `docker pull gcr.io/cpp-projects/cpp-ci:`. 4 | 5 | Builds are currently done manually. Docs on how to push new builds are available from [Google](https://cloud.google.com/container-registry/docs/pushing-and-pulling). When adding a new build, include a new incremented integer tag (1, 2, ...) as well as a tag of the commit SHA of the Dockerfile used to generate the build. 6 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to contribute 2 | 3 | Third-party patches are essential for keeping Puppet Labs open-source projects 4 | great. We want to keep it as easy as possible to contribute changes that 5 | allow you to get the most out of our projects. There are a few guidelines 6 | that we need contributors to follow so that we can have a chance of keeping on 7 | top of things. For more info, see our canonical guide to contributing: 8 | 9 | [https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md) 10 | -------------------------------------------------------------------------------- /acceptance/Gemfile: -------------------------------------------------------------------------------- 1 | source ENV['GEM_SOURCE'] || "https://rubygems.org" 2 | 3 | def location_for(place, fake_version = nil) 4 | if place =~ /^(git:[^#]*)#(.*)/ 5 | [fake_version, { :git => $1, :branch => $2, :require => false }].compact 6 | elsif place =~ /^file:\/\/(.*)/ 7 | ['>= 0', { :path => File.expand_path($1), :require => false }] 8 | else 9 | [place, { :require => false }] 10 | end 11 | end 12 | 13 | gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 2.8') 14 | gem 'rake', "~> 10.1" 15 | 16 | if File.exists? "#{__FILE__}.local" 17 | eval(File.read("#{__FILE__}.local"), binding) 18 | end 19 | -------------------------------------------------------------------------------- /lib/tests/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # Generate source files from a template based on the project name. 2 | # REMOVE after generating your project. 3 | configure_file("test.cc.in" "${CMAKE_CURRENT_LIST_DIR}/${PROJECT_NAME}.cc") 4 | # REMOVE end 5 | 6 | # Setup compiling the test executable. C++ compile flags are inherited from the parent directory. 7 | include_directories(${LEATHERMAN_CATCH_INCLUDE}) 8 | 9 | set(TEST_CASES ${PROJECT_NAME}.cc) 10 | 11 | add_executable(lib${PROJECT_NAME}_test $ ${TEST_CASES} main.cc) 12 | target_link_libraries(lib${PROJECT_NAME}_test 13 | ${LEATHERMAN_LIBRARIES} 14 | ${Boost_LIBRARIES} 15 | ) 16 | 17 | add_test(NAME "unit_tests" COMMAND lib${PROJECT_NAME}_test) 18 | -------------------------------------------------------------------------------- /MAINTAINERS: -------------------------------------------------------------------------------- 1 | { 2 | "version": 1, 3 | "file_format": "This MAINTAINERS file format is described at http://pup.pt/maintainers", 4 | "issues": "https://github.com/puppetlabs/cpp-project-template/issues", 5 | "internal_list": "https://groups.google.com/a/puppet.com/forum/#!forum/discuss-c-plus-plus", 6 | "people": [ 7 | { 8 | "github": "MikaelSmith", 9 | "email": "michael.smith@puppet.com", 10 | "name": "Michael Smith" 11 | }, 12 | { 13 | "github": "branan", 14 | "email": "branan@puppet.com", 15 | "name": "Branan Riley" 16 | }, 17 | { 18 | "github": "magisus", 19 | "email": "maggie@puppet.com", 20 | "name": "Maggie Dreyer" 21 | } 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | cpp-project-template - Project template for new C++ projects. 2 | 3 | Copyright (C) 2014 Puppet Labs Inc 4 | 5 | Puppet Labs can be contacted at: info@puppetlabs.com 6 | 7 | Licensed under the Apache License, Version 2.0 (the "License"); 8 | you may not use this file except in compliance with the License. 9 | You may obtain a copy of the License at 10 | 11 | http://www.apache.org/licenses/LICENSE-2.0 12 | 13 | Unless required by applicable law or agreed to in writing, software 14 | distributed under the License is distributed on an "AS IS" BASIS, 15 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | See the License for the specific language governing permissions and 17 | limitations under the License. 18 | -------------------------------------------------------------------------------- /lib/version.h.in: -------------------------------------------------------------------------------- 1 | /// 2 | /// @file 3 | /// Declares macros for the @PROJECT_NAME@ library version. 4 | /// 5 | #pragma once 6 | 7 | /// 8 | /// The @PROJECT_NAME@ library major version. 9 | /// 10 | #define @PROJECT_NAME_UPPER@_VERSION_MAJOR @PROJECT_VERSION_MAJOR@ 11 | /// 12 | /// The @PROJECT_NAME@ library minor version. 13 | /// 14 | #define @PROJECT_NAME_UPPER@_VERSION_MINOR @PROJECT_VERSION_MINOR@ 15 | /// 16 | /// The @PROJECT_NAME@ library patch version. 17 | /// 18 | #define @PROJECT_NAME_UPPER@_VERSION_PATCH @PROJECT_VERSION_PATCH@ 19 | 20 | /// 21 | /// The @PROJECT_NAME@ library version as a string (without commit SHA1). 22 | /// 23 | #define @PROJECT_NAME_UPPER@_VERSION "@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@" 24 | 25 | /// 26 | /// The @PROJECT_NAME@ library version as a string (with commit SHA1). 27 | /// 28 | #define @PROJECT_NAME_UPPER@_VERSION_WITH_COMMIT "@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@@PROJECT_COMMIT@" 29 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | All notable changes to this project will be documented in this file. 3 | This project adheres to [Semantic Versioning](http://semver.org/). 4 | 5 | ## [0.2.0] - TBD 6 | 7 | ### Summary 8 | 9 | Fixed minor bugs and irritations. 10 | 11 | ### Features 12 | - Bumped Leatherman submodule from bc900e3d494a3932f97e90b8c6d5916690295a24 to a1627940f269b65537ee1b5f87c0624866218fd3. 13 | - Added specific git commit to @PROJECT_NAME_UPPER@_VERSION_WITH_COMMIT 14 | - Split `cpplint` and `cppcheck` into their own Jenkins CI jobs. 15 | 16 | ### Fixes 17 | - Fixed no-op acceptance Rake task for use in Jenkins CI. 18 | 19 | ## [0.1.0] - 2015-07-08 20 | 21 | ### Summary 22 | 23 | Initial release of cpp-project-template, an example C++11 project. 24 | 25 | ### Features 26 | - Basic command-line skeleton with dynamic library in C++. 27 | - Travis and AppVeyor CI jobs, coveralls.io triggered from Travis, and no-op acceptance Rake tasks. 28 | - Relies on the Leatherman C++ utility library. 29 | -------------------------------------------------------------------------------- /docker/Dockerfile: -------------------------------------------------------------------------------- 1 | # Build a newer version of cppcheck (because it's been buggy) 2 | FROM alpine:3.6 3 | RUN apk add --no-cache alpine-sdk cmake util-linux-dev ninja python zlib pcre-dev && \ 4 | wget https://github.com/danmar/cppcheck/archive/1.87.tar.gz && \ 5 | tar xzvf 1.87.tar.gz && \ 6 | cd cppcheck-1.87 && \ 7 | make install -j4 DESTDIR=/dest SRCDIR=build CFGDIR=/usr/share/cppcheck/cfg HAVE_RULES=yes CXXFLAGS="-O2 -DNDEBUG" 8 | 9 | 10 | FROM alpine:3.6 11 | LABEL author="Michael Smith \"michael.smith@puppet.com\"" 12 | LABEL description="A C++ build container" 13 | 14 | COPY --from=0 /dest / 15 | 16 | # Uses sed to patch https://svn.boost.org/trac10/ticket/12419 17 | RUN apk add --no-cache bash alpine-sdk cmake doxygen boost-dev yaml-cpp-dev openssl-dev \ 18 | curl-dev icu-dev util-linux-dev ruby ruby-irb ruby-json valgrind gettext \ 19 | python2-dev py2-pip libffi-dev && \ 20 | sed -i -e 's/sys\/poll/poll/' /usr/include/boost/asio/detail/socket_types.hpp && \ 21 | pip install cpp-coveralls 22 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: required 2 | services: 3 | - docker 4 | 5 | before_install: 6 | - docker pull gcr.io/cpp-projects/cpp-ci:1 7 | 8 | script: 9 | - > 10 | docker run -v `pwd`:/cpp-project-template gcr.io/cpp-projects/cpp-ci:1 /bin/bash -c " 11 | wget https://github.com/puppetlabs/leatherman/releases/download/${LEATHERMAN_VERSION}/leatherman.tar.gz && 12 | tar xzvf leatherman.tar.gz --strip 1 -C / && 13 | cd /cpp-project-template && 14 | cmake $EXTRA_VARS . && 15 | mkdir dest && 16 | make $TARGET DESTDIR=/cpp-project-template/dest VERBOSE=1 -j2 && 17 | { [[ '$COVERALLS' != 'ON' ]] || coveralls --gcov-options '\-lp' -r . -b . -e src -e vendor >/dev/null || true; } 18 | " 19 | 20 | env: 21 | global: 22 | - LEATHERMAN_VERSION=1.4.2 23 | matrix: 24 | - TARGET=cpplint 25 | - TARGET=cppcheck 26 | - TARGET="all test install ARGS=-v" EXTRA_VARS="-DBOOST_STATIC=ON -DCMAKE_BUILD_TYPE=Debug -DCOVERALLS=ON" COVERALLS=ON 27 | - TARGET="all test install ARGS=-v" EXTRA_VARS="-DBOOST_STATIC=ON" 28 | 29 | notifications: 30 | email: false 31 | -------------------------------------------------------------------------------- /exe/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # Generate source files from a template based on the project name. 2 | # REMOVE after generating your project. 3 | configure_file("driver.cc.in" "${CMAKE_CURRENT_LIST_DIR}/${PROJECT_NAME}.cc") 4 | # REMOVE end 5 | 6 | # Set C++ compile flags based on project settings. 7 | set(CMAKE_CXX_FLAGS ${${PROJECT_NAME_UPPER}_CXX_FLAGS}) 8 | 9 | # Set prefix for logging messages. 10 | leatherman_logging_namespace("puppetlabs.${PROJECT_NAME}.command") 11 | 12 | # Setup compiling the executable. 13 | include_directories( 14 | ../lib/inc 15 | ${Boost_INCLUDE_DIRS} 16 | ${LEATHERMAN_INCLUDE_DIRS} 17 | ) 18 | 19 | add_executable(${PROJECT_NAME} ${PROJECT_NAME}.cc) 20 | target_link_libraries(${PROJECT_NAME} 21 | lib${PROJECT_NAME} 22 | ${Boost_PROGRAM_OPTIONS_LIBRARY} 23 | ${LEATHERMAN_LIBRARIES} 24 | ) 25 | 26 | leatherman_install(${PROJECT_NAME}) 27 | 28 | # Tests for the executable. These don't verify behavior, simply that the executable runs 29 | # without crashing or generating an error. Useful, but should be enhanced with test scripts 30 | # and/or acceptance tests. 31 | add_test(NAME "smoke_test" COMMAND ${PROJECT_NAME}) 32 | add_test(NAME "help_test" COMMAND ${PROJECT_NAME} --help) 33 | add_test(NAME "version_test" COMMAND ${PROJECT_NAME} --version) 34 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CppProjectTemplate 2 | 3 | > At this time we don't anticipate starting new C++ projects, so this template has been archived. 4 | 5 | CppProjectTemplate is a C++ project template for use in creating new command-line utility projects using PuppetLabs' shared libraries. 6 | 7 | ## Required packages 8 | 9 | You will need to install [Boost](http://boost.org) for program_options and to use many of the libraries in [Leatherman](https://github.com/puppetlabs/leatherman). 10 | 11 | ## Creating a new project 12 | 13 | This is most simply accomplished with [Hub](https://hub.github.com/). The following commands will create a new GitHub project based on this template named `new-project` under the `puppetlabs` organization. Use Hub's `-p` option to create a private repo. 14 | 15 | ``` 16 | hub clone --depth 1 --origin source puppetlabs/cpp-project-template new-project 17 | cd new-project 18 | hub create puppetlabs/new-project [-p] 19 | git commit --amend # Rewrite the commit message, and erase the fact that it's a shallow copy 20 | git push origin new-project 21 | ``` 22 | 23 | Finally update the project() name in CMakeLists.txt. 24 | 25 | ## Build the library 26 | 27 | This template is a fully functional example, and can be built with 28 | 29 | ``` 30 | mkdir build && cd build 31 | cmake .. 32 | make -j 33 | ``` 34 | 35 | CMake will generate source files from template files based on the project declared in CMakeLists.txt. For cpp-project-template, git ignores the generated files. For your own project, you can check those files in, and eventually remove the template files and generation logic from CMake as you develop your project (look for the REMOVE string in CMakeLists.txt files). 36 | 37 | Tests can be run with `make test`, and the example tool can be run with `bin/cpp_project_template`. 38 | 39 | ## Maintenance 40 | 41 | Maintainers: Michael Smith 42 | 43 | Tickets: Can be opened in Github Issues. 44 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | version: 0.0.1.{build} 2 | environment: 3 | LEATHERMAN_VERSION: 1.1.1 4 | 5 | init: 6 | - | 7 | choco install -y mingw-w64 -Version 5.2.0 -source https://www.myget.org/F/puppetlabs 8 | choco install -y cmake -Version 3.2.2 -source https://www.myget.org/F/puppetlabs 9 | choco install -y gettext -Version 0.19.6 -source https://www.myget.org/F/puppetlabs 10 | choco install -y pl-toolchain-x64 -Version 2015.12.01.1 -source https://www.myget.org/F/puppetlabs 11 | choco install -y pl-boost-x64 -Version 1.58.0.2 -source https://www.myget.org/F/puppetlabs 12 | choco install -y pl-openssl-x64 -Version 1.0.24.1 -source https://www.myget.org/F/puppetlabs 13 | choco install -y pl-curl-x64 -Version 7.46.0.1 -source https://www.myget.org/F/puppetlabs 14 | 15 | install: 16 | - ps: | 17 | wget "https://github.com/puppetlabs/leatherman/releases/download/$env:LEATHERMAN_VERSION/leatherman.7z" -OutFile "$pwd\leatherman.7z" 18 | 7z.exe x leatherman.7z -oC:\tools | FIND /V "ing " 19 | 20 | # Minimize environment polution; previously we were linking against the wrong OpenSSL DLLs. 21 | - SET PATH=C:\tools\pl-build-tools\bin;C:\tools\mingw64\bin;C:\ProgramData\chocolatey\bin;C:\Program Files\7-Zip;C:\Windows\system32;C:\Windows 22 | - ps: rm -r C:\OpenSSL-Win64 23 | 24 | build_script: 25 | - ps: | 26 | cmake -G "MinGW Makefiles" -DCMAKE_TOOLCHAIN_FILE="C:\tools\pl-build-tools\pl-build-toolchain.cmake" -DCMAKE_PREFIX_PATH="C:\tools\leatherman" -DCMAKE_INSTALL_PREFIX=C:\tools -DBOOST_STATIC=ON . 27 | mingw32-make -j2 28 | 29 | test_script: 30 | # DLLs in C:\Windows\system32 somehow get picked up first, despite PATH. Make local copies to override that behavior. 31 | - ps: | 32 | cp C:\Tools\pl-build-tools\bin\libeay32.dll .\bin 33 | cp C:\Tools\pl-build-tools\bin\ssleay32.dll .\bin 34 | ctest -V 2>&1 | %{ if ($_ -is [System.Management.Automation.ErrorRecord]) { $_ | c++filt } else { $_ } } 35 | mingw32-make install 36 | -------------------------------------------------------------------------------- /lib/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # Generate source files from a template based on the project name. 2 | # REMOVE after generating your project. 3 | configure_file("project.hpp.in" "${CMAKE_CURRENT_LIST_DIR}/inc/${PROJECT_NAME}/${PROJECT_NAME}.hpp") 4 | configure_file("project.cc.in" "${CMAKE_CURRENT_LIST_DIR}/src/${PROJECT_NAME}.cc") 5 | # REMOVE end 6 | 7 | include(leatherman) 8 | get_commit_string(PROJECT_COMMIT) 9 | 10 | # Generate a file containing the above version numbers. 11 | configure_file("version.h.in" "${CMAKE_CURRENT_LIST_DIR}/inc/${PROJECT_NAME}/version.h") 12 | 13 | # Generate files for Doxygen 14 | configure_file("Doxyfile.in" "${CMAKE_CURRENT_LIST_DIR}/Doxyfile") 15 | configure_file("namespaces.dox.in" "${CMAKE_CURRENT_LIST_DIR}/docs/namespaces.dox") 16 | 17 | # Set C++ compile flags based on project settings. 18 | set(CMAKE_CXX_FLAGS ${${PROJECT_NAME_UPPER}_CXX_FLAGS}) 19 | 20 | # Set prefix for logging messages. 21 | leatherman_logging_namespace("puppetlabs.${PROJECT_NAME}") 22 | 23 | # Setup compiling the library. 24 | include_directories(inc ${Boost_INCLUDE_DIRS} ${LEATHERMAN_INCLUDE_DIRS}) 25 | 26 | set(PROJECT_SOURCES "src/${PROJECT_NAME}.cc") 27 | 28 | ## An object target is generated that can be used by both the library and test executable targets. 29 | ## Without the intermediate target, unexported symbols can't be tested. 30 | add_library(libprojectsrc OBJECT ${PROJECT_SOURCES}) 31 | set_target_properties(libprojectsrc PROPERTIES POSITION_INDEPENDENT_CODE true) 32 | 33 | add_library(lib${PROJECT_NAME} $) 34 | set_target_properties(lib${PROJECT_NAME} PROPERTIES VERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}") 35 | target_link_libraries(lib${PROJECT_NAME} 36 | ${LEATHERMAN_LIBRARIES} 37 | ${Boost_LIBRARIES} 38 | ) 39 | 40 | symbol_exports(lib${PROJECT_NAME} "${CMAKE_CURRENT_LIST_DIR}/inc/${PROJECT_NAME}/export.h") 41 | 42 | leatherman_install(lib${PROJECT_NAME}) 43 | install(DIRECTORY inc/${PROJECT_NAME} DESTINATION include) 44 | 45 | add_subdirectory(tests) 46 | -------------------------------------------------------------------------------- /locales/cpp-project-template.pot: -------------------------------------------------------------------------------- 1 | # SOME DESCRIPTIVE TITLE. 2 | # Copyright (C) YEAR Puppet 3 | # This file is distributed under the same license as the cpp-project-template package. 4 | # FIRST AUTHOR , YEAR. 5 | # 6 | #, fuzzy 7 | msgid "" 8 | msgstr "" 9 | "Project-Id-Version: cpp-project-template 0.2.0\n" 10 | "Report-Msgid-Bugs-To: docs@puppet.com\n" 11 | "POT-Creation-Date: \n" 12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" 13 | "Last-Translator: FULL NAME \n" 14 | "Language-Team: LANGUAGE \n" 15 | "Language: \n" 16 | "MIME-Version: 1.0\n" 17 | "Content-Type: text/plain; charset=UTF-8\n" 18 | "Content-Transfer-Encoding: 8bit\n" 19 | 20 | #: exe/cpp-project-template.cc 21 | msgid "" 22 | "Synopsis\n" 23 | "========\n" 24 | "\n" 25 | "Example command-line utility.\n" 26 | "\n" 27 | "Usage\n" 28 | "=====\n" 29 | "\n" 30 | " cpp-project-template [options]\n" 31 | "\n" 32 | "Options\n" 33 | "=======\n" 34 | "\n" 35 | "{1}\n" 36 | "Description\n" 37 | "===========\n" 38 | "\n" 39 | "Displays its own version string." 40 | msgstr "" 41 | 42 | #: exe/cpp-project-template.cc 43 | msgid "Enable full debugging." 44 | msgstr "" 45 | 46 | #: exe/cpp-project-template.cc 47 | msgid "Print this help message." 48 | msgstr "" 49 | 50 | #: exe/cpp-project-template.cc 51 | msgid "Silences all output." 52 | msgstr "" 53 | 54 | #: exe/cpp-project-template.cc 55 | msgid "Enable verbosity." 56 | msgstr "" 57 | 58 | #: exe/cpp-project-template.cc 59 | msgid "Print the program's version number and exit." 60 | msgstr "" 61 | 62 | #: exe/cpp-project-template.cc 63 | msgid "" 64 | "Set logging level.\n" 65 | "Supported levels are: none, trace, debug, info, warn, error, and fatal." 66 | msgstr "" 67 | 68 | #: exe/cpp-project-template.cc 69 | msgid "Error: {1}" 70 | msgstr "" 71 | 72 | #: exe/cpp-project-template.cc 73 | msgid "unhandled exception: {1}" 74 | msgstr "" 75 | 76 | #: exe/cpp-project-template.cc 77 | msgid "Hello!" 78 | msgstr "" 79 | 80 | #. debug 81 | #: lib/src/cpp-project-template.cc 82 | msgid "cpp-project-template version is {1}" 83 | msgstr "" 84 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # Defines how cmake should behave, and the minimum version necessary to build. 2 | cmake_minimum_required(VERSION 3.2.2) 3 | 4 | # Project Setup - modify to match project naming 5 | ## Source code for a simple command-line executable for a dynamic library will be generated from the project name. 6 | ## The command-line and library names will be based off the project name. 7 | project(cpp-project-template VERSION 0.2.0) 8 | 9 | string(MAKE_C_IDENTIFIER ${PROJECT_NAME} PROJECT_C_NAME) 10 | string(TOUPPER ${PROJECT_C_NAME} PROJECT_NAME_UPPER) 11 | string(TOLOWER ${PROJECT_C_NAME} PROJECT_NAME_LOWER) 12 | 13 | # Common cmake setup 14 | if (NOT CMAKE_BUILD_TYPE) 15 | message(STATUS "Defaulting to a release build.") 16 | set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE) 17 | endif() 18 | 19 | enable_testing() 20 | 21 | # Leatherman setup 22 | SET(LEATHERMAN_COMPONENTS locale catch nowide logging) 23 | find_package(Leatherman REQUIRED COMPONENTS ${LEATHERMAN_COMPONENTS}) 24 | 25 | # Now that we have leatherman, we can pull in its options file, which 26 | # we need for finding all our other libraries. 27 | include(options) 28 | ## Pull in common cflags setting from leatherman. Don't override CMAKE_CXX_FLAGS at the project root to avoid impacting 3rd party code. 29 | include(cflags) 30 | set(${PROJECT_NAME_UPPER}_CXX_FLAGS "${LEATHERMAN_CXX_FLAGS}") 31 | add_definitions(${LEATHERMAN_DEFINITIONS}) 32 | add_definitions(-DLEATHERMAN_I18N) 33 | ## Pull in helper macros for working with leatherman libraries 34 | include(leatherman) 35 | 36 | # Add other dependencies 37 | find_package(Boost 1.54 REQUIRED COMPONENTS program_options locale filesystem) 38 | 39 | # Display a summary of the features 40 | include(FeatureSummary) 41 | feature_summary(WHAT ALL) 42 | 43 | file(GLOB_RECURSE ALL_SOURCES lib/src/*.cc lib/inc/*.hpp exe/*.cc) 44 | add_subdirectory(lib) 45 | add_subdirectory(exe) 46 | add_subdirectory(locales) 47 | 48 | # Add cpplint and cppcheck targets 49 | file(GLOB_RECURSE ALL_SOURCES lib/src/*.cc lib/inc/*.hpp exe/*.cc) 50 | add_cpplint_files(${ALL_SOURCES}) 51 | enable_cpplint() 52 | 53 | add_cppcheck_dirs("${PROJECT_SOURCE_DIR}/lib" "${PROJECT_SOURCE_DIR}/exe") 54 | enable_cppcheck() 55 | 56 | -------------------------------------------------------------------------------- /locales/fr.po: -------------------------------------------------------------------------------- 1 | # French translation of cpp-project-template.pot 2 | # Copyright (C) 2016 Puppet 3 | # This file is distributed under the same license as the cpp-project-template package. 4 | # 5 | msgid "" 6 | msgstr "" 7 | "Project-Id-Version: cpp-project-template 0.2.0\n" 8 | "Report-Msgid-Bugs-To: docs@puppet.com\n" 9 | "POT-Creation-Date: \n" 10 | "PO-Revision-Date: 2016-07-31 20:25-0700\n" 11 | "Last-Translator: \n" 12 | "Language-Team: \n" 13 | "Language: fr_FR.utf8\n" 14 | "MIME-Version: 1.0\n" 15 | "Content-Type: text/plain; charset=UTF-8\n" 16 | "Content-Transfer-Encoding: 8bit\n" 17 | "X-Generator: Poedit 1.8.8\n" 18 | "Plural-Forms: nplurals=2; plural=(n > 1);\n" 19 | 20 | #: exe/cpp-project-template.cc 21 | msgid "" 22 | "Synopsis\n" 23 | "========\n" 24 | "\n" 25 | "Example command-line utility.\n" 26 | "\n" 27 | "Usage\n" 28 | "=====\n" 29 | "\n" 30 | " cpp-project-template [options]\n" 31 | "\n" 32 | "Options\n" 33 | "=======\n" 34 | "\n" 35 | "{1}\n" 36 | "Description\n" 37 | "===========\n" 38 | "\n" 39 | "Displays its own version string." 40 | msgstr "" 41 | "Carnet de bord\n" 42 | "==============\n" 43 | "\n" 44 | "Utilitaire de ligne de commande de l’exemple.\n" 45 | "\n" 46 | "Utilisation\n" 47 | "===========\n" 48 | "\n" 49 | " cpp-project-template [options]\n" 50 | "\n" 51 | "Options\n" 52 | "=======\n" 53 | "\n" 54 | "{1}\n" 55 | "Description\n" 56 | "===========\n" 57 | "\n" 58 | "Affiche sa propre chaîne de version." 59 | 60 | #: exe/cpp-project-template.cc 61 | msgid "Enable full debugging." 62 | msgstr "Activer le débogage complet." 63 | 64 | #: exe/cpp-project-template.cc 65 | msgid "Print this help message." 66 | msgstr "Produire le message d’aide" 67 | 68 | #: exe/cpp-project-template.cc 69 | msgid "Silences all output." 70 | msgstr "Silences toutes les sorties." 71 | 72 | #: exe/cpp-project-template.cc 73 | msgid "Enable verbosity." 74 | msgstr "Activer verbosité." 75 | 76 | #: exe/cpp-project-template.cc 77 | msgid "Print the program's version number and exit." 78 | msgstr "Imprimer la version de make API de et sortir." 79 | 80 | #: exe/cpp-project-template.cc 81 | msgid "" 82 | "Set logging level.\n" 83 | "Supported levels are: none, trace, debug, info, warn, error, and fatal." 84 | msgstr "" 85 | "Réglez le niveau d’enregistrement.\n" 86 | "Niveaux de prises en charge sont : aucun, trace, debug, info, warn, error et " 87 | "fatal." 88 | 89 | #: exe/cpp-project-template.cc 90 | msgid "Error: {1}" 91 | msgstr "Erreur: {1}" 92 | 93 | #: exe/cpp-project-template.cc 94 | msgid "unhandled exception: {1}" 95 | msgstr "exception non gérée: {1}" 96 | 97 | #: exe/cpp-project-template.cc 98 | msgid "Hello!" 99 | msgstr "Salut!" 100 | 101 | #. debug 102 | #: lib/src/cpp-project-template.cc 103 | msgid "cpp-project-template version is {1}" 104 | msgstr "cpp-project-template de version est {1}" 105 | -------------------------------------------------------------------------------- /exe/driver.cc.in: -------------------------------------------------------------------------------- 1 | #include <@PROJECT_NAME@/@PROJECT_NAME@.hpp> 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | 8 | // boost includes are not always warning-clean. Disable warnings that 9 | // cause problems before including the headers, then re-enable the warnings. 10 | #pragma GCC diagnostic push 11 | #pragma GCC diagnostic ignored "-Wattributes" 12 | #include 13 | #pragma GCC diagnostic pop 14 | 15 | using namespace std; 16 | using namespace leatherman::logging; 17 | using namespace leatherman::locale; 18 | namespace po = boost::program_options; 19 | 20 | void help(po::options_description& desc) 21 | { 22 | boost::nowide::cout << 23 | _("Synopsis\n" 24 | "========\n" 25 | "\n" 26 | "Example command-line utility.\n" 27 | "\n" 28 | "Usage\n" 29 | "=====\n" 30 | "\n" 31 | " @PROJECT_NAME@ [options]\n" 32 | "\n" 33 | "Options\n" 34 | "=======\n\n" 35 | "{1}\nDescription\n" 36 | "===========\n" 37 | "\n" 38 | "Displays its own version string.", desc) << endl; 39 | } 40 | 41 | void conflicting_options(po::variables_map const& vm, string const& opt1, string const& opt2) 42 | { 43 | if (vm.count(opt1) && !vm[opt1].defaulted() && vm.count(opt2) && !vm[opt2].defaulted()) { 44 | throw po::error(opt1 + " and " + opt2 + " options conflict: please specify only one."); 45 | } 46 | } 47 | 48 | template 49 | void conflicting_options(po::variables_map const& vm, string const& opt1, string const& opt2, TOpts && ...opts) 50 | { 51 | conflicting_options(vm, opt1, opt2); 52 | conflicting_options(vm, opt1, opts...); 53 | conflicting_options(vm, opt2, opts...); 54 | } 55 | 56 | int main(int argc, char **argv) { 57 | try { 58 | // Fix args on Windows to be UTF-8 59 | boost::nowide::args arg_utf8(argc, argv); 60 | 61 | // Setup logging 62 | setup_logging(boost::nowide::cerr); 63 | 64 | // Setup UTF-8 for filesystem operations (on Windows) 65 | // When Boost is statically linked, this needs to be done in every binary using Boost.Filesystem. 66 | boost::filesystem::path::imbue(leatherman::locale::get_locale()); 67 | 68 | po::options_description visible_options(""); 69 | visible_options.add_options() 70 | ("debug,d", _("Enable full debugging.").c_str()) 71 | ("help,h", _("Print this help message.").c_str()) 72 | ("quiet,q", _("Silences all output.").c_str()) 73 | ("verbose,V", _("Enable verbosity.").c_str()) 74 | ("version,v", _("Print the program's version number and exit.").c_str()); 75 | 76 | po::options_description hidden_options(""); 77 | hidden_options.add_options() 78 | ("log-level,l", po::value()->default_value(log_level::warning, "warn"), _("Set logging level.\nSupported levels are: none, trace, debug, info, warn, error, and fatal.").c_str()); 79 | 80 | po::options_description command_line_options(""); 81 | command_line_options.add(visible_options).add(hidden_options); 82 | 83 | po::variables_map vm; 84 | 85 | try { 86 | po::store(po::parse_command_line(argc, argv, command_line_options), vm); 87 | 88 | if (vm.count("help")) { 89 | help(visible_options); 90 | return EXIT_SUCCESS; 91 | } 92 | 93 | po::notify(vm); 94 | 95 | conflicting_options(vm, "log-level", "quiet", "verbose", "debug"); 96 | } catch (exception& ex) { 97 | colorize(boost::nowide::cerr, log_level::error); 98 | boost::nowide::cerr << _("Error: {1}", ex.what()) << endl; 99 | colorize(boost::nowide::cerr); 100 | help(visible_options); 101 | return EXIT_FAILURE; 102 | } 103 | 104 | // Get the logging level 105 | auto lvl = vm["log-level"].as(); 106 | if (vm.count("debug")) { 107 | lvl = log_level::debug; 108 | } else if (vm.count("verbose")) { 109 | lvl = log_level::info; 110 | } else if (vm.count("quiet")) { 111 | lvl = log_level::none; 112 | } 113 | set_level(lvl); 114 | 115 | if (vm.count("version")) { 116 | boost::nowide::cout << @PROJECT_NAME_LOWER@::version() << endl; 117 | return EXIT_SUCCESS; 118 | } 119 | } catch (exception& ex) { 120 | colorize(boost::nowide::cerr, log_level::fatal); 121 | boost::nowide::cerr << _("unhandled exception: {1}", ex.what()) << endl; 122 | colorize(boost::nowide::cerr); 123 | return EXIT_FAILURE; 124 | } 125 | 126 | boost::nowide::cout << _("Hello!") << endl; 127 | 128 | return error_has_been_logged() ? EXIT_FAILURE : EXIT_SUCCESS; 129 | } 130 | -------------------------------------------------------------------------------- /lib/Doxyfile.in: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.7 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 = "@PROJECT_NAME@" 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 = @PROJECT_VERSION@ 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52 | # to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # 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 = YES 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 = YES 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 = inc/ 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 = YES 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 209 | # new page for each member. If set to NO, the documentation of a member will be 210 | # part 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 by putting a % sign in front of the word 299 | # or 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 = YES 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 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 347 | # (for instance a group of public functions) to be put as a subgroup of that 348 | # type (e.g. under the Public Functions section). Set it to NO to prevent 349 | # subgrouping. Alternatively, this can be done per class using the 350 | # \nosubgrouping command. 351 | # The default value is: YES. 352 | 353 | SUBGROUPING = YES 354 | 355 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 356 | # are shown inside the group in which they are included (e.g. using \ingroup) 357 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 358 | # and RTF). 359 | # 360 | # Note that this feature does not work in combination with 361 | # SEPARATE_MEMBER_PAGES. 362 | # The default value is: NO. 363 | 364 | INLINE_GROUPED_CLASSES = NO 365 | 366 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 367 | # with only public data fields or simple typedef fields will be shown inline in 368 | # the documentation of the scope in which they are defined (i.e. file, 369 | # namespace, or group documentation), provided this scope is documented. If set 370 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 371 | # Man pages) or section (for LaTeX and RTF). 372 | # The default value is: NO. 373 | 374 | INLINE_SIMPLE_STRUCTS = NO 375 | 376 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 377 | # enum is documented as struct, union, or enum with the name of the typedef. So 378 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 379 | # with name TypeT. When disabled the typedef will appear as a member of a file, 380 | # namespace, or class. And the struct will be named TypeS. This can typically be 381 | # useful for C code in case the coding convention dictates that all compound 382 | # types are typedef'ed and only the typedef is referenced, never the tag name. 383 | # The default value is: NO. 384 | 385 | TYPEDEF_HIDES_STRUCT = YES 386 | 387 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 388 | # cache is used to resolve symbols given their name and scope. Since this can be 389 | # an expensive process and often the same symbol appears multiple times in the 390 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 391 | # doxygen will become slower. If the cache is too large, memory is wasted. The 392 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 393 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 394 | # symbols. At the end of a run doxygen will report the cache usage and suggest 395 | # the optimal cache size from a speed point of view. 396 | # Minimum value: 0, maximum value: 9, default value: 0. 397 | 398 | LOOKUP_CACHE_SIZE = 0 399 | 400 | #--------------------------------------------------------------------------- 401 | # Build related configuration options 402 | #--------------------------------------------------------------------------- 403 | 404 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 405 | # documentation are documented, even if no documentation was available. Private 406 | # class members and static file members will be hidden unless the 407 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 408 | # Note: This will also disable the warnings about undocumented members that are 409 | # normally produced when WARNINGS is set to YES. 410 | # The default value is: NO. 411 | 412 | EXTRACT_ALL = NO 413 | 414 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 415 | # be included in the documentation. 416 | # The default value is: NO. 417 | 418 | EXTRACT_PRIVATE = NO 419 | 420 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 421 | # scope will be included in the documentation. 422 | # The default value is: NO. 423 | 424 | EXTRACT_PACKAGE = YES 425 | 426 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 427 | # included in the documentation. 428 | # The default value is: NO. 429 | 430 | EXTRACT_STATIC = YES 431 | 432 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 433 | # locally in source files will be included in the documentation. If set to NO 434 | # only classes defined in header files are included. Does not have any effect 435 | # for Java sources. 436 | # The default value is: YES. 437 | 438 | EXTRACT_LOCAL_CLASSES = YES 439 | 440 | # This flag is only useful for Objective-C code. When set to YES local methods, 441 | # which are defined in the implementation section but not in the interface are 442 | # included in the documentation. If set to NO only methods in the interface are 443 | # included. 444 | # The default value is: NO. 445 | 446 | EXTRACT_LOCAL_METHODS = YES 447 | 448 | # If this flag is set to YES, the members of anonymous namespaces will be 449 | # extracted and appear in the documentation as a namespace called 450 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 451 | # the file that contains the anonymous namespace. By default anonymous namespace 452 | # are hidden. 453 | # The default value is: NO. 454 | 455 | EXTRACT_ANON_NSPACES = YES 456 | 457 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 458 | # undocumented members inside documented classes or files. If set to NO these 459 | # members will be included in the various overviews, but no documentation 460 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 461 | # The default value is: NO. 462 | 463 | HIDE_UNDOC_MEMBERS = NO 464 | 465 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 466 | # undocumented classes that are normally visible in the class hierarchy. If set 467 | # to NO these classes will be included in the various overviews. This option has 468 | # no effect if EXTRACT_ALL is enabled. 469 | # The default value is: NO. 470 | 471 | HIDE_UNDOC_CLASSES = NO 472 | 473 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 474 | # (class|struct|union) declarations. If set to NO these declarations will be 475 | # included in the documentation. 476 | # The default value is: NO. 477 | 478 | HIDE_FRIEND_COMPOUNDS = NO 479 | 480 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 481 | # documentation blocks found inside the body of a function. If set to NO these 482 | # blocks will be appended to the function's detailed documentation block. 483 | # The default value is: NO. 484 | 485 | HIDE_IN_BODY_DOCS = NO 486 | 487 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 488 | # \internal command is included. If the tag is set to NO then the documentation 489 | # will be excluded. Set it to YES to include the internal documentation. 490 | # The default value is: NO. 491 | 492 | INTERNAL_DOCS = NO 493 | 494 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 495 | # names in lower-case letters. If set to YES upper-case letters are also 496 | # allowed. This is useful if you have classes or files whose names only differ 497 | # in case and if your file system supports case sensitive file names. Windows 498 | # and Mac users are advised to set this option to NO. 499 | # The default value is: system dependent. 500 | 501 | CASE_SENSE_NAMES = NO 502 | 503 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 504 | # their full class and namespace scopes in the documentation. If set to YES the 505 | # scope will be hidden. 506 | # The default value is: NO. 507 | 508 | HIDE_SCOPE_NAMES = NO 509 | 510 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 511 | # the files that are included by a file in the documentation of that file. 512 | # The default value is: YES. 513 | 514 | SHOW_INCLUDE_FILES = NO 515 | 516 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 517 | # grouped member an include statement to the documentation, telling the reader 518 | # which file to include in order to use the member. 519 | # The default value is: NO. 520 | 521 | SHOW_GROUPED_MEMB_INC = YES 522 | 523 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 524 | # files with double quotes in the documentation rather than with sharp brackets. 525 | # The default value is: NO. 526 | 527 | FORCE_LOCAL_INCLUDES = NO 528 | 529 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 530 | # documentation for inline members. 531 | # The default value is: YES. 532 | 533 | INLINE_INFO = YES 534 | 535 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 536 | # (detailed) documentation of file and class members alphabetically by member 537 | # name. If set to NO the members will appear in declaration order. 538 | # The default value is: YES. 539 | 540 | SORT_MEMBER_DOCS = YES 541 | 542 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 543 | # descriptions of file, namespace and class members alphabetically by member 544 | # name. If set to NO the members will appear in declaration order. Note that 545 | # this will also influence the order of the classes in the class list. 546 | # The default value is: NO. 547 | 548 | SORT_BRIEF_DOCS = NO 549 | 550 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 551 | # (brief and detailed) documentation of class members so that constructors and 552 | # destructors are listed first. If set to NO the constructors will appear in the 553 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 554 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 555 | # member documentation. 556 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 557 | # detailed member documentation. 558 | # The default value is: NO. 559 | 560 | SORT_MEMBERS_CTORS_1ST = NO 561 | 562 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 563 | # of group names into alphabetical order. If set to NO the group names will 564 | # appear in their defined order. 565 | # The default value is: NO. 566 | 567 | SORT_GROUP_NAMES = YES 568 | 569 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 570 | # fully-qualified names, including namespaces. If set to NO, the class list will 571 | # be sorted only by class name, not including the namespace part. 572 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 573 | # Note: This option applies only to the class list, not to the alphabetical 574 | # list. 575 | # The default value is: NO. 576 | 577 | SORT_BY_SCOPE_NAME = NO 578 | 579 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 580 | # type resolution of all parameters of a function it will reject a match between 581 | # the prototype and the implementation of a member function even if there is 582 | # only one candidate or it is obvious which candidate to choose by doing a 583 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 584 | # accept a match between prototype and implementation in such cases. 585 | # The default value is: NO. 586 | 587 | STRICT_PROTO_MATCHING = NO 588 | 589 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 590 | # todo list. This list is created by putting \todo commands in the 591 | # documentation. 592 | # The default value is: YES. 593 | 594 | GENERATE_TODOLIST = YES 595 | 596 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 597 | # test list. This list is created by putting \test commands in the 598 | # documentation. 599 | # The default value is: YES. 600 | 601 | GENERATE_TESTLIST = YES 602 | 603 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 604 | # list. This list is created by putting \bug commands in the documentation. 605 | # The default value is: YES. 606 | 607 | GENERATE_BUGLIST = YES 608 | 609 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 610 | # the deprecated list. This list is created by putting \deprecated commands in 611 | # the documentation. 612 | # The default value is: YES. 613 | 614 | GENERATE_DEPRECATEDLIST= YES 615 | 616 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 617 | # sections, marked by \if ... \endif and \cond 618 | # ... \endcond blocks. 619 | 620 | ENABLED_SECTIONS = 621 | 622 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 623 | # initial value of a variable or macro / define can have for it to appear in the 624 | # documentation. If the initializer consists of more lines than specified here 625 | # it will be hidden. Use a value of 0 to hide initializers completely. The 626 | # appearance of the value of individual variables and macros / defines can be 627 | # controlled using \showinitializer or \hideinitializer command in the 628 | # documentation regardless of this setting. 629 | # Minimum value: 0, maximum value: 10000, default value: 30. 630 | 631 | MAX_INITIALIZER_LINES = 30 632 | 633 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 634 | # the bottom of the documentation of classes and structs. If set to YES the list 635 | # will mention the files that were used to generate the documentation. 636 | # The default value is: YES. 637 | 638 | SHOW_USED_FILES = YES 639 | 640 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 641 | # will remove the Files entry from the Quick Index and from the Folder Tree View 642 | # (if specified). 643 | # The default value is: YES. 644 | 645 | SHOW_FILES = YES 646 | 647 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 648 | # page. This will remove the Namespaces entry from the Quick Index and from the 649 | # Folder Tree View (if specified). 650 | # The default value is: YES. 651 | 652 | SHOW_NAMESPACES = YES 653 | 654 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 655 | # doxygen should invoke to get the current version for each file (typically from 656 | # the version control system). Doxygen will invoke the program by executing (via 657 | # popen()) the command command input-file, where command is the value of the 658 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 659 | # by doxygen. Whatever the program writes to standard output is used as the file 660 | # version. For an example see the documentation. 661 | 662 | FILE_VERSION_FILTER = 663 | 664 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 665 | # by doxygen. The layout file controls the global structure of the generated 666 | # output files in an output format independent way. To create the layout file 667 | # that represents doxygen's defaults, run doxygen with the -l option. You can 668 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 669 | # will be used as the name of the layout file. 670 | # 671 | # Note that if you run doxygen from a directory containing a file called 672 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 673 | # tag is left empty. 674 | 675 | LAYOUT_FILE = 676 | 677 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 678 | # the reference definitions. This must be a list of .bib files. The .bib 679 | # extension is automatically appended if omitted. This requires the bibtex tool 680 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 681 | # For LaTeX the style of the bibliography can be controlled using 682 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 683 | # search path. Do not use file names with spaces, bibtex cannot handle them. See 684 | # also \cite for info how to create references. 685 | 686 | CITE_BIB_FILES = 687 | 688 | #--------------------------------------------------------------------------- 689 | # Configuration options related to warning and progress messages 690 | #--------------------------------------------------------------------------- 691 | 692 | # The QUIET tag can be used to turn on/off the messages that are generated to 693 | # standard output by doxygen. If QUIET is set to YES this implies that the 694 | # messages are off. 695 | # The default value is: NO. 696 | 697 | QUIET = YES 698 | 699 | # The WARNINGS tag can be used to turn on/off the warning messages that are 700 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 701 | # this implies that the warnings are on. 702 | # 703 | # Tip: Turn warnings on while writing the documentation. 704 | # The default value is: YES. 705 | 706 | WARNINGS = YES 707 | 708 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 709 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 710 | # will automatically be disabled. 711 | # The default value is: YES. 712 | 713 | WARN_IF_UNDOCUMENTED = YES 714 | 715 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 716 | # potential errors in the documentation, such as not documenting some parameters 717 | # in a documented function, or documenting parameters that don't exist or using 718 | # markup commands wrongly. 719 | # The default value is: YES. 720 | 721 | WARN_IF_DOC_ERROR = YES 722 | 723 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 724 | # are documented, but have no documentation for their parameters or return 725 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter 726 | # documentation, but not about the absence of documentation. 727 | # The default value is: NO. 728 | 729 | WARN_NO_PARAMDOC = YES 730 | 731 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 732 | # can produce. The string should contain the $file, $line, and $text tags, which 733 | # will be replaced by the file and line number from which the warning originated 734 | # and the warning text. Optionally the format may contain $version, which will 735 | # be replaced by the version of the file (if it could be obtained via 736 | # FILE_VERSION_FILTER) 737 | # The default value is: $file:$line: $text. 738 | 739 | WARN_FORMAT = "$file:$line: $text" 740 | 741 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 742 | # messages should be written. If left blank the output is written to standard 743 | # error (stderr). 744 | 745 | WARN_LOGFILE = html/warnings.txt 746 | 747 | #--------------------------------------------------------------------------- 748 | # Configuration options related to the input files 749 | #--------------------------------------------------------------------------- 750 | 751 | # The INPUT tag is used to specify the files and/or directories that contain 752 | # documented source files. You may enter file names like myfile.cpp or 753 | # directories like /usr/src/myproject. Separate the files or directories with 754 | # spaces. 755 | # Note: If this tag is empty the current directory is searched. 756 | 757 | INPUT = ../README.md \ 758 | inc \ 759 | docs 760 | 761 | # This tag can be used to specify the character encoding of the source files 762 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 763 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 764 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 765 | # possible encodings. 766 | # The default value is: UTF-8. 767 | 768 | INPUT_ENCODING = UTF-8 769 | 770 | # If the value of the INPUT tag contains directories, you can use the 771 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 772 | # *.h) to filter out the source-files in the directories. If left blank the 773 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 774 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 775 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 776 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 777 | # *.qsf, *.as and *.js. 778 | 779 | FILE_PATTERNS = 780 | 781 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 782 | # be searched for input files as well. 783 | # The default value is: NO. 784 | 785 | RECURSIVE = YES 786 | 787 | # The EXCLUDE tag can be used to specify files and/or directories that should be 788 | # excluded from the INPUT source files. This way you can easily exclude a 789 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 790 | # 791 | # Note that relative paths are relative to the directory from which doxygen is 792 | # run. 793 | 794 | EXCLUDE = 795 | 796 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 797 | # directories that are symbolic links (a Unix file system feature) are excluded 798 | # from the input. 799 | # The default value is: NO. 800 | 801 | EXCLUDE_SYMLINKS = NO 802 | 803 | # If the value of the INPUT tag contains directories, you can use the 804 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 805 | # certain files from those directories. 806 | # 807 | # Note that the wildcards are matched against the file with absolute path, so to 808 | # exclude all test directories for example use the pattern */test/* 809 | 810 | EXCLUDE_PATTERNS = 811 | 812 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 813 | # (namespaces, classes, functions, etc.) that should be excluded from the 814 | # output. The symbol name can be a fully qualified name, a word, or if the 815 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 816 | # AClass::ANamespace, ANamespace::*Test 817 | # 818 | # Note that the wildcards are matched against the file with absolute path, so to 819 | # exclude all test directories use the pattern */test/* 820 | 821 | EXCLUDE_SYMBOLS = 822 | 823 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 824 | # that contain example code fragments that are included (see the \include 825 | # command). 826 | 827 | EXAMPLE_PATH = 828 | 829 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 830 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 831 | # *.h) to filter out the source-files in the directories. If left blank all 832 | # files are included. 833 | 834 | EXAMPLE_PATTERNS = 835 | 836 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 837 | # searched for input files to be used with the \include or \dontinclude commands 838 | # irrespective of the value of the RECURSIVE tag. 839 | # The default value is: NO. 840 | 841 | EXAMPLE_RECURSIVE = NO 842 | 843 | # The IMAGE_PATH tag can be used to specify one or more files or directories 844 | # that contain images that are to be included in the documentation (see the 845 | # \image command). 846 | 847 | IMAGE_PATH = 848 | 849 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 850 | # invoke to filter for each input file. Doxygen will invoke the filter program 851 | # by executing (via popen()) the command: 852 | # 853 | # 854 | # 855 | # where is the value of the INPUT_FILTER tag, and is the 856 | # name of an input file. Doxygen will then use the output that the filter 857 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 858 | # will be ignored. 859 | # 860 | # Note that the filter must not add or remove lines; it is applied before the 861 | # code is scanned, but not when the output code is generated. If lines are added 862 | # or removed, the anchors will not be placed correctly. 863 | 864 | INPUT_FILTER = 865 | 866 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 867 | # basis. Doxygen will compare the file name with each pattern and apply the 868 | # filter if there is a match. The filters are a list of the form: pattern=filter 869 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 870 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 871 | # patterns match the file name, INPUT_FILTER is applied. 872 | 873 | FILTER_PATTERNS = 874 | 875 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 876 | # INPUT_FILTER ) will also be used to filter the input files that are used for 877 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 878 | # The default value is: NO. 879 | 880 | FILTER_SOURCE_FILES = NO 881 | 882 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 883 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 884 | # it is also possible to disable source filtering for a specific pattern using 885 | # *.ext= (so without naming a filter). 886 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 887 | 888 | FILTER_SOURCE_PATTERNS = 889 | 890 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 891 | # is part of the input, its contents will be placed on the main page 892 | # (index.html). This can be useful if you have a project on for instance GitHub 893 | # and want to reuse the introduction page also for the doxygen output. 894 | 895 | USE_MDFILE_AS_MAINPAGE = README.md 896 | 897 | #--------------------------------------------------------------------------- 898 | # Configuration options related to source browsing 899 | #--------------------------------------------------------------------------- 900 | 901 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 902 | # generated. Documented entities will be cross-referenced with these sources. 903 | # 904 | # Note: To get rid of all source code in the generated output, make sure that 905 | # also VERBATIM_HEADERS is set to NO. 906 | # The default value is: NO. 907 | 908 | SOURCE_BROWSER = YES 909 | 910 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 911 | # classes and enums directly into the documentation. 912 | # The default value is: NO. 913 | 914 | INLINE_SOURCES = NO 915 | 916 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 917 | # special comment blocks from generated source code fragments. Normal C, C++ and 918 | # Fortran comments will always remain visible. 919 | # The default value is: YES. 920 | 921 | STRIP_CODE_COMMENTS = YES 922 | 923 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 924 | # function all documented functions referencing it will be listed. 925 | # The default value is: NO. 926 | 927 | REFERENCED_BY_RELATION = NO 928 | 929 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 930 | # all documented entities called/used by that function will be listed. 931 | # The default value is: NO. 932 | 933 | REFERENCES_RELATION = NO 934 | 935 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 936 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and 937 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 938 | # link to the documentation. 939 | # The default value is: YES. 940 | 941 | REFERENCES_LINK_SOURCE = YES 942 | 943 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 944 | # source code will show a tooltip with additional information such as prototype, 945 | # brief description and links to the definition and documentation. Since this 946 | # will make the HTML file larger and loading of large files a bit slower, you 947 | # can opt to disable this feature. 948 | # The default value is: YES. 949 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 950 | 951 | SOURCE_TOOLTIPS = YES 952 | 953 | # If the USE_HTAGS tag is set to YES then the references to source code will 954 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 955 | # source browser. The htags tool is part of GNU's global source tagging system 956 | # (see http://www.gnu.org/software/global/global.html). You will need version 957 | # 4.8.6 or higher. 958 | # 959 | # To use it do the following: 960 | # - Install the latest version of global 961 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 962 | # - Make sure the INPUT points to the root of the source tree 963 | # - Run doxygen as normal 964 | # 965 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 966 | # tools must be available from the command line (i.e. in the search path). 967 | # 968 | # The result: instead of the source browser generated by doxygen, the links to 969 | # source code will now point to the output of htags. 970 | # The default value is: NO. 971 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 972 | 973 | USE_HTAGS = NO 974 | 975 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 976 | # verbatim copy of the header file for each class for which an include is 977 | # specified. Set to NO to disable this. 978 | # See also: Section \class. 979 | # The default value is: YES. 980 | 981 | VERBATIM_HEADERS = YES 982 | 983 | #--------------------------------------------------------------------------- 984 | # Configuration options related to the alphabetical class index 985 | #--------------------------------------------------------------------------- 986 | 987 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 988 | # compounds will be generated. Enable this if the project contains a lot of 989 | # classes, structs, unions or interfaces. 990 | # The default value is: YES. 991 | 992 | ALPHABETICAL_INDEX = YES 993 | 994 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 995 | # which the alphabetical index list will be split. 996 | # Minimum value: 1, maximum value: 20, default value: 5. 997 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 998 | 999 | COLS_IN_ALPHA_INDEX = 5 1000 | 1001 | # In case all classes in a project start with a common prefix, all classes will 1002 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1003 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1004 | # while generating the index headers. 1005 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1006 | 1007 | IGNORE_PREFIX = 1008 | 1009 | #--------------------------------------------------------------------------- 1010 | # Configuration options related to the HTML output 1011 | #--------------------------------------------------------------------------- 1012 | 1013 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1014 | # The default value is: YES. 1015 | 1016 | GENERATE_HTML = YES 1017 | 1018 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1019 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1020 | # it. 1021 | # The default directory is: html. 1022 | # This tag requires that the tag GENERATE_HTML is set to YES. 1023 | 1024 | HTML_OUTPUT = html 1025 | 1026 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1027 | # generated HTML page (for example: .htm, .php, .asp). 1028 | # The default value is: .html. 1029 | # This tag requires that the tag GENERATE_HTML is set to YES. 1030 | 1031 | HTML_FILE_EXTENSION = .html 1032 | 1033 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1034 | # each generated HTML page. If the tag is left blank doxygen will generate a 1035 | # standard header. 1036 | # 1037 | # To get valid HTML the header file that includes any scripts and style sheets 1038 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1039 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1040 | # default header using 1041 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1042 | # YourConfigFile 1043 | # and then modify the file new_header.html. See also section "Doxygen usage" 1044 | # for information on how to generate the default header that doxygen normally 1045 | # uses. 1046 | # Note: The header is subject to change so you typically have to regenerate the 1047 | # default header when upgrading to a newer version of doxygen. For a description 1048 | # of the possible markers and block names see the documentation. 1049 | # This tag requires that the tag GENERATE_HTML is set to YES. 1050 | 1051 | HTML_HEADER = 1052 | 1053 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1054 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1055 | # footer. See HTML_HEADER for more information on how to generate a default 1056 | # footer and what special commands can be used inside the footer. See also 1057 | # section "Doxygen usage" for information on how to generate the default footer 1058 | # that doxygen normally uses. 1059 | # This tag requires that the tag GENERATE_HTML is set to YES. 1060 | 1061 | HTML_FOOTER = 1062 | 1063 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1064 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1065 | # the HTML output. If left blank doxygen will generate a default style sheet. 1066 | # See also section "Doxygen usage" for information on how to generate the style 1067 | # sheet that doxygen normally uses. 1068 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1069 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1070 | # obsolete. 1071 | # This tag requires that the tag GENERATE_HTML is set to YES. 1072 | 1073 | HTML_STYLESHEET = 1074 | 1075 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1076 | # defined cascading style sheet that is included after the standard style sheets 1077 | # created by doxygen. Using this option one can overrule certain style aspects. 1078 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1079 | # standard style sheet and is therefor more robust against future updates. 1080 | # Doxygen will copy the style sheet file to the output directory. For an example 1081 | # see the documentation. 1082 | # This tag requires that the tag GENERATE_HTML is set to YES. 1083 | 1084 | HTML_EXTRA_STYLESHEET = 1085 | 1086 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1087 | # other source files which should be copied to the HTML output directory. Note 1088 | # that these files will be copied to the base HTML output directory. Use the 1089 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1090 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1091 | # files will be copied as-is; there are no commands or markers available. 1092 | # This tag requires that the tag GENERATE_HTML is set to YES. 1093 | 1094 | HTML_EXTRA_FILES = 1095 | 1096 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1097 | # will adjust the colors in the stylesheet and background images according to 1098 | # this color. Hue is specified as an angle on a colorwheel, see 1099 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1100 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1101 | # purple, and 360 is red again. 1102 | # Minimum value: 0, maximum value: 359, default value: 220. 1103 | # This tag requires that the tag GENERATE_HTML is set to YES. 1104 | 1105 | HTML_COLORSTYLE_HUE = 220 1106 | 1107 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1108 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1109 | # value of 255 will produce the most vivid colors. 1110 | # Minimum value: 0, maximum value: 255, default value: 100. 1111 | # This tag requires that the tag GENERATE_HTML is set to YES. 1112 | 1113 | HTML_COLORSTYLE_SAT = 100 1114 | 1115 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1116 | # luminance component of the colors in the HTML output. Values below 100 1117 | # gradually make the output lighter, whereas values above 100 make the output 1118 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1119 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1120 | # change the gamma. 1121 | # Minimum value: 40, maximum value: 240, default value: 80. 1122 | # This tag requires that the tag GENERATE_HTML is set to YES. 1123 | 1124 | HTML_COLORSTYLE_GAMMA = 80 1125 | 1126 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1127 | # page will contain the date and time when the page was generated. Setting this 1128 | # to NO can help when comparing the output of multiple runs. 1129 | # The default value is: YES. 1130 | # This tag requires that the tag GENERATE_HTML is set to YES. 1131 | 1132 | HTML_TIMESTAMP = YES 1133 | 1134 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1135 | # documentation will contain sections that can be hidden and shown after the 1136 | # page has loaded. 1137 | # The default value is: NO. 1138 | # This tag requires that the tag GENERATE_HTML is set to YES. 1139 | 1140 | HTML_DYNAMIC_SECTIONS = NO 1141 | 1142 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1143 | # shown in the various tree structured indices initially; the user can expand 1144 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1145 | # such a level that at most the specified number of entries are visible (unless 1146 | # a fully collapsed tree already exceeds this amount). So setting the number of 1147 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1148 | # representing an infinite number of entries and will result in a full expanded 1149 | # tree by default. 1150 | # Minimum value: 0, maximum value: 9999, default value: 100. 1151 | # This tag requires that the tag GENERATE_HTML is set to YES. 1152 | 1153 | HTML_INDEX_NUM_ENTRIES = 100 1154 | 1155 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1156 | # generated that can be used as input for Apple's Xcode 3 integrated development 1157 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1158 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1159 | # Makefile in the HTML output directory. Running make will produce the docset in 1160 | # that directory and running make install will install the docset in 1161 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1162 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1163 | # for more information. 1164 | # The default value is: NO. 1165 | # This tag requires that the tag GENERATE_HTML is set to YES. 1166 | 1167 | GENERATE_DOCSET = NO 1168 | 1169 | # This tag determines the name of the docset feed. A documentation feed provides 1170 | # an umbrella under which multiple documentation sets from a single provider 1171 | # (such as a company or product suite) can be grouped. 1172 | # The default value is: Doxygen generated docs. 1173 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1174 | 1175 | DOCSET_FEEDNAME = "Doxygen generated docs" 1176 | 1177 | # This tag specifies a string that should uniquely identify the documentation 1178 | # set bundle. This should be a reverse domain-name style string, e.g. 1179 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1180 | # The default value is: org.doxygen.Project. 1181 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1182 | 1183 | DOCSET_BUNDLE_ID = org.doxygen.Project 1184 | 1185 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1186 | # the documentation publisher. This should be a reverse domain-name style 1187 | # string, e.g. com.mycompany.MyDocSet.documentation. 1188 | # The default value is: org.doxygen.Publisher. 1189 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1190 | 1191 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1192 | 1193 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1194 | # The default value is: Publisher. 1195 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1196 | 1197 | DOCSET_PUBLISHER_NAME = Publisher 1198 | 1199 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1200 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1201 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1202 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1203 | # Windows. 1204 | # 1205 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1206 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1207 | # files are now used as the Windows 98 help format, and will replace the old 1208 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1209 | # HTML files also contain an index, a table of contents, and you can search for 1210 | # words in the documentation. The HTML workshop also contains a viewer for 1211 | # compressed HTML files. 1212 | # The default value is: NO. 1213 | # This tag requires that the tag GENERATE_HTML is set to YES. 1214 | 1215 | GENERATE_HTMLHELP = NO 1216 | 1217 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1218 | # file. You can add a path in front of the file if the result should not be 1219 | # written to the html output directory. 1220 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1221 | 1222 | CHM_FILE = 1223 | 1224 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1225 | # including file name) of the HTML help compiler ( hhc.exe). If non-empty 1226 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1227 | # The file has to be specified with full path. 1228 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1229 | 1230 | HHC_LOCATION = 1231 | 1232 | # The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1233 | # YES) or that it should be included in the master .chm file ( NO). 1234 | # The default value is: NO. 1235 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1236 | 1237 | GENERATE_CHI = NO 1238 | 1239 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1240 | # and project file content. 1241 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1242 | 1243 | CHM_INDEX_ENCODING = 1244 | 1245 | # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1246 | # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it 1247 | # enables the Previous and Next buttons. 1248 | # The default value is: NO. 1249 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1250 | 1251 | BINARY_TOC = NO 1252 | 1253 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1254 | # the table of contents of the HTML help documentation and to the tree view. 1255 | # The default value is: NO. 1256 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1257 | 1258 | TOC_EXPAND = NO 1259 | 1260 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1261 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1262 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1263 | # (.qch) of the generated HTML documentation. 1264 | # The default value is: NO. 1265 | # This tag requires that the tag GENERATE_HTML is set to YES. 1266 | 1267 | GENERATE_QHP = NO 1268 | 1269 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1270 | # the file name of the resulting .qch file. The path specified is relative to 1271 | # the HTML output folder. 1272 | # This tag requires that the tag GENERATE_QHP is set to YES. 1273 | 1274 | QCH_FILE = 1275 | 1276 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1277 | # Project output. For more information please see Qt Help Project / Namespace 1278 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1279 | # The default value is: org.doxygen.Project. 1280 | # This tag requires that the tag GENERATE_QHP is set to YES. 1281 | 1282 | QHP_NAMESPACE = 1283 | 1284 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1285 | # Help Project output. For more information please see Qt Help Project / Virtual 1286 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1287 | # folders). 1288 | # The default value is: doc. 1289 | # This tag requires that the tag GENERATE_QHP is set to YES. 1290 | 1291 | QHP_VIRTUAL_FOLDER = doc 1292 | 1293 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1294 | # filter to add. For more information please see Qt Help Project / Custom 1295 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1296 | # filters). 1297 | # This tag requires that the tag GENERATE_QHP is set to YES. 1298 | 1299 | QHP_CUST_FILTER_NAME = 1300 | 1301 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1302 | # custom filter to add. For more information please see Qt Help Project / Custom 1303 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1304 | # filters). 1305 | # This tag requires that the tag GENERATE_QHP is set to YES. 1306 | 1307 | QHP_CUST_FILTER_ATTRS = 1308 | 1309 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1310 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1311 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1312 | # This tag requires that the tag GENERATE_QHP is set to YES. 1313 | 1314 | QHP_SECT_FILTER_ATTRS = 1315 | 1316 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1317 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1318 | # generated .qhp file. 1319 | # This tag requires that the tag GENERATE_QHP is set to YES. 1320 | 1321 | QHG_LOCATION = 1322 | 1323 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1324 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1325 | # install this plugin and make it available under the help contents menu in 1326 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1327 | # to be copied into the plugins directory of eclipse. The name of the directory 1328 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1329 | # After copying Eclipse needs to be restarted before the help appears. 1330 | # The default value is: NO. 1331 | # This tag requires that the tag GENERATE_HTML is set to YES. 1332 | 1333 | GENERATE_ECLIPSEHELP = NO 1334 | 1335 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1336 | # the directory name containing the HTML and XML files should also have this 1337 | # name. Each documentation set should have its own identifier. 1338 | # The default value is: org.doxygen.Project. 1339 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1340 | 1341 | ECLIPSE_DOC_ID = org.doxygen.Project 1342 | 1343 | # If you want full control over the layout of the generated HTML pages it might 1344 | # be necessary to disable the index and replace it with your own. The 1345 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1346 | # of each HTML page. A value of NO enables the index and the value YES disables 1347 | # it. Since the tabs in the index contain the same information as the navigation 1348 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1349 | # The default value is: NO. 1350 | # This tag requires that the tag GENERATE_HTML is set to YES. 1351 | 1352 | DISABLE_INDEX = NO 1353 | 1354 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1355 | # structure should be generated to display hierarchical information. If the tag 1356 | # value is set to YES, a side panel will be generated containing a tree-like 1357 | # index structure (just like the one that is generated for HTML Help). For this 1358 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1359 | # (i.e. any modern browser). Windows users are probably better off using the 1360 | # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1361 | # further fine-tune the look of the index. As an example, the default style 1362 | # sheet generated by doxygen has an example that shows how to put an image at 1363 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1364 | # the same information as the tab index, you could consider setting 1365 | # DISABLE_INDEX to YES when enabling this option. 1366 | # The default value is: NO. 1367 | # This tag requires that the tag GENERATE_HTML is set to YES. 1368 | 1369 | GENERATE_TREEVIEW = NO 1370 | 1371 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1372 | # doxygen will group on one line in the generated HTML documentation. 1373 | # 1374 | # Note that a value of 0 will completely suppress the enum values from appearing 1375 | # in the overview section. 1376 | # Minimum value: 0, maximum value: 20, default value: 4. 1377 | # This tag requires that the tag GENERATE_HTML is set to YES. 1378 | 1379 | ENUM_VALUES_PER_LINE = 4 1380 | 1381 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1382 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1383 | # Minimum value: 0, maximum value: 1500, default value: 250. 1384 | # This tag requires that the tag GENERATE_HTML is set to YES. 1385 | 1386 | TREEVIEW_WIDTH = 250 1387 | 1388 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1389 | # external symbols imported via tag files in a separate window. 1390 | # The default value is: NO. 1391 | # This tag requires that the tag GENERATE_HTML is set to YES. 1392 | 1393 | EXT_LINKS_IN_WINDOW = NO 1394 | 1395 | # Use this tag to change the font size of LaTeX formulas included as images in 1396 | # the HTML documentation. When you change the font size after a successful 1397 | # doxygen run you need to manually remove any form_*.png images from the HTML 1398 | # output directory to force them to be regenerated. 1399 | # Minimum value: 8, maximum value: 50, default value: 10. 1400 | # This tag requires that the tag GENERATE_HTML is set to YES. 1401 | 1402 | FORMULA_FONTSIZE = 10 1403 | 1404 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1405 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1406 | # supported properly for IE 6.0, but are supported on all modern browsers. 1407 | # 1408 | # Note that when changing this option you need to delete any form_*.png files in 1409 | # the HTML output directory before the changes have effect. 1410 | # The default value is: YES. 1411 | # This tag requires that the tag GENERATE_HTML is set to YES. 1412 | 1413 | FORMULA_TRANSPARENT = YES 1414 | 1415 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1416 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1417 | # instead of using prerendered bitmaps. Use this if you do not have LaTeX 1418 | # installed or if you want to formulas look prettier in the HTML output. When 1419 | # enabled you may also need to install MathJax separately and configure the path 1420 | # to it using the MATHJAX_RELPATH option. 1421 | # The default value is: NO. 1422 | # This tag requires that the tag GENERATE_HTML is set to YES. 1423 | 1424 | USE_MATHJAX = NO 1425 | 1426 | # When MathJax is enabled you can set the default output format to be used for 1427 | # the MathJax output. See the MathJax site (see: 1428 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1429 | # Possible values are: HTML-CSS (which is slower, but has the best 1430 | # compatibility), NativeMML (i.e. MathML) and SVG. 1431 | # The default value is: HTML-CSS. 1432 | # This tag requires that the tag USE_MATHJAX is set to YES. 1433 | 1434 | MATHJAX_FORMAT = HTML-CSS 1435 | 1436 | # When MathJax is enabled you need to specify the location relative to the HTML 1437 | # output directory using the MATHJAX_RELPATH option. The destination directory 1438 | # should contain the MathJax.js script. For instance, if the mathjax directory 1439 | # is located at the same level as the HTML output directory, then 1440 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1441 | # Content Delivery Network so you can quickly see the result without installing 1442 | # MathJax. However, it is strongly recommended to install a local copy of 1443 | # MathJax from http://www.mathjax.org before deployment. 1444 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1445 | # This tag requires that the tag USE_MATHJAX is set to YES. 1446 | 1447 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1448 | 1449 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1450 | # extension names that should be enabled during MathJax rendering. For example 1451 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1452 | # This tag requires that the tag USE_MATHJAX is set to YES. 1453 | 1454 | MATHJAX_EXTENSIONS = 1455 | 1456 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1457 | # of code that will be used on startup of the MathJax code. See the MathJax site 1458 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1459 | # example see the documentation. 1460 | # This tag requires that the tag USE_MATHJAX is set to YES. 1461 | 1462 | MATHJAX_CODEFILE = 1463 | 1464 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1465 | # the HTML output. The underlying search engine uses javascript and DHTML and 1466 | # should work on any modern browser. Note that when using HTML help 1467 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1468 | # there is already a search function so this one should typically be disabled. 1469 | # For large projects the javascript based search engine can be slow, then 1470 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1471 | # search using the keyboard; to jump to the search box use + S 1472 | # (what the is depends on the OS and browser, but it is typically 1473 | # , /