diff --git a/.clang-format b/.clang-format new file mode 100644 index 00000000..95d3b738 --- /dev/null +++ b/.clang-format @@ -0,0 +1,47 @@ +--- +AlignAfterOpenBracket: true +AlignEscapedNewlines: Left +AlignTrailingComments: false +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortFunctionsOnASingleLine: false +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakBeforeMultilineStrings: false +BasedOnStyle: LLVM +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Linux +BreakBeforeTernaryOperators: false +BreakStringLiterals: false +ColumnLimit: 120 +CommentPragmas: ^ cppcheck-supress +ContinuationIndentWidth: 8 +IncludeBlocks: Regroup +IncludeCategories: + - Regex: '"rtrlib/.+"' + Priority: 1 + - Regex: '"third-party/.+"' + Priority: 2 + - Regex: '.+_private.+' + Priority: 0 + - Regex: '"[[:alnum:]_]+"' + Priority: 0 + - Regex: '".+"' + Priority: 0 + - Regex: '<.+>' + Priority: 3 +IncludeIsMainRegex: '(private)?$' +IndentCaseLabels: false +IndentWidth: 8 +KeepEmptyLinesAtTheStartOfBlocks: false +Language: Cpp +MaxEmptyLinesToKeep: 1 +PenaltyBreakAssignment: 10 +PenaltyBreakBeforeFirstCallParameter: 30 +PenaltyBreakComment: 10 +PenaltyBreakFirstLessLess: 0 +PenaltyBreakString: 10 +PenaltyExcessCharacter: 100 +ReflowComments: false +SortIncludes: true +SpaceAfterCStyleCast: false +UseTab: Always diff --git a/.codecov.yml b/.codecov.yml index 57d0d895..87f3b1ec 100644 --- a/.codecov.yml +++ b/.codecov.yml @@ -8,7 +8,7 @@ coverage: range: "50...80" ignore: - - rtrlib/spki/hashtable/tommyds-1.8/.* + - third-party/ - tests/* status: {} diff --git a/.editorconfig b/.editorconfig index 2416fbf1..391a6cd4 100644 --- a/.editorconfig +++ b/.editorconfig @@ -12,3 +12,8 @@ indent_size = 4 [{.travis.yml,CMakeLists.txt}] indent_style = space indent_size = 4 + +[*.md] +indent_style = space +indent_size = 2 +max_line_width = 72 diff --git a/.git-blame-ignore b/.git-blame-ignore new file mode 100644 index 00000000..cb014f68 --- /dev/null +++ b/.git-blame-ignore @@ -0,0 +1,3 @@ +642ad37219aead62bc138c4a40b5f56be7e1c487 +8c6f66c0fabc97a011c3a32b54e27535145b52ec +b946a2c133199bf23cfdc838ef74d272483abfb1 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..b3d4372c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +### Description + + +### Steps to reproduce the issue + + +### Expected results + + +### Actual results + + +### Versions + + + + diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 00000000..6b7c217b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,17 @@ +--- +name: Enhancement Request +about: Ask for the enhancement of an existing feature. + +--- + +### Description of current state + + +### Improvement + + +### Useful links + + + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..398efacb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,15 @@ +--- +name: Feature Request +about: Ask for missing features. + +--- + +### Description + + +### Useful links + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..e5d42cc2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ + + +### Contribution description + + + + +### Testing procedure + + + + +### Issues/PRs references + + + diff --git a/.gitignore b/.gitignore index de48f599..f481594a 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ tags *.so* */Makefile rtrlib/rtrlib.h +rtrlib/config.h tools/rpki-rov tools/rtrclient diff --git a/.travis.yml b/.travis.yml index 434eec8a..a1216c19 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,21 +1,7 @@ -sudo: required -dist: trusty +dist: xenial language: c -before_install: - - sudo apt-get -qq update - - sudo apt-get -y install cppcheck doxygen libssh-dev - -install: - - wget https://cmocka.org/files/1.1/cmocka-1.1.0.tar.xz - - tar xvf cmocka-1.1.0.tar.xz && pushd cmocka-1.1.0 - - mkdir build && pushd build - - cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug - - make - - sudo make install - - popd && popd - env: global: # The next declaration is the encrypted COVERITY_SCAN_TOKEN, created @@ -32,6 +18,14 @@ addons: build_command: "make" branch_pattern: coverity_scan + apt: + packages: + - cppcheck + - doxygen + - libssh-dev + - libcmocka-dev + - ctags + script: - if [ "${COVERITY_SCAN_BRANCH}" != 1 ]; then scripts/travis.sh; fi diff --git a/CHANGELOG b/CHANGELOG index 379807fd..edf73da3 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -3,7 +3,47 @@ https://github.com/rtrlib/rtrlib/commits/master Release History: -* Version 0.6.0 +* Version 0.8.0 + - Fix blocking when stopping sockets in some cases + - Add callback to allow user created sockets + - Add ability to change the connect timeout + - Add support for password authentication to ssh transport + - Update tools to allow for password authentication when using ssh transport + - Improve error handling in ssh transport + - Improve error output in TCP transport + - Improve libssh detection when running configure + - Initialise structures properly in rtrclient + - Fix several compiler warnings + - Extend log messages to include prefixes when using ssh transport + - Fix bug that constantly called tr_recv because of ignoring timeout argument when using ssh transport + - Apply kernel coding style in all source files + +* Version 0.7.0 + - Fix to ensure shadow tables are only freed when initialized before + - Fix SSH transport w/o bind address and add host key verification + - Fix bug in cache groups to ensure uniqueness of cache server preferences + - Fix race condition in rtr_stop + - Remove error PDU null termination check + - Update tommyds implementation to version 2.2 + - tools/rpki-rov: improve validation of command line arguments + - tools/rtrclient: add ROA export with templates, support for CSV and JSON + - Output log messages to stderr instead of stdout + - style: increase max line length to 120 characters + +* Version 0.6.3 + - Fix IPv4 string conversion to support big endian systems + +* Version 0.6.2 + - Add C++ support by disabling name mangling for RTRlib symbols + - Make pfx_table, pfx_table_init(), pfx_table_add(), + pfx_table_free(), pfx_table_src_remove() public; to use RTRlib + without online connection to an RPKI cache server + - Hide symbols of Tommy hash table without using forward declaration, + to resolve dependency on C11 + - Fix cmake build errors in Debian and OpenBSD + - Add connection timeout in tests/test_dynamic_groups + +* Version 0.6.1 - Fix for cmake versions >= 2.8 - Fix rpm build - Fix Ubuntu 12.04 build @@ -26,7 +66,7 @@ Release History: - Add atomtic reset for pfx table and spki table - Improve code for packets - Add rpm package build infrastructure - - Add cppcheck suppresions for public api functions + - Add cppcheck suppressions for public api functions - Add new test to verify correctness of prefix removal - Remove function rtr_mgr_find_group in RTR Manager because it is not used diff --git a/CMakeLists.txt b/CMakeLists.txt index 4660d782..d1e81ec0 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,18 +1,28 @@ +cmake_minimum_required(VERSION 3.10) project(rtrlib C) set(PROJECT_DESCRIPTION "Lightweight C library that implements the RPKI/RTR protocol and prefix origin validation.") - -cmake_minimum_required(VERSION 2.6) - set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/modules) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -std=gnu99 -fstack-protector-all") if(CMAKE_BUILD_TYPE STREQUAL Debug) - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99 -Wall -Wextra -Wformat-security -Wmissing-prototypes -Wmissing-declarations -Wdeclaration-after-statement -Winit-self -Waggregate-return -Wmissing-format-attribute -Wundef -Wbad-function-cast -Wwrite-strings -Wformat=2") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99 -Wall -Wextra -Wformat-security -Winit-self -Wundef -Wwrite-strings") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wformat=2 -Werror=missing-prototypes -Werror=missing-declarations") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wmissing-format-attribute -Werror=implicit-function-declaration") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror=bad-function-cast -Werror=return-type") + execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion OUTPUT_VARIABLE GCC_VERSION) if(GCC_VERSION VERSION_GREATER 4.8 OR GCC_VERSION VERSION_EQUAL 4.8) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wfree-nonheap-object") endif() + if(GCC_VERSION VERSION_GREATER 5.1 OR GCC_VERSION VERSION_EQUAL 5.1) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror=incompatible-pointer-types") + endif() + + if(GCC_VERSION VERSION_GREATER 8.0 OR GCC_VERSION VERSION_EQUAL 8.0) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror=cast-function-type") + endif() + set(DOCS_EXCLUDE_PATTERN "") else() set(DOCS_EXCLUDE_PATTERN "*_private.h") @@ -20,34 +30,71 @@ endif(CMAKE_BUILD_TYPE STREQUAL Debug) include_directories(.) +add_subdirectory(third-party) + find_package(codecov) find_package(Threads REQUIRED) -if(NOT APPLE) +if(NOT APPLE AND NOT ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") find_library(RT_LIB rt) -endif(NOT APPLE) +endif(NOT APPLE AND NOT ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") -include(UseMultiArch) # needed for debian packaging include(GNUInstallDirs) # for man page install path set(RTRLIB_SRC rtrlib/rtr_mgr.c rtrlib/lib/utils.c rtrlib/lib/alloc_utils.c rtrlib/lib/convert_byte_order.c rtrlib/lib/ip.c rtrlib/lib/ipv4.c rtrlib/lib/ipv6.c rtrlib/lib/log.c rtrlib/pfx/trie/trie.c rtrlib/pfx/trie/trie-pfx.c rtrlib/transport/transport.c rtrlib/transport/tcp/tcp_transport.c rtrlib/rtr/rtr.c rtrlib/rtr/packets.c - rtrlib/spki/hashtable/ht-spkitable.c rtrlib/spki/hashtable/tommyds-1.8/tommy.c) + rtrlib/spki/hashtable/ht-spkitable.c rtrlib/aspa/aspa_array/aspa_array.c + rtrlib/aspa/aspa.c rtrlib/aspa/aspa_verification.c ${tommyds}) set(RTRLIB_LINK ${RT_LIB} ${CMAKE_THREAD_LIBS_INIT}) -find_package(LibSSH 0.5.0 QUIET) -if(LIBSSH_FOUND AND NOT NOSSH) - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D LIBSSH_VERSION_MAJOR=${LibSSH_VERSION_MAJOR} -D LIBSSH_VERSION_MINOR=${LibSSH_VERSION_MINOR}") - set(RTRLIB_HAVE_LIBSSH 1) - include_directories(${LIBSSH_INCLUDE_DIRS}) - set(RTRLIB_SRC ${RTRLIB_SRC} rtrlib/transport/ssh/ssh_transport.c) - set(RTRLIB_LINK ${RTRLIB_LINK} ${LIBSSH_LIBRARIES}) - message(STATUS "libssh found, building librtr with SSH ${LibSSH_VERSION} support") +include(FindPkgConfig) + +if (NOT DEFINED RTRLIB_TRANSPORT_SSH OR RTRLIB_TRANSPORT_SSH) + pkg_check_modules(LIBSSH libssh>=0.5.0) + + if(LIBSSH_FOUND) + # extract version number components + string(REGEX MATCH "^([0-9]+)\\.([0-9]+)\\.([0-9]+)$" RTRLIB_LIBSSH_VERSION_MATCH ${LIBSSH_VERSION}) + if (NOT RTRLIB_LIBSSH_VERSION_MATCH) + message(FATAL_ERROR "Could not parse libssh version ${LIBSSH_VERSION}") + endif(NOT RTRLIB_LIBSSH_VERSION_MATCH) + SET(LIBSSH_VERSION_MAJOR ${CMAKE_MATCH_1}) + SET(LIBSSH_VERSION_MINOR ${CMAKE_MATCH_2}) + SET(LIBSSH_VERSION_PATCH ${CMAKE_MATCH_3}) + + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D LIBSSH_VERSION_MAJOR=${LIBSSH_VERSION_MAJOR} -D LIBSSH_VERSION_MINOR=${LIBSSH_VERSION_MINOR}") + set(RTRLIB_HAVE_LIBSSH 1) + include_directories(${LIBSSH_INCLUDE_DIRS}) + set(RTRLIB_SRC ${RTRLIB_SRC} rtrlib/transport/ssh/ssh_transport.c) + set(RTRLIB_LINK ${RTRLIB_LINK} ${LIBSSH_LIBRARIES}) + message(STATUS "libssh found, building librtr with SSH ${LibSSH_VERSION} support") + elseif(NOT LIBSSH_FOUND AND RTRLIB_TRANSPORT_SSH) + message(FATAL_ERROR "libssh >= 0.5.0 not found but ssh support was requested. Omit RTRLIB_TRANSPORT_SSH to build without ssh support.") + else() + message(WARNING "libssh >= 0.5.0 not found") + endif(LIBSSH_FOUND) +endif(NOT DEFINED RTRLIB_TRANSPORT_SSH OR RTRLIB_TRANSPORT_SSH) + +# bgpsec +if(DEFINED WITH_BGPSEC AND NOT WITH_BGPSEC) + message(STATUS "building librtr without BGPsec support") else() - message(WARNING "libssh >=0.5.0 not found, building librtr without SSH support") -endif(LIBSSH_FOUND AND NOT NOSSH) + find_package(OpenSSL 1.0 QUIET) + + if(OPENSSL_FOUND AND OPENSSL_CRYPTO_LIBRARY) + set(RTRLIB_BGPSEC_ENABLED 1) + include_directories(${OPENSSL_INCLUDE_DIRS}) + set(RTRLIB_SRC ${RTRLIB_SRC} rtrlib/bgpsec/bgpsec.c rtrlib/bgpsec/bgpsec_utils.c) + set(RTRLIB_LINK ${RTRLIB_LINK} ${OPENSSL_LIBRARIES}) + message(STATUS "libcrypto (OpenSSL ${OPENSSL_VERSION}) found, building librtr with BGPsec support") + elseif(WITH_BGPSEC) + message(FATAL_ERROR "libcrypto (OpenSSL) not found, aborting build.") + else() + message(STATUS "libcrypto (OpenSSL) not found, building librtr without BGPsec support.") + endif(OPENSSL_FOUND AND OPENSSL_CRYPTO_LIBRARY) +endif(DEFINED WITH_BGPSEC AND NOT WITH_BGPSEC) #doxygen target find_package(Doxygen) @@ -78,24 +125,30 @@ ADD_SUBDIRECTORY(tests) ENABLE_TESTING() ADD_TEST(test_pfx tests/test_pfx) ADD_TEST(test_trie tests/test_trie) -#ADD_TEST(test_pfx_locks tests/test_pfx_locks) - ADD_TEST(test_ht_spkitable tests/test_ht_spkitable) ADD_TEST(test_ht_spkitable_locks tests/test_ht_spkitable_locks) - ADD_TEST(test_live_validation tests/test_live_validation) - +ADD_TEST(test_live_fetching tests/test_live_fetching) +ADD_TEST(test_live_disabled_features tests/test_live_disabled_features) ADD_TEST(test_ipaddr tests/test_ipaddr) - ADD_TEST(test_getbits tests/test_getbits) - ADD_TEST(test_dynamic_groups tests/test_dynamic_groups) +ADD_TEST(test_aspa tests/test_aspa) +ADD_TEST(test_aspa_array tests/test_aspa_array) +ADD_TEST(test_as_path_verification tests/test_as_path_verification) + +list(APPEND CMAKE_CTEST_ARGUMENTS "--output-on-failure") + +if(RTRLIB_BGPSEC_ENABLED) + ADD_TEST(test_bgpsec tests/test_bgpsec) +endif(RTRLIB_BGPSEC_ENABLED) #install lib set (RTRLIB_VERSION_MAJOR 0) -set (RTRLIB_VERSION_MINOR 6) -set (RTRLIB_VERSION_PATCH 1) +set (RTRLIB_VERSION_MINOR 8) +set (RTRLIB_VERSION_PATCH 0) CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/rtrlib/rtrlib.h.cmake ${CMAKE_SOURCE_DIR}/rtrlib/rtrlib.h) +CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/rtrlib/config.h.cmake ${CMAKE_SOURCE_DIR}/rtrlib/config.h) set(LIBRARY_VERSION ${RTRLIB_VERSION_MAJOR}.${RTRLIB_VERSION_MINOR}.${RTRLIB_VERSION_PATCH}) set(LIBRARY_SOVERSION ${RTRLIB_VERSION_MAJOR}) set_target_properties(rtrlib PROPERTIES SOVERSION ${LIBRARY_SOVERSION} VERSION ${LIBRARY_VERSION} OUTPUT_NAME rtr) @@ -119,19 +172,18 @@ foreach(ITEM ${RTRLIB_PUBLIC_HEADERS}) endforeach() #pkgconfig file -if(LIBSSH_FOUND) +if(RTRLIB_TRANSPORT_SSH) set (PKG_CONFIG_REQUIRES "libssh >= 0.5.0") -endif(LIBSSH_FOUND) +endif(RTRLIB_TRANSPORT_SSH) -if(IS_ABSOLUTE ${CMAKE_INSTALL_LIBDIR}) - set (PKG_CONFIG_LIBDIR ${CMAKE_INSTALL_LIBDIR}) - set (RTRLIB_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR}) -else() - set (PKG_CONFIG_LIBDIR "\${prefix}/${CMAKE_INSTALL_LIBDIR}") - set (RTRLIB_INSTALL_LIBDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}") -endif(IS_ABSOLUTE ${CMAKE_INSTALL_LIBDIR}) +if(OPENSSL_CRYPTO_LIBRARY) + set (PKG_CONFIG_REQUIRES ${PKG_CONFIG_REQUIRES} "libcrypto >= 1.0") +endif(OPENSSL_CRYPTO_LIBRARY) + +string(REPLACE ";" ", " PKG_CONFIG_REQUIRES "${PKG_CONFIG_REQUIRES}") # '#include ' includes the "rtrlib/" +set (PKG_CONFIG_LIBDIR "\${prefix}/${CMAKE_INSTALL_LIBDIR}") set (PKG_CONFIG_INCLUDEDIR "\${prefix}/include") set (PKG_CONFIG_LIBS "-L\${libdir} -lrtr") set (PKG_CONFIG_CFLAGS "-I\${includedir}") @@ -142,7 +194,7 @@ configure_file ( ) install ( FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc" - DESTINATION "${RTRLIB_INSTALL_LIBDIR}/pkgconfig" + DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig" ) #add uninstall target configure_file( diff --git a/README b/README deleted file mode 100644 index 76901e03..00000000 --- a/README +++ /dev/null @@ -1,126 +0,0 @@ -Introduction ------------- -The RTRlib implements the client-side of the RPKI-RTR protocol (RFC -6810, RFC 8210) and BGP Prefix Origin Validation (RFC 6811). This also -enables the maintenance of router keys. Router keys are required to -deploy BGPSEC. - -The software was successfully tested on Linux and FreeBSD. - -This package contains also the rtrclient program. It connects to an -RTR-Server over TCP or SSH and shows on STDOUT prefix origin data and -router keys that have been received from the RTR server. The program can -be found in the bin/ directory. - -Requirements ------------- -A compiler that supports C11. - -To build the RTRlib, the CMake build system must be installed. - -To establish an SSH connection between RTR-Client and RTR-Server, the -libssh 0.6.x or higher library must also be installed. - -cmocka (optional) is required for unit tests -Doxygen (optional) is required to create the HTML documentation. - - -Compilation ------------ - -* Generate Makefile: - - Without debugging options - - cmake -D CMAKE_BUILD_TYPE=Release . - - With debug symbols and debug messages: - - cmake -D CMAKE_BUILD_TYPE=Debug . - - If the libssh isn't installed within the systems include and library - directories you can run cmake with the following parameters: - - -D LIBSSH_LIBRARY= - -D LIBSSH_INCLUDE= - - To specify another directory where the RTRlib will be installed, you - can pass the following argument to cmake: - - -D CMAKE_INSTALL_PREFIX= - -* Build library, tests, and tools - - make - - -Installation ------------- -To copy libraries and headers to system directories, run (optional): - - make install - - -Linking to RTRlib ----------------------- -The name of the shared library is rtr. To link programs to the RTRlib, -pass the following parameter to gcc: - - -lrtr - -In case an error such as - - -/usr/bin/ld: cannot find -lrtr - -collect2: error: ld returned 1 exit status - -occurs, the location of the library can be passed explicitly as a parameter - - -L - -e.g., - -L/usr/local/lib64/ - - -API Documentation ------------------ -The RTRlib includes a HTML documentation of the API. To build them, -doxygen must be installed. The documentation will be located in the -docs/ directory after the execution of: - - make doc - - -Test RTR-Server Connection --------------------------- -The following command establishes a plain TCP connection to an -RTR-Server using the rtrclient command line tool: - - bin/rtrclient tcp rpki-validator.realmv6.org 8282 - -rpki-validator.realmv6.org is an open RTR-Server instance for testing -purposes, which runs the RIPE Validator. It listens on port 8282 and -validates ROAs from the following trust anchors: AfriNIC, APNIC, ARIN, -LACNIC, RIPE. - - -Directories ------------ -* cmake/ - CMake modules -* doxygen/ - Example code and graphics used in the Doxygen - documentation -* rtrlib/ - Header and source code files of the RTRlib -* tests/ - Unit tests -* tools/ - Contains the rtrclient - - -Contact -------- -Website: http://rtrlib.realmv6.org/ - -Mailing List: rtrlib@googlegroups.com - - - - - -/* vim: set tw=72 sts=2 sw=2 ts=2 expandtab: */ diff --git a/README.md b/README.md new file mode 100644 index 00000000..ed8970b9 --- /dev/null +++ b/README.md @@ -0,0 +1,174 @@ +[![Build Status][travis-badge]][travis-link] +[![GitHub release][release-badge]][release-link] +[![License][license-badge]][license-link] +[![API docs][api-badge]][api-link] +[![Wiki][wiki-badge]][wiki-link] +[![Read the Docs][rtd-badge]][rtd-link] +[![Help wanted][helpwanted-badge]][helpwanted-link] + +Introduction +------------ +The RTRlib implements the client-side of the RPKI-RTR protocol +([RFC 6810](https://tools.ietf.org/html/rfc6810)), +([RFC 8210](https://tools.ietf.org/html/rfc8210)), BGP Prefix Origin +Validation ([RFC 6811](https://tools.ietf.org/html/rfc6811)), and ASPA-based Route Leak +detection ([Rev. 18](https://datatracker.ietf.org/doc/draft-ietf-sidrops-aspa-verification/)). +This also enables the maintenance of router keys. Router keys are required to deploy BGPSEC. + +The software was successfully tested on Linux and FreeBSD. + +This package contains also the `rtrclient` program. It connects to an +RTR-Server over TCP or SSH and shows on STDOUT prefix origin data and +router keys that have been received from the RTR server. The program can +be found in the bin/ directory. + +Requirements +------------ +To build the RTRlib, the CMake build system must be installed. + +To establish an SSH connection between RTR-Client and RTR-Server, the +libssh 0.6.x or higher library must also be installed. + +To enable BGPsec support for validating and signing AS paths, libssl +1.0 or higher needs to be installed. + +cmocka (optional) is required for unit tests +Doxygen (optional) is required to create the HTML documentation. + + +Compilation +----------- + +* Generate Makefile: + + Without debugging options + + cmake -D CMAKE_BUILD_TYPE=Release . + + With debug symbols and debug messages: + + cmake -D CMAKE_BUILD_TYPE=Debug . + + If the libssh isn't installed within the systems include and library + directories you can run cmake with the following parameters: + + -D LIBSSH_LIBRARIES= + -D LIBSSH_INCLUDE_DIRS= + + If libssh is installed but you do not want to build rtrlib with ssh + support, you can disable it with the following parameter: + + -D RTRLIB_TRANSPORT_SSH=No + + Or to enforce ssh support: + + -D RTRLIB_TRANSPORT_SSH=Yes + + To specify another directory where the RTRlib will be installed, you + can pass the following argument to cmake: + + -D CMAKE_INSTALL_PREFIX= + + BGPsec support is enabled by default. If dependencies cannot be + resolved, rtrlib builds without BGPsec. + + To explicitly disable BGPsec: + + -D WITH_BGPSEC=No + + To explicitly enable BGPsec and fail the build if dependencies + cannot be resolved: + + -D WITH_BGPSEC=Yes + +* Build library, tests, and tools + + make + + +Installation +------------ +To copy libraries and headers to system directories, run (optional): + + make install + + +Linking to RTRlib +---------------------- +The name of the shared library is rtr. To link programs to the RTRlib, +pass the following parameter to gcc: + + -lrtr + +In case an error such as + + -/usr/bin/ld: cannot find -lrtr + -collect2: error: ld returned 1 exit status + +occurs, the location of the library can be passed explicitly as a parameter + + -L + +e.g., + + -L/usr/local/lib64/ + + +API Documentation +----------------- +The RTRlib includes a HTML documentation of the API. To build them, +doxygen must be installed. The documentation will be located in the +docs/ directory after the execution of: + + make doc + + +Test RTR-Server Connection +-------------------------- +The following command establishes a plain TCP connection to an +RTR-Server using the rtrclient command line tool: + + bin/rtrclient tcp rpki-validator.realmv6.org 8282 + +`rpki-cache.netd.cs.tu-dresden.de` is an open RTR-Server instance for testing +purposes, which runs the RIPE Validator. It listens on port 3323 and +validates ROAs from the following trust anchors: AfriNIC, APNIC, ARIN, +LACNIC, RIPE. + + +Directories +----------- +* cmake/ - CMake modules +* doxygen/ - Example code and graphics used in the Doxygen + documentation +* rtrlib/ - Header and source code files of the RTRlib +* tests/ - Unit tests +* tools/ - Contains the rtrclient + + +CONTRIBUTE +---------- +To contribute something to RTRlib, please refer to our [contributing document](CONTRIBUTING). + + +Contact +------- +Website: [http://rtrlib.realmv6.org/](http://rtrlib.realmv6.org/) + +Mailing List: [rtrlib@googlegroups.com](mailto:rtrlib@googlegroups.com) + + +[travis-badge]:https://travis-ci.com/rtrlib/rtrlib.svg?branch=master +[travis-link]:https://travis-ci.com/rtrlib/rtrlib +[release-badge]: https://img.shields.io/github/release/rtrlib/rtrlib.svg +[release-link]: https://github.com/rtrlib/rtrlib/releases/latest +[license-badge]: https://img.shields.io/github/license/rtrlib/rtrlib +[license-link]: https://github.com/rtrlib/rtrlib/blob/master/LICENSE +[api-badge]: https://img.shields.io/badge/docs-API-informational.svg +[api-link]: http://rtrlib.realmv6.org/doxygen/latest/ +[wiki-badge]: https://img.shields.io/badge/docs-Wiki-informational.svg +[wiki-link]: https://github.com/rtrlib/rtrlib/wiki +[rtd-badge]: https://readthedocs.org/projects/rtrlib/badge/?version=latest +[rtd-link]: http://rtrlib.readthedocs.io/en/latest/?badge=latest +[helpwanted-badge]: https://img.shields.io/badge/help-wanted-orange.svg +[helpwanted-link]: https://github.com/rtrlib/rtrlib/issues diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..28c21fd6 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,34 @@ +# RTRlib Security Policy + +All security bugs reported will be silently fixed in `master` and backported +to the current release. + +## Reporting a Vulnerability + +If a security issue is discovered, please report it to security-rtrlib@googlegroups.com. +A response will be provided within one week. +The issue will be tracked using the [security mailing +list](mailto:security-rtrlib@googlegroups.com). +Only maintainers of the RTRlib are members of this mailing list. +The original reporter of the security vulnerability will be included in the +discussion of the issue, though. + +## Notification of a Vulnerability + +After a fix is provided the security issue will be privately disclosed to the +original reporter, RTRlib security maintainers, and "Trusted RTRlib Users". +A public announcement of the security fix will be made two weeks after the +point release, though this may vary depending on the severity and ability of +trusted RTRlib users to provide the fix. + +## Trusted RTRlib Users + +To access the "Trusted RTRlib Users" notifications on the mailing list +please send information on the RTRlib based service or product as well as +your prefered email address to receive notifications to the [security +mailing list](mailto:security-rtrlib@googlegroups.com). +Early notification of security bugs will be available and should not be +shared publicly. +If done, it will result in access removal from the "Trusted RTRlib Users" +notifications. + diff --git a/cmake/modules/FindLibSSH.cmake b/cmake/modules/FindLibSSH.cmake deleted file mode 100644 index dc58cd1d..00000000 --- a/cmake/modules/FindLibSSH.cmake +++ /dev/null @@ -1,104 +0,0 @@ -# - Try to find LibSSH -# Once done this will define -# -# LIBSSH_FOUND - system has LibSSH -# LIBSSH_INCLUDE_DIRS - the LibSSH include directory -# LIBSSH_LIBRARIES - Link these to use LibSSH -# LIBSSH_DEFINITIONS - Compiler switches required for using LibSSH -# -# Copyright (c) 2009 Andreas Schneider -# -# Redistribution and use is allowed according to the terms of the New -# BSD license. -# For details see the accompanying COPYING-CMAKE-SCRIPTS file. -# -set(NOSSH false) - -if(CMAKE_BUILD_TYPE STREQUAL NoSSH) - set(NOSSH true) -endif(CMAKE_BUILD_TYPE STREQUAL NoSSH) - -if (NOT NoSSH) - if (LIBSSH_LIBRARIES AND LIBSSH_INCLUDE_DIRS) - # in cache already - set(LIBSSH_FOUND TRUE) - else (LIBSSH_LIBRARIES AND LIBSSH_INCLUDE_DIRS) - - find_path(LIBSSH_INCLUDE_DIR - NAMES - libssh/libssh.h - PATHS - ${LIBSSH_INCLUDE} - /usr/include - /usr/local/include - /opt/local/include - /sw/include - ${CMAKE_INCLUDE_PATH} - ${CMAKE_INSTALL_PREFIX}/include - ) - - find_library(SSH_LIBRARY - NAMES - ssh - libssh - PATHS - ${LIBSSH_LIBRARY} - /usr/lib - /usr/local/lib - /opt/local/lib - /sw/lib - ${CMAKE_LIBRARY_PATH} - ${CMAKE_INSTALL_PREFIX}/lib - ) - - if (LIBSSH_INCLUDE_DIR AND SSH_LIBRARY) - set(SSH_FOUND TRUE) - endif (LIBSSH_INCLUDE_DIR AND SSH_LIBRARY) - - set(LIBSSH_INCLUDE_DIRS - ${LIBSSH_INCLUDE_DIR} - ) - - if (SSH_FOUND) - set(LIBSSH_LIBRARIES - ${LIBSSH_LIBRARIES} - ${SSH_LIBRARY} - ) - - if (LibSSH_FIND_VERSION) - file(STRINGS ${LIBSSH_INCLUDE_DIR}/libssh/libssh.h LIBSSH_VERSION_MAJOR - REGEX "#define[ ]+LIBSSH_VERSION_MAJOR[ ]+[0-9]+") - # Older versions of libssh like libssh-0.2 have LIBSSH_VERSION but not LIBSSH_VERSION_MAJOR - if (LIBSSH_VERSION_MAJOR) - string(REGEX MATCH "[0-9]+" LIBSSH_VERSION_MAJOR ${LIBSSH_VERSION_MAJOR}) - file(STRINGS ${LIBSSH_INCLUDE_DIR}/libssh/libssh.h LIBSSH_VERSION_MINOR - REGEX "#define[ ]+LIBSSH_VERSION_MINOR[ ]+[0-9]+") - string(REGEX MATCH "[0-9]+" LIBSSH_VERSION_MINOR ${LIBSSH_VERSION_MINOR}) - file(STRINGS ${LIBSSH_INCLUDE_DIR}/libssh/libssh.h LIBSSH_VERSION_PATCH - REGEX "#define[ ]+LIBSSH_VERSION_MICRO[ ]+[0-9]+") - string(REGEX MATCH "[0-9]+" LIBSSH_VERSION_PATCH ${LIBSSH_VERSION_PATCH}) - - set(LibSSH_VERSION ${LIBSSH_VERSION_MAJOR}.${LIBSSH_VERSION_MINOR}.${LIBSSH_VERSION_PATCH}) - - include(FindPackageVersionCheck) - find_package_version_check(LibSSH DEFAULT_MSG) - else (LIBSSH_VERSION_MAJOR) - message(STATUS "LIBSSH_VERSION_MAJOR not found in ${LIBSSH_INCLUDE_DIR}/libssh/libssh.h, assuming libssh is too old") - set(LIBSSH_FOUND FALSE) - endif (LIBSSH_VERSION_MAJOR) - endif (LibSSH_FIND_VERSION) - endif (SSH_FOUND) - - # If the version is too old, but libs and includes are set, - # find_package_handle_standard_args will set LIBSSH_FOUND to TRUE again, - # so we need this if() here. - if (LIBSSH_FOUND) - include(FindPackageHandleStandardArgs) - find_package_handle_standard_args(LibSSH DEFAULT_MSG LIBSSH_LIBRARIES LIBSSH_INCLUDE_DIRS) - endif (LIBSSH_FOUND) - - # show the LIBSSH_INCLUDE_DIRS and LIBSSH_LIBRARIES variables only in the advanced view - mark_as_advanced(LIBSSH_INCLUDE_DIRS LIBSSH_LIBRARIES) - - endif (LIBSSH_LIBRARIES AND LIBSSH_INCLUDE_DIRS) -endif(NOT NoSSH) diff --git a/debian/changelog b/debian/changelog index 30bfb6f8..8ce0b1b5 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,51 @@ +librtr0 (0.8.0) stable; urgency=high + * Fix blocking when stopping sockets in some cases + * Add callback to allow user created sockets + * Add ability to change the connect timeout + * Add support for password authentication to ssh transport + * Update tools to allow for password authentication when using ssh transport + * Improve error handling in ssh transport + * Improve error output in TCP transport + * Improve libssh detection when running configure + * Initialise structures properly in rtrclient + * Fix several compiler warnings + * Extend log messages to include prefixes when using ssh transport + * Fix bug that constantly called tr_recv because of ignoring timeout argument when using ssh transport + * Apply kernel coding style in all source files + + -- Marcel Röthke Tue, 7 Sep 2021 12:00:00 +0200 + +librtr0 (0.7.0.0) stable; urgency=high + * Fix to ensure shadow tables are only freed when initialized before + * Fix SSH transport w/o bind address and add host key verification + * Fix bug in cache groups to ensure uniqueness of cache server preferences + * Fix race condition in rtr_stop + * Remove error PDU null termination check + * Update tommyds implementation to version 2.2 + * tools/rpki-rov: improve validation of command line arguments + * tools/rtrclient: add ROA export with templates, support for CSV and JSON + * Output log messages to stderr instead of stdout + * style: increase max line length to 120 characters + + -- Sebastian Meiling Wed, 10 Jul 2019 10:00:00 +0200 + +librtr0 (0.6.3.0) stable; urgency=high + * Fix IPv4 string conversion to support big endian systems + + -- Matthias Waehlisch Sun, 9 Dec 2018 12:45:00 +0100 + +librtr0 (0.6.2.0) stable; urgency=high + * Add C++ support by disabling name mangling for RTRlib symbols + * Make pfx_table, pfx_table_init(), pfx_table_add(), + pfx_table_free(), pfx_table_src_remove() public; to use RTRlib + without online connection to an RPKI cache server + * Hide symbols of Tommy hash table without using forward declaration, + to resolve dependency on C11 + * Fix cmake build errors in Debian and OpenBSD + * Add connection timeout in tests/test_dynamic_groups + + -- Matthias Waehlisch Fri, 30 Nov 2018 17:31:00 +0100 + librtr0 (0.6.1.0) stable; urgency=high * Fix for cmake versions >= 2.8 * Fix rpm build @@ -22,7 +70,7 @@ librtr0 (0.6.0.0) stable; urgency=high * Add atomtic reset for pfx table and spki table * Improve code for packets * Add rpm package build infrastructure - * Add cppcheck suppresions for public api functions + * Add cppcheck suppressions for public api functions * Add new test to verify correctness of prefix removal * Remove function rtr_mgr_find_group in RTR Manager because it is not used diff --git a/debian/control b/debian/control index 4be8da31..f147bb19 100644 --- a/debian/control +++ b/debian/control @@ -2,7 +2,7 @@ Source: librtr0 Section: libs Priority: optional Maintainer: Fabian Holler -Build-Depends: cmake, dpkg-dev (>= 1.16.1~), debhelper (>= 9), libssh-dev (>= 0.5.0), doxygen +Build-Depends: cmake, dpkg-dev (>= 1.16.1~), debhelper (>= 9), libssh-dev (>= 0.5.0), libssl1.0-dev (>= 1.0) | libssl-dev (>= 1.0), doxygen Standards-Version: 3.9.6 Vcs-Git: git://github.com/rtrlib/rtrlib.git Vcs-Browser: https://github.com/rtrlib/rtrlib @@ -16,9 +16,9 @@ Depends: ${shlibs:Depends}, ${misc:Depends}, libssh-4 (>= 0.5.0) Description: Small extensible RPKI-RTR-Client C library. RTRlib is an open-source C implementation of the RPKI/Router Protocol client. The library allows one to fetch and store validated prefix origin data - from a RTR-cache and performs origin verification of prefixes. It supports - different types of transport sessions (e.g., SSH, unprotected TCP) and is - easily extendable. + from a RTR-cache and performs origin verification of prefixes. It also allows + validating and signing BGPsec AS paths. RTRlib supports different types of + transport sessions (e.g., SSH, unprotected TCP) and is easily extendable. Package: librtr-dev Section: libdevel @@ -30,9 +30,9 @@ Suggests: librtr-doc Description: Small extensible RPKI-RTR-Client C library. Development files RTRlib is an open-source C implementation of the RPKI/Router Protocol client. The library allows one to fetch and store validated prefix origin data - from a RTR-cache and performs origin verification of prefixes. It supports - different types of transport sessions (e.g., SSH, unprotected TCP) and is - easily extendable. + from a RTR-cache and performs origin verification of prefixes. It also allows + validating and signing BGPsec AS paths. RTRlib supports different types of + transport sessions (e.g., SSH, unprotected TCP) and is easily extendable. . This package contains development files. @@ -45,9 +45,9 @@ Depends: librtr0 (= ${binary:Version}), ${misc:Depends} Description: Small extensible RPKI-RTR-Client C library. Debug Symbols RTRlib is an open-source C implementation of the RPKI/Router Protocol client. The library allows one to fetch and store validated prefix origin data - from a RTR-cache and performs origin verification of prefixes. It supports - different types of transport sessions (e.g., SSH, unprotected TCP) and is - easily extendable. + from a RTR-cache and performs origin verification of prefixes. It also allows + validating and signing BGPsec AS paths. RTRlib supports different types of + transport sessions (e.g., SSH, unprotected TCP) and is easily extendable. . This package contains debug symbols. @@ -60,9 +60,9 @@ Suggests: doc-base Description: Small extensible RPKI-RTR-Client C library. Documentation files RTRlib is an open-source C implementation of the RPKI/Router Protocol client. The library allows one to fetch and store validated prefix origin data - from a RTR-cache and performs origin verification of prefixes. It supports - different types of transport sessions (e.g., SSH, unprotected TCP) and is - easily extendable. + from a RTR-cache and performs origin verification of prefixes. It also allows + validating and signing BGPsec AS paths. RTRlib supports different types of + transport sessions (e.g., SSH, unprotected TCP) and is easily extendable. . This package contains documentation files. diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in index a9bef9ea..473d6c3f 100644 --- a/doxygen/Doxyfile.in +++ b/doxygen/Doxyfile.in @@ -1,2332 +1,244 @@ -# Doxyfile 1.8.8 +PROJECT_NAME = RTRlib +PROJECT_NUMBER = -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). +OUTPUT_DIRECTORY = docs/ -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/rtrlib/ @CMAKE_CURRENT_SOURCE_DIR@/doxygen/ doxygen/mainpage.dox -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. +USE_MDFILE_AS_MAINPAGE = @CMAKE_CURRENT_SOURCE_DIR@/doxygen/mainpage.dox +FILE_PATTERNS = *.h *.md +RECURSIVE = YES -DOXYFILE_ENCODING = UTF-8 +HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/doxygen/assets/doxygen-awesome.css \ + @CMAKE_CURRENT_SOURCE_DIR@/doxygen/assets/doxygen-awesome-sidebar-only.css \ + @CMAKE_CURRENT_SOURCE_DIR@/doxygen/assets/doxygen-awesome-sidebar-only-darkmode-toggle.css \ -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. +HTML_EXTRA_FILES = @CMAKE_CURRENT_SOURCE_DIR@/doxygen/assets/doxygen-awesome-darkmode-toggle.js \ + @CMAKE_CURRENT_SOURCE_DIR@/doxygen/assets/doxygen-awesome-tabs.js \ + @CMAKE_CURRENT_SOURCE_DIR@/doxygen/assets/doxygen-awesome-interactive-toc.js \ + @CMAKE_CURRENT_SOURCE_DIR@/doxygen/assets/doxygen-awesome-paragraph-link.js \ + @CMAKE_CURRENT_SOURCE_DIR@/doxygen/assets/doxygen-awesome-fragment-copy-button.js -PROJECT_NAME = RTRlib - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = docs/ - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. +IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/doxygen/graphics/ CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - +CREATE_SUBDIRS_LEVEL = 8 ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = NO - -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = NO - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = YES +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - +JAVADOC_AUTOBRIEF = YES +JAVADOC_BANNER = NO +QT_AUTOBRIEF = YES MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - +PYTHON_DOCSTRING = YES INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. -# The default value is: NO. - SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - +TAB_SIZE = 8 OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - +OPTIMIZE_OUTPUT_SLICE = NO EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - +TOC_INCLUDE_HEADINGS = 5 +MARKDOWN_ID_STYLE = DOXYGEN AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - +CPP_CLI_SUPPORT = YES SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = NO - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - +IDL_PROPERTY_SUPPORT = YES DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - +GROUP_NESTED_COMPOUNDS = NO SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = YES - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will -# be included in the documentation. -# The default value is: NO. - +TYPEDEF_HIDES_STRUCT = NO +LOOKUP_CACHE_SIZE = 9 +NUM_PROC_THREADS = 1 +TIMESTAMP = YES +EXTRACT_ALL = YES EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = NO - -# This flag is only useful for Objective-C code. When set to YES local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - +EXTRACT_PRIV_VIRTUAL = NO +EXTRACT_PACKAGE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = YES EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - +RESOLVE_UNNAMED_PARAMS = YES HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = YES - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. -# The default value is: NO. - +HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the -# scope will be hidden. -# The default value is: NO. - +CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - +HIDE_COMPOUND_REFERENCE= NO +SHOW_HEADERFILE = YES SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = YES - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - +SHOW_GROUPED_MEMB_INC = YES +FORCE_LOCAL_INCLUDES = NO INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. -# The default value is: YES. - SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = YES - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - +SORT_BRIEF_DOCS = NO SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - +SORT_GROUP_NAMES = YES +SORT_BY_SCOPE_NAME = YES +STRICT_PROTO_MATCHING = YES +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = NO +GENERATE_BUGLIST = NO GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = NO - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = NO - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - +MAX_INITIALIZER_LINES = 300 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - QUIET = YES - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = NO - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - +WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = YES - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - +WARN_IF_INCOMPLETE_DOC = YES +WARN_NO_PARAMDOC = NO +WARN_IF_UNDOC_ENUM_VAL = NO +WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - +WARN_LINE_FORMAT = "at line $line of file $file" WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. -# Note: If this tag is empty the current directory is searched. - -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/rtrlib/ @CMAKE_CURRENT_SOURCE_DIR@/doxygen/ - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = *.h \ - *.dox - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = */rtrlib/spki/hashtable/* @DOCS_EXCLUDE_PATTERN@ - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/doxygen/examples/ - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - +INPUT_FILE_ENCODING = +EXAMPLE_PATH = EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/doxygen/graphics/ - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - +EXAMPLE_RECURSIVE = YES INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = YES - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output -# The default value is: YES. - GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra stylesheet files is of importance (e.g. the last -# stylesheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - +HTML_COLORSTYLE = LIGHT HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = YES +HTML_CODE_FOLDING = YES +HTML_COPY_CLIPBOARD = YES +HTML_PROJECT_COOKIE = HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - +GENERATE_DOCSET = YES DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - +DOCSET_FEEDURL = DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - +CHM_FILE = NO HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - +BINARY_TOC = YES TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - +SITEMAP_URL = GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - +GENERATE_TREEVIEW = YES +FULL_SIDEBAR = NO ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - +TREEVIEW_WIDTH = 300 EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - +OBFUSCATE_EMAILS = NO +HTML_FORMULA_FORMAT = png FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - +FORMULA_MACROFILE = USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - +MATHJAX_VERSION = MathJax_2 MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://www.mathjax.org/mathjax - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /