[
{
"path": ".gitattributes",
"content": "*.pdf -crlf -diff\n"
},
{
"path": ".gitignore",
"content": "/Makefile\n/Emakefile\n/.Emakefile\n/config.status\n/ct_run.*ct*@*\n/ct_run.nonode*\n/all_runs.html\n/index.html\n/.externalToolBuilders\n/.Makefile.swp\n/.make-doc\n/variables-ct*@*\n/variables-*_ct*@*\n/variables-nonode@nohost\n/erl_crash.dump\n/autom4te.cache\n/aclocal.m4\n*.beam\n*~\n/ct_log_cache\n/result_increment_10_1000.txt\n/result_increment_1_10000.txt\n/result_read_10_10000.txt\n/result_read_1_100000.txt\n/Thumbs.db\n/python3-api\n/TAGS*\n/*.log\nebin/\n*.swp\n*.swo\n.DS_Store\nSession.vim\n.vimrc\n/src/user_default.erl\n/ct_default.css\n/jquery-latest.js\n/jquery.tablesorter.min.js\n/contrib/toke\n/contrib/erlang_js\ncontrib/slurm/slurm-*.out\n/java-api/target\n/cpp-api/scalaris\n/cpp-api/ssl-tests\n/.maven\n/priv/*.so\n/priv/*.so.dSYM/\n/contrib/log4erl/src/log4erl_lex.erl\n/contrib/log4erl/src/log4erl_parser.erl\n/cpp-api/tests.dSYM/\n/cpp-api/compile_commands.json\n/bin/jsonclient\n"
},
{
"path": ".project",
"content": "\n\n\tScalaris\n\t\n\t\n\t\n\t\n\t\t\n\t\t\torg.python.pydev.PyDevBuilder\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\tnet.sourceforge.texlipse.builder.TexlipseBuilder\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\torg.erlide.core.erlbuilder\n\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\tnet.sourceforge.texlipse.builder.TexlipseNature\n\t\torg.erlide.core.erlnature\n\t\torg.python.pydev.pythonNature\n\t\n\t\n\t\t\n\t\t\t1489147896928\n\t\t\t\n\t\t\t10\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-false-false-java-api\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896931\n\t\t\t\n\t\t\t14\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-*ct*@*\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896934\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-ct_*.log\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896937\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-TAGS*\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896939\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-all_runs.html\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896942\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-ct_default.css\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896944\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-jquery-latest.js\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896946\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-jquery.tablesorter.min.js\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896948\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-ct_log_cache\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896950\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-config.log\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896952\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-config.status\n\t\t\t\n\t\t\n\t\t\n\t\t\t1489147896954\n\t\t\t\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-index.html\n\t\t\t\n\t\t\n\t\t\n\t\t\t1318159459801\n\t\t\tcontrib\n\t\t\t10\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-false-false-wikipedia\n\t\t\t\n\t\t\n\t\t\n\t\t\t1378048114063\n\t\t\ttest\n\t\t\t6\n\t\t\t\n\t\t\t\torg.eclipse.ui.ide.multiFilter\n\t\t\t\t1.0-name-matches-true-false-*.beam\n\t\t\t\n\t\t\n\t\n\n"
},
{
"path": ".pydevproject",
"content": "\n\n\n\nDefault\npython 2.7\n\n"
},
{
"path": ".settings/org.eclipse.core.resources.prefs",
"content": "#Wed Jul 28 11:29:12 CEST 2010\neclipse.preferences.version=1\nencoding//user-dev-guide/main.tex=ISO-8859-1\n"
},
{
"path": ".settings/org.erlide.core.prefs",
"content": "backend_version=R16\ncompiler/raw={d, enable_debug}, {d, with_crypto_hash}, {d, with_rand}, {d, have_callback_support}, {d, with_maps}\\n , {d, 'HAVE_ERLANG_SENDFILE'}, {d, 'HAVE_CRYPTO_HASH'}\neclipse.preferences.version=1\nexternal_includes=\nexternal_modules=\ninclude_dirs=contrib/yaws/include;contrib/log4erl/include;include;\noutput_dir=ebin/eclipse\nsource_dirs=test;src;src/comm_layer;src/json;src/rbr;src/tx;src/transactions;src/rrepair;src/cp;src/paxos;\nuse_pathz=false\n"
},
{
"path": ".settings/org.erlide.model.prefs",
"content": "builderData=INTERNAL|compile|clean|test|\nconfigType=INTERNAL\neclipse.preferences.version=1\n"
},
{
"path": ".travis.yml",
"content": "language: generic\n\nmatrix:\n include:\n - os: osx\n osx_image: xcode11.4\n addons:\n homebrew:\n packages:\n - boost\n - erlang\n - python\n - ant\n - openssl\n - os: linux\n sudo: false\n addons:\n apt:\n sources:\n - boost-latest\n packages:\n - automake\n - clang\n - libboost-all-dev\n - python3\n - erlang\n - erlang-dev\n - ant\n\nscript:\n - env | grep TRAVIS\n - clang++ -v\n - 'if [[ \"$TRAVIS_OS_NAME\" == \"osx\" ]]; then CXX=clang++ ./configure --with-openssl=/usr/local/opt/openssl; fi'\n - 'if [[ \"$TRAVIS_OS_NAME\" == \"linux\" ]]; then CXX=clang++ ./configure; fi'\n - touch TAGS.root TAGS.contrib\n - make\n - make cpp\n - make python\n - 'if [[ \"$TRAVIS_OS_NAME\" == \"linux\" ]]; then make python3; fi'\n - make java\n"
},
{
"path": "AUTHORS",
"content": "Ufuk Celebi\nJens Fischer\nChristian Hennig\nMikael Högqvist\nMarie Hoffmann\nStefan Keidel\nNico Kruber\nMaik Lange\nMaximilian Michels\nMonika Moser\nMagnus Müller\nStefan Plantikow\nTanguy Racinet\nFlorian Schintke\nThorsten Schütt\nJan Skrzypczak\nJeroen Vlek\n"
},
{
"path": "ChangeLog",
"content": "Scalaris 0.9.0 (codename \"Vriesea scalaris\") - February 29, 2016\n============================================================\n(partly supported by the EU project IES Cities http://iescities.eu/)\n\nPackaging:\n\n- add a libscalaris-dev[el] package with the C++ API (rpm, deb)\n- Maven: let Maven also create a source jar file for the Java-API\n- Maven: allow proper snapshot versions for the maven repository at\n https://scalaris-team.github.io/scalaris/maven\n\nAPI:\n\n- CPP-API: provide a new C++ client library\n- DataNucleus: provide a new storage back-end for Scalaris\n- add a Scalaris adapter for YCSB\n- new functions in all APIs for generic routing table operations\n\nBusiness Logic:\n\n- rrepair: considerably improve the set reconciliation algorithms' performance\n and run more processes in parallel\n- rrepair: further reduce the reconciliation costs\n- rrepair: re-use left-over failure probability from phase 1 for phase 2\n- rrepair: increase accuracy in several formulaes of the set reconciliation\n algorithms\n- rrepair: support creating multiple Merkle trees for fewer message rounds\n ('rr_merkle_num_trees' configuration variable)\n- rrepair: remove support for aligning bit sizes (no improvements there)\n- transactions: speed up write ops when the transaction log already contains\n a read op on the same key\n- RM: optimise the traffic of state exchanges during ring maintenance\n- RT: improve routing parallelism by handling more messages in the routing\n process itself instead of inside the dht_node process\n- RT: improve performance along the routing path\n- support for dynamic replication factors given by the 'replication_factor'\n configuration variable\n- pid_groups: shuffle pids in find_a/1 for more better distributed (parallel)\n requests\n\nInfrastructure:\n\n- pid_groups: group names are now atoms instead of strings\n (allows faster access)\n- scalarisctl: do not set any default Erlang scheduler flags (allow changes\n through the ERL_SCHED_FLAGS environment variable)\n- extend the example scripts for running Scalaris on a SLURM cluster\n- add SLURM scripts for running Basho Bench\n- use configure to select the routing table type (--with-rt=rt_chord)\n- change hanoidb detection to \"configure --enable-hanoidb=\"\n- change erlang_js detection to \"configure --enable-erlang-js=\"\n- dht_node_monitor: switch messages on/off via configuration variable\n 'dht_node_monitor'\n- msg_delay: remove extraneous error messages for trigger messages of killed\n processes\n- prbr: allow write_filter to return value to qwrite calling process\n- update yaws to version 2.0.2\n- support for Erlang R14B04 up to 18.2.3 and current otp master\n\nTests:\n\n- allow running single test groups via \"make :_GROUP\"\n\nTools:\n\n- gen_component: allow processes to provide their own start functions\n- trace_mpath: write whole message of log_info to the tex output\n\nBugs:\n\n- fix cleanup of some special cases with transactions\n- fix several math issues and increase the math functions' performance\n- fix some errors which occurred in large scale deployments\n- fix several warnings reported by Coverity Scan\n- fix numerous more bugs\n\nScalaris 0.8.2 - July 24, 2015\n============================================================\n(partly supported by the EU project IES Cities http://iescities.eu/)\n\nBusiness Logic:\n- rrepair: minor performance improvements\n\nBugs:\n\n- rrepair: fix a rare crash due to hash collisions\n- rrepair: fix calculation of the next MaxItemCount in the merkle tree\n repair protocol (was one level behind)\n- tests: fix rare crashes in some unit tests\n- fix a few more minor bugs\n\nScalaris 0.8.1 - July 12, 2015\n============================================================\n(partly supported by the EU project IES Cities http://iescities.eu/)\n\nBusiness Logic:\n\n- rrepair: allow specifying the minimum number of hash bits to use\n to create non-approximate algorithms\n\nBugs:\n\n- rrepair: fix a badarith if rr_recon_version_bits is set to 'variable'\n- rrepair: fix a bug in the accuracy of the evaluation\n- fix two crashes in gossip\n\nScalaris 0.8.0 (codename \"Picoides scalaris\") - July 10, 2015\n============================================================\n(partly supported by the EU project IES Cities http://iescities.eu/\nand the EIT ICT Labs project MCData)\n\nPackaging:\n\n- also install docs on Arch Linux\n- fix lintian errors and warnings for Debian-based packages\n- fix permissions on the log directory (owned by the 'scalaris' user)\n and the config files (not owned by the 'scalaris' user anymore!)\n- adapt packages for newer distributions\n\nAPI:\n\n- Java-API: integrate new OtpErlang library (1.5.12 from Erlang 17.4)\n- Python-API: do not include a shebang with a pre-defined path to python\n anymore\n- Python-API: fix unclosed sockets in various tests\n- Python-API: increase python{2,3} test speed\n- Ruby-API: try to fallback to the normal json module if the gem is missing\n- Ruby-API: considerably increase the ruby test speed\n- remove the Publish/Subscribe API\n\nBusiness Logic:\n\n- rrepair: faster and more accurate bloom filter repair protocol\n- rrepair: faster, more accurate and less bandwidth-consuming merkle tree\n repair protocol\n- rrepair: reduce memory footprint of merkle_tree\n- rrepair: more accurate and less bandwidth-consuming trivial repair\n protocol\n- rrepair: add a new simple hash ('shash') algorithm\n- rrepair: switch to (the more efficient) push-only resolve phase for\n synchronisation\n- rrepair: add replica repair algorithm evaluation scripts\n- RM: faster cyclon cache integration, especially during node jumps\n- comm_layer: envelops can be nested\n- comm_layer: allow send options for comm:send_local/3 and msg_delay\n (currently only ?quiet supported)\n\nInfrastructure:\n\n- FD: simplify the API, support envelopes and remove own cookie handling\n- FD: extend the failure detector with generic notifications (not just\n crashes) to subscribed nodes\n- DB: add an (experimental) mnesia back-end\n- DB: add an (experimental) hanoidb back-end\n- DB: make the back-end configurable via the scalaris.cfg option\n 'db_backend'\n- improve the speed of several utility functions\n- scalarisctl: add '-l' parameter for specifying the logdir\n- scalarisctl: do not use the '-s' parameter anymore, instead specify the\n start type with the new '-t' parameter\n- scalarisctl: allow starting several dht_nodes per vm with given keys via\n the new parameter '-j'\n- update yaws to version 1.99\n- make \"$HOME/.scalaris/log\" the default log dir\n- support for Erlang R14B04 up to 18.0.2 and current otp master\n- add example scripts for running Scalaris on a SLURM cluster\n- move sources to github: https://github.com/scalaris-team/scalaris\n- new project homepage: http://scalaris.zib.de\n\nTests:\n\n- reduce log spam in proto_sched tests and only print proto_sched results\n when the tests fail\n- extended and improved various test suites\n\nTools:\n\n- proto_sched: support callbacks\n- proto_sched: add support for user msg shepherds\n- proto_sched: better error handling when sending messages to dead\n (local) processes\n- tester: add value creator and type checker for orddict:orddict()\n- tester: full support for Erlang 18.0\n- let 'make dialyzer' run over test as well and ignore some false-positives\n for Erlang >= 18.0 using the '-dialyzer()' attribute\n\nBugs:\n\n- slide: fix some race conditions with 'jump' operations\n- JSON-API: fix test_and_set not working correctly inside req_list\n- fix numerous more bugs\n\nScalaris 0.7.2 - October 23, 2014\n============================================================\n(partly supported by the EU project IES Cities http://iescities.eu/\nand the EIT ICT Labs project MCData)\n\nPackaging:\n\n- fix ArchLinux packages with newest Java versions\n\nDemonstrator \"Wiki on Scalaris\":\n\n- fix the separate count key optimisation not using Scalaris' increment\n operation\n\nBusiness Logic:\n\n- rrepair: let the trivial algorithm assume the worst case in order to always\n meet the configured \"recon probability of one error\" (p1e)\n- rrepair: fix the trivial algorithm having an effectively doubled p1e\n- rrepair: fix the bloom algorithm having an effectively tripled p1e\n- rrepair: allow disabling byte-alignment\n\nBugs:\n\n- fix a few minor bugs\n\nScalaris 0.7.1 - September 30, 2014\n============================================================\n(partly supported by the EU project IES Cities http://iescities.eu/\nand the EIT ICT Labs project MCData)\n\nPackaging:\n\n- add support for new distribution versions\n- support systemd and SELinux\n- include daemon for monitoring Scalaris through JMX\n\nAPI:\n\n- Java-API: integrate new OtpErlang library (1.5.10 from Erlang 17.3)\n\nDemonstrator \"Wiki on Scalaris\":\n\n- fix storing template back-links for magic words\n- fix ARTICLE_COUNT partitioning with hashes\n\nBusiness Logic:\n\n- more robust (still experimental) support for active load balancing with\n Karger and Ruhl's algorithm including more flexible \"load\" definitions\n- rm_tman: less overhead by only sending unknown nodes to neighbours\n- slide: better support for slide aborts\n- node join: less overhead during joins, especially in setups with huge\n lists of known nodes\n- cyclon: move to new gossip framework\n- vivaldi: move to new gossip framework\n- monitor: move performance monitor to the basic_services group\n (once per VM)\n\nInfrastructure:\n\n- several smaller performance optimisations\n- support for Erlang R13B01 up to 17.3 and current otp master\n\nTests:\n\n- some new unit tests and higher test coverage\n\nDocumentation:\n\n- add rrepair sequence diagrams\n\nBugs:\n\n- fix numerous bugs\n\nScalaris 0.7.0 (codename \"Stauroderus scalaris\") - April 28, 2014\n============================================================\n\nAPI:\n\n- Java-API: integrate new OtpErlang library (1.5.9 from Erlang 17.0)\n\nDemonstrator \"Wiki on Scalaris\" (supported by 4CaaSt http://www.4caast.eu/\n and Contrail http://contrail-project.eu):\n\n- add support for reading 7z dumps\n\nBusiness Logic (partly supported by the EU project IES Cities http://iescities.eu/\n and the EIT ICT Labs project MCData):\n\n- add an experimental Map-Reduce framework on top of Scalaris\n- add experimental support for active load balancing with Karger and\n Ruhl's algorithm including more flexible \"load\" definitions\n- rrepair: completely new merkle tree sync protocol with an order of\n magnitude lower traffic costs (use dynamic signature sizes based\n on a \"recon probability of one error\" (p1e) in the leaf nodes)\n- rrepair: add a trivial probabilistic reconciliation protocol using the\n \"recon probability of one error\" (p1e)\n- rrepair: replace bloom_fpr parameter with a generic \"recon probability of\n one error\" (p1e)\n- rrepair: add a trivial reconciliation phase for the differences identified\n by bloom\n- rrepair: more efficient resolve also including a list of keys to request\n- gossip: completely new (more flexible) gossip framework\n- slide: add support for 'jump' operations\n- slide: do not create a timer for each received message (use a periodic\n cleanup)\n- comm_layer: tune TCP connection parameters to increase throughput and\n latency (no delay_send)\n- comm_layer: close idle TCP connections, support for no_keep_alive\n connections (used by cyclon, for example)\n- comm_layer: try to bundle more messages\n- node join: less overhead during joins, especially in small rings\n- rm_tman: less overhead by not adding nodes in the cache to the dn_cache\n- rt_chord: skip trying to contact nodes in the own range\n- rt_chord: stop stabilize when the own node is reached\n\nInfrastructure:\n\n- intervals: more compact (and transfer-friendly) representation\n- trigger: replace modules with msg_delay:send_trigger/2\n- config: replace implementation with a public ets table\n- tune the garbage collection of some core processes and periodically\n garbage collect all processes\n- reduce the number of generated atoms and the number of ets tables used\n- several smaller performance optimisations\n- support for Erlang R13B01 up to 17.0 and current otp master\n\nTests:\n\n- improve test coverage (manual tests and random tests)\n- change test definitions and allow groups of tests, e.g.\n test (default), test-skipped,\n all_TESTS, all_with_cover_TESTS, performance_TESTS, proto_sched_TESTS,\n type_check_TESTS\n\nDocumentation:\n\n- add rrepair documentation\n\nTools:\n\n- proto_sched: new API, better determinism, more strict self-control\n- proto_sched: support for short-lived processes\n- proto_sched: more information in get_infos\n- trace_mpath: more flexible LaTeX exports with more detailed message info\n- trace_mpath: support meaningful PID names when tracing remote messages\n- tester: full support for Erlang 17.0\n- make: re-compile after Emakefile changes\n\nBugs:\n\n- rrepair: fix unnecessary feedback for KVV items of the same version\n- bulkowner: some fixes for (gracefully) leaving nodes\n- fix numerous more (less severe) bugs\n\nScalaris 0.6.1 - October 11, 2013\n============================================================\n\nPackaging:\n\n- add ArchLinux ruby API packages\n\nAPI:\n\n- Java-API: add Maven build support\n- Java-API: add CircularByteArrayOutputStream#clear()\n- Java-API: fix ConnectionPool#getConnection(timeout) throwing\n IllegalMonitorStateException if a single ConnectionPool is used\n by multiple threads and no more connections are available\n- Java-API: add a \"-monitor\" command line parameter\n- api_monitor: return the latency and stddev values of the micro-benchmark\n executed by monitor_perf for node and service performance\n\nDemonstrator \"Wiki on Scalaris\" (supported by 4CaaSt http://www.4caast.eu/\n and Contrail http://contrail-project.eu):\n\n- separate list counters from their list partitions for a better data layout\n- fix high memory use of the Scalaris import if the import is slow\n- use tomcat 7.0.42\n\nBusiness Logic:\n\n- rrepair: reduce overhead of ART reconciliation\n- rrepair: allow resolving of multiple merkle node leaves with a single\n resolve request\n- rrepair: don't create resolve requests for empty intervals\n- rrepair: reduce overhead of update_key_entry requests (use a single request\n with all the data instead of one request for each item)\n- rrepair: allow arbitrary intervals in interval_upd and interval_upd_send\n resolve requests again\n- rrepair: when hashing merkle_tree/ART children, also include the represented\n interval (fixes indistinguishable empty leaf nodes in ART)\n- tx_tm_rtm: re-enable takeover by rtms on tm crash\n- rt_chord: only re-build the RT if the pred or succ processes change or the\n own new node ID is not between the new pred and succ any more\n\nInfrastructure:\n\n- DB: improve performance of fold[lr] implementations by a factor of 2\n- FD: get rid of annoying, wrongly raised log warnings\n- RM: provide a more generic Reason for RM subscriptions\n- RM: remove trigger infections\n- RT: don't trigger an update when a slide finishes\n- RT, FRT: reduce the number of messages sent on lookups\n- log: don't exit with a badmatch if our error_logger is not the only one\n\nTests:\n\n- add protocol scheduler tests for slide, join and leave\n\nDocumentation:\n\n- user-dev-guide: add section on scalarisctl checkinstallation\n- user-dev-guide: clarify the section about how to set up Scalaris\n\nTools:\n\n- proto scheduler: continue in case of send errors\n- top: improve process messages output\n\nBugs:\n\n- node join: fix not being able to join a system with passive load balancer\n if the number of items in the DB is too high\n- tx_tm_rtm: fix wrong asserts\n- fix node resposibility check not always including message forward and\n db_range intervals\n- tx_tp: add missing snapshot number in tp_do_commit_abort message\n- bulkowner: respect the nodes' DB ranges and forward requests for\n non-responsible ranges\n- dn_cache: fix reporting wrong PIDs back as zombies after node reboots\n- fix some more (less severe) bugs\n\nScalaris 0.6.0 (codename \"Conus scalaris\") - August 19, 2013\n============================================================\n\nPackaging:\n\n- add ArchLinux packages\n- add support for new distribution versions\n\nAPI:\n\n- no more timeouts in client APIs\n- Java-API: re-worked the request and result list handling\n -> move result processing to the operation classes\n- Java-API: better support for custom operations\n- Java-API: support the new partial reads:\n ReadRandomFromListOp and ReadSublistOp\n- Java-API: compile with \"vars\" debug info\n- Java-API: integrate new OtpErlang library (1.5.8 from R16B) with fixed\n support for compressed binaries\n- Java-API: add back-ports from the Wiki on Scalaris demonstrator:\n * list-change operations: ScalarisChangeListOp and ScalarisListAppendRemoveOp\n * MultiMap classes are now in de.zib.tools\n * CircularByteArrayOutputStream\n- Java-API: fix hostname issues with Erlang and Java\n- Java-API: slightly changed the delete API\n- JSON-API: add API for auto-scale requests\n- Python-API: add API for auto-scale requests\n- Python-API: use default socket timeout\n- Ruby-API: use default socket timeout\n- all APIs: support lists of composite types\n\nDemonstrator \"Wiki on Scalaris\" (supported by 4CaaSt http://www.4caast.eu/\n and Contrail http://contrail-project.eu):\n\n- allow monitoring via JMX in the FourCaastMonitoringPlugin\n- support for getting random articles via the new partial read op\n- new optimisation scheme \"Buckets with Write Cache\" - uses a single big list\n to read from and the rest of the buckets to write to\n- improve import and dump-processing (faster, more memory-efficient)\n- add on-the-fly conversion to the different optimisation schemes during import\n (only one prepared DB dump needed now)\n- several UI enhancements and rendering fixes\n- update bliki lib (includes code ported to upstream)\n- add auto-import ability\n- use tomcat 7.0.33\n\nBusiness Logic:\n\n- replace common message tags with integers to reduce bandwidth\n- more flexible read operations (easier to extend)\n- add support for the following partial reads: random_from_list and sublist\n- save bandwidth by not returning the full value for write operations\n (only the version is required)\n- new DB back-end implementation with a smaller and cleaner interface\n- faster DB get_chunk processing\n- tx: allow overwriting old/outdated DB entries\n- tx: allow overwriting old/outdated write-locked entries\n- tx: allow setting write lock on old/outdated read-locked entries\n- tx: always reply when the majority replied during read\n- tx: make sure that if not_found is reported to the user (while reading),\n a write cannot go through if it is not also based on not_found\n- tx: committing a test_and_set op on a non-existing entry now fails as well\n (the op itself already returned the failure)\n- tx: add a 2s delay to wait for slow learner_decide answers before cleaning up\n (results in a faster state cleanup after the fourth response)\n- tx: small performance improvements in several modules\n- rm: only add alive, non-leaving nodes\n- rm: if a predecessor crashes, start repairing the range (rrepair)\n- rrepair: stabilised rrepair (not considered experimental any more)\n- rrepair: also update entries with existing but outdated WriteLocks\n- rrepair: several performance improvements\n (bloom, merkle_tree, art and rrepair processes in general)\n- rrepair: re-design of rr_recon\n- rrepair: don't offload heavy work onto the dht_node (increases responsiveness\n of the dht_node process during replica repair)\n- rrepair: improve db_generator tool and random_bias binomial distribution used\n for tests\n- rrepair: support differently configured nodes (use the same reconciliation\n structure parameters)\n- rrepair: de-activate self-repair (a node with multiple copies of the same\n items does not need a reconciliation structure to repair some of\n them)\n- rrepair: activate rrepair periodically every 10 minutes with a probability\n of 33%\n- slide v2.0: fewer message to initiate a slide\n- slide v2.0: generic (asynchronous) call-backs for different ring maintenance\n algorithms\n- slide v2.0: re-work handling of planned next operations, e.g. used by\n incremental slides\n- slide v2.0: don't directly work on the DB any more (there may be more data\n needed to slide) - let dht_node_state decide\n- slide v2.0: activate incremental join and leave operations\n- slide v2.0: actively report graceful node shutdown to the local FD of the\n leaving node to inform subscribers\n- slide v2.0: code clean-up\n- slide v2.0: some fixes for incremental slides\n- slide v2.0: more robust in general\n- more smooth node joins by also reporting when a join is not possible due to\n a running slide at the existing node\n- passive load balancing: random selection of (equally qualified) nodes\n- add new routing algorithms FRT-Chord (flexible routing tables) and\n GFRT-Chord (supports proximity routing and data centers) as alternatives to\n Chord (see rt_frtchord and rt_gfrtchord modules)\n- add auto-scale framework, e.g. for cloud environments (supported by\n Contrail http://contrail-project.eu/) which is able to scale the deployment\n to maintain a given target latency of executed transactions\n- cache config reads in the process dictionary for better performance\n- cyclon: if the cache is empty, try one of the nodes in known_hosts\n- add support for consistent snapshots (experimental)\n\nInfrastructure:\n\n- add a daemon to monitor Scalaris via JMX\n- disable message compression (only client values are compressed - the rest is\n too expensive, at least on GbE)\n- support for distributions with python3 available as \"python\" and\n python2 as \"python2\"\n- support for Ruby 1.9\n- yaws 1.96 (with patch to compile on otp master and a patch to fix a\n performance regression)\n- support for Erlang R13B01 up to R16B01 and current otp master\n\nTests:\n\n- add test suite to find memory leaks\n- let \"make test\" run the major test suites and \"make test-skipped\" for some\n more (time-consuming) tests\n- clean-up ring after timetrap timeout failures via common test hook\n- new ?compare macro for custom comparison functions\n- higher test coverage with more random-testing via the \"tester\"\n\nDocumentation:\n\n- user-dev-guide: add user tutorial on using scalaris\n- user-dev-guide: add a section about the slide protocol\n- user-dev-guide: extended description of scientific background\n- add replica repair sequence diagrams\n- better code descriptions\n\nTools:\n\n- gen_component: synchronous breakpoint set and delete for more deterministic\n usage\n- trace_mpath: allow selective tracing via filter fun\n- trace_mpath: fix several triggers becoming infected by trace_mpath resulting\n in infinite tracing\n- trace_mpath: improve latex output of traces\n- tester: copy dictionary to worker threads\n- tester: add support for more types, e.g. neg_integer(), gb_rees\n- tester: better type check error reporting\n- tester: print tester last calls when aborting unit tests\n (timeout or exception)\n- tester: add support for constraints in type specs (\"when is_subtype(A,B)\")\n- web debug interface: add cluster graph visualisation\n- web debug interface: display vivaldi distance\n- web debug interface: add IP addresses and ports to the ring charts and tables\n- web debug interface: allow navigating to the web interfaces of shown nodes\n- top: support for showing messages in message queue of an inspected PID\n- top: support for showing larger dictionary values\n- allow recursive reply_as envelopes\n- experimental protocol scheduler to check protocols with random message\n interleavings (see proto_sched module)\n\nBugs:\n\n- fix RM handling of (out-dated) nodes with the same ID as newly added nodes\n- fix ganglia integration not working any more\n- restore the ability to start nodes at a specific key via \"scalarisctl -k ...\"\n- fix some memory leaks in the tx system\n- fix statistics of comm_connection (not send in some cases, not overflow-aware)\n- use /bin/bash instead of /bin/sh which may not result in a bash session\n- fix init.d scripts not checking for existing processes correctly\n- fix dc_clustering\n- fix numerous other bugs\n\nScalaris 0.5.0 (codename \"Saperda scalaris\") - October 11, 2012\n===============================================================\n\nPackaging:\n\n- new init.d script to start Scalaris\n- added chef scripts to deploy Scalaris nodes\n- improved Windows start scripts (support for R15B01 and R15B02, don't close\n command prompt window immediately after shutdown if double-clicked)\n- more flexible scalarisctl (arbitrary parameter order, allow setting cookie,\n ports and number of nodes in VM via parameters, allow using screen for\n daemonised sessions, allow graceful leave via \"gstop\" command, new \"status\"\n command)\n- support for new linux distributions (Fedora 17, Ubuntu 12.04, openSUSE 12.2)\n- let scalarisctl checkinstallation also perform runtime tests for the APIs\n\nAPI:\n\n- allow Scalaris monitoring via JMX through the Java API\n- added an executor-service to the Java-API (de.zib.scalaris.executor.*)\n- added a node discovery daemon to the Java-API\n- allow compressed communication between the Java-API and Erlang for increased\n performance, especially if the two are on separate nodes\n- added VM management support to the JSON- and Python-API\n- added transaction log filtering to the Java-API, i.e. only sent the needed\n parts of the tlog back to Erlang and re-combine the result\n- fixed api_tx:req_list_commit_each/1 not running requests in parallel\n -> do not assure any order of requests, even if on same key!\n\nDemonstrator \"Wiki on Scalaris\" (supported by 4CaaSt http://www.4caast.eu/\n\t and Contrail http://contrail-project.eu):\n\n- allow different partitioned data models for better performance and\n scalability\n- allow logging of user requests\n- added support for checking whether another article exists (approximate)\n -> show link colours based on this check\n- added check for bad page titles\n- allow SERVERNAME and SERVERPATH in config for setups with load balancers\n- reduced memory footprint of Wiki data in Scalaris\n- support for newer wiki xml dumps\n- added support for using a MediaWiki-like SQLite-DB backend for e.g.\n filtering\n- improved overall performance\n- several rendering fixes\n\nBusiness Logic:\n\n- added (experimental) support for replica repair (disabled by default)\n (thanks to Maik Lange)\n- added monitoring of memory statistics (also available via web interface)\n- better error reporting in the failure detector\n- reduced message overhead by UIDs and message/tuple tags\n- reduced overall message size of transactions:\n * do not include the (uncompressed) value in messages of the read phase of\n write operations\n * do not include the value in init_TP messages\n- allow VM-flag \"first\" to be set via config file\n- gather overall connection statistics in comm_stats (also available via web\n interface)\n- reduced erroneous failure messages on node shutdown\n- integrated comm_layer into comm_server\n- better scalability in pid_groups (find processes round-robin in find_a/1)\n- several changes to improve overall performance and/or CPU time at the nodes\n\nTests:\n\n- support for more types in the runtime type-checker\n- verify several API functions via runtime type-checker (also test private\n functions if possible!)\n\nTools:\n\n- distributed protocol visualisation via trace_mpath (text-based or latex-file\n for graphical presentation)\n- better profiling via top for Erlang processes\n- better debugging, e.g. via ASCII supervisor-tree rendering in verbose mode\n\nBugs:\n\n- fixed memory leaks in read and write operations\n- fixed memory leaks in tx_tm_rtm\n- prevent potential endless loops in tx_tm_rtm\n- fixed inform RTMs sometimes informing the wrong RTMs\n- fixed numerous other bugs\n\nScalaris 0.4.1 - March 22, 2012\n===============================\n\nPackaging:\n\n- new official ConPaaS packages (http://www.conpaas.eu/)\n- install rubygem dependencies in Debian postinstall scripts for Ruby API\n- improved Windows start scripts (if set, uses the ERLANG_HOME environment\n variable to find Erlang, otherwise searches for Erlang in common paths)\n\nBugs:\n\n- better tx cleanup (should fix rare occurance of duplicate client inform)\n- forward additional parameters of the start scripts to new syntax of scalarisctl\n\nScalaris 0.4.0 (codename \"Pomacea scalaris\") - January 25, 2012\n===============================================================\n\nAPI:\n\n- new functions for incremental data change:\n test_and_set: check for a provided old value before setting a new one\n add_on_nr: increment a numeric value\n add_del_on_list: append or delete entries from a list value\n- added VM API to manage Scalaris nodes inside an Erlang virtual machine\n- added monitoring API to retrieve some live metrics\n- added a connection pool convenience class (Java, Python)\n\nDemonstrator \"Wiki on Scalaris\" (supported by 4CaaSt http://www.4caast.eu/):\n\n- improved performance of page edits\n- improved performance of Wikipedia dump loading\n- several rendering fixes\n\nBusiness Logic:\n\n- improved handling of large values by reducing overhead of transaction\n log handling (empty TLog after commit), no copy of value in TLog\n returned to user after read requests)\n- eliminated timeouts in data hand-over protocol (relies on fd now)\n- added a DB subscribe mechanism, e.g. to become informed when locks\n are freed\n- fixed a strong consistency issue in the tx protocol\n- gather some run-time statistics and expose them via the APIs and the\n web debug interface\n\nInfrastructure:\n\n- support for Erlang 15B\n- fd now also uses feedback from TCP layer\n- made message sending more flexible (gets an option list)\n- added and corrected several Erlang type specifications\n- added scripts to create Scalaris images for OpenNebula\n- added tools for using Scalaris as the Database as a Service\n component in ConPaaS (http://www.conpaas.eu/) which is part of the\n EU project Contrail (http://contrail-project.eu/)\n- added a separate communication channel for priority messages, e.g. fd\n (reduces falsely reported node crashes under heavy load)\n\nTests:\n\n- added runtime type-checker for random testing extended unittests\n\nDocumentation:\n\n- updated documentation to extended APIs\n\nBugs:\n\n- fixed numerous bugs\n\n\nScalaris 0.3.0 (codename \"Rhinechis Scalaris\") - July 15, 2011\n==============================================================\n\nAPI:\n\n- new API with interoperable bindings to Java, Python, Ruby, and JSON\n- support for several data types, including strings, integers, JSON\n objects, binary objects.\n- new transaction interface with support for bundled requests for\n better latency.\n- separate APIs to access the raw DHT, a DHT with replication, and the\n transactional DHT\n\nDemonstrator:\n\n- added Wikipedia-hosting using Scalaris as demonstrator application\n\nBusiness Logic:\n\n- fault-tolerant startup: start Scalaris when a quorum of the\n known_hosts becomes available (option -q in bin/scalarisctl)\n- perform data hand-over when nodes join/gracefully leave\n (also works when transactions are executed concurrently)\n- added passive load balancing (when a node joins a ring, it samples\n several other nodes and joins at the node that balances the number\n of stored items the most)\n- completely rewritten transaction layer (more modular, more\n extendible, less latency)\n- modularized / reimplemented Paxos algorithm, so the algorithm can\n also be used outside transactions (e.g. used for quorum-startup)\n- switched almost all components to our component framework 'gen_component'\n- added gossiping for estimating e.g. the number of nodes or the\n average load in a ring\n- more reliable unreliable look-up\n- better ring start-up on slow networks\n\nInfrastructure:\n\n- Vivaldi and topology inference\n- support for Erlang 13B01 and newer\n- faster TCP/IP communication between Scalaris nodes\n- completely rewritten failure detector framework for more accurate\n detection of node failures\n- added numerous Erlang type specifications\n- extended unittests\n\nTests:\n\n- added own random testing framework that reads type specifications\n and scans the source code for constants to generate proper random\n test-data\n- extended gen_component with breakpoint-support for debugging and\n testing (perform deterministic pseudo-random message interleaving\n tests)\n- added numerous unittests\n- added language-binding interoperability tests\n\nDocumentation:\n\n- extended, but - as always - by far not enough...\n\nBugs:\n\n- fixed countless bugs\n\nScalaris 0.2.0 - 0.2.3\n======================\n\n- changes not explicitly recorded (see the corresponding\n commit messages)\n\n"
},
{
"path": "Doxyfile",
"content": "# Doxyfile 1.8.9.1\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) for a project.\n#\n# All text after a double hash (##) is considered a comment and is placed in\n# front of the TAG it is preceding.\n#\n# All text after a single hash (#) is considered a comment and will be ignored.\n# The format is:\n# TAG = value [value, ...]\n# For lists, items can also be appended using:\n# TAG += value [value, ...]\n# Values that contain spaces should be placed between quotes (\\\" \\\").\n\n#---------------------------------------------------------------------------\n# Project related configuration options\n#---------------------------------------------------------------------------\n\n# This tag specifies the encoding used for all characters in the config file\n# that follow. The default is UTF-8 which is also the encoding used for all text\n# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv\n# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv\n# for the list of possible encodings.\n# The default value is: UTF-8.\n\nDOXYFILE_ENCODING = UTF-8\n\n# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n# double-quotes, unless you are using Doxywizard) that should identify the\n# project for which the documentation is generated. This name is used in the\n# title of most generated pages and in a few other places.\n# The default value is: My Project.\n\nPROJECT_NAME = \"Scalaris Project\"\n\n# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n# could be handy for archiving the generated documentation or if some version\n# control system is used.\n\nPROJECT_NUMBER =\n\n# Using the PROJECT_BRIEF tag one can provide an optional one line description\n# for a project that appears at the top of each page and should give viewer a\n# quick idea about the purpose of the project. Keep the description short.\n\nPROJECT_BRIEF = \"Scalaris, a distributed, transactional key-value store\"\n\n# With the PROJECT_LOGO tag one can specify a logo or an icon that is included\n# in the documentation. The maximum height of the logo should not exceed 55\n# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy\n# the logo to the output directory.\n\nPROJECT_LOGO =\n\n# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n# into which the generated documentation will be written. If a relative path is\n# entered, it will be relative to the location where doxygen was started. If\n# left blank the current directory will be used.\n\nOUTPUT_DIRECTORY = docs\n\n# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-\n# directories (in 2 levels) under the output directory of each output format and\n# will distribute the generated files over these directories. Enabling this\n# option can be useful when feeding doxygen a huge amount of source files, where\n# putting all generated files in the same directory would otherwise causes\n# performance problems for the file system.\n# The default value is: NO.\n\nCREATE_SUBDIRS = NO\n\n# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII\n# characters to appear in the names of generated files. If set to NO, non-ASCII\n# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode\n# U+3044.\n# The default value is: NO.\n\nALLOW_UNICODE_NAMES = NO\n\n# The OUTPUT_LANGUAGE tag is used to specify the language in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all constant output in the proper language.\n# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,\n# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),\n# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,\n# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),\n# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,\n# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,\n# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,\n# Ukrainian and Vietnamese.\n# The default value is: English.\n\nOUTPUT_LANGUAGE = English\n\n# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member\n# descriptions after the members that are listed in the file and class\n# documentation (similar to Javadoc). Set to NO to disable this.\n# The default value is: YES.\n\nBRIEF_MEMBER_DESC = YES\n\n# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief\n# description of a member or function before the detailed description\n#\n# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n# brief descriptions will be completely suppressed.\n# The default value is: YES.\n\nREPEAT_BRIEF = YES\n\n# This tag implements a quasi-intelligent brief description abbreviator that is\n# used to form the text in various listings. Each string in this list, if found\n# as the leading text of the brief description, will be stripped from the text\n# and the result, after processing the whole list, is used as the annotated\n# text. Otherwise, the brief description is used as-is. If left blank, the\n# following values are used ($name is automatically replaced with the name of\n# the entity):The $name class, The $name widget, The $name file, is, provides,\n# specifies, contains, represents, a, an and the.\n\nABBREVIATE_BRIEF =\n\n# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n# doxygen will generate a detailed section even if there is only a brief\n# description.\n# The default value is: NO.\n\nALWAYS_DETAILED_SEC = NO\n\n# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n# inherited members of a class in the documentation of that class as if those\n# members were ordinary class members. Constructors, destructors and assignment\n# operators of the base classes will not be shown.\n# The default value is: NO.\n\nINLINE_INHERITED_MEMB = NO\n\n# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path\n# before files name in the file list and in the header files. If set to NO the\n# shortest path that makes the file name unique will be used\n# The default value is: YES.\n\nFULL_PATH_NAMES = YES\n\n# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n# Stripping is only done if one of the specified strings matches the left-hand\n# part of the path. The tag can be used to show relative paths in the file list.\n# If left blank the directory from which doxygen is run is used as the path to\n# strip.\n#\n# Note that you can specify absolute paths here, but also relative paths, which\n# will be relative from the directory where doxygen is started.\n# This tag requires that the tag FULL_PATH_NAMES is set to YES.\n\nSTRIP_FROM_PATH =\n\n# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n# path mentioned in the documentation of a class, which tells the reader which\n# header file to include in order to use a class. If left blank only the name of\n# the header file containing the class definition is used. Otherwise one should\n# specify the list of include paths that are normally passed to the compiler\n# using the -I flag.\n\nSTRIP_FROM_INC_PATH =\n\n# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n# less readable) file names. This can be useful is your file systems doesn't\n# support long names like on DOS, Mac, or CD-ROM.\n# The default value is: NO.\n\nSHORT_NAMES = NO\n\n# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\n# first line (until the first dot) of a Javadoc-style comment as the brief\n# description. If set to NO, the Javadoc-style will behave just like regular Qt-\n# style comments (thus requiring an explicit @brief command for a brief\n# description.)\n# The default value is: NO.\n\nJAVADOC_AUTOBRIEF = NO\n\n# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n# line (until the first dot) of a Qt-style comment as the brief description. If\n# set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n# requiring an explicit \\brief command for a brief description.)\n# The default value is: NO.\n\nQT_AUTOBRIEF = NO\n\n# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\n# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n# a brief description. This used to be the default behavior. The new default is\n# to treat a multi-line C++ comment block as a detailed description. Set this\n# tag to YES if you prefer the old behavior instead.\n#\n# Note that setting this tag to YES also means that rational rose comments are\n# not recognized any more.\n# The default value is: NO.\n\nMULTILINE_CPP_IS_BRIEF = NO\n\n# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n# documentation from any documented member that it re-implements.\n# The default value is: YES.\n\nINHERIT_DOCS = YES\n\n# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new\n# page for each member. If set to NO, the documentation of a member will be part\n# of the file/class/namespace that contains it.\n# The default value is: NO.\n\nSEPARATE_MEMBER_PAGES = NO\n\n# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n# uses this value to replace tabs by spaces in code fragments.\n# Minimum value: 1, maximum value: 16, default value: 4.\n\nTAB_SIZE = 4\n\n# This tag can be used to specify a number of aliases that act as commands in\n# the documentation. An alias has the form:\n# name=value\n# For example adding\n# \"sideeffect=@par Side Effects:\\n\"\n# will allow you to put the command \\sideeffect (or @sideeffect) in the\n# documentation, which will result in a user-defined paragraph with heading\n# \"Side Effects:\". You can put \\n's in the value part of an alias to insert\n# newlines.\n\nALIASES =\n\n# This tag can be used to specify a number of word-keyword mappings (TCL only).\n# A mapping has the form \"name=value\". For example adding \"class=itcl::class\"\n# will allow you to use the command class in the itcl::class meaning.\n\nTCL_SUBST =\n\n# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n# only. Doxygen will then generate output that is more tailored for C. For\n# instance, some of the names that are used will be different. The list of all\n# members will be omitted, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_FOR_C = YES\n\n# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n# Python sources only. Doxygen will then generate output that is more tailored\n# for that language. For instance, namespaces will be presented as packages,\n# qualified scopes will look different, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_JAVA = NO\n\n# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n# sources. Doxygen will then generate output that is tailored for Fortran.\n# The default value is: NO.\n\nOPTIMIZE_FOR_FORTRAN = NO\n\n# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n# sources. Doxygen will then generate output that is tailored for VHDL.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_VHDL = NO\n\n# Doxygen selects the parser to use depending on the extension of the files it\n# parses. With this tag you can assign which parser to use for a given\n# extension. Doxygen has a built-in mapping, but you can override or extend it\n# using this tag. The format is ext=language, where ext is a file extension, and\n# language is one of the parsers supported by doxygen: IDL, Java, Javascript,\n# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:\n# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:\n# Fortran. In the later case the parser tries to guess whether the code is fixed\n# or free formatted code, this is the default for Fortran type files), VHDL. For\n# instance to make doxygen treat .inc files as Fortran files (default is PHP),\n# and .f files as C (default is Fortran), use: inc=Fortran f=C.\n#\n# Note: For files without extension you can use no_extension as a placeholder.\n#\n# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n# the files are not read by doxygen.\n\nEXTENSION_MAPPING =\n\n# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\n# according to the Markdown format, which allows for more readable\n# documentation. See http://daringfireball.net/projects/markdown/ for details.\n# The output of markdown processing is further processed by doxygen, so you can\n# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n# case of backward compatibilities issues.\n# The default value is: YES.\n\nMARKDOWN_SUPPORT = YES\n\n# When enabled doxygen tries to link words that correspond to documented\n# classes, or namespaces to their corresponding documentation. Such a link can\n# be prevented in individual cases by putting a % sign in front of the word or\n# globally by setting AUTOLINK_SUPPORT to NO.\n# The default value is: YES.\n\nAUTOLINK_SUPPORT = YES\n\n# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n# to include (a tag file for) the STL sources as input, then you should set this\n# tag to YES in order to let doxygen match functions declarations and\n# definitions whose arguments contain STL classes (e.g. func(std::string);\n# versus func(std::string) {}). This also make the inheritance and collaboration\n# diagrams that involve STL classes more complete and accurate.\n# The default value is: NO.\n\nBUILTIN_STL_SUPPORT = YES\n\n# If you use Microsoft's C++/CLI language, you should set this option to YES to\n# enable parsing support.\n# The default value is: NO.\n\nCPP_CLI_SUPPORT = NO\n\n# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen\n# will parse them like normal C++ but will assume all classes use public instead\n# of private inheritance when no explicit protection keyword is present.\n# The default value is: NO.\n\nSIP_SUPPORT = NO\n\n# For Microsoft's IDL there are propget and propput attributes to indicate\n# getter and setter methods for a property. Setting this option to YES will make\n# doxygen to replace the get and set methods by a property in the documentation.\n# This will only work if the methods are indeed getting or setting a simple\n# type. If this is not the case, or you want to show the methods anyway, you\n# should set this option to NO.\n# The default value is: YES.\n\nIDL_PROPERTY_SUPPORT = YES\n\n# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n# tag is set to YES then doxygen will reuse the documentation of the first\n# member in the group (if any) for the other members of the group. By default\n# all members of a group must be documented explicitly.\n# The default value is: NO.\n\nDISTRIBUTE_GROUP_DOC = NO\n\n# Set the SUBGROUPING tag to YES to allow class member groups of the same type\n# (for instance a group of public functions) to be put as a subgroup of that\n# type (e.g. under the Public Functions section). Set it to NO to prevent\n# subgrouping. Alternatively, this can be done per class using the\n# \\nosubgrouping command.\n# The default value is: YES.\n\nSUBGROUPING = YES\n\n# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n# are shown inside the group in which they are included (e.g. using \\ingroup)\n# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n# and RTF).\n#\n# Note that this feature does not work in combination with\n# SEPARATE_MEMBER_PAGES.\n# The default value is: NO.\n\nINLINE_GROUPED_CLASSES = NO\n\n# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n# with only public data fields or simple typedef fields will be shown inline in\n# the documentation of the scope in which they are defined (i.e. file,\n# namespace, or group documentation), provided this scope is documented. If set\n# to NO, structs, classes, and unions are shown on a separate page (for HTML and\n# Man pages) or section (for LaTeX and RTF).\n# The default value is: NO.\n\nINLINE_SIMPLE_STRUCTS = NO\n\n# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n# enum is documented as struct, union, or enum with the name of the typedef. So\n# typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n# with name TypeT. When disabled the typedef will appear as a member of a file,\n# namespace, or class. And the struct will be named TypeS. This can typically be\n# useful for C code in case the coding convention dictates that all compound\n# types are typedef'ed and only the typedef is referenced, never the tag name.\n# The default value is: NO.\n\nTYPEDEF_HIDES_STRUCT = NO\n\n# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n# cache is used to resolve symbols given their name and scope. Since this can be\n# an expensive process and often the same symbol appears multiple times in the\n# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n# doxygen will become slower. If the cache is too large, memory is wasted. The\n# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n# symbols. At the end of a run doxygen will report the cache usage and suggest\n# the optimal cache size from a speed point of view.\n# Minimum value: 0, maximum value: 9, default value: 0.\n\nLOOKUP_CACHE_SIZE = 0\n\n#---------------------------------------------------------------------------\n# Build related configuration options\n#---------------------------------------------------------------------------\n\n# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in\n# documentation are documented, even if no documentation was available. Private\n# class members and static file members will be hidden unless the\n# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n# Note: This will also disable the warnings about undocumented members that are\n# normally produced when WARNINGS is set to YES.\n# The default value is: NO.\n\nEXTRACT_ALL = NO\n\n# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will\n# be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIVATE = NO\n\n# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal\n# scope will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PACKAGE = NO\n\n# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be\n# included in the documentation.\n# The default value is: NO.\n\nEXTRACT_STATIC = NO\n\n# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined\n# locally in source files will be included in the documentation. If set to NO,\n# only classes defined in header files are included. Does not have any effect\n# for Java sources.\n# The default value is: YES.\n\nEXTRACT_LOCAL_CLASSES = YES\n\n# This flag is only useful for Objective-C code. If set to YES, local methods,\n# which are defined in the implementation section but not in the interface are\n# included in the documentation. If set to NO, only methods in the interface are\n# included.\n# The default value is: NO.\n\nEXTRACT_LOCAL_METHODS = NO\n\n# If this flag is set to YES, the members of anonymous namespaces will be\n# extracted and appear in the documentation as a namespace called\n# 'anonymous_namespace{file}', where file will be replaced with the base name of\n# the file that contains the anonymous namespace. By default anonymous namespace\n# are hidden.\n# The default value is: NO.\n\nEXTRACT_ANON_NSPACES = NO\n\n# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n# undocumented members inside documented classes or files. If set to NO these\n# members will be included in the various overviews, but no documentation\n# section is generated. This option has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_MEMBERS = NO\n\n# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n# undocumented classes that are normally visible in the class hierarchy. If set\n# to NO, these classes will be included in the various overviews. This option\n# has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_CLASSES = NO\n\n# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n# (class|struct|union) declarations. If set to NO, these declarations will be\n# included in the documentation.\n# The default value is: NO.\n\nHIDE_FRIEND_COMPOUNDS = NO\n\n# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n# documentation blocks found inside the body of a function. If set to NO, these\n# blocks will be appended to the function's detailed documentation block.\n# The default value is: NO.\n\nHIDE_IN_BODY_DOCS = NO\n\n# The INTERNAL_DOCS tag determines if documentation that is typed after a\n# \\internal command is included. If the tag is set to NO then the documentation\n# will be excluded. Set it to YES to include the internal documentation.\n# The default value is: NO.\n\nINTERNAL_DOCS = NO\n\n# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file\n# names in lower-case letters. If set to YES, upper-case letters are also\n# allowed. This is useful if you have classes or files whose names only differ\n# in case and if your file system supports case sensitive file names. Windows\n# and Mac users are advised to set this option to NO.\n# The default value is: system dependent.\n\nCASE_SENSE_NAMES = NO\n\n# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n# their full class and namespace scopes in the documentation. If set to YES, the\n# scope will be hidden.\n# The default value is: NO.\n\nHIDE_SCOPE_NAMES = NO\n\n# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will\n# append additional text to a page's title, such as Class Reference. If set to\n# YES the compound reference will be hidden.\n# The default value is: NO.\n\nHIDE_COMPOUND_REFERENCE= NO\n\n# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n# the files that are included by a file in the documentation of that file.\n# The default value is: YES.\n\nSHOW_INCLUDE_FILES = YES\n\n# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each\n# grouped member an include statement to the documentation, telling the reader\n# which file to include in order to use the member.\n# The default value is: NO.\n\nSHOW_GROUPED_MEMB_INC = NO\n\n# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n# files with double quotes in the documentation rather than with sharp brackets.\n# The default value is: NO.\n\nFORCE_LOCAL_INCLUDES = NO\n\n# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n# documentation for inline members.\n# The default value is: YES.\n\nINLINE_INFO = YES\n\n# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n# (detailed) documentation of file and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order.\n# The default value is: YES.\n\nSORT_MEMBER_DOCS = YES\n\n# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n# descriptions of file, namespace and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order. Note that\n# this will also influence the order of the classes in the class list.\n# The default value is: NO.\n\nSORT_BRIEF_DOCS = NO\n\n# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\n# (brief and detailed) documentation of class members so that constructors and\n# destructors are listed first. If set to NO the constructors will appear in the\n# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n# member documentation.\n# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n# detailed member documentation.\n# The default value is: NO.\n\nSORT_MEMBERS_CTORS_1ST = NO\n\n# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n# of group names into alphabetical order. If set to NO the group names will\n# appear in their defined order.\n# The default value is: NO.\n\nSORT_GROUP_NAMES = NO\n\n# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n# fully-qualified names, including namespaces. If set to NO, the class list will\n# be sorted only by class name, not including the namespace part.\n# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n# Note: This option applies only to the class list, not to the alphabetical\n# list.\n# The default value is: NO.\n\nSORT_BY_SCOPE_NAME = NO\n\n# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\n# type resolution of all parameters of a function it will reject a match between\n# the prototype and the implementation of a member function even if there is\n# only one candidate or it is obvious which candidate to choose by doing a\n# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n# accept a match between prototype and implementation in such cases.\n# The default value is: NO.\n\nSTRICT_PROTO_MATCHING = NO\n\n# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo\n# list. This list is created by putting \\todo commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TODOLIST = YES\n\n# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test\n# list. This list is created by putting \\test commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TESTLIST = YES\n\n# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug\n# list. This list is created by putting \\bug commands in the documentation.\n# The default value is: YES.\n\nGENERATE_BUGLIST = YES\n\n# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)\n# the deprecated list. This list is created by putting \\deprecated commands in\n# the documentation.\n# The default value is: YES.\n\nGENERATE_DEPRECATEDLIST= YES\n\n# The ENABLED_SECTIONS tag can be used to enable conditional documentation\n# sections, marked by \\if ... \\endif and \\cond \n# ... \\endcond blocks.\n\nENABLED_SECTIONS =\n\n# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n# initial value of a variable or macro / define can have for it to appear in the\n# documentation. If the initializer consists of more lines than specified here\n# it will be hidden. Use a value of 0 to hide initializers completely. The\n# appearance of the value of individual variables and macros / defines can be\n# controlled using \\showinitializer or \\hideinitializer command in the\n# documentation regardless of this setting.\n# Minimum value: 0, maximum value: 10000, default value: 30.\n\nMAX_INITIALIZER_LINES = 30\n\n# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n# the bottom of the documentation of classes and structs. If set to YES, the\n# list will mention the files that were used to generate the documentation.\n# The default value is: YES.\n\nSHOW_USED_FILES = YES\n\n# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n# will remove the Files entry from the Quick Index and from the Folder Tree View\n# (if specified).\n# The default value is: YES.\n\nSHOW_FILES = YES\n\n# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n# page. This will remove the Namespaces entry from the Quick Index and from the\n# Folder Tree View (if specified).\n# The default value is: YES.\n\nSHOW_NAMESPACES = YES\n\n# The FILE_VERSION_FILTER tag can be used to specify a program or script that\n# doxygen should invoke to get the current version for each file (typically from\n# the version control system). Doxygen will invoke the program by executing (via\n# popen()) the command command input-file, where command is the value of the\n# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n# by doxygen. Whatever the program writes to standard output is used as the file\n# version. For an example see the documentation.\n\nFILE_VERSION_FILTER =\n\n# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n# by doxygen. The layout file controls the global structure of the generated\n# output files in an output format independent way. To create the layout file\n# that represents doxygen's defaults, run doxygen with the -l option. You can\n# optionally specify a file name after the option, if omitted DoxygenLayout.xml\n# will be used as the name of the layout file.\n#\n# Note that if you run doxygen from a directory containing a file called\n# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\n# tag is left empty.\n\nLAYOUT_FILE =\n\n# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n# the reference definitions. This must be a list of .bib files. The .bib\n# extension is automatically appended if omitted. This requires the bibtex tool\n# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.\n# For LaTeX the style of the bibliography can be controlled using\n# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n# search path. See also \\cite for info how to create references.\n\nCITE_BIB_FILES =\n\n#---------------------------------------------------------------------------\n# Configuration options related to warning and progress messages\n#---------------------------------------------------------------------------\n\n# The QUIET tag can be used to turn on/off the messages that are generated to\n# standard output by doxygen. If QUIET is set to YES this implies that the\n# messages are off.\n# The default value is: NO.\n\nQUIET = NO\n\n# The WARNINGS tag can be used to turn on/off the warning messages that are\n# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES\n# this implies that the warnings are on.\n#\n# Tip: Turn warnings on while writing the documentation.\n# The default value is: YES.\n\nWARNINGS = YES\n\n# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate\n# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: YES.\n\nWARN_IF_UNDOCUMENTED = YES\n\n# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n# potential errors in the documentation, such as not documenting some parameters\n# in a documented function, or documenting parameters that don't exist or using\n# markup commands wrongly.\n# The default value is: YES.\n\nWARN_IF_DOC_ERROR = YES\n\n# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n# are documented, but have no documentation for their parameters or return\n# value. If set to NO, doxygen will only warn about wrong or incomplete\n# parameter documentation, but not about the absence of documentation.\n# The default value is: NO.\n\nWARN_NO_PARAMDOC = NO\n\n# The WARN_FORMAT tag determines the format of the warning messages that doxygen\n# can produce. The string should contain the $file, $line, and $text tags, which\n# will be replaced by the file and line number from which the warning originated\n# and the warning text. Optionally the format may contain $version, which will\n# be replaced by the version of the file (if it could be obtained via\n# FILE_VERSION_FILTER)\n# The default value is: $file:$line: $text.\n\nWARN_FORMAT = \"$file:$line: $text\"\n\n# The WARN_LOGFILE tag can be used to specify a file to which warning and error\n# messages should be written. If left blank the output is written to standard\n# error (stderr).\n\nWARN_LOGFILE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the input files\n#---------------------------------------------------------------------------\n\n# The INPUT tag is used to specify the files and/or directories that contain\n# documented source files. You may enter file names like myfile.cpp or\n# directories like /usr/src/myproject. Separate the files or directories with\n# spaces.\n# Note: If this tag is empty the current directory is searched.\n\nINPUT = cpp-api\n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n# documentation (see: http://www.gnu.org/software/libiconv) for the list of\n# possible encodings.\n# The default value is: UTF-8.\n\nINPUT_ENCODING = UTF-8\n\n# If the value of the INPUT tag contains directories, you can use the\n# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank the\n# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,\n# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,\n# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,\n# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,\n# *.qsf, *.as and *.js.\n\nFILE_PATTERNS = *.hpp *.h *.cpp\n\n# The RECURSIVE tag can be used to specify whether or not subdirectories should\n# be searched for input files as well.\n# The default value is: NO.\n\nRECURSIVE = YES\n\n# The EXCLUDE tag can be used to specify files and/or directories that should be\n# excluded from the INPUT source files. This way you can easily exclude a\n# subdirectory from a directory tree whose root is specified with the INPUT tag.\n#\n# Note that relative paths are relative to the directory from which doxygen is\n# run.\n\nEXCLUDE =\n\n# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n# directories that are symbolic links (a Unix file system feature) are excluded\n# from the input.\n# The default value is: NO.\n\nEXCLUDE_SYMLINKS = NO\n\n# If the value of the INPUT tag contains directories, you can use the\n# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n# certain files from those directories.\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories for example use the pattern */test/*\n\nEXCLUDE_PATTERNS =\n\n# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n# (namespaces, classes, functions, etc.) that should be excluded from the\n# output. The symbol name can be a fully qualified name, a word, or if the\n# wildcard * is used, a substring. Examples: ANamespace, AClass,\n# AClass::ANamespace, ANamespace::*Test\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories use the pattern */test/*\n\nEXCLUDE_SYMBOLS =\n\n# The EXAMPLE_PATH tag can be used to specify one or more files or directories\n# that contain example code fragments that are included (see the \\include\n# command).\n\nEXAMPLE_PATH =\n\n# If the value of the EXAMPLE_PATH tag contains directories, you can use the\n# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank all\n# files are included.\n\nEXAMPLE_PATTERNS =\n\n# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n# searched for input files to be used with the \\include or \\dontinclude commands\n# irrespective of the value of the RECURSIVE tag.\n# The default value is: NO.\n\nEXAMPLE_RECURSIVE = NO\n\n# The IMAGE_PATH tag can be used to specify one or more files or directories\n# that contain images that are to be included in the documentation (see the\n# \\image command).\n\nIMAGE_PATH =\n\n# The INPUT_FILTER tag can be used to specify a program that doxygen should\n# invoke to filter for each input file. Doxygen will invoke the filter program\n# by executing (via popen()) the command:\n#\n# \n#\n# where is the value of the INPUT_FILTER tag, and is the\n# name of an input file. Doxygen will then use the output that the filter\n# program writes to standard output. If FILTER_PATTERNS is specified, this tag\n# will be ignored.\n#\n# Note that the filter must not add or remove lines; it is applied before the\n# code is scanned, but not when the output code is generated. If lines are added\n# or removed, the anchors will not be placed correctly.\n\nINPUT_FILTER =\n\n# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n# basis. Doxygen will compare the file name with each pattern and apply the\n# filter if there is a match. The filters are a list of the form: pattern=filter\n# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n# patterns match the file name, INPUT_FILTER is applied.\n\nFILTER_PATTERNS =\n\n# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n# INPUT_FILTER) will also be used to filter the input files that are used for\n# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n# The default value is: NO.\n\nFILTER_SOURCE_FILES = NO\n\n# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n# it is also possible to disable source filtering for a specific pattern using\n# *.ext= (so without naming a filter).\n# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\n\nFILTER_SOURCE_PATTERNS =\n\n# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n# is part of the input, its contents will be placed on the main page\n# (index.html). This can be useful if you have a project on for instance GitHub\n# and want to reuse the introduction page also for the doxygen output.\n\nUSE_MDFILE_AS_MAINPAGE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to source browsing\n#---------------------------------------------------------------------------\n\n# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n# generated. Documented entities will be cross-referenced with these sources.\n#\n# Note: To get rid of all source code in the generated output, make sure that\n# also VERBATIM_HEADERS is set to NO.\n# The default value is: NO.\n\nSOURCE_BROWSER = NO\n\n# Setting the INLINE_SOURCES tag to YES will include the body of functions,\n# classes and enums directly into the documentation.\n# The default value is: NO.\n\nINLINE_SOURCES = NO\n\n# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n# special comment blocks from generated source code fragments. Normal C, C++ and\n# Fortran comments will always remain visible.\n# The default value is: YES.\n\nSTRIP_CODE_COMMENTS = YES\n\n# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n# function all documented functions referencing it will be listed.\n# The default value is: NO.\n\nREFERENCED_BY_RELATION = NO\n\n# If the REFERENCES_RELATION tag is set to YES then for each documented function\n# all documented entities called/used by that function will be listed.\n# The default value is: NO.\n\nREFERENCES_RELATION = NO\n\n# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n# to YES then the hyperlinks from functions in REFERENCES_RELATION and\n# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n# link to the documentation.\n# The default value is: YES.\n\nREFERENCES_LINK_SOURCE = YES\n\n# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n# source code will show a tooltip with additional information such as prototype,\n# brief description and links to the definition and documentation. Since this\n# will make the HTML file larger and loading of large files a bit slower, you\n# can opt to disable this feature.\n# The default value is: YES.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nSOURCE_TOOLTIPS = YES\n\n# If the USE_HTAGS tag is set to YES then the references to source code will\n# point to the HTML generated by the htags(1) tool instead of doxygen built-in\n# source browser. The htags tool is part of GNU's global source tagging system\n# (see http://www.gnu.org/software/global/global.html). You will need version\n# 4.8.6 or higher.\n#\n# To use it do the following:\n# - Install the latest version of global\n# - Enable SOURCE_BROWSER and USE_HTAGS in the config file\n# - Make sure the INPUT points to the root of the source tree\n# - Run doxygen as normal\n#\n# Doxygen will invoke htags (and that will in turn invoke gtags), so these\n# tools must be available from the command line (i.e. in the search path).\n#\n# The result: instead of the source browser generated by doxygen, the links to\n# source code will now point to the output of htags.\n# The default value is: NO.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nUSE_HTAGS = NO\n\n# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n# verbatim copy of the header file for each class for which an include is\n# specified. Set to NO to disable this.\n# See also: Section \\class.\n# The default value is: YES.\n\nVERBATIM_HEADERS = YES\n\n#---------------------------------------------------------------------------\n# Configuration options related to the alphabetical class index\n#---------------------------------------------------------------------------\n\n# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n# compounds will be generated. Enable this if the project contains a lot of\n# classes, structs, unions or interfaces.\n# The default value is: YES.\n\nALPHABETICAL_INDEX = YES\n\n# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in\n# which the alphabetical index list will be split.\n# Minimum value: 1, maximum value: 20, default value: 5.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nCOLS_IN_ALPHA_INDEX = 5\n\n# In case all classes in a project start with a common prefix, all classes will\n# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag\n# can be used to specify a prefix (or a list of prefixes) that should be ignored\n# while generating the index headers.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nIGNORE_PREFIX =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the HTML output\n#---------------------------------------------------------------------------\n\n# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output\n# The default value is: YES.\n\nGENERATE_HTML = YES\n\n# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n# it.\n# The default directory is: html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_OUTPUT = html\n\n# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n# generated HTML page (for example: .htm, .php, .asp).\n# The default value is: .html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FILE_EXTENSION = .html\n\n# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n# each generated HTML page. If the tag is left blank doxygen will generate a\n# standard header.\n#\n# To get valid HTML the header file that includes any scripts and style sheets\n# that doxygen needs, which is dependent on the configuration options used (e.g.\n# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n# default header using\n# doxygen -w html new_header.html new_footer.html new_stylesheet.css\n# YourConfigFile\n# and then modify the file new_header.html. See also section \"Doxygen usage\"\n# for information on how to generate the default header that doxygen normally\n# uses.\n# Note: The header is subject to change so you typically have to regenerate the\n# default header when upgrading to a newer version of doxygen. For a description\n# of the possible markers and block names see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_HEADER =\n\n# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n# generated HTML page. If the tag is left blank doxygen will generate a standard\n# footer. See HTML_HEADER for more information on how to generate a default\n# footer and what special commands can be used inside the footer. See also\n# section \"Doxygen usage\" for information on how to generate the default footer\n# that doxygen normally uses.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FOOTER =\n\n# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n# sheet that is used by each HTML page. It can be used to fine-tune the look of\n# the HTML output. If left blank doxygen will generate a default style sheet.\n# See also section \"Doxygen usage\" for information on how to generate the style\n# sheet that doxygen normally uses.\n# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n# it is more robust and this tag (HTML_STYLESHEET) will in the future become\n# obsolete.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_STYLESHEET =\n\n# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined\n# cascading style sheets that are included after the standard style sheets\n# created by doxygen. Using this option one can overrule certain style aspects.\n# This is preferred over using HTML_STYLESHEET since it does not replace the\n# standard style sheet and is therefore more robust against future updates.\n# Doxygen will copy the style sheet files to the output directory.\n# Note: The order of the extra style sheet files is of importance (e.g. the last\n# style sheet in the list overrules the setting of the previous ones in the\n# list). For an example see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_STYLESHEET =\n\n# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n# other source files which should be copied to the HTML output directory. Note\n# that these files will be copied to the base HTML output directory. Use the\n# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n# files will be copied as-is; there are no commands or markers available.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_FILES =\n\n# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n# will adjust the colors in the style sheet and background images according to\n# this color. Hue is specified as an angle on a colorwheel, see\n# http://en.wikipedia.org/wiki/Hue for more information. For instance the value\n# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n# purple, and 360 is red again.\n# Minimum value: 0, maximum value: 359, default value: 220.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_HUE = 220\n\n# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n# in the HTML output. For a value of 0 the output will use grayscales only. A\n# value of 255 will produce the most vivid colors.\n# Minimum value: 0, maximum value: 255, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_SAT = 100\n\n# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n# luminance component of the colors in the HTML output. Values below 100\n# gradually make the output lighter, whereas values above 100 make the output\n# darker. The value divided by 100 is the actual gamma applied, so 80 represents\n# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n# change the gamma.\n# Minimum value: 40, maximum value: 240, default value: 80.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_GAMMA = 80\n\n# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n# page will contain the date and time when the page was generated. Setting this\n# to NO can help when comparing the output of multiple runs.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_TIMESTAMP = YES\n\n# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n# documentation will contain sections that can be hidden and shown after the\n# page has loaded.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_SECTIONS = NO\n\n# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n# shown in the various tree structured indices initially; the user can expand\n# and collapse entries dynamically later on. Doxygen will expand the tree to\n# such a level that at most the specified number of entries are visible (unless\n# a fully collapsed tree already exceeds this amount). So setting the number of\n# entries 1 will produce a full collapsed tree by default. 0 is a special value\n# representing an infinite number of entries and will result in a full expanded\n# tree by default.\n# Minimum value: 0, maximum value: 9999, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_INDEX_NUM_ENTRIES = 100\n\n# If the GENERATE_DOCSET tag is set to YES, additional index files will be\n# generated that can be used as input for Apple's Xcode 3 integrated development\n# environment (see: http://developer.apple.com/tools/xcode/), introduced with\n# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a\n# Makefile in the HTML output directory. Running make will produce the docset in\n# that directory and running make install will install the docset in\n# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html\n# for more information.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_DOCSET = NO\n\n# This tag determines the name of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# The default value is: Doxygen generated docs.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDNAME = \"Doxygen generated docs\"\n\n# This tag specifies a string that should uniquely identify the documentation\n# set bundle. This should be a reverse domain-name style string, e.g.\n# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_BUNDLE_ID = org.doxygen.Project\n\n# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n# the documentation publisher. This should be a reverse domain-name style\n# string, e.g. com.mycompany.MyDocSet.documentation.\n# The default value is: org.doxygen.Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_ID = org.doxygen.Publisher\n\n# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n# The default value is: Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_NAME = Publisher\n\n# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\n# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on\n# Windows.\n#\n# The HTML Help Workshop contains a compiler that can convert all HTML output\n# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\n# files are now used as the Windows 98 help format, and will replace the old\n# Windows help format (.hlp) on all Windows platforms in the future. Compressed\n# HTML files also contain an index, a table of contents, and you can search for\n# words in the documentation. The HTML workshop also contains a viewer for\n# compressed HTML files.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_HTMLHELP = NO\n\n# The CHM_FILE tag can be used to specify the file name of the resulting .chm\n# file. You can add a path in front of the file if the result should not be\n# written to the html output directory.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_FILE =\n\n# The HHC_LOCATION tag can be used to specify the location (absolute path\n# including file name) of the HTML help compiler (hhc.exe). If non-empty,\n# doxygen will try to run the HTML help compiler on the generated index.hhp.\n# The file has to be specified with full path.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nHHC_LOCATION =\n\n# The GENERATE_CHI flag controls if a separate .chi index file is generated\n# (YES) or that it should be included in the master .chm file (NO).\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nGENERATE_CHI = NO\n\n# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)\n# and project file content.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_INDEX_ENCODING =\n\n# The BINARY_TOC flag controls whether a binary table of contents is generated\n# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it\n# enables the Previous and Next buttons.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nBINARY_TOC = NO\n\n# The TOC_EXPAND flag can be set to YES to add extra items for group members to\n# the table of contents of the HTML help documentation and to the tree view.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nTOC_EXPAND = NO\n\n# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n# (.qch) of the generated HTML documentation.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_QHP = NO\n\n# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n# the file name of the resulting .qch file. The path specified is relative to\n# the HTML output folder.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQCH_FILE =\n\n# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n# Project output. For more information please see Qt Help Project / Namespace\n# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_NAMESPACE = org.doxygen.Project\n\n# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n# Help Project output. For more information please see Qt Help Project / Virtual\n# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-\n# folders).\n# The default value is: doc.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_VIRTUAL_FOLDER = doc\n\n# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n# filter to add. For more information please see Qt Help Project / Custom\n# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\n# filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_NAME =\n\n# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n# custom filter to add. For more information please see Qt Help Project / Custom\n# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\n# filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_ATTRS =\n\n# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n# project's filter section matches. Qt Help Project / Filter Attributes (see:\n# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_SECT_FILTER_ATTRS =\n\n# The QHG_LOCATION tag can be used to specify the location of Qt's\n# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the\n# generated .qhp file.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHG_LOCATION =\n\n# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n# generated, together with the HTML files, they form an Eclipse help plugin. To\n# install this plugin and make it available under the help contents menu in\n# Eclipse, the contents of the directory containing the HTML and XML files needs\n# to be copied into the plugins directory of eclipse. The name of the directory\n# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n# After copying Eclipse needs to be restarted before the help appears.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_ECLIPSEHELP = NO\n\n# A unique identifier for the Eclipse help plugin. When installing the plugin\n# the directory name containing the HTML and XML files should also have this\n# name. Each documentation set should have its own identifier.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\n\nECLIPSE_DOC_ID = org.doxygen.Project\n\n# If you want full control over the layout of the generated HTML pages it might\n# be necessary to disable the index and replace it with your own. The\n# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n# of each HTML page. A value of NO enables the index and the value YES disables\n# it. Since the tabs in the index contain the same information as the navigation\n# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nDISABLE_INDEX = NO\n\n# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n# structure should be generated to display hierarchical information. If the tag\n# value is set to YES, a side panel will be generated containing a tree-like\n# index structure (just like the one that is generated for HTML Help). For this\n# to work a browser that supports JavaScript, DHTML, CSS and frames is required\n# (i.e. any modern browser). Windows users are probably better off using the\n# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can\n# further fine-tune the look of the index. As an example, the default style\n# sheet generated by doxygen has an example that shows how to put an image at\n# the root of the tree instead of the PROJECT_NAME. Since the tree basically has\n# the same information as the tab index, you could consider setting\n# DISABLE_INDEX to YES when enabling this option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_TREEVIEW = NO\n\n# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n# doxygen will group on one line in the generated HTML documentation.\n#\n# Note that a value of 0 will completely suppress the enum values from appearing\n# in the overview section.\n# Minimum value: 0, maximum value: 20, default value: 4.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nENUM_VALUES_PER_LINE = 4\n\n# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n# to set the initial width (in pixels) of the frame in which the tree is shown.\n# Minimum value: 0, maximum value: 1500, default value: 250.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nTREEVIEW_WIDTH = 250\n\n# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to\n# external symbols imported via tag files in a separate window.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nEXT_LINKS_IN_WINDOW = NO\n\n# Use this tag to change the font size of LaTeX formulas included as images in\n# the HTML documentation. When you change the font size after a successful\n# doxygen run you need to manually remove any form_*.png images from the HTML\n# output directory to force them to be regenerated.\n# Minimum value: 8, maximum value: 50, default value: 10.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_FONTSIZE = 10\n\n# Use the FORMULA_TRANPARENT tag to determine whether or not the images\n# generated for formulas are transparent PNGs. Transparent PNGs are not\n# supported properly for IE 6.0, but are supported on all modern browsers.\n#\n# Note that when changing this option you need to delete any form_*.png files in\n# the HTML output directory before the changes have effect.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_TRANSPARENT = YES\n\n# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n# http://www.mathjax.org) which uses client side Javascript for the rendering\n# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX\n# installed or if you want to formulas look prettier in the HTML output. When\n# enabled you may also need to install MathJax separately and configure the path\n# to it using the MATHJAX_RELPATH option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nUSE_MATHJAX = NO\n\n# When MathJax is enabled you can set the default output format to be used for\n# the MathJax output. See the MathJax site (see:\n# http://docs.mathjax.org/en/latest/output.html) for more details.\n# Possible values are: HTML-CSS (which is slower, but has the best\n# compatibility), NativeMML (i.e. MathML) and SVG.\n# The default value is: HTML-CSS.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_FORMAT = HTML-CSS\n\n# When MathJax is enabled you need to specify the location relative to the HTML\n# output directory using the MATHJAX_RELPATH option. The destination directory\n# should contain the MathJax.js script. For instance, if the mathjax directory\n# is located at the same level as the HTML output directory, then\n# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n# Content Delivery Network so you can quickly see the result without installing\n# MathJax. However, it is strongly recommended to install a local copy of\n# MathJax from http://www.mathjax.org before deployment.\n# The default value is: http://cdn.mathjax.org/mathjax/latest.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest\n\n# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n# extension names that should be enabled during MathJax rendering. For example\n# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_EXTENSIONS =\n\n# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\n# of code that will be used on startup of the MathJax code. See the MathJax site\n# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an\n# example see the documentation.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_CODEFILE =\n\n# When the SEARCHENGINE tag is enabled doxygen will generate a search box for\n# the HTML output. The underlying search engine uses javascript and DHTML and\n# should work on any modern browser. Note that when using HTML help\n# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n# there is already a search function so this one should typically be disabled.\n# For large projects the javascript based search engine can be slow, then\n# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n# search using the keyboard; to jump to the search box use + S\n# (what the is depends on the OS and browser, but it is typically\n# , /