mt-libcouchbase 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +22 -0
- data/.gitmodules +3 -0
- data/.rspec +1 -0
- data/.travis.yml +38 -0
- data/Gemfile +4 -0
- data/LICENSE +24 -0
- data/README.md +445 -0
- data/Rakefile +76 -0
- data/ext/README.md +6 -0
- data/ext/Rakefile +19 -0
- data/ext/libcouchbase/.gitignore +132 -0
- data/ext/libcouchbase/CMakeLists.txt +455 -0
- data/ext/libcouchbase/CONTRIBUTING.md +105 -0
- data/ext/libcouchbase/LICENSE +202 -0
- data/ext/libcouchbase/README.markdown +195 -0
- data/ext/libcouchbase/RELEASE_NOTES.markdown +3523 -0
- data/ext/libcouchbase/cmake/Modules/ConfigureDtrace.cmake +52 -0
- data/ext/libcouchbase/cmake/Modules/CopyPDB.cmake +42 -0
- data/ext/libcouchbase/cmake/Modules/DistScript.cmake +17 -0
- data/ext/libcouchbase/cmake/Modules/DownloadLcbDep.cmake +18 -0
- data/ext/libcouchbase/cmake/Modules/FindCouchbaseHdrHistogram.cmake +15 -0
- data/ext/libcouchbase/cmake/Modules/FindCouchbaseLibev.cmake +73 -0
- data/ext/libcouchbase/cmake/Modules/FindCouchbaseLibevent.cmake +54 -0
- data/ext/libcouchbase/cmake/Modules/FindCouchbaseLibuv.cmake +57 -0
- data/ext/libcouchbase/cmake/Modules/FindProfiler.cmake +16 -0
- data/ext/libcouchbase/cmake/Modules/GenerateConfigDotH.cmake +49 -0
- data/ext/libcouchbase/cmake/Modules/GetLibcouchbaseFlags.cmake +142 -0
- data/ext/libcouchbase/cmake/Modules/GetPlatformCCInfo.cmake +45 -0
- data/ext/libcouchbase/cmake/Modules/GetVersionInfo.cmake +70 -0
- data/ext/libcouchbase/cmake/config-cmake.h.in +80 -0
- data/ext/libcouchbase/cmake/configure +355 -0
- data/ext/libcouchbase/cmake/defs.mk.in +6 -0
- data/ext/libcouchbase/cmake/dtrace-instr-link.pl +51 -0
- data/ext/libcouchbase/cmake/libcouchbase.stp.in +829 -0
- data/ext/libcouchbase/cmake/source_files.cmake +104 -0
- data/ext/libcouchbase/contrib/cJSON/cJSON.c +1022 -0
- data/ext/libcouchbase/contrib/cJSON/cJSON.h +158 -0
- data/ext/libcouchbase/contrib/cbsasl/CMakeLists.txt +25 -0
- data/ext/libcouchbase/contrib/cbsasl/COPYING +202 -0
- data/ext/libcouchbase/contrib/cbsasl/include/cbsasl/cbsasl.h +259 -0
- data/ext/libcouchbase/contrib/cbsasl/src/client.c +419 -0
- data/ext/libcouchbase/contrib/cbsasl/src/common.c +50 -0
- data/ext/libcouchbase/contrib/cbsasl/src/cram-md5/hmac.c +67 -0
- data/ext/libcouchbase/contrib/cbsasl/src/cram-md5/hmac.h +33 -0
- data/ext/libcouchbase/contrib/cbsasl/src/cram-md5/md5.c +296 -0
- data/ext/libcouchbase/contrib/cbsasl/src/cram-md5/md5.h +45 -0
- data/ext/libcouchbase/contrib/cbsasl/src/hash.c +573 -0
- data/ext/libcouchbase/contrib/cbsasl/src/hash.h +15 -0
- data/ext/libcouchbase/contrib/cbsasl/src/scram-sha/scram_utils.c +500 -0
- data/ext/libcouchbase/contrib/cbsasl/src/scram-sha/scram_utils.h +99 -0
- data/ext/libcouchbase/contrib/cbsasl/src/util.h +31 -0
- data/ext/libcouchbase/contrib/cliopts/CMakeLists.txt +2 -0
- data/ext/libcouchbase/contrib/cliopts/cliopts.c +938 -0
- data/ext/libcouchbase/contrib/cliopts/cliopts.h +610 -0
- data/ext/libcouchbase/contrib/genhash/genhash.c +371 -0
- data/ext/libcouchbase/contrib/genhash/genhash.h +241 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/CHANGES +157 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/CMakeLists.txt +252 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/CONTRIBUTORS +37 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/LICENSE +28 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/MINIFY.sh +15 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/README +435 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/cmake/internal_utils.cmake +227 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest-death-test.h +294 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest-message.h +250 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest-param-test.h +1421 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest-param-test.h.pump +487 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest-printers.h +855 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest-spi.h +232 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest-test-part.h +179 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest-typed-test.h +259 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest.h +2291 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest_pred_impl.h +358 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/gtest_prod.h +58 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-death-test-internal.h +319 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-filepath.h +206 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-internal.h +1158 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-linked_ptr.h +233 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-param-util-generated.h +5143 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-param-util-generated.h.pump +301 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-param-util.h +619 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-port.h +1947 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-string.h +167 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-tuple.h +1012 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-tuple.h.pump +339 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-type-util.h +3331 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/include/gtest/internal/gtest-type-util.h.pump +297 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest-all.cc +48 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest-death-test.cc +1344 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest-filepath.cc +382 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest-internal-inl.h +1218 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest-port.cc +805 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest-printers.cc +363 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest-test-part.cc +110 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest-typed-test.cc +110 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest.cc +5015 -0
- data/ext/libcouchbase/contrib/gtest-1.7.0/src/gtest_main.cc +38 -0
- data/ext/libcouchbase/contrib/http_parser/LICENSE-MIT +23 -0
- data/ext/libcouchbase/contrib/http_parser/README.md +178 -0
- data/ext/libcouchbase/contrib/http_parser/http_parser.c +2060 -0
- data/ext/libcouchbase/contrib/http_parser/http_parser.h +321 -0
- data/ext/libcouchbase/contrib/jsonsl/LICENSE +20 -0
- data/ext/libcouchbase/contrib/jsonsl/jsonsl.c +1452 -0
- data/ext/libcouchbase/contrib/jsonsl/jsonsl.h +971 -0
- data/ext/libcouchbase/contrib/lcb-jsoncpp/CMakeLists.txt +6 -0
- data/ext/libcouchbase/contrib/lcb-jsoncpp/LICENSE +55 -0
- data/ext/libcouchbase/contrib/lcb-jsoncpp/lcb-jsoncpp-forwards.h +255 -0
- data/ext/libcouchbase/contrib/lcb-jsoncpp/lcb-jsoncpp.cpp +4893 -0
- data/ext/libcouchbase/contrib/lcb-jsoncpp/lcb-jsoncpp.h +1961 -0
- data/ext/libcouchbase/contrib/snappy/CMakeLists.txt +7 -0
- data/ext/libcouchbase/contrib/snappy/COPYING +28 -0
- data/ext/libcouchbase/contrib/snappy/snappy-c.cc +90 -0
- data/ext/libcouchbase/contrib/snappy/snappy-c.h +138 -0
- data/ext/libcouchbase/contrib/snappy/snappy-internal.h +150 -0
- data/ext/libcouchbase/contrib/snappy/snappy-lcb-msvc.h +5 -0
- data/ext/libcouchbase/contrib/snappy/snappy-sinksource.cc +75 -0
- data/ext/libcouchbase/contrib/snappy/snappy-sinksource.h +137 -0
- data/ext/libcouchbase/contrib/snappy/snappy-stubs-internal.cc +42 -0
- data/ext/libcouchbase/contrib/snappy/snappy-stubs-internal.h +491 -0
- data/ext/libcouchbase/contrib/snappy/snappy-stubs-public.h +100 -0
- data/ext/libcouchbase/contrib/snappy/snappy.cc +1312 -0
- data/ext/libcouchbase/contrib/snappy/snappy.h +184 -0
- data/ext/libcouchbase/contrib/win32-defs/iocpdefs.h +133 -0
- data/ext/libcouchbase/contrib/win32-defs/mingwdefs.h +4396 -0
- data/ext/libcouchbase/contrib/win32-defs/win_stdint.h +258 -0
- data/ext/libcouchbase/doc/Doxyfile +2495 -0
- data/ext/libcouchbase/doc/DoxygenLayout.xml +109 -0
- data/ext/libcouchbase/doc/Makefile +44 -0
- data/ext/libcouchbase/doc/apiattr.h +117 -0
- data/ext/libcouchbase/doc/cbc-n1qlback.markdown +88 -0
- data/ext/libcouchbase/doc/cbc-pillowfight.markdown +296 -0
- data/ext/libcouchbase/doc/cbc-subdoc.markdown +299 -0
- data/ext/libcouchbase/doc/cbc.markdown +763 -0
- data/ext/libcouchbase/doc/cbcrc.markdown +52 -0
- data/ext/libcouchbase/doc/common-additional-options.markdown +82 -0
- data/ext/libcouchbase/doc/common-options.markdown +71 -0
- data/ext/libcouchbase/doc/environment.h +93 -0
- data/ext/libcouchbase/doc/example/threads.c +77 -0
- data/ext/libcouchbase/doc/footer.html +22 -0
- data/ext/libcouchbase/doc/genman.sh +25 -0
- data/ext/libcouchbase/doc/header.html +52 -0
- data/ext/libcouchbase/doc/intro.h +130 -0
- data/ext/libcouchbase/doc/mainpage.h +136 -0
- data/ext/libcouchbase/doc/man/cbc-admin.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-bucket-create.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-bucket-delete.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-cat.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-connstr.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-cp.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-create.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-decr.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-flush.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-hash.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-incr.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-lock.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-mcflush.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-mcversion.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-n1ql.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-n1qlback.1 +198 -0
- data/ext/libcouchbase/doc/man/cbc-observe.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-pillowfight.1 +499 -0
- data/ext/libcouchbase/doc/man/cbc-ping.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-rm.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-role-list.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-stats.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-subdoc.1 +494 -0
- data/ext/libcouchbase/doc/man/cbc-unlock.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-user-delete.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-user-list.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-user-upsert.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-verbosity.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-version.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-view.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc-watch.1 +1 -0
- data/ext/libcouchbase/doc/man/cbc.1 +1035 -0
- data/ext/libcouchbase/doc/man/cbcrc.4 +71 -0
- data/ext/libcouchbase/doc/style.css +1162 -0
- data/ext/libcouchbase/example/CMakeLists.txt +52 -0
- data/ext/libcouchbase/example/README.markdown +47 -0
- data/ext/libcouchbase/example/analytics/.gitignore +1 -0
- data/ext/libcouchbase/example/analytics/analytics.c +158 -0
- data/ext/libcouchbase/example/analytics/build-queries.rb +34 -0
- data/ext/libcouchbase/example/analytics/cJSON.c +1 -0
- data/ext/libcouchbase/example/analytics/cJSON.h +1 -0
- data/ext/libcouchbase/example/analytics/queries/00-show-dataverse.json +5 -0
- data/ext/libcouchbase/example/analytics/queries/01-setup-dataset-breweries.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/02-setup-dataset-beers.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/03-initiate-shadow.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/04-list-datasets.json +7 -0
- data/ext/libcouchbase/example/analytics/queries/05-count-breweries.json +5 -0
- data/ext/libcouchbase/example/analytics/queries/06-first-brewery.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/07-key-based-lookup.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/08-exact-match-lookup.json +7 -0
- data/ext/libcouchbase/example/analytics/queries/09-exact-match-lookup-different-shape.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/10-other-query-filters.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/11-equijoin.json +9 -0
- data/ext/libcouchbase/example/analytics/queries/12-equijoin-select-star.json +10 -0
- data/ext/libcouchbase/example/analytics/queries/13-ansi-join.json +8 -0
- data/ext/libcouchbase/example/analytics/queries/14-join-select-values.json +8 -0
- data/ext/libcouchbase/example/analytics/queries/15-nested-outer-join.json +7 -0
- data/ext/libcouchbase/example/analytics/queries/16-theta-join.json +8 -0
- data/ext/libcouchbase/example/analytics/queries/17-existential-quantification.json +9 -0
- data/ext/libcouchbase/example/analytics/queries/18-universal-quantification.json +7 -0
- data/ext/libcouchbase/example/analytics/queries/19-simple-aggregation.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/20-simple-aggregation-unwrapped-value.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/21-simple-aggregation-explicit.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/22-grouping-and-aggregation.json +6 -0
- data/ext/libcouchbase/example/analytics/queries/23-grouping-and-aggregation-with-hint.json +7 -0
- data/ext/libcouchbase/example/analytics/queries/24-grouping-and-limits.json +7 -0
- data/ext/libcouchbase/example/analytics/queries/25-named-parameters.json +7 -0
- data/ext/libcouchbase/example/analytics/queries/26-positional-parameters.json +7 -0
- data/ext/libcouchbase/example/analytics/queries.h +113 -0
- data/ext/libcouchbase/example/crypto/.gitignore +2 -0
- data/ext/libcouchbase/example/crypto/Makefile +13 -0
- data/ext/libcouchbase/example/crypto/common_provider.c +26 -0
- data/ext/libcouchbase/example/crypto/common_provider.h +33 -0
- data/ext/libcouchbase/example/crypto/openssl_symmetric_decrypt.c +144 -0
- data/ext/libcouchbase/example/crypto/openssl_symmetric_encrypt.c +146 -0
- data/ext/libcouchbase/example/crypto/openssl_symmetric_provider.c +271 -0
- data/ext/libcouchbase/example/crypto/openssl_symmetric_provider.h +29 -0
- data/ext/libcouchbase/example/db/db.c +171 -0
- data/ext/libcouchbase/example/db/vb.c +227 -0
- data/ext/libcouchbase/example/fts/.gitignore +1 -0
- data/ext/libcouchbase/example/fts/build-queries.rb +33 -0
- data/ext/libcouchbase/example/fts/fts.c +142 -0
- data/ext/libcouchbase/example/fts/queries/00-simple-text-query.json +12 -0
- data/ext/libcouchbase/example/fts/queries/01-simple-text-query-on-non-default-index.json +9 -0
- data/ext/libcouchbase/example/fts/queries/02-simple-text-query-on-stored-field.json +13 -0
- data/ext/libcouchbase/example/fts/queries/03-match-query-with-facet.json +19 -0
- data/ext/libcouchbase/example/fts/queries/04-docid-query.json +11 -0
- data/ext/libcouchbase/example/fts/queries/05-unanalyzed-term-query-with-fuzziness-level-of-0.json +13 -0
- data/ext/libcouchbase/example/fts/queries/06-unanalyzed-term-query-with-fuzziness-level-of-2.json +14 -0
- data/ext/libcouchbase/example/fts/queries/07-match-phrase-query.json +13 -0
- data/ext/libcouchbase/example/fts/queries/08-phrase-query.json +16 -0
- data/ext/libcouchbase/example/fts/queries/09-query-string-query.json +9 -0
- data/ext/libcouchbase/example/fts/queries/10-conjunction-query.json +21 -0
- data/ext/libcouchbase/example/fts/queries/11-wild-card-query.json +13 -0
- data/ext/libcouchbase/example/fts/queries/12-numeric-range-query.json +11 -0
- data/ext/libcouchbase/example/fts/queries/13-regexp-query.json +13 -0
- data/ext/libcouchbase/example/fts/queries.h +61 -0
- data/ext/libcouchbase/example/instancepool/main.cc +112 -0
- data/ext/libcouchbase/example/instancepool/pool.cc +102 -0
- data/ext/libcouchbase/example/instancepool/pool.h +69 -0
- data/ext/libcouchbase/example/libeventdirect/main.c +222 -0
- data/ext/libcouchbase/example/mcc/mcc.cc +246 -0
- data/ext/libcouchbase/example/minimal/.gitignore +1 -0
- data/ext/libcouchbase/example/minimal/minimal.c +132 -0
- data/ext/libcouchbase/example/minimal/query.c +185 -0
- data/ext/libcouchbase/example/observe/durability.c +102 -0
- data/ext/libcouchbase/example/observe/observe.c +159 -0
- data/ext/libcouchbase/example/subdoc/subdoc-multi.cc +143 -0
- data/ext/libcouchbase/example/subdoc/subdoc-simple.cc +201 -0
- data/ext/libcouchbase/example/subdoc/subdoc-xattrs.c +286 -0
- data/ext/libcouchbase/example/tick/tick.c +119 -0
- data/ext/libcouchbase/example/tracing/.gitignore +2 -0
- data/ext/libcouchbase/example/tracing/Makefile +8 -0
- data/ext/libcouchbase/example/tracing/cJSON.c +1 -0
- data/ext/libcouchbase/example/tracing/cJSON.h +1 -0
- data/ext/libcouchbase/example/tracing/tracing.c +439 -0
- data/ext/libcouchbase/example/tracing/views.c +444 -0
- data/ext/libcouchbase/example/users/README +48 -0
- data/ext/libcouchbase/example/users/users.c +147 -0
- data/ext/libcouchbase/example/views/views-example.cc +83 -0
- data/ext/libcouchbase/include/libcouchbase/_cxxwrap.h +150 -0
- data/ext/libcouchbase/include/libcouchbase/api-legacy.h +1689 -0
- data/ext/libcouchbase/include/libcouchbase/api3.h +2 -0
- data/ext/libcouchbase/include/libcouchbase/assert.h +44 -0
- data/ext/libcouchbase/include/libcouchbase/auth.h +297 -0
- data/ext/libcouchbase/include/libcouchbase/cbft.h +151 -0
- data/ext/libcouchbase/include/libcouchbase/cntl-private.h +319 -0
- data/ext/libcouchbase/include/libcouchbase/cntl.h +1418 -0
- data/ext/libcouchbase/include/libcouchbase/configuration.h.in +29 -0
- data/ext/libcouchbase/include/libcouchbase/couchbase.h +4089 -0
- data/ext/libcouchbase/include/libcouchbase/crypto.h +306 -0
- data/ext/libcouchbase/include/libcouchbase/deprecated.h +312 -0
- data/ext/libcouchbase/include/libcouchbase/error.h +680 -0
- data/ext/libcouchbase/include/libcouchbase/http.h +1 -0
- data/ext/libcouchbase/include/libcouchbase/iops.h +1053 -0
- data/ext/libcouchbase/include/libcouchbase/ixmgmt.h +263 -0
- data/ext/libcouchbase/include/libcouchbase/kvbuf.h +137 -0
- data/ext/libcouchbase/include/libcouchbase/metrics.h +79 -0
- data/ext/libcouchbase/include/libcouchbase/n1ql.h +539 -0
- data/ext/libcouchbase/include/libcouchbase/pktfwd.h +270 -0
- data/ext/libcouchbase/include/libcouchbase/plugins/io/bsdio-inl.c +370 -0
- data/ext/libcouchbase/include/libcouchbase/plugins/io/wsaerr-inl.c +76 -0
- data/ext/libcouchbase/include/libcouchbase/plugins/io/wsaerr.h +199 -0
- data/ext/libcouchbase/include/libcouchbase/subdoc.h +347 -0
- data/ext/libcouchbase/include/libcouchbase/sysdefs.h +98 -0
- data/ext/libcouchbase/include/libcouchbase/tracing.h +437 -0
- data/ext/libcouchbase/include/libcouchbase/vbucket.h +680 -0
- data/ext/libcouchbase/include/libcouchbase/views.h +357 -0
- data/ext/libcouchbase/include/libcouchbase/visibility.h +66 -0
- data/ext/libcouchbase/include/memcached/COPYING +30 -0
- data/ext/libcouchbase/include/memcached/README +10 -0
- data/ext/libcouchbase/include/memcached/protocol_binary.h +885 -0
- data/ext/libcouchbase/packaging/README +7 -0
- data/ext/libcouchbase/packaging/abicheck/.gitignore +4 -0
- data/ext/libcouchbase/packaging/abicheck/Makefile +17 -0
- data/ext/libcouchbase/packaging/abicheck/README.md +27 -0
- data/ext/libcouchbase/packaging/abicheck/template.xml +3 -0
- data/ext/libcouchbase/packaging/deb/compat +1 -0
- data/ext/libcouchbase/packaging/deb/control +72 -0
- data/ext/libcouchbase/packaging/deb/copyright +10 -0
- data/ext/libcouchbase/packaging/deb/libcouchbase-dev.docs +3 -0
- data/ext/libcouchbase/packaging/deb/package.mk +31 -0
- data/ext/libcouchbase/packaging/deb/rules +46 -0
- data/ext/libcouchbase/packaging/deb/source/format +1 -0
- data/ext/libcouchbase/packaging/distinfo/README +1 -0
- data/ext/libcouchbase/packaging/distinfo/distinfo.cmake.in +4 -0
- data/ext/libcouchbase/packaging/dllversion.rc.in +39 -0
- data/ext/libcouchbase/packaging/libcouchbase.pc.in +10 -0
- data/ext/libcouchbase/packaging/nuget/libcouchbase.autopkg +76 -0
- data/ext/libcouchbase/packaging/parse-git-describe.pl +166 -0
- data/ext/libcouchbase/packaging/rpm/libcouchbase.spec.in +101 -0
- data/ext/libcouchbase/packaging/rpm/package.mk +40 -0
- data/ext/libcouchbase/plugins/io/iocp/CMakeLists.txt +9 -0
- data/ext/libcouchbase/plugins/io/iocp/iocp_iops.c +467 -0
- data/ext/libcouchbase/plugins/io/iocp/iocp_iops.h +217 -0
- data/ext/libcouchbase/plugins/io/iocp/iocp_loop.c +295 -0
- data/ext/libcouchbase/plugins/io/iocp/iocp_timer.c +79 -0
- data/ext/libcouchbase/plugins/io/iocp/iocp_util.c +229 -0
- data/ext/libcouchbase/plugins/io/libev/CMakeLists.txt +31 -0
- data/ext/libcouchbase/plugins/io/libev/libev_io_opts.h +66 -0
- data/ext/libcouchbase/plugins/io/libev/plugin-libev.c +289 -0
- data/ext/libcouchbase/plugins/io/libevent/CMakeLists.txt +31 -0
- data/ext/libcouchbase/plugins/io/libevent/libevent_io_opts.h +67 -0
- data/ext/libcouchbase/plugins/io/libevent/plugin-libevent.c +292 -0
- data/ext/libcouchbase/plugins/io/libuv/CMakeLists.txt +44 -0
- data/ext/libcouchbase/plugins/io/libuv/libuv_compat.h +218 -0
- data/ext/libcouchbase/plugins/io/libuv/libuv_io_opts.h +118 -0
- data/ext/libcouchbase/plugins/io/libuv/plugin-internal.h +155 -0
- data/ext/libcouchbase/plugins/io/libuv/plugin-libuv.c +709 -0
- data/ext/libcouchbase/plugins/io/select/CMakeLists.txt +13 -0
- data/ext/libcouchbase/plugins/io/select/plugin-select.c +451 -0
- data/ext/libcouchbase/plugins/io/select/select_io_opts.h +39 -0
- data/ext/libcouchbase/src/README.md +101 -0
- data/ext/libcouchbase/src/aspend.h +105 -0
- data/ext/libcouchbase/src/auth-priv.h +85 -0
- data/ext/libcouchbase/src/auth.cc +146 -0
- data/ext/libcouchbase/src/bootstrap.cc +263 -0
- data/ext/libcouchbase/src/bootstrap.h +149 -0
- data/ext/libcouchbase/src/bucketconfig/bc_cccp.cc +450 -0
- data/ext/libcouchbase/src/bucketconfig/bc_file.cc +281 -0
- data/ext/libcouchbase/src/bucketconfig/bc_http.cc +527 -0
- data/ext/libcouchbase/src/bucketconfig/bc_http.h +107 -0
- data/ext/libcouchbase/src/bucketconfig/bc_static.cc +150 -0
- data/ext/libcouchbase/src/bucketconfig/clconfig.h +700 -0
- data/ext/libcouchbase/src/bucketconfig/confmon.cc +403 -0
- data/ext/libcouchbase/src/callbacks.c +380 -0
- data/ext/libcouchbase/src/cbft.cc +253 -0
- data/ext/libcouchbase/src/cntl.cc +1057 -0
- data/ext/libcouchbase/src/config_static.h +176 -0
- data/ext/libcouchbase/src/connspec.cc +555 -0
- data/ext/libcouchbase/src/connspec.h +155 -0
- data/ext/libcouchbase/src/crypto.cc +399 -0
- data/ext/libcouchbase/src/ctx-log-inl.h +44 -0
- data/ext/libcouchbase/src/dns-srv.cc +146 -0
- data/ext/libcouchbase/src/dump.cc +103 -0
- data/ext/libcouchbase/src/errmap.cc +173 -0
- data/ext/libcouchbase/src/errmap.h +271 -0
- data/ext/libcouchbase/src/getconfig.cc +72 -0
- data/ext/libcouchbase/src/gethrtime.c +109 -0
- data/ext/libcouchbase/src/handler.cc +1101 -0
- data/ext/libcouchbase/src/hashtable.c +75 -0
- data/ext/libcouchbase/src/hdr_timings.c +92 -0
- data/ext/libcouchbase/src/hostlist.cc +293 -0
- data/ext/libcouchbase/src/hostlist.h +160 -0
- data/ext/libcouchbase/src/http/http-priv.h +326 -0
- data/ext/libcouchbase/src/http/http.cc +672 -0
- data/ext/libcouchbase/src/http/http.h +1 -0
- data/ext/libcouchbase/src/http/http_io.cc +316 -0
- data/ext/libcouchbase/src/instance.cc +917 -0
- data/ext/libcouchbase/src/internal.h +285 -0
- data/ext/libcouchbase/src/iofactory.c +575 -0
- data/ext/libcouchbase/src/jsparse/parser.cc +445 -0
- data/ext/libcouchbase/src/jsparse/parser.h +159 -0
- data/ext/libcouchbase/src/lcbht/lcbht.cc +177 -0
- data/ext/libcouchbase/src/lcbht/lcbht.h +210 -0
- data/ext/libcouchbase/src/lcbio/connect.cc +603 -0
- data/ext/libcouchbase/src/lcbio/connect.h +400 -0
- data/ext/libcouchbase/src/lcbio/ctx.c +658 -0
- data/ext/libcouchbase/src/lcbio/ctx.h +405 -0
- data/ext/libcouchbase/src/lcbio/iotable.c +290 -0
- data/ext/libcouchbase/src/lcbio/iotable.h +169 -0
- data/ext/libcouchbase/src/lcbio/ioutils.cc +356 -0
- data/ext/libcouchbase/src/lcbio/ioutils.h +144 -0
- data/ext/libcouchbase/src/lcbio/lcbio.h +51 -0
- data/ext/libcouchbase/src/lcbio/manager.cc +579 -0
- data/ext/libcouchbase/src/lcbio/manager.h +195 -0
- data/ext/libcouchbase/src/lcbio/protoctx.c +84 -0
- data/ext/libcouchbase/src/lcbio/rw-inl.h +137 -0
- data/ext/libcouchbase/src/lcbio/ssl.h +159 -0
- data/ext/libcouchbase/src/lcbio/timer-cxx.h +87 -0
- data/ext/libcouchbase/src/lcbio/timer-ng.h +179 -0
- data/ext/libcouchbase/src/lcbio/timer.c +132 -0
- data/ext/libcouchbase/src/legacy.c +431 -0
- data/ext/libcouchbase/src/list.c +144 -0
- data/ext/libcouchbase/src/list.h +127 -0
- data/ext/libcouchbase/src/logging.c +244 -0
- data/ext/libcouchbase/src/logging.h +88 -0
- data/ext/libcouchbase/src/mc/compress.cc +171 -0
- data/ext/libcouchbase/src/mc/compress.h +56 -0
- data/ext/libcouchbase/src/mc/forward.c +186 -0
- data/ext/libcouchbase/src/mc/forward.h +90 -0
- data/ext/libcouchbase/src/mc/iovcursor-inl.h +279 -0
- data/ext/libcouchbase/src/mc/iovcursor.h +66 -0
- data/ext/libcouchbase/src/mc/mcreq-flush-inl.h +115 -0
- data/ext/libcouchbase/src/mc/mcreq.c +983 -0
- data/ext/libcouchbase/src/mc/mcreq.h +1015 -0
- data/ext/libcouchbase/src/mcserver/mcserver.cc +1055 -0
- data/ext/libcouchbase/src/mcserver/mcserver.h +221 -0
- data/ext/libcouchbase/src/mcserver/negotiate.cc +757 -0
- data/ext/libcouchbase/src/mcserver/negotiate.h +128 -0
- data/ext/libcouchbase/src/mctx-helper.h +62 -0
- data/ext/libcouchbase/src/metrics.cc +132 -0
- data/ext/libcouchbase/src/n1ql/ixmgmt.cc +857 -0
- data/ext/libcouchbase/src/n1ql/n1ql-internal.h +22 -0
- data/ext/libcouchbase/src/n1ql/n1ql.cc +830 -0
- data/ext/libcouchbase/src/n1ql/params.cc +260 -0
- data/ext/libcouchbase/src/netbuf/netbuf-defs.h +89 -0
- data/ext/libcouchbase/src/netbuf/netbuf-mblock.h +235 -0
- data/ext/libcouchbase/src/netbuf/netbuf.c +929 -0
- data/ext/libcouchbase/src/netbuf/netbuf.h +452 -0
- data/ext/libcouchbase/src/newconfig.cc +365 -0
- data/ext/libcouchbase/src/nodeinfo.cc +184 -0
- data/ext/libcouchbase/src/operations/cbflush.cc +63 -0
- data/ext/libcouchbase/src/operations/counter.cc +117 -0
- data/ext/libcouchbase/src/operations/durability-cas.cc +251 -0
- data/ext/libcouchbase/src/operations/durability-seqno.cc +170 -0
- data/ext/libcouchbase/src/operations/durability.cc +668 -0
- data/ext/libcouchbase/src/operations/durability_internal.h +306 -0
- data/ext/libcouchbase/src/operations/get.cc +409 -0
- data/ext/libcouchbase/src/operations/observe-seqno.cc +94 -0
- data/ext/libcouchbase/src/operations/observe.cc +367 -0
- data/ext/libcouchbase/src/operations/ping.cc +496 -0
- data/ext/libcouchbase/src/operations/pktfwd.cc +86 -0
- data/ext/libcouchbase/src/operations/remove.cc +84 -0
- data/ext/libcouchbase/src/operations/stats.cc +459 -0
- data/ext/libcouchbase/src/operations/store.cc +358 -0
- data/ext/libcouchbase/src/operations/subdoc.cc +614 -0
- data/ext/libcouchbase/src/operations/touch.cc +84 -0
- data/ext/libcouchbase/src/packetutils.h +388 -0
- data/ext/libcouchbase/src/probes.d +182 -0
- data/ext/libcouchbase/src/rdb/bigalloc.c +225 -0
- data/ext/libcouchbase/src/rdb/bigalloc.h +73 -0
- data/ext/libcouchbase/src/rdb/chunkalloc.c +174 -0
- data/ext/libcouchbase/src/rdb/libcalloc.c +94 -0
- data/ext/libcouchbase/src/rdb/rope.c +419 -0
- data/ext/libcouchbase/src/rdb/rope.h +488 -0
- data/ext/libcouchbase/src/retrychk.cc +113 -0
- data/ext/libcouchbase/src/retryq.cc +458 -0
- data/ext/libcouchbase/src/retryq.h +170 -0
- data/ext/libcouchbase/src/ringbuffer.c +442 -0
- data/ext/libcouchbase/src/ringbuffer.h +100 -0
- data/ext/libcouchbase/src/rnd.cc +61 -0
- data/ext/libcouchbase/src/rnd.h +39 -0
- data/ext/libcouchbase/src/settings.c +125 -0
- data/ext/libcouchbase/src/settings.h +273 -0
- data/ext/libcouchbase/src/sllist-inl.h +197 -0
- data/ext/libcouchbase/src/sllist.h +76 -0
- data/ext/libcouchbase/src/ssl/CMakeLists.txt +11 -0
- data/ext/libcouchbase/src/ssl/ssl_c.c +442 -0
- data/ext/libcouchbase/src/ssl/ssl_common.c +478 -0
- data/ext/libcouchbase/src/ssl/ssl_e.c +421 -0
- data/ext/libcouchbase/src/ssl/ssl_iot_common.h +182 -0
- data/ext/libcouchbase/src/strcodecs/base64.c +307 -0
- data/ext/libcouchbase/src/strcodecs/strcodecs.h +302 -0
- data/ext/libcouchbase/src/timings.c +207 -0
- data/ext/libcouchbase/src/trace.h +117 -0
- data/ext/libcouchbase/src/tracing/span.cc +421 -0
- data/ext/libcouchbase/src/tracing/threshold_logging_tracer.cc +213 -0
- data/ext/libcouchbase/src/tracing/tracer.cc +53 -0
- data/ext/libcouchbase/src/tracing/tracing-internal.h +198 -0
- data/ext/libcouchbase/src/utilities.c +176 -0
- data/ext/libcouchbase/src/vbucket/CMakeLists.txt +2 -0
- data/ext/libcouchbase/src/vbucket/aliases.h +35 -0
- data/ext/libcouchbase/src/vbucket/crc32.h +83 -0
- data/ext/libcouchbase/src/vbucket/hash.h +30 -0
- data/ext/libcouchbase/src/vbucket/json-inl.h +112 -0
- data/ext/libcouchbase/src/vbucket/ketama.c +66 -0
- data/ext/libcouchbase/src/vbucket/rfc1321/global.h +32 -0
- data/ext/libcouchbase/src/vbucket/rfc1321/md5.h +35 -0
- data/ext/libcouchbase/src/vbucket/rfc1321/md5c-inl.h +335 -0
- data/ext/libcouchbase/src/vbucket/vbucket.c +1735 -0
- data/ext/libcouchbase/src/views/docreq.cc +213 -0
- data/ext/libcouchbase/src/views/docreq.h +94 -0
- data/ext/libcouchbase/src/views/viewreq.cc +381 -0
- data/ext/libcouchbase/src/views/viewreq.h +87 -0
- data/ext/libcouchbase/src/wait.cc +156 -0
- data/ext/libcouchbase/tests/CMakeLists.txt +149 -0
- data/ext/libcouchbase/tests/basic/t_base64.cc +109 -0
- data/ext/libcouchbase/tests/basic/t_ccbc103.cc +95 -0
- data/ext/libcouchbase/tests/basic/t_connstr.cc +456 -0
- data/ext/libcouchbase/tests/basic/t_creds.cc +96 -0
- data/ext/libcouchbase/tests/basic/t_ctlcodes.cc +92 -0
- data/ext/libcouchbase/tests/basic/t_host.cc +210 -0
- data/ext/libcouchbase/tests/basic/t_jsparse.cc +82 -0
- data/ext/libcouchbase/tests/basic/t_jsparse.h +589 -0
- data/ext/libcouchbase/tests/basic/t_list.cc +155 -0
- data/ext/libcouchbase/tests/basic/t_logger.cc +65 -0
- data/ext/libcouchbase/tests/basic/t_misc.cc +24 -0
- data/ext/libcouchbase/tests/basic/t_n1qlstrings.cc +17 -0
- data/ext/libcouchbase/tests/basic/t_netbuf.cc +446 -0
- data/ext/libcouchbase/tests/basic/t_packet.cc +215 -0
- data/ext/libcouchbase/tests/basic/t_ringbuffer.cc +278 -0
- data/ext/libcouchbase/tests/basic/t_scram.cc +514 -0
- data/ext/libcouchbase/tests/basic/t_slist.cc +429 -0
- data/ext/libcouchbase/tests/basic/t_strerror.cc +64 -0
- data/ext/libcouchbase/tests/basic/t_urlencode.cc +132 -0
- data/ext/libcouchbase/tests/check-all.cc +612 -0
- data/ext/libcouchbase/tests/htparse/t_basic.cc +173 -0
- data/ext/libcouchbase/tests/ioserver/connection.cc +166 -0
- data/ext/libcouchbase/tests/ioserver/future.cc +50 -0
- data/ext/libcouchbase/tests/ioserver/ioserver.cc +117 -0
- data/ext/libcouchbase/tests/ioserver/ioserver.h +478 -0
- data/ext/libcouchbase/tests/ioserver/socket.cc +88 -0
- data/ext/libcouchbase/tests/ioserver/ssl_connection.cc +145 -0
- data/ext/libcouchbase/tests/ioserver/threads-pthreads.cc +119 -0
- data/ext/libcouchbase/tests/ioserver/threads-win32.cc +117 -0
- data/ext/libcouchbase/tests/ioserver/threads.h +66 -0
- data/ext/libcouchbase/tests/iotests/iotests.h +15 -0
- data/ext/libcouchbase/tests/iotests/mock-environment.cc +632 -0
- data/ext/libcouchbase/tests/iotests/mock-environment.h +480 -0
- data/ext/libcouchbase/tests/iotests/mock-unit-test.cc +67 -0
- data/ext/libcouchbase/tests/iotests/mock-unit-test.h +61 -0
- data/ext/libcouchbase/tests/iotests/serverparams.h +76 -0
- data/ext/libcouchbase/tests/iotests/t_arithmetic.cc +143 -0
- data/ext/libcouchbase/tests/iotests/t_behavior.cc +220 -0
- data/ext/libcouchbase/tests/iotests/t_configcache.cc +117 -0
- data/ext/libcouchbase/tests/iotests/t_confmon.cc +223 -0
- data/ext/libcouchbase/tests/iotests/t_durability.cc +1108 -0
- data/ext/libcouchbase/tests/iotests/t_eerrs.cc +121 -0
- data/ext/libcouchbase/tests/iotests/t_errmap.cc +181 -0
- data/ext/libcouchbase/tests/iotests/t_forward.cc +118 -0
- data/ext/libcouchbase/tests/iotests/t_get.cc +512 -0
- data/ext/libcouchbase/tests/iotests/t_http.cc +438 -0
- data/ext/libcouchbase/tests/iotests/t_iops.cc +175 -0
- data/ext/libcouchbase/tests/iotests/t_lock.cc +274 -0
- data/ext/libcouchbase/tests/iotests/t_misc.cc +777 -0
- data/ext/libcouchbase/tests/iotests/t_mutate.cc +609 -0
- data/ext/libcouchbase/tests/iotests/t_n1ql.cc +270 -0
- data/ext/libcouchbase/tests/iotests/t_netfail.cc +778 -0
- data/ext/libcouchbase/tests/iotests/t_obseqno.cc +156 -0
- data/ext/libcouchbase/tests/iotests/t_regression.cc +321 -0
- data/ext/libcouchbase/tests/iotests/t_sched.cc +87 -0
- data/ext/libcouchbase/tests/iotests/t_serverops.cc +231 -0
- data/ext/libcouchbase/tests/iotests/t_smoke.cc +528 -0
- data/ext/libcouchbase/tests/iotests/t_snappy.cc +316 -0
- data/ext/libcouchbase/tests/iotests/t_subdoc.cc +857 -0
- data/ext/libcouchbase/tests/iotests/t_syncmode.cc +64 -0
- data/ext/libcouchbase/tests/iotests/t_views.cc +417 -0
- data/ext/libcouchbase/tests/iotests/testutil.cc +251 -0
- data/ext/libcouchbase/tests/iotests/testutil.h +163 -0
- data/ext/libcouchbase/tests/mc/mctest.h +119 -0
- data/ext/libcouchbase/tests/mc/pktmaker.h +101 -0
- data/ext/libcouchbase/tests/mc/t_alloc.cc +269 -0
- data/ext/libcouchbase/tests/mc/t_context.cc +100 -0
- data/ext/libcouchbase/tests/mc/t_flush.cc +185 -0
- data/ext/libcouchbase/tests/mc/t_forward.cc +239 -0
- data/ext/libcouchbase/tests/mc/t_ioflush.cc +102 -0
- data/ext/libcouchbase/tests/mc/t_iovcursor.cc +173 -0
- data/ext/libcouchbase/tests/mocksupport/procutil.c +305 -0
- data/ext/libcouchbase/tests/mocksupport/procutil.h +89 -0
- data/ext/libcouchbase/tests/mocksupport/server.c +391 -0
- data/ext/libcouchbase/tests/mocksupport/server.h +72 -0
- data/ext/libcouchbase/tests/mocksupport/timeout.c +69 -0
- data/ext/libcouchbase/tests/nonio_tests.cc +23 -0
- data/ext/libcouchbase/tests/rdb/rdbtest.h +133 -0
- data/ext/libcouchbase/tests/rdb/t_basic.cc +128 -0
- data/ext/libcouchbase/tests/rdb/t_bigalloc.cc +93 -0
- data/ext/libcouchbase/tests/rdb/t_refs.cc +112 -0
- data/ext/libcouchbase/tests/socktests/socktest.cc +344 -0
- data/ext/libcouchbase/tests/socktests/socktest.h +447 -0
- data/ext/libcouchbase/tests/socktests/t_basic.cc +143 -0
- data/ext/libcouchbase/tests/socktests/t_ctx.cc +73 -0
- data/ext/libcouchbase/tests/socktests/t_manager.cc +159 -0
- data/ext/libcouchbase/tests/socktests/t_putex.cc +256 -0
- data/ext/libcouchbase/tests/socktests/t_read.cc +187 -0
- data/ext/libcouchbase/tests/socktests/t_reentrant.cc +143 -0
- data/ext/libcouchbase/tests/socktests/t_ssl.cc +80 -0
- data/ext/libcouchbase/tests/socktests/t_write.cc +95 -0
- data/ext/libcouchbase/tests/start_mock.bat +15 -0
- data/ext/libcouchbase/tests/start_mock.sh +42 -0
- data/ext/libcouchbase/tests/unit_tests.cc +43 -0
- data/ext/libcouchbase/tests/vbucket/confdata/bad.json +101 -0
- data/ext/libcouchbase/tests/vbucket/confdata/full_25.json +363 -0
- data/ext/libcouchbase/tests/vbucket/confdata/ketama_expected.json +2562 -0
- data/ext/libcouchbase/tests/vbucket/confdata/map_node_present_nodesext_missing_nodes.json +94 -0
- data/ext/libcouchbase/tests/vbucket/confdata/memd_25.json +90 -0
- data/ext/libcouchbase/tests/vbucket/confdata/memd_30.json +1 -0
- data/ext/libcouchbase/tests/vbucket/confdata/memd_45.json +1 -0
- data/ext/libcouchbase/tests/vbucket/confdata/memd_ketama_config.json +31 -0
- data/ext/libcouchbase/tests/vbucket/confdata/terse_25.json +291 -0
- data/ext/libcouchbase/tests/vbucket/confdata/terse_30.json +1 -0
- data/ext/libcouchbase/tests/vbucket/t_config.cc +386 -0
- data/ext/libcouchbase/tools/CMakeLists.txt +80 -0
- data/ext/libcouchbase/tools/cbc-handlers.h +636 -0
- data/ext/libcouchbase/tools/cbc-n1qlback.cc +496 -0
- data/ext/libcouchbase/tools/cbc-pillowfight.cc +1230 -0
- data/ext/libcouchbase/tools/cbc-proxy.cc +534 -0
- data/ext/libcouchbase/tools/cbc-subdoc.cc +825 -0
- data/ext/libcouchbase/tools/cbc.cc +1928 -0
- data/ext/libcouchbase/tools/common/histogram.cc +44 -0
- data/ext/libcouchbase/tools/common/histogram.h +23 -0
- data/ext/libcouchbase/tools/common/options.cc +451 -0
- data/ext/libcouchbase/tools/common/options.h +90 -0
- data/ext/libcouchbase/tools/docgen/docgen.h +495 -0
- data/ext/libcouchbase/tools/docgen/loc.h +211 -0
- data/ext/libcouchbase/tools/docgen/placeholders.h +211 -0
- data/ext/libcouchbase/tools/docgen/seqgen.h +122 -0
- data/ext/libcouchbase/tools/extract-packets.rb +110 -0
- data/ext/libcouchbase/tools/linenoise/linenoise.c +1199 -0
- data/ext/libcouchbase/tools/linenoise/linenoise.h +73 -0
- data/lib/mt-libcouchbase/bucket.rb +825 -0
- data/lib/mt-libcouchbase/callbacks.rb +69 -0
- data/lib/mt-libcouchbase/connection.rb +896 -0
- data/lib/mt-libcouchbase/design_docs.rb +92 -0
- data/lib/mt-libcouchbase/error.rb +68 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdbase.rb +23 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdcounter.rb +36 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdendure.rb +26 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdfts.rb +24 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdget.rb +30 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdgetreplica.rb +49 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdhttp.rb +58 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdn1ql.rb +40 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdobseqno.rb +33 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdobserve.rb +30 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdstore.rb +40 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdstoredur.rb +45 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdsubdoc.rb +61 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdverbosity.rb +29 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/cmdviewquery.rb +61 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/contigbuf.rb +14 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/create_st.rb +15 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/create_st0.rb +23 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/create_st1.rb +26 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/create_st2.rb +32 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/create_st3.rb +26 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/crst_u.rb +20 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/durability_opts_st_v.rb +11 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/durability_opts_t.rb +14 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/durabilityopt_sv0.rb +63 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/enums.rb +1007 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/fragbuf.rb +18 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/ftshandle.rb +7 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/histogram.rb +34 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/http_request_t.rb +7 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/keybuf.rb +20 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/multicmd_ctx.rb +30 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/mutation_token.rb +17 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/n1qlhandle.rb +7 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/n1qlparams.rb +7 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respbase.rb +29 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respcounter.rb +32 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respendure.rb +49 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respfts.rb +40 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respget.rb +44 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/resphttp.rb +48 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respmcversion.rb +38 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respn1ql.rb +41 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respobseqno.rb +52 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respobserve.rb +41 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respserverbase.rb +32 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respstats.rb +38 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respstore.rb +32 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respstoredur.rb +38 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respsubdoc.rb +35 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/respviewquery.rb +67 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/sdentry.rb +22 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/sdspec.rb +31 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/t.rb +7 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/valbuf.rb +22 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/valbuf_u_buf.rb +14 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase/viewhandle.rb +7 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase.rb +1175 -0
- data/lib/mt-libcouchbase/ext/mt-libcouchbase_libuv.rb +22 -0
- data/lib/mt-libcouchbase/ext/tasks.rb +39 -0
- data/lib/mt-libcouchbase/n1ql.rb +80 -0
- data/lib/mt-libcouchbase/query_full_text.rb +147 -0
- data/lib/mt-libcouchbase/query_n1ql.rb +123 -0
- data/lib/mt-libcouchbase/query_view.rb +135 -0
- data/lib/mt-libcouchbase/results_fiber.rb +281 -0
- data/lib/mt-libcouchbase/results_native.rb +220 -0
- data/lib/mt-libcouchbase/subdoc_request.rb +139 -0
- data/lib/mt-libcouchbase/version.rb +5 -0
- data/lib/mt-libcouchbase.rb +40 -0
- data/mt-libcouchbase.gemspec +68 -0
- data/spec/bucket_spec.rb +290 -0
- data/spec/connection_spec.rb +257 -0
- data/spec/design_docs_spec.rb +31 -0
- data/spec/error_spec.rb +26 -0
- data/spec/fts_spec.rb +135 -0
- data/spec/n1ql_spec.rb +260 -0
- data/spec/results_libuv_spec.rb +244 -0
- data/spec/results_native_spec.rb +259 -0
- data/spec/seed/2016-10-25T043505Z/2016-10-25T043505Z-full/bucket-default/design.json +1 -0
- data/spec/seed/2016-10-25T043505Z/2016-10-25T043505Z-full/bucket-default/node-127.0.0.1%3A8091/data-0000.cbb +0 -0
- data/spec/seed/2016-10-25T043505Z/2016-10-25T043505Z-full/bucket-default/node-127.0.0.1%3A8091/failover.json +1 -0
- data/spec/seed/2016-10-25T043505Z/2016-10-25T043505Z-full/bucket-default/node-127.0.0.1%3A8091/meta.json +1 -0
- data/spec/seed/2016-10-25T043505Z/2016-10-25T043505Z-full/bucket-default/node-127.0.0.1%3A8091/seqno.json +1 -0
- data/spec/seed/2016-10-25T043505Z/2016-10-25T043505Z-full/bucket-default/node-127.0.0.1%3A8091/snapshot_markers.json +1 -0
- data/spec/subdoc_spec.rb +192 -0
- data/spec/view_spec.rb +201 -0
- data/windows_build.md +36 -0
- metadata +873 -0
@@ -0,0 +1,2495 @@
|
|
1
|
+
# Doxyfile 1.8.14
|
2
|
+
|
3
|
+
# This file describes the settings to be used by the documentation system
|
4
|
+
# doxygen (www.doxygen.org) for a project.
|
5
|
+
#
|
6
|
+
# All text after a double hash (##) is considered a comment and is placed in
|
7
|
+
# front of the TAG it is preceding.
|
8
|
+
#
|
9
|
+
# All text after a single hash (#) is considered a comment and will be ignored.
|
10
|
+
# The format is:
|
11
|
+
# TAG = value [value, ...]
|
12
|
+
# For lists, items can also be appended using:
|
13
|
+
# TAG += value [value, ...]
|
14
|
+
# Values that contain spaces should be placed between quotes (\" \").
|
15
|
+
|
16
|
+
#---------------------------------------------------------------------------
|
17
|
+
# Project related configuration options
|
18
|
+
#---------------------------------------------------------------------------
|
19
|
+
|
20
|
+
# This tag specifies the encoding used for all characters in the config file
|
21
|
+
# that follow. The default is UTF-8 which is also the encoding used for all text
|
22
|
+
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
|
23
|
+
# built into libc) for the transcoding. See
|
24
|
+
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
|
25
|
+
# The default value is: UTF-8.
|
26
|
+
|
27
|
+
DOXYFILE_ENCODING = UTF-8
|
28
|
+
|
29
|
+
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
|
30
|
+
# double-quotes, unless you are using Doxywizard) that should identify the
|
31
|
+
# project for which the documentation is generated. This name is used in the
|
32
|
+
# title of most generated pages and in a few other places.
|
33
|
+
# The default value is: My Project.
|
34
|
+
|
35
|
+
PROJECT_NAME = "Couchbase C Client"
|
36
|
+
|
37
|
+
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
38
|
+
# could be handy for archiving the generated documentation or if some version
|
39
|
+
# control system is used.
|
40
|
+
|
41
|
+
PROJECT_NUMBER = 2.9.5
|
42
|
+
|
43
|
+
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
44
|
+
# for a project that appears at the top of each page and should give viewer a
|
45
|
+
# quick idea about the purpose of the project. Keep the description short.
|
46
|
+
|
47
|
+
PROJECT_BRIEF = "Asynchronous C Client for Couchbase"
|
48
|
+
|
49
|
+
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
|
50
|
+
# in the documentation. The maximum height of the logo should not exceed 55
|
51
|
+
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
52
|
+
# the logo to the output directory.
|
53
|
+
|
54
|
+
PROJECT_LOGO =
|
55
|
+
|
56
|
+
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
57
|
+
# into which the generated documentation will be written. If a relative path is
|
58
|
+
# entered, it will be relative to the location where doxygen was started. If
|
59
|
+
# left blank the current directory will be used.
|
60
|
+
|
61
|
+
OUTPUT_DIRECTORY = doc
|
62
|
+
|
63
|
+
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
|
64
|
+
# directories (in 2 levels) under the output directory of each output format and
|
65
|
+
# will distribute the generated files over these directories. Enabling this
|
66
|
+
# option can be useful when feeding doxygen a huge amount of source files, where
|
67
|
+
# putting all generated files in the same directory would otherwise causes
|
68
|
+
# performance problems for the file system.
|
69
|
+
# The default value is: NO.
|
70
|
+
|
71
|
+
CREATE_SUBDIRS = NO
|
72
|
+
|
73
|
+
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
|
74
|
+
# characters to appear in the names of generated files. If set to NO, non-ASCII
|
75
|
+
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
|
76
|
+
# U+3044.
|
77
|
+
# The default value is: NO.
|
78
|
+
|
79
|
+
ALLOW_UNICODE_NAMES = NO
|
80
|
+
|
81
|
+
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
82
|
+
# documentation generated by doxygen is written. Doxygen will use this
|
83
|
+
# information to generate all constant output in the proper language.
|
84
|
+
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
|
85
|
+
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
|
86
|
+
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
|
87
|
+
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
|
88
|
+
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
|
89
|
+
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
|
90
|
+
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
|
91
|
+
# Ukrainian and Vietnamese.
|
92
|
+
# The default value is: English.
|
93
|
+
|
94
|
+
OUTPUT_LANGUAGE = English
|
95
|
+
|
96
|
+
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
|
97
|
+
# descriptions after the members that are listed in the file and class
|
98
|
+
# documentation (similar to Javadoc). Set to NO to disable this.
|
99
|
+
# The default value is: YES.
|
100
|
+
|
101
|
+
BRIEF_MEMBER_DESC = YES
|
102
|
+
|
103
|
+
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
|
104
|
+
# description of a member or function before the detailed description
|
105
|
+
#
|
106
|
+
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
107
|
+
# brief descriptions will be completely suppressed.
|
108
|
+
# The default value is: YES.
|
109
|
+
|
110
|
+
REPEAT_BRIEF = YES
|
111
|
+
|
112
|
+
# This tag implements a quasi-intelligent brief description abbreviator that is
|
113
|
+
# used to form the text in various listings. Each string in this list, if found
|
114
|
+
# as the leading text of the brief description, will be stripped from the text
|
115
|
+
# and the result, after processing the whole list, is used as the annotated
|
116
|
+
# text. Otherwise, the brief description is used as-is. If left blank, the
|
117
|
+
# following values are used ($name is automatically replaced with the name of
|
118
|
+
# the entity):The $name class, The $name widget, The $name file, is, provides,
|
119
|
+
# specifies, contains, represents, a, an and the.
|
120
|
+
|
121
|
+
ABBREVIATE_BRIEF = "The $name class" \
|
122
|
+
"The $name widget" \
|
123
|
+
"The $name file" \
|
124
|
+
is \
|
125
|
+
provides \
|
126
|
+
specifies \
|
127
|
+
contains \
|
128
|
+
represents \
|
129
|
+
a \
|
130
|
+
an \
|
131
|
+
the
|
132
|
+
|
133
|
+
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
134
|
+
# doxygen will generate a detailed section even if there is only a brief
|
135
|
+
# description.
|
136
|
+
# The default value is: NO.
|
137
|
+
|
138
|
+
ALWAYS_DETAILED_SEC = NO
|
139
|
+
|
140
|
+
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
141
|
+
# inherited members of a class in the documentation of that class as if those
|
142
|
+
# members were ordinary class members. Constructors, destructors and assignment
|
143
|
+
# operators of the base classes will not be shown.
|
144
|
+
# The default value is: NO.
|
145
|
+
|
146
|
+
INLINE_INHERITED_MEMB = NO
|
147
|
+
|
148
|
+
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
|
149
|
+
# before files name in the file list and in the header files. If set to NO the
|
150
|
+
# shortest path that makes the file name unique will be used
|
151
|
+
# The default value is: YES.
|
152
|
+
|
153
|
+
FULL_PATH_NAMES = NO
|
154
|
+
|
155
|
+
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
|
156
|
+
# Stripping is only done if one of the specified strings matches the left-hand
|
157
|
+
# part of the path. The tag can be used to show relative paths in the file list.
|
158
|
+
# If left blank the directory from which doxygen is run is used as the path to
|
159
|
+
# strip.
|
160
|
+
#
|
161
|
+
# Note that you can specify absolute paths here, but also relative paths, which
|
162
|
+
# will be relative from the directory where doxygen is started.
|
163
|
+
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
|
164
|
+
|
165
|
+
STRIP_FROM_PATH =
|
166
|
+
|
167
|
+
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
|
168
|
+
# path mentioned in the documentation of a class, which tells the reader which
|
169
|
+
# header file to include in order to use a class. If left blank only the name of
|
170
|
+
# the header file containing the class definition is used. Otherwise one should
|
171
|
+
# specify the list of include paths that are normally passed to the compiler
|
172
|
+
# using the -I flag.
|
173
|
+
|
174
|
+
STRIP_FROM_INC_PATH =
|
175
|
+
|
176
|
+
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
|
177
|
+
# less readable) file names. This can be useful is your file systems doesn't
|
178
|
+
# support long names like on DOS, Mac, or CD-ROM.
|
179
|
+
# The default value is: NO.
|
180
|
+
|
181
|
+
SHORT_NAMES = NO
|
182
|
+
|
183
|
+
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
|
184
|
+
# first line (until the first dot) of a Javadoc-style comment as the brief
|
185
|
+
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
|
186
|
+
# style comments (thus requiring an explicit @brief command for a brief
|
187
|
+
# description.)
|
188
|
+
# The default value is: NO.
|
189
|
+
|
190
|
+
JAVADOC_AUTOBRIEF = YES
|
191
|
+
|
192
|
+
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
|
193
|
+
# line (until the first dot) of a Qt-style comment as the brief description. If
|
194
|
+
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
|
195
|
+
# requiring an explicit \brief command for a brief description.)
|
196
|
+
# The default value is: NO.
|
197
|
+
|
198
|
+
QT_AUTOBRIEF = NO
|
199
|
+
|
200
|
+
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
|
201
|
+
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
|
202
|
+
# a brief description. This used to be the default behavior. The new default is
|
203
|
+
# to treat a multi-line C++ comment block as a detailed description. Set this
|
204
|
+
# tag to YES if you prefer the old behavior instead.
|
205
|
+
#
|
206
|
+
# Note that setting this tag to YES also means that rational rose comments are
|
207
|
+
# not recognized any more.
|
208
|
+
# The default value is: NO.
|
209
|
+
|
210
|
+
MULTILINE_CPP_IS_BRIEF = NO
|
211
|
+
|
212
|
+
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
|
213
|
+
# documentation from any documented member that it re-implements.
|
214
|
+
# The default value is: YES.
|
215
|
+
|
216
|
+
INHERIT_DOCS = YES
|
217
|
+
|
218
|
+
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
|
219
|
+
# page for each member. If set to NO, the documentation of a member will be part
|
220
|
+
# of the file/class/namespace that contains it.
|
221
|
+
# The default value is: NO.
|
222
|
+
|
223
|
+
SEPARATE_MEMBER_PAGES = NO
|
224
|
+
|
225
|
+
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
|
226
|
+
# uses this value to replace tabs by spaces in code fragments.
|
227
|
+
# Minimum value: 1, maximum value: 16, default value: 4.
|
228
|
+
|
229
|
+
TAB_SIZE = 8
|
230
|
+
|
231
|
+
# This tag can be used to specify a number of aliases that act as commands in
|
232
|
+
# the documentation. An alias has the form:
|
233
|
+
# name=value
|
234
|
+
# For example adding
|
235
|
+
# "sideeffect=@par Side Effects:\n"
|
236
|
+
# will allow you to put the command \sideeffect (or @sideeffect) in the
|
237
|
+
# documentation, which will result in a user-defined paragraph with heading
|
238
|
+
# "Side Effects:". You can put \n's in the value part of an alias to insert
|
239
|
+
# newlines (in the resulting output). You can put ^^ in the value part of an
|
240
|
+
# alias to insert a newline as if a physical newline was in the original file.
|
241
|
+
|
242
|
+
ALIASES = "committed=\par Stability^^\xrefitem lcb_apiattr_committed \"Committed\" \"Committed Interfaces\"" \
|
243
|
+
"uncommitted=\par Stability^^\xrefitem lcb_apiattr_uncommitted \"Uncommitted\" \"Uncommitted Interfaces\"" \
|
244
|
+
"volatile=\par Stability^^\xrefitem lcb_apiattr_volatile \"Volatile\" \"Volatile Interfaces\"" \
|
245
|
+
"internal=\par Stability^^\xrefitem lcb_apiattr_internal \"Internal\" \"Internal Interfaces\"" \
|
246
|
+
"commited=committed" \
|
247
|
+
"comitted=committed" \
|
248
|
+
"uncommited=uncommitted" \
|
249
|
+
"lcb_see_detailed_neterr=^^\note This error code is returned only if \ref LCB_CNTL_DETAILED_ERRCODES is set^^" \
|
250
|
+
"cntl_arg_both{1}=@par Argument^^Modes|Arg^^---|---^^Get, Set|\1^^" \
|
251
|
+
"cntl_arg_getonly{1}=@par Argument^^Modes|Arg^^---|---^^Get|\1^^" \
|
252
|
+
"cntl_arg_setonly{1}=@par Argument^^Modes|Arg^^---|---^^Set|\1^^" \
|
253
|
+
"cntl_arg_get_and_set{2}=@par Argument^^Modes|Arg^^---|---^^Get|\1^^Set|\2^^" \
|
254
|
+
"return_rc=\return Status code indicating whether the operation was scheduled or not. See 'exceptions' section for errors received in callbacks" \
|
255
|
+
"cb_err=\li"
|
256
|
+
|
257
|
+
# This tag can be used to specify a number of word-keyword mappings (TCL only).
|
258
|
+
# A mapping has the form "name=value". For example adding "class=itcl::class"
|
259
|
+
# will allow you to use the command class in the itcl::class meaning.
|
260
|
+
|
261
|
+
TCL_SUBST =
|
262
|
+
|
263
|
+
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
264
|
+
# only. Doxygen will then generate output that is more tailored for C. For
|
265
|
+
# instance, some of the names that are used will be different. The list of all
|
266
|
+
# members will be omitted, etc.
|
267
|
+
# The default value is: NO.
|
268
|
+
|
269
|
+
OPTIMIZE_OUTPUT_FOR_C = YES
|
270
|
+
|
271
|
+
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
|
272
|
+
# Python sources only. Doxygen will then generate output that is more tailored
|
273
|
+
# for that language. For instance, namespaces will be presented as packages,
|
274
|
+
# qualified scopes will look different, etc.
|
275
|
+
# The default value is: NO.
|
276
|
+
|
277
|
+
OPTIMIZE_OUTPUT_JAVA = NO
|
278
|
+
|
279
|
+
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
|
280
|
+
# sources. Doxygen will then generate output that is tailored for Fortran.
|
281
|
+
# The default value is: NO.
|
282
|
+
|
283
|
+
OPTIMIZE_FOR_FORTRAN = NO
|
284
|
+
|
285
|
+
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
|
286
|
+
# sources. Doxygen will then generate output that is tailored for VHDL.
|
287
|
+
# The default value is: NO.
|
288
|
+
|
289
|
+
OPTIMIZE_OUTPUT_VHDL = NO
|
290
|
+
|
291
|
+
# Doxygen selects the parser to use depending on the extension of the files it
|
292
|
+
# parses. With this tag you can assign which parser to use for a given
|
293
|
+
# extension. Doxygen has a built-in mapping, but you can override or extend it
|
294
|
+
# using this tag. The format is ext=language, where ext is a file extension, and
|
295
|
+
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
|
296
|
+
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
|
297
|
+
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
|
298
|
+
# Fortran. In the later case the parser tries to guess whether the code is fixed
|
299
|
+
# or free formatted code, this is the default for Fortran type files), VHDL. For
|
300
|
+
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
|
301
|
+
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
|
302
|
+
#
|
303
|
+
# Note: For files without extension you can use no_extension as a placeholder.
|
304
|
+
#
|
305
|
+
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
|
306
|
+
# the files are not read by doxygen.
|
307
|
+
|
308
|
+
EXTENSION_MAPPING =
|
309
|
+
|
310
|
+
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
|
311
|
+
# according to the Markdown format, which allows for more readable
|
312
|
+
# documentation. See http://daringfireball.net/projects/markdown/ for details.
|
313
|
+
# The output of markdown processing is further processed by doxygen, so you can
|
314
|
+
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
|
315
|
+
# case of backward compatibilities issues.
|
316
|
+
# The default value is: YES.
|
317
|
+
|
318
|
+
MARKDOWN_SUPPORT = YES
|
319
|
+
|
320
|
+
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
|
321
|
+
# to that level are automatically included in the table of contents, even if
|
322
|
+
# they do not have an id attribute.
|
323
|
+
# Note: This feature currently applies only to Markdown headings.
|
324
|
+
# Minimum value: 0, maximum value: 99, default value: 0.
|
325
|
+
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
|
326
|
+
|
327
|
+
TOC_INCLUDE_HEADINGS = 0
|
328
|
+
|
329
|
+
# When enabled doxygen tries to link words that correspond to documented
|
330
|
+
# classes, or namespaces to their corresponding documentation. Such a link can
|
331
|
+
# be prevented in individual cases by putting a % sign in front of the word or
|
332
|
+
# globally by setting AUTOLINK_SUPPORT to NO.
|
333
|
+
# The default value is: YES.
|
334
|
+
|
335
|
+
AUTOLINK_SUPPORT = YES
|
336
|
+
|
337
|
+
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
|
338
|
+
# to include (a tag file for) the STL sources as input, then you should set this
|
339
|
+
# tag to YES in order to let doxygen match functions declarations and
|
340
|
+
# definitions whose arguments contain STL classes (e.g. func(std::string);
|
341
|
+
# versus func(std::string) {}). This also make the inheritance and collaboration
|
342
|
+
# diagrams that involve STL classes more complete and accurate.
|
343
|
+
# The default value is: NO.
|
344
|
+
|
345
|
+
BUILTIN_STL_SUPPORT = NO
|
346
|
+
|
347
|
+
# If you use Microsoft's C++/CLI language, you should set this option to YES to
|
348
|
+
# enable parsing support.
|
349
|
+
# The default value is: NO.
|
350
|
+
|
351
|
+
CPP_CLI_SUPPORT = NO
|
352
|
+
|
353
|
+
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
|
354
|
+
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
|
355
|
+
# will parse them like normal C++ but will assume all classes use public instead
|
356
|
+
# of private inheritance when no explicit protection keyword is present.
|
357
|
+
# The default value is: NO.
|
358
|
+
|
359
|
+
SIP_SUPPORT = NO
|
360
|
+
|
361
|
+
# For Microsoft's IDL there are propget and propput attributes to indicate
|
362
|
+
# getter and setter methods for a property. Setting this option to YES will make
|
363
|
+
# doxygen to replace the get and set methods by a property in the documentation.
|
364
|
+
# This will only work if the methods are indeed getting or setting a simple
|
365
|
+
# type. If this is not the case, or you want to show the methods anyway, you
|
366
|
+
# should set this option to NO.
|
367
|
+
# The default value is: YES.
|
368
|
+
|
369
|
+
IDL_PROPERTY_SUPPORT = YES
|
370
|
+
|
371
|
+
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
372
|
+
# tag is set to YES then doxygen will reuse the documentation of the first
|
373
|
+
# member in the group (if any) for the other members of the group. By default
|
374
|
+
# all members of a group must be documented explicitly.
|
375
|
+
# The default value is: NO.
|
376
|
+
|
377
|
+
DISTRIBUTE_GROUP_DOC = NO
|
378
|
+
|
379
|
+
# If one adds a struct or class to a group and this option is enabled, then also
|
380
|
+
# any nested class or struct is added to the same group. By default this option
|
381
|
+
# is disabled and one has to add nested compounds explicitly via \ingroup.
|
382
|
+
# The default value is: NO.
|
383
|
+
|
384
|
+
GROUP_NESTED_COMPOUNDS = NO
|
385
|
+
|
386
|
+
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
|
387
|
+
# (for instance a group of public functions) to be put as a subgroup of that
|
388
|
+
# type (e.g. under the Public Functions section). Set it to NO to prevent
|
389
|
+
# subgrouping. Alternatively, this can be done per class using the
|
390
|
+
# \nosubgrouping command.
|
391
|
+
# The default value is: YES.
|
392
|
+
|
393
|
+
SUBGROUPING = YES
|
394
|
+
|
395
|
+
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
|
396
|
+
# are shown inside the group in which they are included (e.g. using \ingroup)
|
397
|
+
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
|
398
|
+
# and RTF).
|
399
|
+
#
|
400
|
+
# Note that this feature does not work in combination with
|
401
|
+
# SEPARATE_MEMBER_PAGES.
|
402
|
+
# The default value is: NO.
|
403
|
+
|
404
|
+
INLINE_GROUPED_CLASSES = YES
|
405
|
+
|
406
|
+
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
|
407
|
+
# with only public data fields or simple typedef fields will be shown inline in
|
408
|
+
# the documentation of the scope in which they are defined (i.e. file,
|
409
|
+
# namespace, or group documentation), provided this scope is documented. If set
|
410
|
+
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
|
411
|
+
# Man pages) or section (for LaTeX and RTF).
|
412
|
+
# The default value is: NO.
|
413
|
+
|
414
|
+
INLINE_SIMPLE_STRUCTS = YES
|
415
|
+
|
416
|
+
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
|
417
|
+
# enum is documented as struct, union, or enum with the name of the typedef. So
|
418
|
+
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
419
|
+
# with name TypeT. When disabled the typedef will appear as a member of a file,
|
420
|
+
# namespace, or class. And the struct will be named TypeS. This can typically be
|
421
|
+
# useful for C code in case the coding convention dictates that all compound
|
422
|
+
# types are typedef'ed and only the typedef is referenced, never the tag name.
|
423
|
+
# The default value is: NO.
|
424
|
+
|
425
|
+
TYPEDEF_HIDES_STRUCT = YES
|
426
|
+
|
427
|
+
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
|
428
|
+
# cache is used to resolve symbols given their name and scope. Since this can be
|
429
|
+
# an expensive process and often the same symbol appears multiple times in the
|
430
|
+
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
|
431
|
+
# doxygen will become slower. If the cache is too large, memory is wasted. The
|
432
|
+
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
|
433
|
+
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
|
434
|
+
# symbols. At the end of a run doxygen will report the cache usage and suggest
|
435
|
+
# the optimal cache size from a speed point of view.
|
436
|
+
# Minimum value: 0, maximum value: 9, default value: 0.
|
437
|
+
|
438
|
+
LOOKUP_CACHE_SIZE = 0
|
439
|
+
|
440
|
+
#---------------------------------------------------------------------------
|
441
|
+
# Build related configuration options
|
442
|
+
#---------------------------------------------------------------------------
|
443
|
+
|
444
|
+
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
|
445
|
+
# documentation are documented, even if no documentation was available. Private
|
446
|
+
# class members and static file members will be hidden unless the
|
447
|
+
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
|
448
|
+
# Note: This will also disable the warnings about undocumented members that are
|
449
|
+
# normally produced when WARNINGS is set to YES.
|
450
|
+
# The default value is: NO.
|
451
|
+
|
452
|
+
EXTRACT_ALL = NO
|
453
|
+
|
454
|
+
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
|
455
|
+
# be included in the documentation.
|
456
|
+
# The default value is: NO.
|
457
|
+
|
458
|
+
EXTRACT_PRIVATE = NO
|
459
|
+
|
460
|
+
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
|
461
|
+
# scope will be included in the documentation.
|
462
|
+
# The default value is: NO.
|
463
|
+
|
464
|
+
EXTRACT_PACKAGE = NO
|
465
|
+
|
466
|
+
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
|
467
|
+
# included in the documentation.
|
468
|
+
# The default value is: NO.
|
469
|
+
|
470
|
+
EXTRACT_STATIC = NO
|
471
|
+
|
472
|
+
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
|
473
|
+
# locally in source files will be included in the documentation. If set to NO,
|
474
|
+
# only classes defined in header files are included. Does not have any effect
|
475
|
+
# for Java sources.
|
476
|
+
# The default value is: YES.
|
477
|
+
|
478
|
+
EXTRACT_LOCAL_CLASSES = YES
|
479
|
+
|
480
|
+
# This flag is only useful for Objective-C code. If set to YES, local methods,
|
481
|
+
# which are defined in the implementation section but not in the interface are
|
482
|
+
# included in the documentation. If set to NO, only methods in the interface are
|
483
|
+
# included.
|
484
|
+
# The default value is: NO.
|
485
|
+
|
486
|
+
EXTRACT_LOCAL_METHODS = NO
|
487
|
+
|
488
|
+
# If this flag is set to YES, the members of anonymous namespaces will be
|
489
|
+
# extracted and appear in the documentation as a namespace called
|
490
|
+
# 'anonymous_namespace{file}', where file will be replaced with the base name of
|
491
|
+
# the file that contains the anonymous namespace. By default anonymous namespace
|
492
|
+
# are hidden.
|
493
|
+
# The default value is: NO.
|
494
|
+
|
495
|
+
EXTRACT_ANON_NSPACES = NO
|
496
|
+
|
497
|
+
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
|
498
|
+
# undocumented members inside documented classes or files. If set to NO these
|
499
|
+
# members will be included in the various overviews, but no documentation
|
500
|
+
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
|
501
|
+
# The default value is: NO.
|
502
|
+
|
503
|
+
HIDE_UNDOC_MEMBERS = NO
|
504
|
+
|
505
|
+
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
|
506
|
+
# undocumented classes that are normally visible in the class hierarchy. If set
|
507
|
+
# to NO, these classes will be included in the various overviews. This option
|
508
|
+
# has no effect if EXTRACT_ALL is enabled.
|
509
|
+
# The default value is: NO.
|
510
|
+
|
511
|
+
HIDE_UNDOC_CLASSES = YES
|
512
|
+
|
513
|
+
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
|
514
|
+
# (class|struct|union) declarations. If set to NO, these declarations will be
|
515
|
+
# included in the documentation.
|
516
|
+
# The default value is: NO.
|
517
|
+
|
518
|
+
HIDE_FRIEND_COMPOUNDS = NO
|
519
|
+
|
520
|
+
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
|
521
|
+
# documentation blocks found inside the body of a function. If set to NO, these
|
522
|
+
# blocks will be appended to the function's detailed documentation block.
|
523
|
+
# The default value is: NO.
|
524
|
+
|
525
|
+
HIDE_IN_BODY_DOCS = NO
|
526
|
+
|
527
|
+
# The INTERNAL_DOCS tag determines if documentation that is typed after a
|
528
|
+
# \internal command is included. If the tag is set to NO then the documentation
|
529
|
+
# will be excluded. Set it to YES to include the internal documentation.
|
530
|
+
# The default value is: NO.
|
531
|
+
|
532
|
+
INTERNAL_DOCS = NO
|
533
|
+
|
534
|
+
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
|
535
|
+
# names in lower-case letters. If set to YES, upper-case letters are also
|
536
|
+
# allowed. This is useful if you have classes or files whose names only differ
|
537
|
+
# in case and if your file system supports case sensitive file names. Windows
|
538
|
+
# and Mac users are advised to set this option to NO.
|
539
|
+
# The default value is: system dependent.
|
540
|
+
|
541
|
+
CASE_SENSE_NAMES = NO
|
542
|
+
|
543
|
+
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
|
544
|
+
# their full class and namespace scopes in the documentation. If set to YES, the
|
545
|
+
# scope will be hidden.
|
546
|
+
# The default value is: NO.
|
547
|
+
|
548
|
+
HIDE_SCOPE_NAMES = YES
|
549
|
+
|
550
|
+
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
|
551
|
+
# append additional text to a page's title, such as Class Reference. If set to
|
552
|
+
# YES the compound reference will be hidden.
|
553
|
+
# The default value is: NO.
|
554
|
+
|
555
|
+
HIDE_COMPOUND_REFERENCE= NO
|
556
|
+
|
557
|
+
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
|
558
|
+
# the files that are included by a file in the documentation of that file.
|
559
|
+
# The default value is: YES.
|
560
|
+
|
561
|
+
SHOW_INCLUDE_FILES = YES
|
562
|
+
|
563
|
+
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
|
564
|
+
# grouped member an include statement to the documentation, telling the reader
|
565
|
+
# which file to include in order to use the member.
|
566
|
+
# The default value is: NO.
|
567
|
+
|
568
|
+
SHOW_GROUPED_MEMB_INC = NO
|
569
|
+
|
570
|
+
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
|
571
|
+
# files with double quotes in the documentation rather than with sharp brackets.
|
572
|
+
# The default value is: NO.
|
573
|
+
|
574
|
+
FORCE_LOCAL_INCLUDES = NO
|
575
|
+
|
576
|
+
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
|
577
|
+
# documentation for inline members.
|
578
|
+
# The default value is: YES.
|
579
|
+
|
580
|
+
INLINE_INFO = YES
|
581
|
+
|
582
|
+
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
|
583
|
+
# (detailed) documentation of file and class members alphabetically by member
|
584
|
+
# name. If set to NO, the members will appear in declaration order.
|
585
|
+
# The default value is: YES.
|
586
|
+
|
587
|
+
SORT_MEMBER_DOCS = NO
|
588
|
+
|
589
|
+
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
|
590
|
+
# descriptions of file, namespace and class members alphabetically by member
|
591
|
+
# name. If set to NO, the members will appear in declaration order. Note that
|
592
|
+
# this will also influence the order of the classes in the class list.
|
593
|
+
# The default value is: NO.
|
594
|
+
|
595
|
+
SORT_BRIEF_DOCS = NO
|
596
|
+
|
597
|
+
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
|
598
|
+
# (brief and detailed) documentation of class members so that constructors and
|
599
|
+
# destructors are listed first. If set to NO the constructors will appear in the
|
600
|
+
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
|
601
|
+
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
|
602
|
+
# member documentation.
|
603
|
+
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
|
604
|
+
# detailed member documentation.
|
605
|
+
# The default value is: NO.
|
606
|
+
|
607
|
+
SORT_MEMBERS_CTORS_1ST = NO
|
608
|
+
|
609
|
+
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
|
610
|
+
# of group names into alphabetical order. If set to NO the group names will
|
611
|
+
# appear in their defined order.
|
612
|
+
# The default value is: NO.
|
613
|
+
|
614
|
+
SORT_GROUP_NAMES = NO
|
615
|
+
|
616
|
+
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
|
617
|
+
# fully-qualified names, including namespaces. If set to NO, the class list will
|
618
|
+
# be sorted only by class name, not including the namespace part.
|
619
|
+
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
620
|
+
# Note: This option applies only to the class list, not to the alphabetical
|
621
|
+
# list.
|
622
|
+
# The default value is: NO.
|
623
|
+
|
624
|
+
SORT_BY_SCOPE_NAME = NO
|
625
|
+
|
626
|
+
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
|
627
|
+
# type resolution of all parameters of a function it will reject a match between
|
628
|
+
# the prototype and the implementation of a member function even if there is
|
629
|
+
# only one candidate or it is obvious which candidate to choose by doing a
|
630
|
+
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
|
631
|
+
# accept a match between prototype and implementation in such cases.
|
632
|
+
# The default value is: NO.
|
633
|
+
|
634
|
+
STRICT_PROTO_MATCHING = NO
|
635
|
+
|
636
|
+
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
|
637
|
+
# list. This list is created by putting \todo commands in the documentation.
|
638
|
+
# The default value is: YES.
|
639
|
+
|
640
|
+
GENERATE_TODOLIST = NO
|
641
|
+
|
642
|
+
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
|
643
|
+
# list. This list is created by putting \test commands in the documentation.
|
644
|
+
# The default value is: YES.
|
645
|
+
|
646
|
+
GENERATE_TESTLIST = YES
|
647
|
+
|
648
|
+
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
|
649
|
+
# list. This list is created by putting \bug commands in the documentation.
|
650
|
+
# The default value is: YES.
|
651
|
+
|
652
|
+
GENERATE_BUGLIST = YES
|
653
|
+
|
654
|
+
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
|
655
|
+
# the deprecated list. This list is created by putting \deprecated commands in
|
656
|
+
# the documentation.
|
657
|
+
# The default value is: YES.
|
658
|
+
|
659
|
+
GENERATE_DEPRECATEDLIST= YES
|
660
|
+
|
661
|
+
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
|
662
|
+
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
|
663
|
+
# ... \endcond blocks.
|
664
|
+
|
665
|
+
ENABLED_SECTIONS =
|
666
|
+
|
667
|
+
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
|
668
|
+
# initial value of a variable or macro / define can have for it to appear in the
|
669
|
+
# documentation. If the initializer consists of more lines than specified here
|
670
|
+
# it will be hidden. Use a value of 0 to hide initializers completely. The
|
671
|
+
# appearance of the value of individual variables and macros / defines can be
|
672
|
+
# controlled using \showinitializer or \hideinitializer command in the
|
673
|
+
# documentation regardless of this setting.
|
674
|
+
# Minimum value: 0, maximum value: 10000, default value: 30.
|
675
|
+
|
676
|
+
MAX_INITIALIZER_LINES = 0
|
677
|
+
|
678
|
+
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
|
679
|
+
# the bottom of the documentation of classes and structs. If set to YES, the
|
680
|
+
# list will mention the files that were used to generate the documentation.
|
681
|
+
# The default value is: YES.
|
682
|
+
|
683
|
+
SHOW_USED_FILES = YES
|
684
|
+
|
685
|
+
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
|
686
|
+
# will remove the Files entry from the Quick Index and from the Folder Tree View
|
687
|
+
# (if specified).
|
688
|
+
# The default value is: YES.
|
689
|
+
|
690
|
+
SHOW_FILES = YES
|
691
|
+
|
692
|
+
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
|
693
|
+
# page. This will remove the Namespaces entry from the Quick Index and from the
|
694
|
+
# Folder Tree View (if specified).
|
695
|
+
# The default value is: YES.
|
696
|
+
|
697
|
+
SHOW_NAMESPACES = YES
|
698
|
+
|
699
|
+
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
700
|
+
# doxygen should invoke to get the current version for each file (typically from
|
701
|
+
# the version control system). Doxygen will invoke the program by executing (via
|
702
|
+
# popen()) the command command input-file, where command is the value of the
|
703
|
+
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
|
704
|
+
# by doxygen. Whatever the program writes to standard output is used as the file
|
705
|
+
# version. For an example see the documentation.
|
706
|
+
|
707
|
+
FILE_VERSION_FILTER =
|
708
|
+
|
709
|
+
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
710
|
+
# by doxygen. The layout file controls the global structure of the generated
|
711
|
+
# output files in an output format independent way. To create the layout file
|
712
|
+
# that represents doxygen's defaults, run doxygen with the -l option. You can
|
713
|
+
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
|
714
|
+
# will be used as the name of the layout file.
|
715
|
+
#
|
716
|
+
# Note that if you run doxygen from a directory containing a file called
|
717
|
+
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
|
718
|
+
# tag is left empty.
|
719
|
+
|
720
|
+
LAYOUT_FILE = doc/DoxygenLayout.xml
|
721
|
+
|
722
|
+
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
|
723
|
+
# the reference definitions. This must be a list of .bib files. The .bib
|
724
|
+
# extension is automatically appended if omitted. This requires the bibtex tool
|
725
|
+
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
|
726
|
+
# For LaTeX the style of the bibliography can be controlled using
|
727
|
+
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
|
728
|
+
# search path. See also \cite for info how to create references.
|
729
|
+
|
730
|
+
CITE_BIB_FILES =
|
731
|
+
|
732
|
+
#---------------------------------------------------------------------------
|
733
|
+
# Configuration options related to warning and progress messages
|
734
|
+
#---------------------------------------------------------------------------
|
735
|
+
|
736
|
+
# The QUIET tag can be used to turn on/off the messages that are generated to
|
737
|
+
# standard output by doxygen. If QUIET is set to YES this implies that the
|
738
|
+
# messages are off.
|
739
|
+
# The default value is: NO.
|
740
|
+
|
741
|
+
QUIET = NO
|
742
|
+
|
743
|
+
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
744
|
+
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
|
745
|
+
# this implies that the warnings are on.
|
746
|
+
#
|
747
|
+
# Tip: Turn warnings on while writing the documentation.
|
748
|
+
# The default value is: YES.
|
749
|
+
|
750
|
+
WARNINGS = YES
|
751
|
+
|
752
|
+
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
|
753
|
+
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
|
754
|
+
# will automatically be disabled.
|
755
|
+
# The default value is: YES.
|
756
|
+
|
757
|
+
WARN_IF_UNDOCUMENTED = NO
|
758
|
+
|
759
|
+
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
|
760
|
+
# potential errors in the documentation, such as not documenting some parameters
|
761
|
+
# in a documented function, or documenting parameters that don't exist or using
|
762
|
+
# markup commands wrongly.
|
763
|
+
# The default value is: YES.
|
764
|
+
|
765
|
+
WARN_IF_DOC_ERROR = YES
|
766
|
+
|
767
|
+
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
|
768
|
+
# are documented, but have no documentation for their parameters or return
|
769
|
+
# value. If set to NO, doxygen will only warn about wrong or incomplete
|
770
|
+
# parameter documentation, but not about the absence of documentation.
|
771
|
+
# The default value is: NO.
|
772
|
+
|
773
|
+
WARN_NO_PARAMDOC = NO
|
774
|
+
|
775
|
+
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
|
776
|
+
# a warning is encountered.
|
777
|
+
# The default value is: NO.
|
778
|
+
|
779
|
+
WARN_AS_ERROR = NO
|
780
|
+
|
781
|
+
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
|
782
|
+
# can produce. The string should contain the $file, $line, and $text tags, which
|
783
|
+
# will be replaced by the file and line number from which the warning originated
|
784
|
+
# and the warning text. Optionally the format may contain $version, which will
|
785
|
+
# be replaced by the version of the file (if it could be obtained via
|
786
|
+
# FILE_VERSION_FILTER)
|
787
|
+
# The default value is: $file:$line: $text.
|
788
|
+
|
789
|
+
WARN_FORMAT = "$file:$line: $text"
|
790
|
+
|
791
|
+
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
|
792
|
+
# messages should be written. If left blank the output is written to standard
|
793
|
+
# error (stderr).
|
794
|
+
|
795
|
+
WARN_LOGFILE =
|
796
|
+
|
797
|
+
#---------------------------------------------------------------------------
|
798
|
+
# Configuration options related to the input files
|
799
|
+
#---------------------------------------------------------------------------
|
800
|
+
|
801
|
+
# The INPUT tag is used to specify the files and/or directories that contain
|
802
|
+
# documented source files. You may enter file names like myfile.cpp or
|
803
|
+
# directories like /usr/src/myproject. Separate the files or directories with
|
804
|
+
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
805
|
+
# Note: If this tag is empty the current directory is searched.
|
806
|
+
|
807
|
+
INPUT = include/libcouchbase/couchbase.h \
|
808
|
+
include/libcouchbase \
|
809
|
+
plugins/io/libevent/libevent_io_opts.h \
|
810
|
+
plugins/io/libev/libev_io_opts.h \
|
811
|
+
plugins/io/libuv/libuv_io_opts.h \
|
812
|
+
doc/apiattr.h \
|
813
|
+
doc/mainpage.h \
|
814
|
+
doc/intro.h \
|
815
|
+
doc/environment.h \
|
816
|
+
doc/cbc.markdown \
|
817
|
+
doc/cbc-pillowfight.markdown \
|
818
|
+
doc/cbcrc.markdown \
|
819
|
+
doc/cbc-n1qlback.markdown \
|
820
|
+
doc/cbc-subdoc.markdown
|
821
|
+
|
822
|
+
# This tag can be used to specify the character encoding of the source files
|
823
|
+
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
824
|
+
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
|
825
|
+
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
|
826
|
+
# possible encodings.
|
827
|
+
# The default value is: UTF-8.
|
828
|
+
|
829
|
+
INPUT_ENCODING = UTF-8
|
830
|
+
|
831
|
+
# If the value of the INPUT tag contains directories, you can use the
|
832
|
+
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
|
833
|
+
# *.h) to filter out the source-files in the directories.
|
834
|
+
#
|
835
|
+
# Note that for custom extensions or not directly supported extensions you also
|
836
|
+
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
837
|
+
# read by doxygen.
|
838
|
+
#
|
839
|
+
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
|
840
|
+
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
|
841
|
+
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
|
842
|
+
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
|
843
|
+
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
|
844
|
+
|
845
|
+
FILE_PATTERNS = *.h
|
846
|
+
|
847
|
+
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
848
|
+
# be searched for input files as well.
|
849
|
+
# The default value is: NO.
|
850
|
+
|
851
|
+
RECURSIVE = YES
|
852
|
+
|
853
|
+
# The EXCLUDE tag can be used to specify files and/or directories that should be
|
854
|
+
# excluded from the INPUT source files. This way you can easily exclude a
|
855
|
+
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
856
|
+
#
|
857
|
+
# Note that relative paths are relative to the directory from which doxygen is
|
858
|
+
# run.
|
859
|
+
|
860
|
+
EXCLUDE = contrib \
|
861
|
+
gtest* \
|
862
|
+
tests \
|
863
|
+
include/libcouchbase/cxxwrap.h
|
864
|
+
|
865
|
+
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
866
|
+
# directories that are symbolic links (a Unix file system feature) are excluded
|
867
|
+
# from the input.
|
868
|
+
# The default value is: NO.
|
869
|
+
|
870
|
+
EXCLUDE_SYMLINKS = NO
|
871
|
+
|
872
|
+
# If the value of the INPUT tag contains directories, you can use the
|
873
|
+
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
874
|
+
# certain files from those directories.
|
875
|
+
#
|
876
|
+
# Note that the wildcards are matched against the file with absolute path, so to
|
877
|
+
# exclude all test directories for example use the pattern */test/*
|
878
|
+
|
879
|
+
EXCLUDE_PATTERNS =
|
880
|
+
|
881
|
+
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
882
|
+
# (namespaces, classes, functions, etc.) that should be excluded from the
|
883
|
+
# output. The symbol name can be a fully qualified name, a word, or if the
|
884
|
+
# wildcard * is used, a substring. Examples: ANamespace, AClass,
|
885
|
+
# AClass::ANamespace, ANamespace::*Test
|
886
|
+
#
|
887
|
+
# Note that the wildcards are matched against the file with absolute path, so to
|
888
|
+
# exclude all test directories use the pattern */test/*
|
889
|
+
|
890
|
+
EXCLUDE_SYMBOLS =
|
891
|
+
|
892
|
+
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
|
893
|
+
# that contain example code fragments that are included (see the \include
|
894
|
+
# command).
|
895
|
+
|
896
|
+
EXAMPLE_PATH = example/ \
|
897
|
+
doc/example
|
898
|
+
|
899
|
+
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
900
|
+
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
|
901
|
+
# *.h) to filter out the source-files in the directories. If left blank all
|
902
|
+
# files are included.
|
903
|
+
|
904
|
+
EXAMPLE_PATTERNS = *.c
|
905
|
+
|
906
|
+
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
907
|
+
# searched for input files to be used with the \include or \dontinclude commands
|
908
|
+
# irrespective of the value of the RECURSIVE tag.
|
909
|
+
# The default value is: NO.
|
910
|
+
|
911
|
+
EXAMPLE_RECURSIVE = YES
|
912
|
+
|
913
|
+
# The IMAGE_PATH tag can be used to specify one or more files or directories
|
914
|
+
# that contain images that are to be included in the documentation (see the
|
915
|
+
# \image command).
|
916
|
+
|
917
|
+
IMAGE_PATH =
|
918
|
+
|
919
|
+
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
920
|
+
# invoke to filter for each input file. Doxygen will invoke the filter program
|
921
|
+
# by executing (via popen()) the command:
|
922
|
+
#
|
923
|
+
# <filter> <input-file>
|
924
|
+
#
|
925
|
+
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
|
926
|
+
# name of an input file. Doxygen will then use the output that the filter
|
927
|
+
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
|
928
|
+
# will be ignored.
|
929
|
+
#
|
930
|
+
# Note that the filter must not add or remove lines; it is applied before the
|
931
|
+
# code is scanned, but not when the output code is generated. If lines are added
|
932
|
+
# or removed, the anchors will not be placed correctly.
|
933
|
+
#
|
934
|
+
# Note that for custom extensions or not directly supported extensions you also
|
935
|
+
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
936
|
+
# properly processed by doxygen.
|
937
|
+
|
938
|
+
INPUT_FILTER =
|
939
|
+
|
940
|
+
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
941
|
+
# basis. Doxygen will compare the file name with each pattern and apply the
|
942
|
+
# filter if there is a match. The filters are a list of the form: pattern=filter
|
943
|
+
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
|
944
|
+
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
|
945
|
+
# patterns match the file name, INPUT_FILTER is applied.
|
946
|
+
#
|
947
|
+
# Note that for custom extensions or not directly supported extensions you also
|
948
|
+
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
949
|
+
# properly processed by doxygen.
|
950
|
+
|
951
|
+
FILTER_PATTERNS =
|
952
|
+
|
953
|
+
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
954
|
+
# INPUT_FILTER) will also be used to filter the input files that are used for
|
955
|
+
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
956
|
+
# The default value is: NO.
|
957
|
+
|
958
|
+
FILTER_SOURCE_FILES = NO
|
959
|
+
|
960
|
+
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
|
961
|
+
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
|
962
|
+
# it is also possible to disable source filtering for a specific pattern using
|
963
|
+
# *.ext= (so without naming a filter).
|
964
|
+
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
|
965
|
+
|
966
|
+
FILTER_SOURCE_PATTERNS =
|
967
|
+
|
968
|
+
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
|
969
|
+
# is part of the input, its contents will be placed on the main page
|
970
|
+
# (index.html). This can be useful if you have a project on for instance GitHub
|
971
|
+
# and want to reuse the introduction page also for the doxygen output.
|
972
|
+
|
973
|
+
USE_MDFILE_AS_MAINPAGE =
|
974
|
+
|
975
|
+
#---------------------------------------------------------------------------
|
976
|
+
# Configuration options related to source browsing
|
977
|
+
#---------------------------------------------------------------------------
|
978
|
+
|
979
|
+
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
|
980
|
+
# generated. Documented entities will be cross-referenced with these sources.
|
981
|
+
#
|
982
|
+
# Note: To get rid of all source code in the generated output, make sure that
|
983
|
+
# also VERBATIM_HEADERS is set to NO.
|
984
|
+
# The default value is: NO.
|
985
|
+
|
986
|
+
SOURCE_BROWSER = NO
|
987
|
+
|
988
|
+
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
|
989
|
+
# classes and enums directly into the documentation.
|
990
|
+
# The default value is: NO.
|
991
|
+
|
992
|
+
INLINE_SOURCES = NO
|
993
|
+
|
994
|
+
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
|
995
|
+
# special comment blocks from generated source code fragments. Normal C, C++ and
|
996
|
+
# Fortran comments will always remain visible.
|
997
|
+
# The default value is: YES.
|
998
|
+
|
999
|
+
STRIP_CODE_COMMENTS = YES
|
1000
|
+
|
1001
|
+
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
|
1002
|
+
# function all documented functions referencing it will be listed.
|
1003
|
+
# The default value is: NO.
|
1004
|
+
|
1005
|
+
REFERENCED_BY_RELATION = YES
|
1006
|
+
|
1007
|
+
# If the REFERENCES_RELATION tag is set to YES then for each documented function
|
1008
|
+
# all documented entities called/used by that function will be listed.
|
1009
|
+
# The default value is: NO.
|
1010
|
+
|
1011
|
+
REFERENCES_RELATION = YES
|
1012
|
+
|
1013
|
+
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
|
1014
|
+
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
|
1015
|
+
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
|
1016
|
+
# link to the documentation.
|
1017
|
+
# The default value is: YES.
|
1018
|
+
|
1019
|
+
REFERENCES_LINK_SOURCE = YES
|
1020
|
+
|
1021
|
+
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
|
1022
|
+
# source code will show a tooltip with additional information such as prototype,
|
1023
|
+
# brief description and links to the definition and documentation. Since this
|
1024
|
+
# will make the HTML file larger and loading of large files a bit slower, you
|
1025
|
+
# can opt to disable this feature.
|
1026
|
+
# The default value is: YES.
|
1027
|
+
# This tag requires that the tag SOURCE_BROWSER is set to YES.
|
1028
|
+
|
1029
|
+
SOURCE_TOOLTIPS = YES
|
1030
|
+
|
1031
|
+
# If the USE_HTAGS tag is set to YES then the references to source code will
|
1032
|
+
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
|
1033
|
+
# source browser. The htags tool is part of GNU's global source tagging system
|
1034
|
+
# (see https://www.gnu.org/software/global/global.html). You will need version
|
1035
|
+
# 4.8.6 or higher.
|
1036
|
+
#
|
1037
|
+
# To use it do the following:
|
1038
|
+
# - Install the latest version of global
|
1039
|
+
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
|
1040
|
+
# - Make sure the INPUT points to the root of the source tree
|
1041
|
+
# - Run doxygen as normal
|
1042
|
+
#
|
1043
|
+
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
|
1044
|
+
# tools must be available from the command line (i.e. in the search path).
|
1045
|
+
#
|
1046
|
+
# The result: instead of the source browser generated by doxygen, the links to
|
1047
|
+
# source code will now point to the output of htags.
|
1048
|
+
# The default value is: NO.
|
1049
|
+
# This tag requires that the tag SOURCE_BROWSER is set to YES.
|
1050
|
+
|
1051
|
+
USE_HTAGS = NO
|
1052
|
+
|
1053
|
+
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
|
1054
|
+
# verbatim copy of the header file for each class for which an include is
|
1055
|
+
# specified. Set to NO to disable this.
|
1056
|
+
# See also: Section \class.
|
1057
|
+
# The default value is: YES.
|
1058
|
+
|
1059
|
+
VERBATIM_HEADERS = YES
|
1060
|
+
|
1061
|
+
#---------------------------------------------------------------------------
|
1062
|
+
# Configuration options related to the alphabetical class index
|
1063
|
+
#---------------------------------------------------------------------------
|
1064
|
+
|
1065
|
+
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
|
1066
|
+
# compounds will be generated. Enable this if the project contains a lot of
|
1067
|
+
# classes, structs, unions or interfaces.
|
1068
|
+
# The default value is: YES.
|
1069
|
+
|
1070
|
+
ALPHABETICAL_INDEX = YES
|
1071
|
+
|
1072
|
+
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
|
1073
|
+
# which the alphabetical index list will be split.
|
1074
|
+
# Minimum value: 1, maximum value: 20, default value: 5.
|
1075
|
+
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
|
1076
|
+
|
1077
|
+
COLS_IN_ALPHA_INDEX = 5
|
1078
|
+
|
1079
|
+
# In case all classes in a project start with a common prefix, all classes will
|
1080
|
+
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
|
1081
|
+
# can be used to specify a prefix (or a list of prefixes) that should be ignored
|
1082
|
+
# while generating the index headers.
|
1083
|
+
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
|
1084
|
+
|
1085
|
+
IGNORE_PREFIX =
|
1086
|
+
|
1087
|
+
#---------------------------------------------------------------------------
|
1088
|
+
# Configuration options related to the HTML output
|
1089
|
+
#---------------------------------------------------------------------------
|
1090
|
+
|
1091
|
+
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
|
1092
|
+
# The default value is: YES.
|
1093
|
+
|
1094
|
+
GENERATE_HTML = YES
|
1095
|
+
|
1096
|
+
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
|
1097
|
+
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
1098
|
+
# it.
|
1099
|
+
# The default directory is: html.
|
1100
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1101
|
+
|
1102
|
+
HTML_OUTPUT = html
|
1103
|
+
|
1104
|
+
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
|
1105
|
+
# generated HTML page (for example: .htm, .php, .asp).
|
1106
|
+
# The default value is: .html.
|
1107
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1108
|
+
|
1109
|
+
HTML_FILE_EXTENSION = .html
|
1110
|
+
|
1111
|
+
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
|
1112
|
+
# each generated HTML page. If the tag is left blank doxygen will generate a
|
1113
|
+
# standard header.
|
1114
|
+
#
|
1115
|
+
# To get valid HTML the header file that includes any scripts and style sheets
|
1116
|
+
# that doxygen needs, which is dependent on the configuration options used (e.g.
|
1117
|
+
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
|
1118
|
+
# default header using
|
1119
|
+
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
|
1120
|
+
# YourConfigFile
|
1121
|
+
# and then modify the file new_header.html. See also section "Doxygen usage"
|
1122
|
+
# for information on how to generate the default header that doxygen normally
|
1123
|
+
# uses.
|
1124
|
+
# Note: The header is subject to change so you typically have to regenerate the
|
1125
|
+
# default header when upgrading to a newer version of doxygen. For a description
|
1126
|
+
# of the possible markers and block names see the documentation.
|
1127
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1128
|
+
|
1129
|
+
HTML_HEADER = doc/header.html
|
1130
|
+
|
1131
|
+
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
|
1132
|
+
# generated HTML page. If the tag is left blank doxygen will generate a standard
|
1133
|
+
# footer. See HTML_HEADER for more information on how to generate a default
|
1134
|
+
# footer and what special commands can be used inside the footer. See also
|
1135
|
+
# section "Doxygen usage" for information on how to generate the default footer
|
1136
|
+
# that doxygen normally uses.
|
1137
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1138
|
+
|
1139
|
+
HTML_FOOTER = doc/footer.html
|
1140
|
+
|
1141
|
+
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
|
1142
|
+
# sheet that is used by each HTML page. It can be used to fine-tune the look of
|
1143
|
+
# the HTML output. If left blank doxygen will generate a default style sheet.
|
1144
|
+
# See also section "Doxygen usage" for information on how to generate the style
|
1145
|
+
# sheet that doxygen normally uses.
|
1146
|
+
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
|
1147
|
+
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
|
1148
|
+
# obsolete.
|
1149
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1150
|
+
|
1151
|
+
HTML_STYLESHEET =
|
1152
|
+
|
1153
|
+
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
|
1154
|
+
# cascading style sheets that are included after the standard style sheets
|
1155
|
+
# created by doxygen. Using this option one can overrule certain style aspects.
|
1156
|
+
# This is preferred over using HTML_STYLESHEET since it does not replace the
|
1157
|
+
# standard style sheet and is therefore more robust against future updates.
|
1158
|
+
# Doxygen will copy the style sheet files to the output directory.
|
1159
|
+
# Note: The order of the extra style sheet files is of importance (e.g. the last
|
1160
|
+
# style sheet in the list overrules the setting of the previous ones in the
|
1161
|
+
# list). For an example see the documentation.
|
1162
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1163
|
+
|
1164
|
+
HTML_EXTRA_STYLESHEET = doc/style.css
|
1165
|
+
|
1166
|
+
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
1167
|
+
# other source files which should be copied to the HTML output directory. Note
|
1168
|
+
# that these files will be copied to the base HTML output directory. Use the
|
1169
|
+
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
|
1170
|
+
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
|
1171
|
+
# files will be copied as-is; there are no commands or markers available.
|
1172
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1173
|
+
|
1174
|
+
HTML_EXTRA_FILES =
|
1175
|
+
|
1176
|
+
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
|
1177
|
+
# will adjust the colors in the style sheet and background images according to
|
1178
|
+
# this color. Hue is specified as an angle on a colorwheel, see
|
1179
|
+
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
|
1180
|
+
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
|
1181
|
+
# purple, and 360 is red again.
|
1182
|
+
# Minimum value: 0, maximum value: 359, default value: 220.
|
1183
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1184
|
+
|
1185
|
+
HTML_COLORSTYLE_HUE = 220
|
1186
|
+
|
1187
|
+
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
|
1188
|
+
# in the HTML output. For a value of 0 the output will use grayscales only. A
|
1189
|
+
# value of 255 will produce the most vivid colors.
|
1190
|
+
# Minimum value: 0, maximum value: 255, default value: 100.
|
1191
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1192
|
+
|
1193
|
+
HTML_COLORSTYLE_SAT = 100
|
1194
|
+
|
1195
|
+
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
|
1196
|
+
# luminance component of the colors in the HTML output. Values below 100
|
1197
|
+
# gradually make the output lighter, whereas values above 100 make the output
|
1198
|
+
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
|
1199
|
+
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
|
1200
|
+
# change the gamma.
|
1201
|
+
# Minimum value: 40, maximum value: 240, default value: 80.
|
1202
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1203
|
+
|
1204
|
+
HTML_COLORSTYLE_GAMMA = 80
|
1205
|
+
|
1206
|
+
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
1207
|
+
# page will contain the date and time when the page was generated. Setting this
|
1208
|
+
# to YES can help to show when doxygen was last run and thus if the
|
1209
|
+
# documentation is up to date.
|
1210
|
+
# The default value is: NO.
|
1211
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1212
|
+
|
1213
|
+
HTML_TIMESTAMP = YES
|
1214
|
+
|
1215
|
+
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
|
1216
|
+
# documentation will contain a main index with vertical navigation menus that
|
1217
|
+
# are dynamically created via Javascript. If disabled, the navigation index will
|
1218
|
+
# consists of multiple levels of tabs that are statically embedded in every HTML
|
1219
|
+
# page. Disable this option to support browsers that do not have Javascript,
|
1220
|
+
# like the Qt help browser.
|
1221
|
+
# The default value is: YES.
|
1222
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1223
|
+
|
1224
|
+
HTML_DYNAMIC_MENUS = YES
|
1225
|
+
|
1226
|
+
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
|
1227
|
+
# documentation will contain sections that can be hidden and shown after the
|
1228
|
+
# page has loaded.
|
1229
|
+
# The default value is: NO.
|
1230
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1231
|
+
|
1232
|
+
HTML_DYNAMIC_SECTIONS = NO
|
1233
|
+
|
1234
|
+
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
|
1235
|
+
# shown in the various tree structured indices initially; the user can expand
|
1236
|
+
# and collapse entries dynamically later on. Doxygen will expand the tree to
|
1237
|
+
# such a level that at most the specified number of entries are visible (unless
|
1238
|
+
# a fully collapsed tree already exceeds this amount). So setting the number of
|
1239
|
+
# entries 1 will produce a full collapsed tree by default. 0 is a special value
|
1240
|
+
# representing an infinite number of entries and will result in a full expanded
|
1241
|
+
# tree by default.
|
1242
|
+
# Minimum value: 0, maximum value: 9999, default value: 100.
|
1243
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1244
|
+
|
1245
|
+
HTML_INDEX_NUM_ENTRIES = 100
|
1246
|
+
|
1247
|
+
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
|
1248
|
+
# generated that can be used as input for Apple's Xcode 3 integrated development
|
1249
|
+
# environment (see: https://developer.apple.com/tools/xcode/), introduced with
|
1250
|
+
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
|
1251
|
+
# Makefile in the HTML output directory. Running make will produce the docset in
|
1252
|
+
# that directory and running make install will install the docset in
|
1253
|
+
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
|
1254
|
+
# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html
|
1255
|
+
# for more information.
|
1256
|
+
# The default value is: NO.
|
1257
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1258
|
+
|
1259
|
+
GENERATE_DOCSET = NO
|
1260
|
+
|
1261
|
+
# This tag determines the name of the docset feed. A documentation feed provides
|
1262
|
+
# an umbrella under which multiple documentation sets from a single provider
|
1263
|
+
# (such as a company or product suite) can be grouped.
|
1264
|
+
# The default value is: Doxygen generated docs.
|
1265
|
+
# This tag requires that the tag GENERATE_DOCSET is set to YES.
|
1266
|
+
|
1267
|
+
DOCSET_FEEDNAME = "Doxygen generated docs"
|
1268
|
+
|
1269
|
+
# This tag specifies a string that should uniquely identify the documentation
|
1270
|
+
# set bundle. This should be a reverse domain-name style string, e.g.
|
1271
|
+
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
|
1272
|
+
# The default value is: org.doxygen.Project.
|
1273
|
+
# This tag requires that the tag GENERATE_DOCSET is set to YES.
|
1274
|
+
|
1275
|
+
DOCSET_BUNDLE_ID = org.doxygen.Project
|
1276
|
+
|
1277
|
+
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
|
1278
|
+
# the documentation publisher. This should be a reverse domain-name style
|
1279
|
+
# string, e.g. com.mycompany.MyDocSet.documentation.
|
1280
|
+
# The default value is: org.doxygen.Publisher.
|
1281
|
+
# This tag requires that the tag GENERATE_DOCSET is set to YES.
|
1282
|
+
|
1283
|
+
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
1284
|
+
|
1285
|
+
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
1286
|
+
# The default value is: Publisher.
|
1287
|
+
# This tag requires that the tag GENERATE_DOCSET is set to YES.
|
1288
|
+
|
1289
|
+
DOCSET_PUBLISHER_NAME = Publisher
|
1290
|
+
|
1291
|
+
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
|
1292
|
+
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
|
1293
|
+
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
|
1294
|
+
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
|
1295
|
+
# Windows.
|
1296
|
+
#
|
1297
|
+
# The HTML Help Workshop contains a compiler that can convert all HTML output
|
1298
|
+
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
|
1299
|
+
# files are now used as the Windows 98 help format, and will replace the old
|
1300
|
+
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
|
1301
|
+
# HTML files also contain an index, a table of contents, and you can search for
|
1302
|
+
# words in the documentation. The HTML workshop also contains a viewer for
|
1303
|
+
# compressed HTML files.
|
1304
|
+
# The default value is: NO.
|
1305
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1306
|
+
|
1307
|
+
GENERATE_HTMLHELP = NO
|
1308
|
+
|
1309
|
+
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
|
1310
|
+
# file. You can add a path in front of the file if the result should not be
|
1311
|
+
# written to the html output directory.
|
1312
|
+
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
1313
|
+
|
1314
|
+
CHM_FILE =
|
1315
|
+
|
1316
|
+
# The HHC_LOCATION tag can be used to specify the location (absolute path
|
1317
|
+
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
|
1318
|
+
# doxygen will try to run the HTML help compiler on the generated index.hhp.
|
1319
|
+
# The file has to be specified with full path.
|
1320
|
+
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
1321
|
+
|
1322
|
+
HHC_LOCATION =
|
1323
|
+
|
1324
|
+
# The GENERATE_CHI flag controls if a separate .chi index file is generated
|
1325
|
+
# (YES) or that it should be included in the master .chm file (NO).
|
1326
|
+
# The default value is: NO.
|
1327
|
+
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
1328
|
+
|
1329
|
+
GENERATE_CHI = NO
|
1330
|
+
|
1331
|
+
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
|
1332
|
+
# and project file content.
|
1333
|
+
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
1334
|
+
|
1335
|
+
CHM_INDEX_ENCODING =
|
1336
|
+
|
1337
|
+
# The BINARY_TOC flag controls whether a binary table of contents is generated
|
1338
|
+
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
|
1339
|
+
# enables the Previous and Next buttons.
|
1340
|
+
# The default value is: NO.
|
1341
|
+
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
1342
|
+
|
1343
|
+
BINARY_TOC = NO
|
1344
|
+
|
1345
|
+
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
|
1346
|
+
# the table of contents of the HTML help documentation and to the tree view.
|
1347
|
+
# The default value is: NO.
|
1348
|
+
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
1349
|
+
|
1350
|
+
TOC_EXPAND = NO
|
1351
|
+
|
1352
|
+
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
|
1353
|
+
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
|
1354
|
+
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
|
1355
|
+
# (.qch) of the generated HTML documentation.
|
1356
|
+
# The default value is: NO.
|
1357
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1358
|
+
|
1359
|
+
GENERATE_QHP = NO
|
1360
|
+
|
1361
|
+
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
|
1362
|
+
# the file name of the resulting .qch file. The path specified is relative to
|
1363
|
+
# the HTML output folder.
|
1364
|
+
# This tag requires that the tag GENERATE_QHP is set to YES.
|
1365
|
+
|
1366
|
+
QCH_FILE =
|
1367
|
+
|
1368
|
+
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
|
1369
|
+
# Project output. For more information please see Qt Help Project / Namespace
|
1370
|
+
# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace).
|
1371
|
+
# The default value is: org.doxygen.Project.
|
1372
|
+
# This tag requires that the tag GENERATE_QHP is set to YES.
|
1373
|
+
|
1374
|
+
QHP_NAMESPACE = org.doxygen.Project
|
1375
|
+
|
1376
|
+
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
|
1377
|
+
# Help Project output. For more information please see Qt Help Project / Virtual
|
1378
|
+
# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders).
|
1379
|
+
# The default value is: doc.
|
1380
|
+
# This tag requires that the tag GENERATE_QHP is set to YES.
|
1381
|
+
|
1382
|
+
QHP_VIRTUAL_FOLDER = doc
|
1383
|
+
|
1384
|
+
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
|
1385
|
+
# filter to add. For more information please see Qt Help Project / Custom
|
1386
|
+
# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
|
1387
|
+
# This tag requires that the tag GENERATE_QHP is set to YES.
|
1388
|
+
|
1389
|
+
QHP_CUST_FILTER_NAME =
|
1390
|
+
|
1391
|
+
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
|
1392
|
+
# custom filter to add. For more information please see Qt Help Project / Custom
|
1393
|
+
# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
|
1394
|
+
# This tag requires that the tag GENERATE_QHP is set to YES.
|
1395
|
+
|
1396
|
+
QHP_CUST_FILTER_ATTRS =
|
1397
|
+
|
1398
|
+
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
1399
|
+
# project's filter section matches. Qt Help Project / Filter Attributes (see:
|
1400
|
+
# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes).
|
1401
|
+
# This tag requires that the tag GENERATE_QHP is set to YES.
|
1402
|
+
|
1403
|
+
QHP_SECT_FILTER_ATTRS =
|
1404
|
+
|
1405
|
+
# The QHG_LOCATION tag can be used to specify the location of Qt's
|
1406
|
+
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
|
1407
|
+
# generated .qhp file.
|
1408
|
+
# This tag requires that the tag GENERATE_QHP is set to YES.
|
1409
|
+
|
1410
|
+
QHG_LOCATION =
|
1411
|
+
|
1412
|
+
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
|
1413
|
+
# generated, together with the HTML files, they form an Eclipse help plugin. To
|
1414
|
+
# install this plugin and make it available under the help contents menu in
|
1415
|
+
# Eclipse, the contents of the directory containing the HTML and XML files needs
|
1416
|
+
# to be copied into the plugins directory of eclipse. The name of the directory
|
1417
|
+
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
|
1418
|
+
# After copying Eclipse needs to be restarted before the help appears.
|
1419
|
+
# The default value is: NO.
|
1420
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1421
|
+
|
1422
|
+
GENERATE_ECLIPSEHELP = NO
|
1423
|
+
|
1424
|
+
# A unique identifier for the Eclipse help plugin. When installing the plugin
|
1425
|
+
# the directory name containing the HTML and XML files should also have this
|
1426
|
+
# name. Each documentation set should have its own identifier.
|
1427
|
+
# The default value is: org.doxygen.Project.
|
1428
|
+
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
|
1429
|
+
|
1430
|
+
ECLIPSE_DOC_ID = org.doxygen.Project
|
1431
|
+
|
1432
|
+
# If you want full control over the layout of the generated HTML pages it might
|
1433
|
+
# be necessary to disable the index and replace it with your own. The
|
1434
|
+
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
|
1435
|
+
# of each HTML page. A value of NO enables the index and the value YES disables
|
1436
|
+
# it. Since the tabs in the index contain the same information as the navigation
|
1437
|
+
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
|
1438
|
+
# The default value is: NO.
|
1439
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1440
|
+
|
1441
|
+
DISABLE_INDEX = YES
|
1442
|
+
|
1443
|
+
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
1444
|
+
# structure should be generated to display hierarchical information. If the tag
|
1445
|
+
# value is set to YES, a side panel will be generated containing a tree-like
|
1446
|
+
# index structure (just like the one that is generated for HTML Help). For this
|
1447
|
+
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
|
1448
|
+
# (i.e. any modern browser). Windows users are probably better off using the
|
1449
|
+
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
|
1450
|
+
# further fine-tune the look of the index. As an example, the default style
|
1451
|
+
# sheet generated by doxygen has an example that shows how to put an image at
|
1452
|
+
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
|
1453
|
+
# the same information as the tab index, you could consider setting
|
1454
|
+
# DISABLE_INDEX to YES when enabling this option.
|
1455
|
+
# The default value is: NO.
|
1456
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1457
|
+
|
1458
|
+
GENERATE_TREEVIEW = YES
|
1459
|
+
|
1460
|
+
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
|
1461
|
+
# doxygen will group on one line in the generated HTML documentation.
|
1462
|
+
#
|
1463
|
+
# Note that a value of 0 will completely suppress the enum values from appearing
|
1464
|
+
# in the overview section.
|
1465
|
+
# Minimum value: 0, maximum value: 20, default value: 4.
|
1466
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1467
|
+
|
1468
|
+
ENUM_VALUES_PER_LINE = 0
|
1469
|
+
|
1470
|
+
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
|
1471
|
+
# to set the initial width (in pixels) of the frame in which the tree is shown.
|
1472
|
+
# Minimum value: 0, maximum value: 1500, default value: 250.
|
1473
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1474
|
+
|
1475
|
+
TREEVIEW_WIDTH = 150
|
1476
|
+
|
1477
|
+
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
|
1478
|
+
# external symbols imported via tag files in a separate window.
|
1479
|
+
# The default value is: NO.
|
1480
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1481
|
+
|
1482
|
+
EXT_LINKS_IN_WINDOW = NO
|
1483
|
+
|
1484
|
+
# Use this tag to change the font size of LaTeX formulas included as images in
|
1485
|
+
# the HTML documentation. When you change the font size after a successful
|
1486
|
+
# doxygen run you need to manually remove any form_*.png images from the HTML
|
1487
|
+
# output directory to force them to be regenerated.
|
1488
|
+
# Minimum value: 8, maximum value: 50, default value: 10.
|
1489
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1490
|
+
|
1491
|
+
FORMULA_FONTSIZE = 10
|
1492
|
+
|
1493
|
+
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
|
1494
|
+
# generated for formulas are transparent PNGs. Transparent PNGs are not
|
1495
|
+
# supported properly for IE 6.0, but are supported on all modern browsers.
|
1496
|
+
#
|
1497
|
+
# Note that when changing this option you need to delete any form_*.png files in
|
1498
|
+
# the HTML output directory before the changes have effect.
|
1499
|
+
# The default value is: YES.
|
1500
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1501
|
+
|
1502
|
+
FORMULA_TRANSPARENT = YES
|
1503
|
+
|
1504
|
+
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
|
1505
|
+
# https://www.mathjax.org) which uses client side Javascript for the rendering
|
1506
|
+
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
|
1507
|
+
# installed or if you want to formulas look prettier in the HTML output. When
|
1508
|
+
# enabled you may also need to install MathJax separately and configure the path
|
1509
|
+
# to it using the MATHJAX_RELPATH option.
|
1510
|
+
# The default value is: NO.
|
1511
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1512
|
+
|
1513
|
+
USE_MATHJAX = NO
|
1514
|
+
|
1515
|
+
# When MathJax is enabled you can set the default output format to be used for
|
1516
|
+
# the MathJax output. See the MathJax site (see:
|
1517
|
+
# http://docs.mathjax.org/en/latest/output.html) for more details.
|
1518
|
+
# Possible values are: HTML-CSS (which is slower, but has the best
|
1519
|
+
# compatibility), NativeMML (i.e. MathML) and SVG.
|
1520
|
+
# The default value is: HTML-CSS.
|
1521
|
+
# This tag requires that the tag USE_MATHJAX is set to YES.
|
1522
|
+
|
1523
|
+
MATHJAX_FORMAT = HTML-CSS
|
1524
|
+
|
1525
|
+
# When MathJax is enabled you need to specify the location relative to the HTML
|
1526
|
+
# output directory using the MATHJAX_RELPATH option. The destination directory
|
1527
|
+
# should contain the MathJax.js script. For instance, if the mathjax directory
|
1528
|
+
# is located at the same level as the HTML output directory, then
|
1529
|
+
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
|
1530
|
+
# Content Delivery Network so you can quickly see the result without installing
|
1531
|
+
# MathJax. However, it is strongly recommended to install a local copy of
|
1532
|
+
# MathJax from https://www.mathjax.org before deployment.
|
1533
|
+
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/.
|
1534
|
+
# This tag requires that the tag USE_MATHJAX is set to YES.
|
1535
|
+
|
1536
|
+
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
1537
|
+
|
1538
|
+
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
|
1539
|
+
# extension names that should be enabled during MathJax rendering. For example
|
1540
|
+
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
|
1541
|
+
# This tag requires that the tag USE_MATHJAX is set to YES.
|
1542
|
+
|
1543
|
+
MATHJAX_EXTENSIONS =
|
1544
|
+
|
1545
|
+
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
|
1546
|
+
# of code that will be used on startup of the MathJax code. See the MathJax site
|
1547
|
+
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
|
1548
|
+
# example see the documentation.
|
1549
|
+
# This tag requires that the tag USE_MATHJAX is set to YES.
|
1550
|
+
|
1551
|
+
MATHJAX_CODEFILE =
|
1552
|
+
|
1553
|
+
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
|
1554
|
+
# the HTML output. The underlying search engine uses javascript and DHTML and
|
1555
|
+
# should work on any modern browser. Note that when using HTML help
|
1556
|
+
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
|
1557
|
+
# there is already a search function so this one should typically be disabled.
|
1558
|
+
# For large projects the javascript based search engine can be slow, then
|
1559
|
+
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
|
1560
|
+
# search using the keyboard; to jump to the search box use <access key> + S
|
1561
|
+
# (what the <access key> is depends on the OS and browser, but it is typically
|
1562
|
+
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
|
1563
|
+
# key> to jump into the search results window, the results can be navigated
|
1564
|
+
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
|
1565
|
+
# the search. The filter options can be selected when the cursor is inside the
|
1566
|
+
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
|
1567
|
+
# to select a filter and <Enter> or <escape> to activate or cancel the filter
|
1568
|
+
# option.
|
1569
|
+
# The default value is: YES.
|
1570
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
1571
|
+
|
1572
|
+
SEARCHENGINE = NO
|
1573
|
+
|
1574
|
+
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
1575
|
+
# implemented using a web server instead of a web client using Javascript. There
|
1576
|
+
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
|
1577
|
+
# setting. When disabled, doxygen will generate a PHP script for searching and
|
1578
|
+
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
|
1579
|
+
# and searching needs to be provided by external tools. See the section
|
1580
|
+
# "External Indexing and Searching" for details.
|
1581
|
+
# The default value is: NO.
|
1582
|
+
# This tag requires that the tag SEARCHENGINE is set to YES.
|
1583
|
+
|
1584
|
+
SERVER_BASED_SEARCH = NO
|
1585
|
+
|
1586
|
+
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
|
1587
|
+
# script for searching. Instead the search results are written to an XML file
|
1588
|
+
# which needs to be processed by an external indexer. Doxygen will invoke an
|
1589
|
+
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
|
1590
|
+
# search results.
|
1591
|
+
#
|
1592
|
+
# Doxygen ships with an example indexer (doxyindexer) and search engine
|
1593
|
+
# (doxysearch.cgi) which are based on the open source search engine library
|
1594
|
+
# Xapian (see: https://xapian.org/).
|
1595
|
+
#
|
1596
|
+
# See the section "External Indexing and Searching" for details.
|
1597
|
+
# The default value is: NO.
|
1598
|
+
# This tag requires that the tag SEARCHENGINE is set to YES.
|
1599
|
+
|
1600
|
+
EXTERNAL_SEARCH = NO
|
1601
|
+
|
1602
|
+
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
|
1603
|
+
# which will return the search results when EXTERNAL_SEARCH is enabled.
|
1604
|
+
#
|
1605
|
+
# Doxygen ships with an example indexer (doxyindexer) and search engine
|
1606
|
+
# (doxysearch.cgi) which are based on the open source search engine library
|
1607
|
+
# Xapian (see: https://xapian.org/). See the section "External Indexing and
|
1608
|
+
# Searching" for details.
|
1609
|
+
# This tag requires that the tag SEARCHENGINE is set to YES.
|
1610
|
+
|
1611
|
+
SEARCHENGINE_URL =
|
1612
|
+
|
1613
|
+
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
|
1614
|
+
# search data is written to a file for indexing by an external tool. With the
|
1615
|
+
# SEARCHDATA_FILE tag the name of this file can be specified.
|
1616
|
+
# The default file is: searchdata.xml.
|
1617
|
+
# This tag requires that the tag SEARCHENGINE is set to YES.
|
1618
|
+
|
1619
|
+
SEARCHDATA_FILE = searchdata.xml
|
1620
|
+
|
1621
|
+
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
|
1622
|
+
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
|
1623
|
+
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
|
1624
|
+
# projects and redirect the results back to the right project.
|
1625
|
+
# This tag requires that the tag SEARCHENGINE is set to YES.
|
1626
|
+
|
1627
|
+
EXTERNAL_SEARCH_ID =
|
1628
|
+
|
1629
|
+
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
|
1630
|
+
# projects other than the one defined by this configuration file, but that are
|
1631
|
+
# all added to the same external search index. Each project needs to have a
|
1632
|
+
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
|
1633
|
+
# to a relative location where the documentation can be found. The format is:
|
1634
|
+
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
|
1635
|
+
# This tag requires that the tag SEARCHENGINE is set to YES.
|
1636
|
+
|
1637
|
+
EXTRA_SEARCH_MAPPINGS =
|
1638
|
+
|
1639
|
+
#---------------------------------------------------------------------------
|
1640
|
+
# Configuration options related to the LaTeX output
|
1641
|
+
#---------------------------------------------------------------------------
|
1642
|
+
|
1643
|
+
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
|
1644
|
+
# The default value is: YES.
|
1645
|
+
|
1646
|
+
GENERATE_LATEX = NO
|
1647
|
+
|
1648
|
+
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
|
1649
|
+
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
1650
|
+
# it.
|
1651
|
+
# The default directory is: latex.
|
1652
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1653
|
+
|
1654
|
+
LATEX_OUTPUT = latex
|
1655
|
+
|
1656
|
+
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
1657
|
+
# invoked.
|
1658
|
+
#
|
1659
|
+
# Note that when enabling USE_PDFLATEX this option is only used for generating
|
1660
|
+
# bitmaps for formulas in the HTML output, but not in the Makefile that is
|
1661
|
+
# written to the output directory.
|
1662
|
+
# The default file is: latex.
|
1663
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1664
|
+
|
1665
|
+
LATEX_CMD_NAME = latex
|
1666
|
+
|
1667
|
+
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
|
1668
|
+
# index for LaTeX.
|
1669
|
+
# The default file is: makeindex.
|
1670
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1671
|
+
|
1672
|
+
MAKEINDEX_CMD_NAME = makeindex
|
1673
|
+
|
1674
|
+
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
|
1675
|
+
# documents. This may be useful for small projects and may help to save some
|
1676
|
+
# trees in general.
|
1677
|
+
# The default value is: NO.
|
1678
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1679
|
+
|
1680
|
+
COMPACT_LATEX = NO
|
1681
|
+
|
1682
|
+
# The PAPER_TYPE tag can be used to set the paper type that is used by the
|
1683
|
+
# printer.
|
1684
|
+
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
|
1685
|
+
# 14 inches) and executive (7.25 x 10.5 inches).
|
1686
|
+
# The default value is: a4.
|
1687
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1688
|
+
|
1689
|
+
PAPER_TYPE = a4
|
1690
|
+
|
1691
|
+
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
|
1692
|
+
# that should be included in the LaTeX output. The package can be specified just
|
1693
|
+
# by its name or with the correct syntax as to be used with the LaTeX
|
1694
|
+
# \usepackage command. To get the times font for instance you can specify :
|
1695
|
+
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
|
1696
|
+
# To use the option intlimits with the amsmath package you can specify:
|
1697
|
+
# EXTRA_PACKAGES=[intlimits]{amsmath}
|
1698
|
+
# If left blank no extra packages will be included.
|
1699
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1700
|
+
|
1701
|
+
EXTRA_PACKAGES =
|
1702
|
+
|
1703
|
+
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
|
1704
|
+
# generated LaTeX document. The header should contain everything until the first
|
1705
|
+
# chapter. If it is left blank doxygen will generate a standard header. See
|
1706
|
+
# section "Doxygen usage" for information on how to let doxygen write the
|
1707
|
+
# default header to a separate file.
|
1708
|
+
#
|
1709
|
+
# Note: Only use a user-defined header if you know what you are doing! The
|
1710
|
+
# following commands have a special meaning inside the header: $title,
|
1711
|
+
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
|
1712
|
+
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
|
1713
|
+
# string, for the replacement values of the other commands the user is referred
|
1714
|
+
# to HTML_HEADER.
|
1715
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1716
|
+
|
1717
|
+
LATEX_HEADER =
|
1718
|
+
|
1719
|
+
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
|
1720
|
+
# generated LaTeX document. The footer should contain everything after the last
|
1721
|
+
# chapter. If it is left blank doxygen will generate a standard footer. See
|
1722
|
+
# LATEX_HEADER for more information on how to generate a default footer and what
|
1723
|
+
# special commands can be used inside the footer.
|
1724
|
+
#
|
1725
|
+
# Note: Only use a user-defined footer if you know what you are doing!
|
1726
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1727
|
+
|
1728
|
+
LATEX_FOOTER =
|
1729
|
+
|
1730
|
+
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
|
1731
|
+
# LaTeX style sheets that are included after the standard style sheets created
|
1732
|
+
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
|
1733
|
+
# will copy the style sheet files to the output directory.
|
1734
|
+
# Note: The order of the extra style sheet files is of importance (e.g. the last
|
1735
|
+
# style sheet in the list overrules the setting of the previous ones in the
|
1736
|
+
# list).
|
1737
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1738
|
+
|
1739
|
+
LATEX_EXTRA_STYLESHEET =
|
1740
|
+
|
1741
|
+
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
|
1742
|
+
# other source files which should be copied to the LATEX_OUTPUT output
|
1743
|
+
# directory. Note that the files will be copied as-is; there are no commands or
|
1744
|
+
# markers available.
|
1745
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1746
|
+
|
1747
|
+
LATEX_EXTRA_FILES =
|
1748
|
+
|
1749
|
+
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
|
1750
|
+
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
|
1751
|
+
# contain links (just like the HTML output) instead of page references. This
|
1752
|
+
# makes the output suitable for online browsing using a PDF viewer.
|
1753
|
+
# The default value is: YES.
|
1754
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1755
|
+
|
1756
|
+
PDF_HYPERLINKS = YES
|
1757
|
+
|
1758
|
+
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
|
1759
|
+
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
|
1760
|
+
# higher quality PDF documentation.
|
1761
|
+
# The default value is: YES.
|
1762
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1763
|
+
|
1764
|
+
USE_PDFLATEX = YES
|
1765
|
+
|
1766
|
+
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
|
1767
|
+
# command to the generated LaTeX files. This will instruct LaTeX to keep running
|
1768
|
+
# if errors occur, instead of asking the user for help. This option is also used
|
1769
|
+
# when generating formulas in HTML.
|
1770
|
+
# The default value is: NO.
|
1771
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1772
|
+
|
1773
|
+
LATEX_BATCHMODE = NO
|
1774
|
+
|
1775
|
+
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
|
1776
|
+
# index chapters (such as File Index, Compound Index, etc.) in the output.
|
1777
|
+
# The default value is: NO.
|
1778
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1779
|
+
|
1780
|
+
LATEX_HIDE_INDICES = NO
|
1781
|
+
|
1782
|
+
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
|
1783
|
+
# code with syntax highlighting in the LaTeX output.
|
1784
|
+
#
|
1785
|
+
# Note that which sources are shown also depends on other settings such as
|
1786
|
+
# SOURCE_BROWSER.
|
1787
|
+
# The default value is: NO.
|
1788
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1789
|
+
|
1790
|
+
LATEX_SOURCE_CODE = NO
|
1791
|
+
|
1792
|
+
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
|
1793
|
+
# bibliography, e.g. plainnat, or ieeetr. See
|
1794
|
+
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
|
1795
|
+
# The default value is: plain.
|
1796
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1797
|
+
|
1798
|
+
LATEX_BIB_STYLE = plain
|
1799
|
+
|
1800
|
+
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
|
1801
|
+
# page will contain the date and time when the page was generated. Setting this
|
1802
|
+
# to NO can help when comparing the output of multiple runs.
|
1803
|
+
# The default value is: NO.
|
1804
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
1805
|
+
|
1806
|
+
LATEX_TIMESTAMP = NO
|
1807
|
+
|
1808
|
+
#---------------------------------------------------------------------------
|
1809
|
+
# Configuration options related to the RTF output
|
1810
|
+
#---------------------------------------------------------------------------
|
1811
|
+
|
1812
|
+
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
|
1813
|
+
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
|
1814
|
+
# readers/editors.
|
1815
|
+
# The default value is: NO.
|
1816
|
+
|
1817
|
+
GENERATE_RTF = NO
|
1818
|
+
|
1819
|
+
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
|
1820
|
+
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
1821
|
+
# it.
|
1822
|
+
# The default directory is: rtf.
|
1823
|
+
# This tag requires that the tag GENERATE_RTF is set to YES.
|
1824
|
+
|
1825
|
+
RTF_OUTPUT = rtf
|
1826
|
+
|
1827
|
+
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
|
1828
|
+
# documents. This may be useful for small projects and may help to save some
|
1829
|
+
# trees in general.
|
1830
|
+
# The default value is: NO.
|
1831
|
+
# This tag requires that the tag GENERATE_RTF is set to YES.
|
1832
|
+
|
1833
|
+
COMPACT_RTF = NO
|
1834
|
+
|
1835
|
+
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
|
1836
|
+
# contain hyperlink fields. The RTF file will contain links (just like the HTML
|
1837
|
+
# output) instead of page references. This makes the output suitable for online
|
1838
|
+
# browsing using Word or some other Word compatible readers that support those
|
1839
|
+
# fields.
|
1840
|
+
#
|
1841
|
+
# Note: WordPad (write) and others do not support links.
|
1842
|
+
# The default value is: NO.
|
1843
|
+
# This tag requires that the tag GENERATE_RTF is set to YES.
|
1844
|
+
|
1845
|
+
RTF_HYPERLINKS = NO
|
1846
|
+
|
1847
|
+
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
|
1848
|
+
# file, i.e. a series of assignments. You only have to provide replacements,
|
1849
|
+
# missing definitions are set to their default value.
|
1850
|
+
#
|
1851
|
+
# See also section "Doxygen usage" for information on how to generate the
|
1852
|
+
# default style sheet that doxygen normally uses.
|
1853
|
+
# This tag requires that the tag GENERATE_RTF is set to YES.
|
1854
|
+
|
1855
|
+
RTF_STYLESHEET_FILE =
|
1856
|
+
|
1857
|
+
# Set optional variables used in the generation of an RTF document. Syntax is
|
1858
|
+
# similar to doxygen's config file. A template extensions file can be generated
|
1859
|
+
# using doxygen -e rtf extensionFile.
|
1860
|
+
# This tag requires that the tag GENERATE_RTF is set to YES.
|
1861
|
+
|
1862
|
+
RTF_EXTENSIONS_FILE =
|
1863
|
+
|
1864
|
+
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
|
1865
|
+
# with syntax highlighting in the RTF output.
|
1866
|
+
#
|
1867
|
+
# Note that which sources are shown also depends on other settings such as
|
1868
|
+
# SOURCE_BROWSER.
|
1869
|
+
# The default value is: NO.
|
1870
|
+
# This tag requires that the tag GENERATE_RTF is set to YES.
|
1871
|
+
|
1872
|
+
RTF_SOURCE_CODE = NO
|
1873
|
+
|
1874
|
+
#---------------------------------------------------------------------------
|
1875
|
+
# Configuration options related to the man page output
|
1876
|
+
#---------------------------------------------------------------------------
|
1877
|
+
|
1878
|
+
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
|
1879
|
+
# classes and files.
|
1880
|
+
# The default value is: NO.
|
1881
|
+
|
1882
|
+
GENERATE_MAN = NO
|
1883
|
+
|
1884
|
+
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
|
1885
|
+
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
1886
|
+
# it. A directory man3 will be created inside the directory specified by
|
1887
|
+
# MAN_OUTPUT.
|
1888
|
+
# The default directory is: man.
|
1889
|
+
# This tag requires that the tag GENERATE_MAN is set to YES.
|
1890
|
+
|
1891
|
+
MAN_OUTPUT = man
|
1892
|
+
|
1893
|
+
# The MAN_EXTENSION tag determines the extension that is added to the generated
|
1894
|
+
# man pages. In case the manual section does not start with a number, the number
|
1895
|
+
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
|
1896
|
+
# optional.
|
1897
|
+
# The default value is: .3.
|
1898
|
+
# This tag requires that the tag GENERATE_MAN is set to YES.
|
1899
|
+
|
1900
|
+
MAN_EXTENSION = .3
|
1901
|
+
|
1902
|
+
# The MAN_SUBDIR tag determines the name of the directory created within
|
1903
|
+
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
|
1904
|
+
# MAN_EXTENSION with the initial . removed.
|
1905
|
+
# This tag requires that the tag GENERATE_MAN is set to YES.
|
1906
|
+
|
1907
|
+
MAN_SUBDIR =
|
1908
|
+
|
1909
|
+
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
|
1910
|
+
# will generate one additional man file for each entity documented in the real
|
1911
|
+
# man page(s). These additional files only source the real man page, but without
|
1912
|
+
# them the man command would be unable to find the correct page.
|
1913
|
+
# The default value is: NO.
|
1914
|
+
# This tag requires that the tag GENERATE_MAN is set to YES.
|
1915
|
+
|
1916
|
+
MAN_LINKS = YES
|
1917
|
+
|
1918
|
+
#---------------------------------------------------------------------------
|
1919
|
+
# Configuration options related to the XML output
|
1920
|
+
#---------------------------------------------------------------------------
|
1921
|
+
|
1922
|
+
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
|
1923
|
+
# captures the structure of the code including all documentation.
|
1924
|
+
# The default value is: NO.
|
1925
|
+
|
1926
|
+
GENERATE_XML = NO
|
1927
|
+
|
1928
|
+
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
|
1929
|
+
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
1930
|
+
# it.
|
1931
|
+
# The default directory is: xml.
|
1932
|
+
# This tag requires that the tag GENERATE_XML is set to YES.
|
1933
|
+
|
1934
|
+
XML_OUTPUT = xml
|
1935
|
+
|
1936
|
+
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
|
1937
|
+
# listings (including syntax highlighting and cross-referencing information) to
|
1938
|
+
# the XML output. Note that enabling this will significantly increase the size
|
1939
|
+
# of the XML output.
|
1940
|
+
# The default value is: YES.
|
1941
|
+
# This tag requires that the tag GENERATE_XML is set to YES.
|
1942
|
+
|
1943
|
+
XML_PROGRAMLISTING = YES
|
1944
|
+
|
1945
|
+
#---------------------------------------------------------------------------
|
1946
|
+
# Configuration options related to the DOCBOOK output
|
1947
|
+
#---------------------------------------------------------------------------
|
1948
|
+
|
1949
|
+
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
|
1950
|
+
# that can be used to generate PDF.
|
1951
|
+
# The default value is: NO.
|
1952
|
+
|
1953
|
+
GENERATE_DOCBOOK = NO
|
1954
|
+
|
1955
|
+
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
|
1956
|
+
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
|
1957
|
+
# front of it.
|
1958
|
+
# The default directory is: docbook.
|
1959
|
+
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
|
1960
|
+
|
1961
|
+
DOCBOOK_OUTPUT = docbook
|
1962
|
+
|
1963
|
+
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
|
1964
|
+
# program listings (including syntax highlighting and cross-referencing
|
1965
|
+
# information) to the DOCBOOK output. Note that enabling this will significantly
|
1966
|
+
# increase the size of the DOCBOOK output.
|
1967
|
+
# The default value is: NO.
|
1968
|
+
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
|
1969
|
+
|
1970
|
+
DOCBOOK_PROGRAMLISTING = NO
|
1971
|
+
|
1972
|
+
#---------------------------------------------------------------------------
|
1973
|
+
# Configuration options for the AutoGen Definitions output
|
1974
|
+
#---------------------------------------------------------------------------
|
1975
|
+
|
1976
|
+
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
|
1977
|
+
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
|
1978
|
+
# the structure of the code including all documentation. Note that this feature
|
1979
|
+
# is still experimental and incomplete at the moment.
|
1980
|
+
# The default value is: NO.
|
1981
|
+
|
1982
|
+
GENERATE_AUTOGEN_DEF = NO
|
1983
|
+
|
1984
|
+
#---------------------------------------------------------------------------
|
1985
|
+
# Configuration options related to the Perl module output
|
1986
|
+
#---------------------------------------------------------------------------
|
1987
|
+
|
1988
|
+
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
|
1989
|
+
# file that captures the structure of the code including all documentation.
|
1990
|
+
#
|
1991
|
+
# Note that this feature is still experimental and incomplete at the moment.
|
1992
|
+
# The default value is: NO.
|
1993
|
+
|
1994
|
+
GENERATE_PERLMOD = NO
|
1995
|
+
|
1996
|
+
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
|
1997
|
+
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
|
1998
|
+
# output from the Perl module output.
|
1999
|
+
# The default value is: NO.
|
2000
|
+
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
|
2001
|
+
|
2002
|
+
PERLMOD_LATEX = NO
|
2003
|
+
|
2004
|
+
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
|
2005
|
+
# formatted so it can be parsed by a human reader. This is useful if you want to
|
2006
|
+
# understand what is going on. On the other hand, if this tag is set to NO, the
|
2007
|
+
# size of the Perl module output will be much smaller and Perl will parse it
|
2008
|
+
# just the same.
|
2009
|
+
# The default value is: YES.
|
2010
|
+
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
|
2011
|
+
|
2012
|
+
PERLMOD_PRETTY = YES
|
2013
|
+
|
2014
|
+
# The names of the make variables in the generated doxyrules.make file are
|
2015
|
+
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
|
2016
|
+
# so different doxyrules.make files included by the same Makefile don't
|
2017
|
+
# overwrite each other's variables.
|
2018
|
+
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
|
2019
|
+
|
2020
|
+
PERLMOD_MAKEVAR_PREFIX =
|
2021
|
+
|
2022
|
+
#---------------------------------------------------------------------------
|
2023
|
+
# Configuration options related to the preprocessor
|
2024
|
+
#---------------------------------------------------------------------------
|
2025
|
+
|
2026
|
+
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
|
2027
|
+
# C-preprocessor directives found in the sources and include files.
|
2028
|
+
# The default value is: YES.
|
2029
|
+
|
2030
|
+
ENABLE_PREPROCESSING = YES
|
2031
|
+
|
2032
|
+
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
|
2033
|
+
# in the source code. If set to NO, only conditional compilation will be
|
2034
|
+
# performed. Macro expansion can be done in a controlled way by setting
|
2035
|
+
# EXPAND_ONLY_PREDEF to YES.
|
2036
|
+
# The default value is: NO.
|
2037
|
+
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
2038
|
+
|
2039
|
+
MACRO_EXPANSION = YES
|
2040
|
+
|
2041
|
+
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
|
2042
|
+
# the macro expansion is limited to the macros specified with the PREDEFINED and
|
2043
|
+
# EXPAND_AS_DEFINED tags.
|
2044
|
+
# The default value is: NO.
|
2045
|
+
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
2046
|
+
|
2047
|
+
EXPAND_ONLY_PREDEF = YES
|
2048
|
+
|
2049
|
+
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
|
2050
|
+
# INCLUDE_PATH will be searched if a #include is found.
|
2051
|
+
# The default value is: YES.
|
2052
|
+
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
2053
|
+
|
2054
|
+
SEARCH_INCLUDES = YES
|
2055
|
+
|
2056
|
+
# The INCLUDE_PATH tag can be used to specify one or more directories that
|
2057
|
+
# contain include files that are not input files but should be processed by the
|
2058
|
+
# preprocessor.
|
2059
|
+
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
|
2060
|
+
|
2061
|
+
INCLUDE_PATH =
|
2062
|
+
|
2063
|
+
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
2064
|
+
# patterns (like *.h and *.hpp) to filter out the header-files in the
|
2065
|
+
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
|
2066
|
+
# used.
|
2067
|
+
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
2068
|
+
|
2069
|
+
INCLUDE_FILE_PATTERNS =
|
2070
|
+
|
2071
|
+
# The PREDEFINED tag can be used to specify one or more macro names that are
|
2072
|
+
# defined before the preprocessor is started (similar to the -D option of e.g.
|
2073
|
+
# gcc). The argument of the tag is a list of macros of the form: name or
|
2074
|
+
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
|
2075
|
+
# is assumed. To prevent a macro definition from being undefined via #undef or
|
2076
|
+
# recursively expanded use the := operator instead of the = operator.
|
2077
|
+
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
2078
|
+
|
2079
|
+
PREDEFINED = LCB_CREATE_V2_FIELDS= \
|
2080
|
+
__LCB_DOXYGEN__ \
|
2081
|
+
LCB_CMDRESP_LABEL \
|
2082
|
+
LCB_DEPRECATED \
|
2083
|
+
LIBCOUCHBASE_API \
|
2084
|
+
LCB_DEPR_API=/**@deprecated*/ \
|
2085
|
+
LCB__HKFIELDS \
|
2086
|
+
LCB_DEPR_CTORS_GET \
|
2087
|
+
LCB_DEPR_CTORS_RGET \
|
2088
|
+
LCB_DEPR_CTORS_UNL \
|
2089
|
+
LCB_DEPR_CTORS_STORE \
|
2090
|
+
LCB_DEPR_CTORS_ARITH \
|
2091
|
+
LCB_DEPR_CTORS_OBS \
|
2092
|
+
LCB_DEPR_CTORS_RM \
|
2093
|
+
LCB_DEPR_CTORS_STATS \
|
2094
|
+
LCB_DEPR_CTORS_VERBOSITY \
|
2095
|
+
LCB_DEPR_CTORS_VERSIONS \
|
2096
|
+
LCB_DEPR_CTORS_FLUSH \
|
2097
|
+
LCB_DEPR_CTORS_HTTP \
|
2098
|
+
LCB_DEPR_CTORS_CRST \
|
2099
|
+
LCB_TRACING
|
2100
|
+
|
2101
|
+
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
|
2102
|
+
# tag can be used to specify a list of macro names that should be expanded. The
|
2103
|
+
# macro definition that is found in the sources will be used. Use the PREDEFINED
|
2104
|
+
# tag if you want to use a different macro definition that overrules the
|
2105
|
+
# definition found in the source code.
|
2106
|
+
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
2107
|
+
|
2108
|
+
EXPAND_AS_DEFINED = LCB_XERR \
|
2109
|
+
X \
|
2110
|
+
LCB_CMD_BASE \
|
2111
|
+
LCB_OBSERVE_FIELDS_COMMON \
|
2112
|
+
LCB_RESP_BASE \
|
2113
|
+
LCB_CMD_BASE \
|
2114
|
+
LCB_RESP_SERVER_FIELDS
|
2115
|
+
|
2116
|
+
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
|
2117
|
+
# remove all references to function-like macros that are alone on a line, have
|
2118
|
+
# an all uppercase name, and do not end with a semicolon. Such function macros
|
2119
|
+
# are typically used for boiler-plate code, and will confuse the parser if not
|
2120
|
+
# removed.
|
2121
|
+
# The default value is: YES.
|
2122
|
+
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
2123
|
+
|
2124
|
+
SKIP_FUNCTION_MACROS = YES
|
2125
|
+
|
2126
|
+
#---------------------------------------------------------------------------
|
2127
|
+
# Configuration options related to external references
|
2128
|
+
#---------------------------------------------------------------------------
|
2129
|
+
|
2130
|
+
# The TAGFILES tag can be used to specify one or more tag files. For each tag
|
2131
|
+
# file the location of the external documentation should be added. The format of
|
2132
|
+
# a tag file without this location is as follows:
|
2133
|
+
# TAGFILES = file1 file2 ...
|
2134
|
+
# Adding location for the tag files is done as follows:
|
2135
|
+
# TAGFILES = file1=loc1 "file2 = loc2" ...
|
2136
|
+
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
|
2137
|
+
# section "Linking to external documentation" for more information about the use
|
2138
|
+
# of tag files.
|
2139
|
+
# Note: Each tag file must have a unique name (where the name does NOT include
|
2140
|
+
# the path). If a tag file is not located in the directory in which doxygen is
|
2141
|
+
# run, you must also specify the path to the tagfile here.
|
2142
|
+
|
2143
|
+
TAGFILES =
|
2144
|
+
|
2145
|
+
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
|
2146
|
+
# tag file that is based on the input files it reads. See section "Linking to
|
2147
|
+
# external documentation" for more information about the usage of tag files.
|
2148
|
+
|
2149
|
+
GENERATE_TAGFILE =
|
2150
|
+
|
2151
|
+
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
|
2152
|
+
# the class index. If set to NO, only the inherited external classes will be
|
2153
|
+
# listed.
|
2154
|
+
# The default value is: NO.
|
2155
|
+
|
2156
|
+
ALLEXTERNALS = NO
|
2157
|
+
|
2158
|
+
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
|
2159
|
+
# in the modules index. If set to NO, only the current project's groups will be
|
2160
|
+
# listed.
|
2161
|
+
# The default value is: YES.
|
2162
|
+
|
2163
|
+
EXTERNAL_GROUPS = YES
|
2164
|
+
|
2165
|
+
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
|
2166
|
+
# the related pages index. If set to NO, only the current project's pages will
|
2167
|
+
# be listed.
|
2168
|
+
# The default value is: YES.
|
2169
|
+
|
2170
|
+
EXTERNAL_PAGES = YES
|
2171
|
+
|
2172
|
+
# The PERL_PATH should be the absolute path and name of the perl script
|
2173
|
+
# interpreter (i.e. the result of 'which perl').
|
2174
|
+
# The default file (with absolute path) is: /usr/bin/perl.
|
2175
|
+
|
2176
|
+
PERL_PATH = /usr/bin/perl
|
2177
|
+
|
2178
|
+
#---------------------------------------------------------------------------
|
2179
|
+
# Configuration options related to the dot tool
|
2180
|
+
#---------------------------------------------------------------------------
|
2181
|
+
|
2182
|
+
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
|
2183
|
+
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
|
2184
|
+
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
|
2185
|
+
# disabled, but it is recommended to install and use dot, since it yields more
|
2186
|
+
# powerful graphs.
|
2187
|
+
# The default value is: YES.
|
2188
|
+
|
2189
|
+
CLASS_DIAGRAMS = YES
|
2190
|
+
|
2191
|
+
# You can define message sequence charts within doxygen comments using the \msc
|
2192
|
+
# command. Doxygen will then run the mscgen tool (see:
|
2193
|
+
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
|
2194
|
+
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
|
2195
|
+
# the mscgen tool resides. If left empty the tool is assumed to be found in the
|
2196
|
+
# default search path.
|
2197
|
+
|
2198
|
+
MSCGEN_PATH =
|
2199
|
+
|
2200
|
+
# You can include diagrams made with dia in doxygen documentation. Doxygen will
|
2201
|
+
# then run dia to produce the diagram and insert it in the documentation. The
|
2202
|
+
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
|
2203
|
+
# If left empty dia is assumed to be found in the default search path.
|
2204
|
+
|
2205
|
+
DIA_PATH =
|
2206
|
+
|
2207
|
+
# If set to YES the inheritance and collaboration graphs will hide inheritance
|
2208
|
+
# and usage relations if the target is undocumented or is not a class.
|
2209
|
+
# The default value is: YES.
|
2210
|
+
|
2211
|
+
HIDE_UNDOC_RELATIONS = YES
|
2212
|
+
|
2213
|
+
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
2214
|
+
# available from the path. This tool is part of Graphviz (see:
|
2215
|
+
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
|
2216
|
+
# Bell Labs. The other options in this section have no effect if this option is
|
2217
|
+
# set to NO
|
2218
|
+
# The default value is: NO.
|
2219
|
+
|
2220
|
+
HAVE_DOT = NO
|
2221
|
+
|
2222
|
+
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
|
2223
|
+
# to run in parallel. When set to 0 doxygen will base this on the number of
|
2224
|
+
# processors available in the system. You can set it explicitly to a value
|
2225
|
+
# larger than 0 to get control over the balance between CPU load and processing
|
2226
|
+
# speed.
|
2227
|
+
# Minimum value: 0, maximum value: 32, default value: 0.
|
2228
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2229
|
+
|
2230
|
+
DOT_NUM_THREADS = 0
|
2231
|
+
|
2232
|
+
# When you want a differently looking font in the dot files that doxygen
|
2233
|
+
# generates you can specify the font name using DOT_FONTNAME. You need to make
|
2234
|
+
# sure dot is able to find the font, which can be done by putting it in a
|
2235
|
+
# standard location or by setting the DOTFONTPATH environment variable or by
|
2236
|
+
# setting DOT_FONTPATH to the directory containing the font.
|
2237
|
+
# The default value is: Helvetica.
|
2238
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2239
|
+
|
2240
|
+
DOT_FONTNAME = Helvetica
|
2241
|
+
|
2242
|
+
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
|
2243
|
+
# dot graphs.
|
2244
|
+
# Minimum value: 4, maximum value: 24, default value: 10.
|
2245
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2246
|
+
|
2247
|
+
DOT_FONTSIZE = 10
|
2248
|
+
|
2249
|
+
# By default doxygen will tell dot to use the default font as specified with
|
2250
|
+
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
|
2251
|
+
# the path where dot can find it using this tag.
|
2252
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2253
|
+
|
2254
|
+
DOT_FONTPATH =
|
2255
|
+
|
2256
|
+
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
|
2257
|
+
# each documented class showing the direct and indirect inheritance relations.
|
2258
|
+
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
|
2259
|
+
# The default value is: YES.
|
2260
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2261
|
+
|
2262
|
+
CLASS_GRAPH = YES
|
2263
|
+
|
2264
|
+
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
|
2265
|
+
# graph for each documented class showing the direct and indirect implementation
|
2266
|
+
# dependencies (inheritance, containment, and class references variables) of the
|
2267
|
+
# class with other documented classes.
|
2268
|
+
# The default value is: YES.
|
2269
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2270
|
+
|
2271
|
+
COLLABORATION_GRAPH = YES
|
2272
|
+
|
2273
|
+
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
|
2274
|
+
# groups, showing the direct groups dependencies.
|
2275
|
+
# The default value is: YES.
|
2276
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2277
|
+
|
2278
|
+
GROUP_GRAPHS = YES
|
2279
|
+
|
2280
|
+
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
|
2281
|
+
# collaboration diagrams in a style similar to the OMG's Unified Modeling
|
2282
|
+
# Language.
|
2283
|
+
# The default value is: NO.
|
2284
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2285
|
+
|
2286
|
+
UML_LOOK = NO
|
2287
|
+
|
2288
|
+
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
|
2289
|
+
# class node. If there are many fields or methods and many nodes the graph may
|
2290
|
+
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
|
2291
|
+
# number of items for each type to make the size more manageable. Set this to 0
|
2292
|
+
# for no limit. Note that the threshold may be exceeded by 50% before the limit
|
2293
|
+
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
|
2294
|
+
# but if the number exceeds 15, the total amount of fields shown is limited to
|
2295
|
+
# 10.
|
2296
|
+
# Minimum value: 0, maximum value: 100, default value: 10.
|
2297
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2298
|
+
|
2299
|
+
UML_LIMIT_NUM_FIELDS = 10
|
2300
|
+
|
2301
|
+
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
|
2302
|
+
# collaboration graphs will show the relations between templates and their
|
2303
|
+
# instances.
|
2304
|
+
# The default value is: NO.
|
2305
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2306
|
+
|
2307
|
+
TEMPLATE_RELATIONS = NO
|
2308
|
+
|
2309
|
+
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
|
2310
|
+
# YES then doxygen will generate a graph for each documented file showing the
|
2311
|
+
# direct and indirect include dependencies of the file with other documented
|
2312
|
+
# files.
|
2313
|
+
# The default value is: YES.
|
2314
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2315
|
+
|
2316
|
+
INCLUDE_GRAPH = YES
|
2317
|
+
|
2318
|
+
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
|
2319
|
+
# set to YES then doxygen will generate a graph for each documented file showing
|
2320
|
+
# the direct and indirect include dependencies of the file with other documented
|
2321
|
+
# files.
|
2322
|
+
# The default value is: YES.
|
2323
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2324
|
+
|
2325
|
+
INCLUDED_BY_GRAPH = YES
|
2326
|
+
|
2327
|
+
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
|
2328
|
+
# dependency graph for every global function or class method.
|
2329
|
+
#
|
2330
|
+
# Note that enabling this option will significantly increase the time of a run.
|
2331
|
+
# So in most cases it will be better to enable call graphs for selected
|
2332
|
+
# functions only using the \callgraph command. Disabling a call graph can be
|
2333
|
+
# accomplished by means of the command \hidecallgraph.
|
2334
|
+
# The default value is: NO.
|
2335
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2336
|
+
|
2337
|
+
CALL_GRAPH = NO
|
2338
|
+
|
2339
|
+
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
|
2340
|
+
# dependency graph for every global function or class method.
|
2341
|
+
#
|
2342
|
+
# Note that enabling this option will significantly increase the time of a run.
|
2343
|
+
# So in most cases it will be better to enable caller graphs for selected
|
2344
|
+
# functions only using the \callergraph command. Disabling a caller graph can be
|
2345
|
+
# accomplished by means of the command \hidecallergraph.
|
2346
|
+
# The default value is: NO.
|
2347
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2348
|
+
|
2349
|
+
CALLER_GRAPH = NO
|
2350
|
+
|
2351
|
+
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
|
2352
|
+
# hierarchy of all classes instead of a textual one.
|
2353
|
+
# The default value is: YES.
|
2354
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2355
|
+
|
2356
|
+
GRAPHICAL_HIERARCHY = YES
|
2357
|
+
|
2358
|
+
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
|
2359
|
+
# dependencies a directory has on other directories in a graphical way. The
|
2360
|
+
# dependency relations are determined by the #include relations between the
|
2361
|
+
# files in the directories.
|
2362
|
+
# The default value is: YES.
|
2363
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2364
|
+
|
2365
|
+
DIRECTORY_GRAPH = YES
|
2366
|
+
|
2367
|
+
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
2368
|
+
# generated by dot. For an explanation of the image formats see the section
|
2369
|
+
# output formats in the documentation of the dot tool (Graphviz (see:
|
2370
|
+
# http://www.graphviz.org/)).
|
2371
|
+
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
|
2372
|
+
# to make the SVG files visible in IE 9+ (other browsers do not have this
|
2373
|
+
# requirement).
|
2374
|
+
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
|
2375
|
+
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
|
2376
|
+
# png:gdiplus:gdiplus.
|
2377
|
+
# The default value is: png.
|
2378
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2379
|
+
|
2380
|
+
DOT_IMAGE_FORMAT = png
|
2381
|
+
|
2382
|
+
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
2383
|
+
# enable generation of interactive SVG images that allow zooming and panning.
|
2384
|
+
#
|
2385
|
+
# Note that this requires a modern browser other than Internet Explorer. Tested
|
2386
|
+
# and working are Firefox, Chrome, Safari, and Opera.
|
2387
|
+
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
|
2388
|
+
# the SVG files visible. Older versions of IE do not have SVG support.
|
2389
|
+
# The default value is: NO.
|
2390
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2391
|
+
|
2392
|
+
INTERACTIVE_SVG = YES
|
2393
|
+
|
2394
|
+
# The DOT_PATH tag can be used to specify the path where the dot tool can be
|
2395
|
+
# found. If left blank, it is assumed the dot tool can be found in the path.
|
2396
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2397
|
+
|
2398
|
+
DOT_PATH =
|
2399
|
+
|
2400
|
+
# The DOTFILE_DIRS tag can be used to specify one or more directories that
|
2401
|
+
# contain dot files that are included in the documentation (see the \dotfile
|
2402
|
+
# command).
|
2403
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2404
|
+
|
2405
|
+
DOTFILE_DIRS =
|
2406
|
+
|
2407
|
+
# The MSCFILE_DIRS tag can be used to specify one or more directories that
|
2408
|
+
# contain msc files that are included in the documentation (see the \mscfile
|
2409
|
+
# command).
|
2410
|
+
|
2411
|
+
MSCFILE_DIRS =
|
2412
|
+
|
2413
|
+
# The DIAFILE_DIRS tag can be used to specify one or more directories that
|
2414
|
+
# contain dia files that are included in the documentation (see the \diafile
|
2415
|
+
# command).
|
2416
|
+
|
2417
|
+
DIAFILE_DIRS =
|
2418
|
+
|
2419
|
+
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
|
2420
|
+
# path where java can find the plantuml.jar file. If left blank, it is assumed
|
2421
|
+
# PlantUML is not used or called during a preprocessing step. Doxygen will
|
2422
|
+
# generate a warning when it encounters a \startuml command in this case and
|
2423
|
+
# will not generate output for the diagram.
|
2424
|
+
|
2425
|
+
PLANTUML_JAR_PATH =
|
2426
|
+
|
2427
|
+
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
|
2428
|
+
# configuration file for plantuml.
|
2429
|
+
|
2430
|
+
PLANTUML_CFG_FILE =
|
2431
|
+
|
2432
|
+
# When using plantuml, the specified paths are searched for files specified by
|
2433
|
+
# the !include statement in a plantuml block.
|
2434
|
+
|
2435
|
+
PLANTUML_INCLUDE_PATH =
|
2436
|
+
|
2437
|
+
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
|
2438
|
+
# that will be shown in the graph. If the number of nodes in a graph becomes
|
2439
|
+
# larger than this value, doxygen will truncate the graph, which is visualized
|
2440
|
+
# by representing a node as a red box. Note that doxygen if the number of direct
|
2441
|
+
# children of the root node in a graph is already larger than
|
2442
|
+
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
|
2443
|
+
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
|
2444
|
+
# Minimum value: 0, maximum value: 10000, default value: 50.
|
2445
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2446
|
+
|
2447
|
+
DOT_GRAPH_MAX_NODES = 50
|
2448
|
+
|
2449
|
+
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
|
2450
|
+
# generated by dot. A depth value of 3 means that only nodes reachable from the
|
2451
|
+
# root by following a path via at most 3 edges will be shown. Nodes that lay
|
2452
|
+
# further from the root node will be omitted. Note that setting this option to 1
|
2453
|
+
# or 2 may greatly reduce the computation time needed for large code bases. Also
|
2454
|
+
# note that the size of a graph can be further restricted by
|
2455
|
+
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
|
2456
|
+
# Minimum value: 0, maximum value: 1000, default value: 0.
|
2457
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2458
|
+
|
2459
|
+
MAX_DOT_GRAPH_DEPTH = 0
|
2460
|
+
|
2461
|
+
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
2462
|
+
# background. This is disabled by default, because dot on Windows does not seem
|
2463
|
+
# to support this out of the box.
|
2464
|
+
#
|
2465
|
+
# Warning: Depending on the platform used, enabling this option may lead to
|
2466
|
+
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
|
2467
|
+
# read).
|
2468
|
+
# The default value is: NO.
|
2469
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2470
|
+
|
2471
|
+
DOT_TRANSPARENT = NO
|
2472
|
+
|
2473
|
+
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
|
2474
|
+
# files in one run (i.e. multiple -o and -T options on the command line). This
|
2475
|
+
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
|
2476
|
+
# this, this feature is disabled by default.
|
2477
|
+
# The default value is: NO.
|
2478
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2479
|
+
|
2480
|
+
DOT_MULTI_TARGETS = NO
|
2481
|
+
|
2482
|
+
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
|
2483
|
+
# explaining the meaning of the various boxes and arrows in the dot generated
|
2484
|
+
# graphs.
|
2485
|
+
# The default value is: YES.
|
2486
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2487
|
+
|
2488
|
+
GENERATE_LEGEND = YES
|
2489
|
+
|
2490
|
+
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
|
2491
|
+
# files that are used to generate the various graphs.
|
2492
|
+
# The default value is: YES.
|
2493
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
2494
|
+
|
2495
|
+
DOT_CLEANUP = YES
|