From 755849115ec18856b45adb08cb6f9f73521b15e2 Mon Sep 17 00:00:00 2001 From: Mike Ellery Date: Wed, 10 Jan 2018 11:20:13 -0800 Subject: [PATCH] Add dev docs generation to Jenkins: Fixes: RIPD-1521 Switch to pure doxygen HTML for developer docs. Remove docca/boostbook system. Convert consensus document to markdown. Add existing markdown files to doxygen input set. Fix some image paths and scale images for use with MD links. Rename/cleanup some files for consistency. Add pipeline logic for windows slaves. Add ninja and parallel test run option. Add make doc target build in build-and-test.sh. Cleanup README files. Add nounity windows build. Add link to jenkins summary table. Add rippled_classic build (win). Improve formatting of summary table. --- .codecov.yml | 6 + .gitignore | 1 + .gitmodules | 3 - .travis.yml | 1 - Builds/ArchLinux/PKGBUILD | 2 +- Builds/Docker/Dockerfile | 2 +- Builds/Docker/build-ci.sh | 2 +- Builds/VisualStudio2015/README.md | 2 +- CMakeLists.txt | 77 +- Jamroot | 11 - Jenkinsfile | 399 ++- README.md | 20 +- RELEASENOTES.md | 11 +- bin/ci/ubuntu/build-and-test.sh | 84 +- {doc => cfg}/rippled-example.cfg | 0 {doc => cfg}/rippled-example.service | 0 {doc => cfg}/rippled.init | 0 {doc => cfg}/validators-example.txt | 0 doc/CHANGELOG | 29 - doc/Doxyfile | 2304 ----------------- doc/ripple-example.txt | 126 - {doc => docs}/CheatSheet.md | 6 +- {doc => docs}/CodingStyle.md | 2 - {doc => docs}/Docker.md | 0 docs/Dockerfile | 43 +- {doc => docs}/HeapProfiling.md | 0 docs/Jamfile.v2 | 81 - .../NodeStoreRefactoringCaseStudy.pdf | Bin docs/README.md | 74 +- docs/boostbook.dtd | 439 ---- docs/{consensus.qbk => consensus.md} | 261 +- docs/docca | 1 - {doc => docs/images}/LogoForDocumentation.png | Bin docs/images/consensus/consensus_overview.png | Bin 12297 -> 34251 bytes docs/images/consensus/disputes.png | Bin 14639 -> 34557 bytes docs/images/consensus/ledger_chain.png | Bin 10403 -> 25726 bytes docs/images/consensus/threshold.png | Bin 6074 -> 13245 bytes docs/images/flow1.png | Bin 0 -> 184656 bytes docs/images/flow2.png | Bin 0 -> 146871 bytes {images => docs/images}/ripple.png | Bin docs/index.xml | 14 - docs/main.qbk | 39 - docs/makeqbk.sh | 11 - docs/quickref.xml | 61 - docs/reference.xsl | 14 - docs/sample_chart.doc | 24 + docs/source.dox | 54 +- images/flow1.png | Bin 103978 -> 0 bytes images/flow2.png | Bin 92024 -> 0 bytes src/ripple/README.md | 2 +- src/ripple/overlay/TODO.md | 1 - 51 files changed, 676 insertions(+), 3531 deletions(-) create mode 100644 .codecov.yml delete mode 100644 Jamroot rename {doc => cfg}/rippled-example.cfg (100%) rename {doc => cfg}/rippled-example.service (100%) rename {doc => cfg}/rippled.init (100%) rename {doc => cfg}/validators-example.txt (100%) delete mode 100644 doc/CHANGELOG delete mode 100644 doc/Doxyfile delete mode 100644 doc/ripple-example.txt rename {doc => docs}/CheatSheet.md (93%) rename {doc => docs}/CodingStyle.md (98%) rename {doc => docs}/Docker.md (100%) rename {doc => docs}/HeapProfiling.md (100%) delete mode 100644 docs/Jamfile.v2 rename {doc => docs}/NodeStoreRefactoringCaseStudy.pdf (100%) delete mode 100644 docs/boostbook.dtd rename docs/{consensus.qbk => consensus.md} (79%) delete mode 160000 docs/docca rename {doc => docs/images}/LogoForDocumentation.png (100%) create mode 100644 docs/images/flow1.png create mode 100644 docs/images/flow2.png rename {images => docs/images}/ripple.png (100%) delete mode 100644 docs/index.xml delete mode 100644 docs/main.qbk delete mode 100755 docs/makeqbk.sh delete mode 100644 docs/quickref.xml delete mode 100644 docs/reference.xsl create mode 100644 docs/sample_chart.doc delete mode 100644 images/flow1.png delete mode 100644 images/flow2.png delete mode 100644 src/ripple/overlay/TODO.md diff --git a/.codecov.yml b/.codecov.yml new file mode 100644 index 0000000000..2d135d55ed --- /dev/null +++ b/.codecov.yml @@ -0,0 +1,6 @@ + +codecov: + ci: + - ci.ops.ripple.com # add custom jenkins server + - !appveyor + - !travis diff --git a/.gitignore b/.gitignore index d7226880d4..c8ae4cc027 100644 --- a/.gitignore +++ b/.gitignore @@ -50,6 +50,7 @@ validators.txt # Doxygen generated documentation output HtmlDocumentation +docs/html_doc # Xcode user-specific project settings # Xcode diff --git a/.gitmodules b/.gitmodules index 58060902fc..d4d194f4c2 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,6 +1,3 @@ -[submodule "docs/docca"] - path = docs/docca - url = https://github.com/vinniefalco/docca.git [submodule "src/nudb/extras/beast"] path = src/nudb/extras/beast url = https://github.com/vinniefalco/Beast.git diff --git a/.travis.yml b/.travis.yml index a048669acb..69ef6e1569 100644 --- a/.travis.yml +++ b/.travis.yml @@ -32,7 +32,6 @@ addons: matrix: include: - # Default BUILD is "scons". - compiler: gcc env: GCC_VER=5 BUILD=cmake TARGET=debug diff --git a/Builds/ArchLinux/PKGBUILD b/Builds/ArchLinux/PKGBUILD index 6ea10324a8..384d982c64 100644 --- a/Builds/ArchLinux/PKGBUILD +++ b/Builds/ArchLinux/PKGBUILD @@ -32,7 +32,7 @@ package() { cd "$srcdir/$pkgname" install -D -m644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE" install -D build/rippled "$pkgdir/usr/bin/rippled" - install -D -m644 doc/rippled-example.cfg "$pkgdir/etc/$pkgname/rippled.cfg" + install -D -m644 cfg/rippled-example.cfg "$pkgdir/etc/$pkgname/rippled.cfg" mkdir -p "$pkgdir/var/lib/$pkgname/db" mkdir -p "$pkgdir/var/log/$pkgname" } diff --git a/Builds/Docker/Dockerfile b/Builds/Docker/Dockerfile index 554f2ab702..aeca3105d9 100644 --- a/Builds/Docker/Dockerfile +++ b/Builds/Docker/Dockerfile @@ -21,7 +21,7 @@ RUN cd src/; scons build/rippled RUN cp src/build/rippled rippled; strip rippled # copy default config -RUN cp src/doc/rippled-example.cfg rippled.cfg +RUN cp src/cfg/rippled-example.cfg rippled.cfg # clean source RUN rm -r src diff --git a/Builds/Docker/build-ci.sh b/Builds/Docker/build-ci.sh index 5e12d01280..d7bccd43af 100755 --- a/Builds/Docker/build-ci.sh +++ b/Builds/Docker/build-ci.sh @@ -1,7 +1,7 @@ set -e mkdir -p build/docker/ -cp doc/rippled-example.cfg build/clang.debug/rippled build/docker/ +cp cfg/rippled-example.cfg build/clang.debug/rippled build/docker/ cp Builds/Docker/Dockerfile-testnet build/docker/Dockerfile mv build/docker/rippled-example.cfg build/docker/rippled.cfg strip build/docker/rippled diff --git a/Builds/VisualStudio2015/README.md b/Builds/VisualStudio2015/README.md index c60b4c4f2c..10fa4fd171 100644 --- a/Builds/VisualStudio2015/README.md +++ b/Builds/VisualStudio2015/README.md @@ -200,7 +200,7 @@ the rippled server where that file is. 1. Create a directory to hold the configuration file. In this example, the ripple config directory was created in `C:\Users\joe\ripple\config`. -2. Copy the example config file located in `doc\rippled-example.cfg` to the +2. Copy the example config file located in `cfg\rippled-example.cfg` to the new directory and rename it "rippled.cfg". 3. Read the rippled.cfg file and edit as appropriate. diff --git a/CMakeLists.txt b/CMakeLists.txt index c7fd641aa0..07af1772d7 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -374,15 +374,10 @@ if (WIN32 OR is_xcode) # Documentation sources. Only needed for IDEs. prepend(doc_srcs docs/ - Jamfile.v2 - boostbook.dtd - consensus.qbk - index.xml - main.qbk - quickref.xml - reference.xsl source.dox) + file(GLOB_RECURSE other_docs docs/*.md) + list(APPEND doc_srcs "${other_docs}") set_property( SOURCE ${doc_srcs} APPEND @@ -484,52 +479,32 @@ list(APPEND targets ${other_target}) # other_target when the user builds the solution (default when pressing ) set_property(TARGET ${other_target} PROPERTY EXCLUDE_FROM_DEFAULT_BUILD true) -find_program( - B2_EXE - NAMES b2 - HINTS ${BOOST_ROOT} - PATHS ${BOOST_ROOT} - DOC "Location of the b2 build executable from Boost") -if(${B2_EXE} STREQUAL "B2_EXE-NOTFOUND") - message(WARNING - "Boost b2 executable not found. docs target will not be buildable") -elseif(NOT BOOST_ROOT) - if(Boost_INCLUDE_DIRS) - set(BOOST_ROOT ${Boost_INCLUDE_DIRS}) - else() - get_filename_component(BOOST_ROOT ${B2_EXE} DIRECTORY) +find_package(Doxygen) +if(TARGET Doxygen::doxygen) + if (NOT DEFINED ENV{PLANTUML_JAR}) + message(WARNING + "PLANTUML_JAR not set - @startuml diagrams will not generate") + endif() + # read the source config and make a modified one + # that points the output files to our build directory + FILE(READ "${CMAKE_SOURCE_DIR}/docs/source.dox" dox_content) + string(REGEX REPLACE "[\t ]*OUTPUT_DIRECTORY[\t ]*=(.*)" + "OUTPUT_DIRECTORY=${CMAKE_BINARY_DIR}\n\\1" + new_config "${dox_content}") + FILE(WRITE "${CMAKE_BINARY_DIR}/source.dox" "${new_config}") + add_custom_target(docs + COMMAND "${DOXYGEN_EXECUTABLE}" "${CMAKE_BINARY_DIR}/source.dox" + BYPRODUCTS "${CMAKE_BINARY_DIR}/html_doc/index.html" + WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/docs" + SOURCES "${doc_srcs}" + ) +else() + message(WARNING + "doxygen executable not found. docs target will not be buildable") + if(${CMAKE_VERSION} VERSION_LESS "3.9.0") + message("...consider updating to CMake 3.9.0 or greater for better doxygen support") endif() endif() -# The value for BOOST_ROOT will be determined based on -# 1) The environment BOOST_ROOT -# 2) The Boost_INCLUDE_DIRS found by `get_boost` -# 3) The folder the `b2` executable is found in. -# If those checks don't yield the correct path, BOOST_ROOT -# can be defined on the cmake command line: -# cmake -DBOOST_ROOT= -if(BOOST_ROOT) - set(B2_PARAMS "-sBOOST_ROOT=${BOOST_ROOT}") -endif() - -# Find bash to help Windows avoid file association problems -find_program( - BASH_EXE - NAMES bash sh - DOC "Location of the bash shell executable" - ) -if(${BASH_EXE} STREQUAL "BASH_EXE-NOTFOUND") - message(WARNING - "Unable to find bash executable. docs target may not be buildable") - set(BASH_EXE "") -endif() - -add_custom_target(docs - COMMAND ${CMAKE_COMMAND} -E env "PATH=$ENV{PATH} " ${BASH_EXE} ./makeqbk.sh - COMMAND ${B2_EXE} ${B2_PARAMS} - BYPRODUCTS "${CMAKE_SOURCE_DIR}/docs/html/index.html" - WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/docs" - SOURCES "${doc_srcs}" - ) set_startup_project(rippled) diff --git a/Jamroot b/Jamroot deleted file mode 100644 index f15328c97e..0000000000 --- a/Jamroot +++ /dev/null @@ -1,11 +0,0 @@ -# -# Copyright (c) 2013-2016 Vinnie Falco (vinnie dot falco at gmail dot com) -# -# Distributed under the Boost Software License, Version 1.0. (See accompanying -# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -# - -import boost ; - -boost.use-project ; - diff --git a/Jenkinsfile b/Jenkinsfile index b2be9324b5..43572d4fbb 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -74,11 +74,11 @@ try { if (! collab_found) { manager.addShortText( - "Author of this change is not a collaborator!", - "Crimson", - "white", - "0px", - "white") + 'Author of this change is not a collaborator!', + 'Crimson', + 'white', + '0px', + 'white') all_status['startup'] = [false, 'Author Check', "$CHANGE_AUTHOR is not a collaborator!"] error "$CHANGE_AUTHOR does not appear to be a collaborator...bailing on this build" @@ -88,93 +88,262 @@ try { } stage ('Parallel Build') { - def variants = [ - 'coverage', - 'clang.debug.unity', - 'clang.debug.nounity', - 'gcc.debug.unity', - 'gcc.debug.nounity', - 'clang.release.unity', - 'gcc.release.unity'] as String[] + String[][] variants = [ + ['coverage'], + ['docs'], + ['msvc.debug'], + // This one does not currently build (TBD): + //['msvc.debug.nounity'], + ['msvc.debug', '', 'PROJECT_NAME=rippled_classic'], + ['msvc.release'], + ['clang.debug.unity'], + ['clang.debug.unity', '', 'PARALLEL_TESTS=false'], + ['clang.debug.nounity'], + ['gcc.debug.unity'], + ['gcc.debug.nounity'], + ['clang.release.unity'], + ['gcc.release.unity'], + // add a static build just to make sure it works + ['gcc.debug.unity', '-Dstatic=true'], + // TODO - sanitizer runs currently fail + //['gcc.debug.nounity' , '-Dsan=address', 'PARALLEL_TESTS=false'], + //['gcc.debug.nounity' , '-Dsan=thread', 'PARALLEL_TESTS=false'], + ] // create a map of all builds // that we want to run. The map // is string keys and node{} object values def builds = [:] for (int index = 0; index < variants.size(); index++) { - def bldtype = variants[index] - builds[bldtype] = { - node('rippled-dev') { + def bldtype = variants[index][0] + def cmake_extra = variants[index].size() > 1 ? variants[index][1] : '' + def bldlabel = bldtype + cmake_extra + def extra_env = variants[index].size() > 2 ? variants[index][2..-1] : [] + for (int j = 0; j < extra_env.size(); j++) { + bldlabel += "_" + extra_env[j] + } + bldlabel = bldlabel.replace('-', '_') + bldlabel = bldlabel.replace(' ', '') + bldlabel = bldlabel.replace('=', '_') + + def compiler = getFirstPart(bldtype) + def target = getSecondPart(bldtype) + def config = getFirstPart(target) + if (compiler == 'coverage' || compiler == 'docs') { + compiler = 'gcc' + } + def cc = + (compiler == 'clang') ? '/opt/llvm-5.0.1/bin/clang' : 'gcc' + def cxx = + (compiler == 'clang') ? '/opt/llvm-5.0.1/bin/clang++' : 'g++' + def ucc = isNoUnity(target) ? 'true' : 'false' + def node_type = + (compiler == 'msvc') ? 'rippled-win' : 'rippled-dev' + // the default disposition for parallel test..disabled + // for coverage, enabled otherwise. Can still be overridden + // by explicitly setting with extra env settings above. + def pt = (compiler == 'coverage') ? 'false' : 'true' + + def env_vars = [ + "TARGET=${target}", + "CONFIG_TYPE=${config}", + "COMPILER=${compiler}", + "PARALLEL_TESTS=${pt}", + 'BUILD=cmake', + "BUILD_DIR=${bldlabel}", + "CMAKE_EXTRA_ARGS=${cmake_extra}", + 'VERBOSE_BUILD=true'] + + builds[bldlabel] = { + node(node_type) { checkout scm dir ('build') { deleteDir() } def cdir = upDir(pwd()) echo "BASEDIR: ${cdir}" - def compiler = getCompiler(bldtype) - def target = getTarget(bldtype) - if (compiler == "coverage") { - compiler = 'gcc' - } echo "COMPILER: ${compiler}" echo "TARGET: ${target}" - def clang_cc = - (compiler == "clang") ? "${LLVM_ROOT}/bin/clang" : '' - def clang_cxx = - (compiler == "clang") ? "${LLVM_ROOT}/bin/clang++" : '' - def ucc = isNoUnity(target) ? 'true' : 'false' + echo "CONFIG: ${config}" echo "USE_CC: ${ucc}" - withEnv(["CCACHE_BASEDIR=${cdir}", - "CCACHE_NOHASHDIR=true", - 'LCOV_ROOT=""', - "TARGET=${target}", - "CC=${compiler}", - 'BUILD=cmake', - 'VERBOSE_BUILD=true', - "CLANG_CC=${clang_cc}", - "CLANG_CXX=${clang_cxx}", - "USE_CCACHE=${ucc}"]) - { - myStage(bldtype) - try { - sh "ccache -s > ${bldtype}.txt" - // the devtoolset from SCL gives us a recent gcc. It's - // not strictly needed when we are building with clang, - // but it doesn't seem to interfere either - sh "source /opt/rh/devtoolset-6/enable && " + - "(/usr/bin/time -p ./bin/ci/ubuntu/build-and-test.sh 2>&1) 2>&1 " + - ">> ${bldtype}.txt" - sh "ccache -s >> ${bldtype}.txt" - } - finally { - def outstr = readFile("${bldtype}.txt") - def st = getResults(outstr) - def time = getTime(outstr) - def fail_count = getFailures(outstr) - outstr = null - def txtcolor = - fail_count == 0 ? "DarkGreen" : "Crimson" - def shortbld = bldtype - shortbld = shortbld.replace('debug', 'dbg') - shortbld = shortbld.replace('release', 'rel') - shortbld = shortbld.replace('unity', 'un') - manager.addShortText( - "${shortbld}: ${st}, t: ${time}", - txtcolor, - "white", - "0px", - "white") - archive("${bldtype}.txt") - lock('rippled_dev_status') { - all_status[bldtype] = - [fail_count == 0, bldtype, "${st}, t: ${time}"] - } - } + if (compiler == 'msvc') { + env_vars.addAll([ + 'BOOST_ROOT=c:\\lib\\boost_1_66', + 'PROJECT_NAME=rippled', + 'MSBUILDDISABLENODEREUSE=1', // this ENV setting is probably redundant since we also pass /nr:false to msbuild + 'OPENSSL_ROOT=c:\\OpenSSL-Win64']) + } + else { + env_vars.addAll([ + 'NINJA_BUILD=false', + "CCACHE_BASEDIR=${cdir}", + 'PLANTUML_JAR=/opt/plantuml/plantuml.jar', + 'CCACHE_NOHASHDIR=true', + "CC=${cc}", + "CXX=${cxx}", + 'LCOV_ROOT=""', + 'PATH+CMAKE_BIN=/opt/local/cmake', + 'GDB_ROOT=/opt/local/gdb', + 'BOOST_ROOT=/opt/local/boost_1_66_0', + "USE_CCACHE=${ucc}"]) } - } - } - } + if (extra_env.size() > 0) { + env_vars.addAll(extra_env) + } + + withCredentials( + [string( + credentialsId: 'RIPPLED_CODECOV_TOKEN', + variable: 'CODECOV_TOKEN')]) + { + withEnv(env_vars) { + myStage(bldlabel) + try { + if (compiler == 'msvc') { + powershell "Remove-Item -Path \"${bldlabel}.txt\" -Force -ErrorAction Ignore" + // we capture stdout to variable because I could + // not figure out how to make powershell redirect internally + output = powershell ( + returnStdout: true, + script: ''' +# Enable streams 3-6 +$WarningPreference = 'Continue' +$VerbosePreference = 'Continue' +$DebugPreference = 'Continue' +$InformationPreference = 'Continue' + +Invoke-BatchFile "${env:ProgramFiles(x86)}\\Microsoft Visual Studio\\2017\\Community\\VC\\Auxiliary\\Build\\vcvarsall.bat" x86_amd64 +Get-ChildItem env:* | Sort-Object name +cl +cmake --version +New-Item -ItemType Directory -Force -Path "build/$env:BUILD_DIR" -ErrorAction Stop +$sw = [Diagnostics.Stopwatch]::StartNew() +try { + Push-Location "build/$env:BUILD_DIR" + if ($env:NINJA_BUILD -eq "true") { + cmake -G"Ninja" -Dtarget="$env:COMPILER.$env:TARGET" -DCMAKE_VERBOSE_MAKEFILE=ON ../.. + } + else { + cmake -G"Visual Studio 15 2017 Win64" -Dtarget="$env:COMPILER.$env:TARGET" -DCMAKE_VERBOSE_MAKEFILE=ON ../.. + } + if ($LastExitCode -ne 0) { throw "CMake failed" } + + ## as of 01/2018, DO NOT USE cmake to run the actual build step. for some + ## reason, cmake spawning the build under jenkins causes MSBUILD/ninja to + ## get stuck at the end of the build. Perhaps cmake is spawning + ## incorrectly or failing to pass certain params + + if ($env:NINJA_BUILD -eq "true") { + ninja -j $env:NUMBER_OF_PROCESSORS -v + } + else { + msbuild /fl /m /nr:false /p:Configuration="$env:CONFIG_TYPE" /p:Platform=x64 /p:GenerateFullPaths=True /v:normal /nologo /clp:"ShowCommandLine;DisableConsoleColor" "$env:PROJECT_NAME.vcxproj" + } + if ($LastExitCode -ne 0) { throw "CMake build failed" } + + $exe = "./$env:CONFIG_TYPE/$env:PROJECT_NAME" + if ($env:NINJA_BUILD -eq "true") { + $exe = "./$env:PROJECT_NAME" + } + "Exe is at $exe" + $params = '--unittest', '--quiet', '--unittest-log' + if ($env:PARALLEL_TESTS -eq "true") { + $params = $params += "--unittest-jobs=$env:NUMBER_OF_PROCESSORS" + } + & $exe $params + if ($LastExitCode -ne 0) { throw "Unit tests failed" } +} +catch { + throw +} +finally { + $sw.Stop() + $sw.Elapsed + Pop-Location +} +''') + // if the powershell command fails (has nonzero exit) + // then the command above throws, we don't get our output, + // and we never create this output file. + // SEE https://issues.jenkins-ci.org/browse/JENKINS-44930 + // Alternatively, figure out how to reliably redirect + // all output above to a file (Start/Stop transcript does not work) + writeFile( + file: "${bldlabel}.txt", + text: output) + } + else { + sh "rm -fv ${bldlabel}.txt" + // execute the bld command in a redirecting shell + // to capture output + sh '''\ +#!/bin/bash +set -ex +log_file=''' + "${bldlabel}.txt" + ''' +exec 3>&1 1>>${log_file} 2>&1 +ccache -s +source /opt/rh/devtoolset-6/enable +/usr/bin/time -p ./bin/ci/ubuntu/build-and-test.sh 2>&1 +ccache -s +''' + } + } + finally { + def outstr = '' + def loglink = '[console](' + env.BUILD_URL + '/console)' + def logfile = "${bldlabel}.txt" + if (fileExists(logfile)) { + outstr = readFile(logfile) + loglink = "[logfile](" + env.BUILD_URL + "/artifact/${logfile})" + } + def st = getResults(outstr, bldlabel) + def time = getTime(outstr, bldlabel) + def fail_count = getFailures(outstr, bldlabel) + outstr = null + def txtcolor = + fail_count == 0 ? 'DarkGreen' : 'Crimson' + def shortbld = bldlabel + shortbld = shortbld.replace('debug', 'dbg') + shortbld = shortbld.replace('release', 'rel') + shortbld = shortbld.replace('unity', 'un') + manager.addShortText( + "${shortbld}: ${st}, t: ${time}", + txtcolor, + 'white', + '0px', + 'white') + archive("${bldlabel}.txt") + if (bldtype == 'docs') { + publishHTML( + allowMissing: true, + alwaysLinkToLastBuild: false, + keepAll: true, + reportName: 'Doxygen', + reportDir: 'build/docs/html_doc', + reportFiles: 'index.html') + } + def envs = '' + for (int j = 0; j < extra_env.size(); j++) { + envs += ",
" + extra_env[j] + } + def cmake_txt = cmake_extra + if (cmake_txt != '') { + cmake_txt = "
" + cmake_txt + } + lock('rippled_dev_status') { + all_status[bldlabel] = + [fail_count == 0, bldtype + cmake_txt + envs, "${st}, t: ${time}", loglink] + } + } //try-catch-finally + } //withEnv + } //withCredentials + } //node + } //builds item + } //for variants + + // this actually executes all the builds we just defined + // above, in parallel as slaves are available parallel builds } } @@ -183,7 +352,7 @@ finally { stage ('Final Status') { node { def start_time = new Date() - def sdf = new SimpleDateFormat("yyyyMMdd - HH:mm:ss") + def sdf = new SimpleDateFormat('yyyyMMdd - HH:mm:ss') def datestamp = sdf.format(start_time) def results = """ @@ -195,19 +364,19 @@ Built at __${datestamp}__ ### Test Results -Build Type | Result | Status ----------- | ------ | ------ +Build Type | Log | Result | Status +---------- | --- | ------ | ------ """ for ( e in all_status) { - results += e.value[1] + " | " + e.value[2] + " | " + - (e.value[0] ? "PASS :white_check_mark: " : "FAIL :red_circle: ") + "\n" + results += e.value[1] + ' | ' + e.value[3] + ' | ' + e.value[2] + ' | ' + + (e.value[0] ? 'PASS :white_check_mark: ' : 'FAIL :red_circle: ') + '\n' } - results += "\n" - echo "FINAL BUILD RESULTS" + results += '\n' + echo 'FINAL BUILD RESULTS' echo results try { - def url_comment = "" + def url_comment = '' if (env.CHANGE_ID && env.CHANGE_ID ==~ /\d+/) { // // CHANGE_ID indicates we are building a PR @@ -251,7 +420,7 @@ Build Type | Result | Status } if (comment_id == 0) { - echo "no existing status comment found" + echo 'no existing status comment found' } def body = JsonOutput.toJson([ @@ -266,8 +435,8 @@ Build Type | Result | Status httpMode: mode, requestBody: body) } - catch (any) { - echo "had a problem interacting with github...status is probably not updated" + catch (e) { + echo 'had a problem interacting with github...status is probably not updated' } } } @@ -295,24 +464,54 @@ ${log} } @NonCPS -def getResults(text) { +def getResults(text, label) { // example: - /// 194.5s, 154 suites, 948 cases, 360485 tests total, 0 failures - def matcher = text =~ /(\d+) cases, (\d+) tests total, (\d+) (failure(s?))/ - matcher ? matcher[0][1] + " cases, " + matcher[0][3] + " failed" : "no test results" + /// 194.5s, 154 suites, 948 cases, 360485 tests total, 0 failures + // or build log format: + // [msvc.release] 71.3s, 162 suites, 995 cases, 318901 tests total, 1 failure + def matcher = + text == '' ? + manager.getLogMatcher(/\[${label}\].+?(\d+) case[s]?, (\d+) test[s]? total, (\d+) (failure(s?))/) : + text =~ /(\d+) case[s]?, (\d+) test[s]? total, (\d+) (failure(s?))/ + matcher ? matcher[0][1] + ' cases, ' + matcher[0][3] + ' failed' : 'no test results' } -def getFailures(text) { - // example: - /// 194.5s, 154 suites, 948 cases, 360485 tests total, 0 failures - def matcher = text =~ /(\d+) tests total, (\d+) (failure(s?))/ +def getFailures(text, label) { + // [see above for format] + def matcher = + text == '' ? + manager.getLogMatcher(/\[${label}\].+?(\d+) test[s]? total, (\d+) (failure(s?))/) : + text =~ /(\d+) test[s]? total, (\d+) (failure(s?))/ // if we didn't match, then return 1 since something is // probably wrong, e.g. maybe the build failed... matcher ? matcher[0][2] as Integer : 1i } @NonCPS -def getCompiler(bld) { +def getTime(text, label) { + // look for text following a label 'real' for + // wallclock time. Some `time`s report fractional + // seconds and we can omit those in what we report + def matcher = + text == '' ? + manager.getLogMatcher(/(?m)^\[${label}\]\s+real\s+(.+)\.(\d+?)[s]?/) : + text =~ /(?m)^real\s+(.+)\.(\d+?)[s]?/ + if (matcher) { + return matcher[0][1] + 's' + } + + // alternatively, look for powershell elapsed time + // format, e.g. : + // TotalSeconds : 523.2140529 + def matcher2 = + text == '' ? + manager.getLogMatcher(/(?m)^\[${label}\]\s+TotalSeconds\s+:\s+(\d+)\.(\d+?)?/) : + text =~ /(?m)^TotalSeconds\s+:\s+(\d+)\.(\d+?)?/ + matcher2 ? matcher2[0][1] + 's' : 'n/a' +} + +@NonCPS +def getFirstPart(bld) { def matcher = bld =~ /^(.+?)\.(.+)$/ matcher ? matcher[0][1] : bld } @@ -324,7 +523,7 @@ def isNoUnity(bld) { } @NonCPS -def getTarget(bld) { +def getSecondPart(bld) { def matcher = bld =~ /^(.+?)\.(.+)$/ matcher ? matcher[0][2] : bld } @@ -337,12 +536,4 @@ def upDir(path) { matcher ? matcher[0][1] : path } -@NonCPS -def getTime(text) { - // look for text following a label 'real' for - // wallclock time. Some `time`s report fractional - // seconds and we can omit those in what we report - def matcher = text =~ /(?m)^real\s+(.+)\.(\d+?)[s]?/ - matcher ? matcher[0][1] + "s" : "n/a" -} diff --git a/README.md b/README.md index 27ed68bbbe..da59daccc5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -![Ripple](/images/ripple.png) - -**Do you work at a digital asset exchange or wallet provider?** - -Please [contact us](mailto:support@ripple.com). We can help guide your integration. - # What is Ripple? + +![Ripple](docs/images/ripple.png) + +> **Do you work at a digital asset exchange or wallet provider?** +> +> Please [contact us](mailto:support@ripple.com). We can help guide your integration. + Ripple is a network of computers which use the [Ripple consensus algorithm](https://www.youtube.com/watch?v=pj1QVb1vlC0) to atomically settle and record transactions on a secure distributed database, the Ripple Consensus Ledger (RCL). Because of its distributed nature, the RCL offers transaction immutability @@ -36,7 +37,7 @@ multiple trading parties, who each layer costs to the transaction. Thin liquidity and many intermediary trading parties make competitive pricing challenging. -![Flow - Direct](images/flow1.png) +![Flow - Direct](docs/images/flow1.png) ### XRP as a Bridge Currency Ripple can bridge even exotic currency pairs directly through XRP. Similar to @@ -47,7 +48,7 @@ counterparty risk, or additional operational costs. By using XRP, liquidity providers can specialize in certain currency corridors, reduce operational costs, and ultimately, offer more competitive FX pricing. -![Flow - Bridged over XRP](images/flow2.png) +![Flow - Bridged over XRP](docs/images/flow2.png) # rippled - Ripple server `rippled` is the reference server implementation of the Ripple @@ -68,7 +69,8 @@ ISC license. See the LICENSE file for more details. | ./bin | Scripts and data files for Ripple integrators. | | ./build | Intermediate and final build outputs. | | ./Builds| Platform or IDE-specific project files. | -| ./doc | Documentation and example configuration files. | +| ./docs | Source documentation files and doxygen config. | +| ./cfg | Example configuration files. | | ./src | Source code. | Some of the directories under `src` are external repositories inlined via diff --git a/RELEASENOTES.md b/RELEASENOTES.md index e9f58da432..5d2f810bea 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,12 +1,15 @@ -![Ripple](/images/ripple.png) +# Release Notes + +![Ripple](docs/images/ripple.png) This document contains the release notes for `rippled`, the reference server implementation of the Ripple protocol. To learn more about how to build and run a `rippled` server, visit https://ripple.com/build/rippled-setup/ -**Do you work at a digital asset exchange or wallet provider?** - -Please [contact us](mailto:support@ripple.com). We can help guide your integration. +> **Do you work at a digital asset exchange or wallet provider?** +> +> Please [contact us](mailto:support@ripple.com). We can help guide your integration. ## Updating `rippled` + If you are using Red Hat Enterprise Linux 7 or CentOS 7, you can [update using `yum`](https://ripple.com/build/rippled-setup/#updating-rippled). For other platforms, please [compile from source](https://wiki.ripple.com/Rippled_build_instructions). # Releases diff --git a/bin/ci/ubuntu/build-and-test.sh b/bin/ci/ubuntu/build-and-test.sh index beae4e37f0..7f77f4bc73 100755 --- a/bin/ci/ubuntu/build-and-test.sh +++ b/bin/ci/ubuntu/build-and-test.sh @@ -6,6 +6,12 @@ set -ex __dirname=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) echo "using CC: $CC" +"${CC}" --version +COMPNAME=$(basename $CC) +echo "using CXX: ${CXX:-notset}" +if [[ $CXX ]]; then + "${CXX}" --version +fi echo "using TARGET: $TARGET" # Ensure APP defaults to rippled if it's not set. @@ -25,42 +31,69 @@ else time= fi -if [[ ${BUILD:-scons} == "cmake" ]]; then +if [[ ${BUILD:-cmake} == "cmake" ]]; then echo "cmake building ${APP}" - CMAKE_EXTRA_ARGS=" -DCMAKE_VERBOSE_MAKEFILE=ON" - CMAKE_TARGET=$CC.$TARGET - BUILDARGS=" -j${JOBS}" - if [[ ${VERBOSE_BUILD:-} == true ]]; then - # TODO: if we use a different generator, this - # option to build verbose would need to change: - BUILDARGS+=" verbose=1" + : ${CMAKE_EXTRA_ARGS:=""} + if [[ ${NINJA_BUILD:-} == true ]]; then + CMAKE_EXTRA_ARGS+=" -G Ninja" fi + CMAKE_TARGET=${COMPNAME}.${TARGET} if [[ ${CI:-} == true ]]; then CMAKE_TARGET=$CMAKE_TARGET.ci fi + # + # allow explicit setting of the name of the build + # dir, otherwise default to the CMAKE_TARGET value + # + : "${BUILD_DIR:=$CMAKE_TARGET}" + BUILDARGS=" -j${JOBS}" + if [[ ${VERBOSE_BUILD:-} == true ]]; then + CMAKE_EXTRA_ARGS+=" -DCMAKE_VERBOSE_MAKEFILE=ON" + + # TODO: if we use a different generator, this + # option to build verbose would need to change: + if [[ ${NINJA_BUILD:-} == true ]]; then + BUILDARGS+=" -v" + else + BUILDARGS+=" verbose=1" + fi + fi if [[ ${USE_CCACHE:-} == true ]]; then echo "using ccache with basedir [${CCACHE_BASEDIR:-}]" - CMAKE_EXTRA_ARGS+=" -DCMAKE_CXX_COMPILER_LAUNCHER=ccache" + CMAKE_EXTRA_ARGS+=" -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache" fi - if [ -d "build/${CMAKE_TARGET}" ]; then - rm -rf "build/${CMAKE_TARGET}" + if [ -d "build/${BUILD_DIR}" ]; then + rm -rf "build/${BUILD_DIR}" fi - mkdir -p "build/${CMAKE_TARGET}" - pushd "build/${CMAKE_TARGET}" + + mkdir -p "build/${BUILD_DIR}" + pushd "build/${BUILD_DIR}" $time cmake ../.. -Dtarget=$CMAKE_TARGET ${CMAKE_EXTRA_ARGS} - $time cmake --build . -- $BUILDARGS - if [[ ${BUILD_BOTH:-} == true ]]; then - if [[ ${TARGET} == *.unity ]]; then - $time cmake --build . --target rippled_classic -- $BUILDARGS + if [[ ${TARGET} == "docs" ]]; then + $time cmake --build . --target docs -- $BUILDARGS + ## mimic the standard test output for docs build + ## to make controlling processes like jenkins happy + if [ -f html_doc/index.html ]; then + echo "1 case, 1 test total, 0 failures" else - $time cmake --build . --target rippled_unity -- $BUILDARGS + echo "1 case, 1 test total, 1 failures" + fi + exit + else + $time cmake --build . -- $BUILDARGS + if [[ ${BUILD_BOTH:-} == true ]]; then + if [[ ${TARGET} == *.unity ]]; then + cmake --build . --target rippled_classic -- $BUILDARGS + else + cmake --build . --target rippled_unity -- $BUILDARGS + fi fi fi popd - export APP_PATH="$PWD/build/${CMAKE_TARGET}/${APP}" + export APP_PATH="$PWD/build/${BUILD_DIR}/${APP}" echo "using APP_PATH: $APP_PATH" else - export APP_PATH="$PWD/build/$CC.$TARGET/${APP}" + export APP_PATH="$PWD/build/${COMPNAME}.${TARGET}/${APP}" echo "using APP_PATH: $APP_PATH" # Make sure vcxproj is up to date $time scons vcxproj @@ -68,21 +101,21 @@ else # $CC will be either `clang` or `gcc` # http://docs.travis-ci.com/user/migrating-from-legacy/?utm_source=legacy-notice&utm_medium=banner&utm_campaign=legacy-upgrade # indicates that 2 cores are available to containers. - $time scons -j${JOBS} $CC.$TARGET + $time scons -j${JOBS} ${COMPNAME}.$TARGET fi -# We can be sure we're using the build/$CC.$TARGET variant -# (-f so never err) -rm -f build/${APP} # See what we've actually built ldd $APP_PATH if [[ ${APP} == "rippled" ]]; then - export APP_ARGS+=" --unittest --quiet --unittest-log" + APP_ARGS+="--unittest --quiet --unittest-log" # Only report on src/ripple files export LCOV_FILES="*/src/ripple/*" # Nothing to explicitly exclude export LCOV_EXCLUDE_FILES="LCOV_NO_EXCLUDE" + if [[ $TARGET != "coverage" && ${PARALLEL_TESTS:-} == true ]]; then + APP_ARGS+=" --unittest-jobs ${JOBS}" + fi else : ${APP_ARGS:=} : ${LCOV_FILES:="*/src/*"} @@ -106,6 +139,7 @@ if [[ $TARGET == debug* && -v GDB_ROOT && -x $GDB_ROOT/bin/gdb ]]; then $GDB_ROOT/bin/gdb -v # Execute unit tests under gdb, printing a call stack # if we get a crash. + export APP_ARGS $GDB_ROOT/bin/gdb -return-child-result -quiet -batch \ -ex "set env MALLOC_CHECK_=3" \ -ex "set print thread-events off" \ diff --git a/doc/rippled-example.cfg b/cfg/rippled-example.cfg similarity index 100% rename from doc/rippled-example.cfg rename to cfg/rippled-example.cfg diff --git a/doc/rippled-example.service b/cfg/rippled-example.service similarity index 100% rename from doc/rippled-example.service rename to cfg/rippled-example.service diff --git a/doc/rippled.init b/cfg/rippled.init similarity index 100% rename from doc/rippled.init rename to cfg/rippled.init diff --git a/doc/validators-example.txt b/cfg/validators-example.txt similarity index 100% rename from doc/validators-example.txt rename to cfg/validators-example.txt diff --git a/doc/CHANGELOG b/doc/CHANGELOG deleted file mode 100644 index 03478bd82b..0000000000 --- a/doc/CHANGELOG +++ /dev/null @@ -1,29 +0,0 @@ -A list of rippled version numbers, and the Github pull requests they contain. - -0.28.0-b12: Includes pulls 836, 887, 902, 903 and 904. -0.28.0-b13: Includes pulls 906, 912, 913, 914 and 915. -0.28.0-b14: Includes pulls 907, 910, 922 and 923. -0.28.0-b15: Includes pulls 832, 870, 879, 883, 911, 916, 919, 920, 924, 925 and 928. FAILED pulls 909 and 926. -0.28.0-b16: Includes pulls 909, 926, 929, 931, 932, 935 and 934. -0.28.0-b17: Includes pulls 927, 939, 940, 943, 944, 945 and 949. -0.28.0-b18: Includes pulls 930, 946, 947, 948, 951, 952, 953, 954, 955, 956, 959, 960 and 962. -0.29.0-b19: Includes pulls 967, 969 and 971. -0.29.0-b20: Includes pulls 935, 942, 957, 958, 963, 964, 965, 966, 968, 972, 973, 974 and 975. -0.29.0-b21: Includes pulls 970 and 976. -0.28.1-b4: Includes pulls 968, 998, 1005, 1008, 1010, 1011 and 1012. -0.28.1-b6: Includes pulls 983, 984, 1013, 1023 and 1024. -0.28.1-b8: Includes pulls 988, 1009, 1014, 1019, 1029, 1031, 1033, 1034 and 1035. -0.28.1-b9: Includes pulls 1026, 1030, 1036, 1037, 1038, 1040, and 1041. -0.28.1-rc2: Includes pulls 1044 -0.28.1-rc3: Includes pulls 1052 and 1055. -0.28.1: Includes pulls 1056, 1059 and 1062, 1063. -0.28.2-b1: Includes pulls 866, 1045, 1046, 1047, 1050, 1051, 1057 -0.28.2-b2: Includes pulls 1058, 1061, 1064 and 1065 -0.28.2-b3: Includes pulls 1066, 1067, 1068 -0.28.2-b4: Includes pulls 1060, 1069, 1071, 1072, 1075 and 1076. -0.28.2-b5: Includes pulls 1073, 1074, 1081, 1083, 1084, 1087, 1089, 1090, 1091 -0.28.2-b6: Includes pulls 1085, 1093, 1094, 1096, 1101, 1102, 1105 -0.28.2-b7: Includes pulls 1077, 1080, 1086, 1095, 1098, 1106 and 1112. -0.28.2-b8: Includes pulls 1078, 1100, 1108, 1114, 1118, 1119 and 1121. -0.28.2-b9: Includes pulls 1053, 1109, 1111, 1117, 1122 and 1123. -0.29.1-b11: Includes pulls 1279, 1271, 1289, 1291, 1290, 1267, 1294, 1276, 1231, and 1286. diff --git a/doc/Doxyfile b/doc/Doxyfile deleted file mode 100644 index f79136c5d8..0000000000 --- a/doc/Doxyfile +++ /dev/null @@ -1,2304 +0,0 @@ -# Doxyfile 1.8.6 - -# 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 (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# 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. - -DOXYFILE_ENCODING = UTF-8 - -# 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. - -PROJECT_NAME = "RippleD" - -# 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 = "RippleD Server Software" - -# 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 = doc/LogoForDocumentation.png - -# 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 = - -# 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. - -CREATE_SUBDIRS = 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 = YES - -# 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 = YES - -# 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. - -FULL_PATH_NAMES = NO - -# 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 = YES - -# 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. - -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. - -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. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# 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, 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. - -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. - -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 = YES - -# 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. - -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 = YES - -# 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. - -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. - -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 = NO - -# 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 = 2 - -#--------------------------------------------------------------------------- -# 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. - -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 = YES - -# 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_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. - -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_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. - -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. - -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 = NO - -# 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. - -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 = NO - -# 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 = NO - -# 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_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. - -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 = YES - -# 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 = YES - -# 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. - -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. Do not use file names with spaces, bibtex cannot handle them. 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 = NO - -# 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 = YES - -# 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_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 = NO - -# 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_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_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 = \ - src/ripple - -# 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 = - -# 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 = - -# 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 = - -# 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. - -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 = - -# 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. - -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 = NO - -# 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 = NO - -# 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. - -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 = NO - -#--------------------------------------------------------------------------- -# 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 = HtmlDocumentation - -# 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 an additional user- -# defined cascading style sheet that is 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 file to the output directory. 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_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 = NO - -# 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 = YES - -# 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_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. - -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_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. - -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. -# 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. - -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. - -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. - -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. - -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. - -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. - -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_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://cdn.mathjax.org/mathjax/latest - -# 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_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 -# , /