diff --git a/.circleci/config.yml b/.circleci/config.yml index f3207a2c2a97..601a3baab339 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,11 +1,12 @@ -# TODO(mattklein123): See if there is a way to put build SHA into a variable. -# In the meantime, it's required to edit the SHA in this file as well as envoy_build_sha.sh. +references: + envoy-build-image: &envoy-build-image + envoyproxy/envoy-build:516cdcd55326648978f8db1fe3a774ec759f5a13 version: 2 jobs: release: docker: - - image: envoyproxy/envoy-build:516cdcd55326648978f8db1fe3a774ec759f5a13 + - image: *envoy-build-image resource_class: xlarge working_directory: /source steps: @@ -16,7 +17,7 @@ jobs: - run: ci/docker_tag.sh asan: docker: - - image: envoyproxy/envoy-build:516cdcd55326648978f8db1fe3a774ec759f5a13 + - image: *envoy-build-image resource_class: xlarge working_directory: /source steps: @@ -24,7 +25,7 @@ jobs: - run: ci/do_circle_ci.sh bazel.asan tsan: docker: - - image: envoyproxy/envoy-build:516cdcd55326648978f8db1fe3a774ec759f5a13 + - image: *envoy-build-image resource_class: xlarge working_directory: /source steps: @@ -32,7 +33,7 @@ jobs: - run: ci/do_circle_ci.sh bazel.tsan coverage: docker: - - image: envoyproxy/envoy-build:516cdcd55326648978f8db1fe3a774ec759f5a13 + - image: *envoy-build-image resource_class: xlarge working_directory: /source steps: @@ -43,7 +44,7 @@ jobs: path: /build/envoy/generated/coverage format: docker: - - image: envoyproxy/envoy-build:516cdcd55326648978f8db1fe3a774ec759f5a13 + - image: *envoy-build-image resource_class: small working_directory: /source steps: @@ -62,13 +63,13 @@ jobs: - run: ci/build_container/docker_push.sh docs: docker: - - image: circleci/python:2.7 - resource_class: small + - image: *envoy-build-image + resource_class: xlarge + working_directory: /source steps: - checkout - - run: docs/build.sh - add_ssh_keys - - run: docs/publish.sh + - run: ci/do_circle_ci.sh docs mac: macos: xcode: "8.3.3" @@ -91,5 +92,8 @@ workflows: - coverage - format - build_image - - docs + - docs: + filters: + tags: + only: /^v.*/ - mac diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index deb4eb37da31..1f365fba5c6a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ maximize the chances of your PR being merged. # Communication -* Before starting work on a major feature, please reach out to us via GitHub, Gitter, +* Before starting work on a major feature, please reach out to us via GitHub, Slack, email, etc. We will make sure no one else is already working on it and ask you to open a GitHub issue. * A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or @@ -98,7 +98,7 @@ maximize the chances of your PR being merged. organization different from the PR author.* E.g., if Lyft authors a PR, at least one approver should be from an organization other than Lyft. This helps us make sure that we aren't putting organization specific shortcuts into the code. -* If there is a question on who should review a PR please discuss in Gitter. +* If there is a question on who should review a PR please discuss in Slack. * Anyone is welcome to review any PR that they want, whether they are a committer or not. * Please **clean up the commit message** before merging. By default, GitHub fills the squash merge commit message with every individual commit from the PR. Generally, we want a commit message diff --git a/DEPRECATED.md b/DEPRECATED.md index d4e577b76b60..80c0e71acfb5 100644 --- a/DEPRECATED.md +++ b/DEPRECATED.md @@ -5,6 +5,16 @@ As of release 1.3.0, Envoy will follow a The following features have been DEPRECATED and will be removed in the specified release cycle. +## Version 1.5.0 + +* The outlier detection `ejections_total` stats counter has been deprecated and not replaced. Monitor + the individual `ejections_detected_*` counters for the detectors of interest, or + `ejections_enforced_total` for the total number of ejections that actually occurred. +* The outlier detection `ejections_consecutive_5xx` stats counter has been deprecated in favour of + `ejections_detected_consecutive_5xx` and `ejections_enforced_consecutive_5xx`. +* The outlier detection `ejections_success_rate` stats counter has been deprecated in favour of + `ejections_detected_success_rate` and `ejections_enforced_success_rate`. + ## Version 1.4.0 * Config option `statsd_local_udp_port` has been deprecated and has been replaced with diff --git a/DEVELOPER.md b/DEVELOPER.md index b5c32606f557..f4f737e8fc78 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -6,7 +6,7 @@ To get started building Envoy locally, see the [Bazel quick start](https://githu Below is a list of additional documentation to aid the development process: -- [General build and installation documentation](https://envoyproxy.github.io/envoy/install/install.html) +- [General build and installation documentation](https://www.envoyproxy.io/docs/envoy/latest/install/install) - [Building and testing Envoy with Bazel](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 4d9ee8ed4da5..c00c5517114e 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -1,30 +1,63 @@ -# Process for becoming a committer +# Process for becoming a maintainer -## Your organization is not yet a committer +## Your organization is not yet a maintainer -* Express interest to the senior committers that your organization is interested in becoming a - committer. Becoming a committer generally means that you are going to be spending substantial +* Express interest to the senior maintainers that your organization is interested in becoming a + maintainer. Becoming a maintainer generally means that you are going to be spending substantial time (>25%) on Envoy for the foreseeable future. You should have domain expertise and be extremely - proficient in C++. Ultimately your goal is to become a senior committer that will represent your + proficient in C++. Ultimately your goal is to become a senior maintainer that will represent your organization. * We will expect you to start contributing increasingly complicated PRs, under the guidance - of the existing senior committers. + of the existing senior maintainers. * We may ask you to do some PRs from our backlog. * As you gain experience with the code base and our standards, we will ask you to do code reviews - for incoming PRs (i.e., all committers are expected to shoulder a proportional share of + for incoming PRs (i.e., all maintainers are expected to shoulder a proportional share of community reviews). * After a period of approximately 2-3 months of working together and making sure we see eye to eye, - the existing senior committers will confer and decide whether to grant commit status or not. We - make no guarantees on the length of time this will take, but 2-3 months is the approximate + the existing senior maintainers will confer and decide whether to grant maintainer status or not. + We make no guarantees on the length of time this will take, but 2-3 months is the approximate goal. -## Your organization is currently a committer +## Your organization is currently a maintainer -* First decide whether your organization really needs more people with commit access. Valid reasons - are "blast radius", a large organization that is working on multiple unrelated projects, etc. -* Contact a senior committer for your organization and express interest. -* Start doing PRs and code reviews under the guidance of your senior committer. -* After a period of 1-2 months the existing senior committers will discuss granting "standard" - commit access. -* "Standard" commit access can be upgraded to "senior" commit access after another 1-2 months of - work and another conference of the existing senior committers. +* First decide whether your organization really needs more people with maintainer access. Valid + reasons are "blast radius", a large organization that is working on multiple unrelated projects, + etc. +* Contact a senior maintainer for your organization and express interest. +* Start doing PRs and code reviews under the guidance of your senior maintainer. +* After a period of 1-2 months the existing senior maintainers will discuss granting "standard" + maintainer access. +* "Standard" maintainer access can be upgraded to "senior" maintainer access aft + +## Maintainer responsibilities + +* Monitor email aliases. +* Monitor Slack (delayed response is perfectly acceptable). +* Triage GitHub issues and perform pull request reviews for other maintainers and the community. +* In general continue to be willing to spend at least 25% of ones time working on Envoy (~1.25 + business days per week). +* Note that currently the above is performed by all maintainers in a best-effort/haphazard way. In + the future we may decide to move to an "on-call" rotation. + +## When does a maintainer lose maintainer status + +If a maintainer is no longer interested or cannot perform the maintainer duties listed above, they +should volunteer to be moved to emeritus status. In extreme cases this can also occur by a vote of +the maintainers per the voting process below. + +# Conflict resolution and voting + +In general, we prefer that technical issues and maintainer membership are amicably worked out +between the persons involved. If a dispute cannot be decided independently, the maintainers can be +called in to decide an issue. If the maintainers themselves cannot decide an issue, the issue will +be resolved by voting. The voting process is a simple majority in which each senior maintainer +receives two votes and each normal maintainer receives one vote. + +# Adding new projects to the envoyproxy GitHub organization + +New projects will be added to the envoyproxy organization via GitHub issue discussion in one of the +existing projects in the organization. Once sufficient discussion has taken place (~3-5 business +days but depending on the volume of conversation), the maintainers of *the project where the issue +was opened* (since different projects in the organization may have different maintainers) will +decide whether the new project should be added. See the section above on voting if the maintainers +cannot easily decide. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index cc2d155d858a..dc6b11223329 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -33,7 +33,7 @@ privacy concerns, sanitize the data prior to sharing the tarball/pasting. *Admin and Stats Output*: >Include the admin output for the following endpoints: /stats, /clusters, /routes, /server_info. For more information, refer to the -[admin endpoint documentation.](https://envoyproxy.github.io/envoy/operations/admin.html) +[admin endpoint documentation.](https://www.envoyproxy.io/docs/envoy/latest/operations/admin) >**Note**: If there are privacy concerns, sanitize the data prior to sharing. diff --git a/OWNERS.md b/OWNERS.md index 06237610718c..8422cc28d0d9 100644 --- a/OWNERS.md +++ b/OWNERS.md @@ -1,12 +1,12 @@ * See [CONTRIBUTING.md](CONTRIBUTING.md) for general contribution guidelines. * See [GOVERNANCE.md](GOVERNANCE.md) for governance guidelines. -# Senior committers +# Senior maintainers * Matt Klein ([mattklein123](https://github.com/mattklein123)) (mklein@lyft.com) * Harvey Tuch ([htuch](https://github.com/htuch)) (htuch@google.com) -# Committers +# Maintainers * Constance Caramanolis ([ccaraman](https://github.com/ccaraman)) (ccaramanolis@lyft.com) * Jose Nino ([junr03](https://github.com/junr03)) (jnino@lyft.com) @@ -14,7 +14,7 @@ * Alyssa Wilk ([alyssawilk](https://github.com/alyssawilk)) (alyssar@google.com) * Daniel Hochman ([danielhochman](https://github.com/danielhochman)) (dhochman@lyft.com) -# Emeritus committers +# Emeritus maintainers * Roman Dzhabarov ([RomanDzhabarov](https://github.com/RomanDzhabarov)) (rdzhabarov@lyft.com) * Bill Gallagher ([wgallagher](https://github.com/wgallagher)) (bgallagher@lyft.com) diff --git a/README.md b/README.md index 8a7e0b082fc1..4f93ef1f8b66 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![Envoy Logo](https://github.com/envoyproxy/artwork/blob/master/PNG/Envoy_Logo_Final_PANTONE.png) -[C++ L7 proxy and communication bus](https://envoyproxy.github.io/) +[C++ L7 proxy and communication bus](https://www.envoyproxy.io/) Envoy is hosted by the [Cloud Native Computing Foundation](https://cncf.io) (CNCF). If you are a company that wants to help shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented, consider joining the CNCF. For details about who's involved and how Envoy plays a role, read the CNCF [announcement](https://www.cncf.io/blog/2017/09/13/cncf-hosts-envoy/). @@ -9,7 +9,7 @@ Envoy is hosted by the [Cloud Native Computing Foundation](https://cncf.io) (CNC ## Documentation -* [Official documentation](https://envoyproxy.github.io). +* [Official documentation](https://www.envoyproxy.io/). * Watch [a video overview of Envoy](https://www.youtube.com/watch?v=RVZX4CwKhGE) ([transcript](https://www.microservices.com/talks/lyfts-envoy-monolith-service-mesh-matt-klein/)) to find out more about the origin story and design philosophy of Envoy. diff --git a/bazel/README.md b/bazel/README.md index a52dedcb468e..10e030792bfd 100644 --- a/bazel/README.md +++ b/bazel/README.md @@ -3,11 +3,11 @@ ## Production environments To build Envoy with Bazel in a production environment, where the [Envoy -dependencies](https://envoyproxy.github.io/envoy/install/requirements.html) are typically +dependencies](https://www.envoyproxy.io/docs/envoy/latest/install/requirements) are typically independently sourced, the following steps should be followed: 1. [Install Bazel](https://bazel.build/versions/master/docs/install.html) in your environment. -2. Configure, build and/or install the [Envoy dependencies](https://envoyproxy.github.io/envoy/install/requirements.html). +2. Configure, build and/or install the [Envoy dependencies](https://www.envoyproxy.io/docs/envoy/latest/install/requirements). 3. Configure a Bazel [WORKSPACE](https://bazel.build/versions/master/docs/be/workspace.html) to point Bazel at the Envoy dependencies. An example is provided in the CI Docker image [WORKSPACE](https://github.com/envoyproxy/envoy/blob/master/ci/WORKSPACE) and corresponding @@ -33,6 +33,11 @@ On Ubuntu, run the following commands: apt-get install realpath ``` +On Fedora (maybe also other red hat distros), run the following: +``` +dnf install cmake libtool libstdc++ +``` + On OS X, you'll need to install several dependencies. This can be accomplished via Homebrew: ``` brew install coreutils # for realpath diff --git a/bazel/external/jinja.BUILD b/bazel/external/jinja.BUILD new file mode 100644 index 000000000000..285a1aa988cb --- /dev/null +++ b/bazel/external/jinja.BUILD @@ -0,0 +1,6 @@ +py_library( + name = "jinja2", + srcs = glob(["jinja2/**/*.py"]), + visibility = ["//visibility:public"], + deps = ["@com_github_pallets_markupsafe//:markupsafe"], +) diff --git a/bazel/external/markupsafe.BUILD b/bazel/external/markupsafe.BUILD new file mode 100644 index 000000000000..76e9b3ab9646 --- /dev/null +++ b/bazel/external/markupsafe.BUILD @@ -0,0 +1,5 @@ +py_library( + name = "markupsafe", + srcs = glob(["markupsafe/**/*.py"]), + visibility = ["//visibility:public"], +) diff --git a/bazel/git_repository_info.py b/bazel/git_repository_info.py new file mode 100755 index 000000000000..e8ffa485976f --- /dev/null +++ b/bazel/git_repository_info.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python + +# Quick-and-dirty Python to fetch git repository info in bazel/repository_locations.bzl. + +import imp +import sys +import subprocess as sp + +repolocs = imp.load_source('replocs', 'bazel/repository_locations.bzl') + +if __name__ == '__main__': + if len(sys.argv) != 2: + print 'Usage: %s ' % sys.argv[0] + sys.exit(1) + repo = sys.argv[1] + if repo not in repolocs.REPOSITORY_LOCATIONS: + print 'Unknown repository: %s' % repo + sys.exit(1) + repoloc = repolocs.REPOSITORY_LOCATIONS[repo] + print '%s %s' % (repoloc['remote'], repoloc['commit']) diff --git a/bazel/repositories.bzl b/bazel/repositories.bzl index 9d0726d58192..a5cdfa283df2 100644 --- a/bazel/repositories.bzl +++ b/bazel/repositories.bzl @@ -1,9 +1,65 @@ +load( + "@bazel_tools//tools/build_defs/repo:git.bzl", + "git_repository", + "new_git_repository", +) load(":genrule_repository.bzl", "genrule_repository") load(":patched_http_archive.bzl", "patched_http_archive") -load(":repository_locations.bzl", "REPO_LOCATIONS") +load(":repository_locations.bzl", "REPOSITORY_LOCATIONS") load(":target_recipes.bzl", "TARGET_RECIPES") -def _repository_impl(ctxt): +def _repository_impl(name, **kwargs): + # `existing_rule_keys` contains the names of repositories that have already + # been defined in the Bazel workspace. By skipping repos with existing keys, + # users can override dependency versions by using standard Bazel repository + # rules in their WORKSPACE files. + existing_rule_keys = native.existing_rules().keys() + if name in existing_rule_keys: + # This repository has already been defined, probably because the user + # wants to override the version. Do nothing. + return + + location = REPOSITORY_LOCATIONS[name] + + # Git tags are mutable. We want to depend on commit IDs instead. Give the + # user a useful error if they accidentally specify a tag. + if "tag" in location: + fail( + "Refusing to depend on Git tag %r for external dependency %r: use 'commit' instead." + % (location["tag"], name)) + + if "commit" in location: + # Git repository at given commit ID. Add a BUILD file if requested. + if "build_file" in kwargs: + new_git_repository( + name = name, + remote = location["remote"], + commit = location["commit"], + **kwargs) + else: + git_repository( + name = name, + remote = location["remote"], + commit = location["commit"], + **kwargs) + else: # HTTP + # HTTP tarball at a given URL. Add a BUILD file if requested. + if "build_file" in kwargs: + native.new_http_archive( + name = name, + urls = location["urls"], + sha256 = location["sha256"], + strip_prefix = location["strip_prefix"], + **kwargs) + else: + native.http_archive( + name = name, + urls = location["urls"], + sha256 = location["sha256"], + strip_prefix = location["strip_prefix"], + **kwargs) + +def _build_recipe_repository_impl(ctxt): # Setup the build directory with links to the relevant files. ctxt.symlink(Label("//bazel:repositories.sh"), "repositories.sh") ctxt.symlink(Label("//ci/build_container:build_and_install_deps.sh"), @@ -33,88 +89,46 @@ def _repository_impl(ctxt): # This error message doesn't appear to the user :( https://github.com/bazelbuild/bazel/issues/3683 fail("External dep build failed") -def py_jinja2_dep(): - BUILD = """ -py_library( - name = "jinja2", - srcs = glob(["jinja2/**/*.py"]), - visibility = ["//visibility:public"], - deps = ["@markupsafe_git//:markupsafe"], -) -""" - native.new_git_repository( - name = "jinja2_git", - remote = REPO_LOCATIONS["jinja2"], - tag = "2.9.6", - build_file_content = BUILD, - ) - -def py_markupsafe_dep(): - BUILD = """ -py_library( - name = "markupsafe", - srcs = glob(["markupsafe/**/*.py"]), - visibility = ["//visibility:public"], -) -""" - native.new_git_repository( - name = "markupsafe_git", - remote = REPO_LOCATIONS["markupsafe"], - tag = "1.0", - build_file_content = BUILD, - ) - # Python dependencies. If these become non-trivial, we might be better off using a virtualenv to # wrap them, but for now we can treat them as first-class Bazel. -def python_deps(skip_targets): - if 'markupsafe' not in skip_targets: - py_markupsafe_dep() - native.bind( - name = "markupsafe", - actual = "@markupsafe_git//:markupsafe", - ) - if 'jinja2' not in skip_targets: - py_jinja2_dep() - native.bind( - name = "jinja2", - actual = "@jinja2_git//:jinja2", - ) - -def cc_grpc_httpjson_transcoding_dep(): - native.git_repository( - name = "grpc_httpjson_transcoding", - remote = REPO_LOCATIONS["grpc_transcoding"], - commit = "e4f58aa07b9002befa493a0a82e10f2e98b51fc6", +def _python_deps(): + _repository_impl( + name = "com_github_pallets_markupsafe", + build_file = "@envoy//bazel/external:markupsafe.BUILD", + ) + native.bind( + name = "markupsafe", + actual = "@com_github_pallets_markupsafe//:markupsafe", + ) + _repository_impl( + name = "com_github_pallets_jinja", + build_file = "@envoy//bazel/external:jinja.BUILD", + ) + native.bind( + name = "jinja2", + actual = "@com_github_pallets_jinja//:jinja2", ) # Bazel native C++ dependencies. For the depedencies that doesn't provide autoconf/automake builds. -def cc_deps(skip_targets): - if 'grpc-httpjson-transcoding' not in skip_targets: - cc_grpc_httpjson_transcoding_dep() - native.bind( - name = "path_matcher", - actual = "@grpc_httpjson_transcoding//src:path_matcher", - ) - native.bind( - name = "grpc_transcoding", - actual = "@grpc_httpjson_transcoding//src:transcoding", - ) +def _cc_deps(): + _repository_impl("grpc_httpjson_transcoding") + native.bind( + name = "path_matcher", + actual = "@grpc_httpjson_transcoding//src:path_matcher", + ) + native.bind( + name = "grpc_transcoding", + actual = "@grpc_httpjson_transcoding//src:transcoding", + ) -def go_deps(skip_targets): - if 'io_bazel_rules_go' not in skip_targets: - native.git_repository( - name = "io_bazel_rules_go", - remote = "https://github.com/bazelbuild/rules_go.git", - commit = "4374be38e9a75ff5957c3922adb155d32086fe14", - ) +def _go_deps(skip_targets): + # Keep the skip_targets check around until Istio Proxy has stopped using + # it to exclude the Go rules. + if "io_bazel_rules_go" not in skip_targets: + _repository_impl("io_bazel_rules_go") -def envoy_api_deps(skip_targets): - if 'envoy_api' not in skip_targets: - native.git_repository( - name = "envoy_api", - remote = REPO_LOCATIONS["data-plane-api"], - commit = "4d18e6d236a6476782076b217cd62d43c30a7dfe", - ) +def _envoy_api_deps(): + _repository_impl("envoy_api") api_bind_targets = [ "address", @@ -181,22 +195,9 @@ def envoy_api_deps(skip_targets): actual = "@googleapis//:http_api_protos_lib", ) -def abseil_deps(skip_targets): - if 'abseil' not in skip_targets: - native.git_repository( - name = "abseil", - remote = REPO_LOCATIONS["abseil_cpp"], - commit = "6de53819a7173bd446156237a37f53464b7732cc", - ) - native.bind( - name = "abseil_base", - actual = "@abseil//absl/base:base", - ) - -def envoy_dependencies(path = "@envoy_deps//", skip_com_google_protobuf = False, skip_targets = [], - repository = ""): +def envoy_dependencies(path = "@envoy_deps//", skip_targets = []): envoy_repository = repository_rule( - implementation = _repository_impl, + implementation = _build_recipe_repository_impl, environ = [ "CC", "CXX", @@ -221,41 +222,6 @@ def envoy_dependencies(path = "@envoy_deps//", skip_com_google_protobuf = False, name = "envoy_deps", recipes = recipes.to_list(), ) - - # `existing_rule_keys` contains the names of repositories that have already - # been defined in the Bazel workspace. By skipping repos with existing keys, - # users can override dependency versions by using standard Bazel repository - # rules in their WORKSPACE files. - # - # The long repo names (`com_github_fmtlib_fmt` instead of `fmtlib`) are - # semi-standard in the Bazel community, intended to avoid both duplicate - # dependencies and name conflicts. - existing_rule_keys = native.existing_rules().keys() - if not ("backward" in skip_targets or "com_github_bombela_backward" in existing_rule_keys): - com_github_bombela_backward(repository) - if not ("xxhash" in skip_targets or "com_github_cyan4973_xxhash" in existing_rule_keys): - com_github_cyan4973_xxhash(repository) - if not ("tclap" in skip_targets or "com_github_eile_tclap" in existing_rule_keys): - com_github_eile_tclap(repository) - if not ("fmtlib" in skip_targets or "com_github_fmtlib_fmt" in existing_rule_keys): - com_github_fmtlib_fmt(repository) - if not ("spdlog" in skip_targets or "com_github_gabime_spdlog" in existing_rule_keys): - com_github_gabime_spdlog(repository) - if not ("gcovr" in skip_targets or "com_github_gcovr_gcovr" in existing_rule_keys): - com_github_gcovr_gcovr(repository) - if not ("lightstep" in skip_targets or "com_github_lightstep_lightstep_tracer_cpp" in existing_rule_keys): - com_github_lightstep_lightstep_tracer_cpp(repository) - if not ("http_parser" in skip_targets or "com_github_nodejs_http_parser" in existing_rule_keys): - com_github_nodejs_http_parser(repository) - if not ("rapidjson" in skip_targets or "com_github_tencent_rapidjson" in existing_rule_keys): - com_github_tencent_rapidjson(repository) - if not ("googletest" in skip_targets or "com_google_googletest" in existing_rule_keys): - com_google_googletest() - if not (skip_com_google_protobuf or "com_google_protobuf" in existing_rule_keys): - com_google_protobuf() - if not ("subpar" in existing_rule_keys): - subpar() - for t in TARGET_RECIPES: if t not in skip_targets: native.bind( @@ -263,177 +229,156 @@ def envoy_dependencies(path = "@envoy_deps//", skip_com_google_protobuf = False, actual = path + ":" + t, ) - python_deps(skip_targets) - cc_deps(skip_targets) - go_deps(skip_targets) - envoy_api_deps(skip_targets) - abseil_deps(skip_targets) + # The long repo names (`com_github_fmtlib_fmt` instead of `fmtlib`) are + # semi-standard in the Bazel community, intended to avoid both duplicate + # dependencies and name conflicts. + _com_github_abseil_abseil_cpp() + _com_github_bombela_backward() + _com_github_cyan4973_xxhash() + _com_github_eile_tclap() + _com_github_fmtlib_fmt() + _com_github_gabime_spdlog() + _com_github_gcovr_gcovr() + _com_github_lightstep_lightstep_tracer_cpp() + _com_github_nodejs_http_parser() + _com_github_tencent_rapidjson() + _com_google_googletest() + _com_google_protobuf() -def com_github_bombela_backward(repository = ""): - native.new_git_repository( - name = "com_github_bombela_backward", - remote = "https://github.com/bombela/backward-cpp", - commit = "cd1c4bd9e48afe812a0e996d335298c455afcd92", # v1.3 - build_file = repository + "//bazel/external:backward.BUILD", - ) - native.bind( - name = "backward", - actual = "@com_github_bombela_backward//:backward", - ) + # Used for bundling gcovr into a relocatable .par file. + _repository_impl("subpar") -def com_github_cyan4973_xxhash(repository = ""): - native.new_git_repository( - name = "com_github_cyan4973_xxhash", - remote = "https://github.com/Cyan4973/xxHash", - commit = "50a564c33c36b3f0c83f027dd21c25cba2967c72", # v0.6.3 - build_file = repository + "//bazel/external:xxhash.BUILD", - ) - native.bind( - name = "xxhash", - actual = "@com_github_cyan4973_xxhash//:xxhash", - ) + _python_deps() + _cc_deps() + _go_deps(skip_targets) + _envoy_api_deps() -def com_github_eile_tclap(repository = ""): - native.new_git_repository( - name = "com_github_eile_tclap", - remote = "https://github.com/eile/tclap", - commit = "3627d9402e529770df9b0edf2aa8c0e0d6c6bb41", # tclap-1-2-1-release-final - build_file = repository + "//bazel/external:tclap.BUILD", - ) - native.bind( - name = "tclap", - actual = "@com_github_eile_tclap//:tclap", - ) +def _com_github_bombela_backward(): + _repository_impl( + name = "com_github_bombela_backward", + build_file = "@envoy//bazel/external:backward.BUILD", + ) + native.bind( + name = "backward", + actual = "@com_github_bombela_backward//:backward", + ) -def com_github_fmtlib_fmt(repository = ""): - native.new_http_archive( - name = "com_github_fmtlib_fmt", - urls = [ - "https://github.com/fmtlib/fmt/releases/download/4.0.0/fmt-4.0.0.zip", - ], - sha256 = "10a9f184d4d66f135093a08396d3b0a0ebe8d97b79f8b3ddb8559f75fe4fcbc3", - strip_prefix = "fmt-4.0.0", - build_file = repository + "//bazel/external:fmtlib.BUILD", - ) - native.bind( - name="fmtlib", - actual="@com_github_fmtlib_fmt//:fmtlib", - ) +def _com_github_cyan4973_xxhash(): + _repository_impl( + name = "com_github_cyan4973_xxhash", + build_file = "@envoy//bazel/external:xxhash.BUILD", + ) + native.bind( + name = "xxhash", + actual = "@com_github_cyan4973_xxhash//:xxhash", + ) -def com_github_gabime_spdlog(repository = ""): - native.new_http_archive( - name = "com_github_gabime_spdlog", - urls = [ - "https://github.com/gabime/spdlog/archive/v0.14.0.tar.gz", - ], - sha256 = "eb5beb4e53f4bfff5b32eb4db8588484bdc15a17b90eeefef3a9fc74fec1d83d", - strip_prefix = "spdlog-0.14.0", - build_file = repository + "//bazel/external:spdlog.BUILD", - ) - native.bind( - name="spdlog", - actual="@com_github_gabime_spdlog//:spdlog", - ) +def _com_github_eile_tclap(): + _repository_impl( + name = "com_github_eile_tclap", + build_file = "@envoy//bazel/external:tclap.BUILD", + ) + native.bind( + name = "tclap", + actual = "@com_github_eile_tclap//:tclap", + ) -def com_github_gcovr_gcovr(repository = ""): - native.new_git_repository( - name = "com_github_gcovr_gcovr", - remote = "https://github.com/gcovr/gcovr", - commit = "c0d77201039c7b119b18bc7fb991564c602dd75d", - build_file = repository + "//bazel/external:gcovr.BUILD", - ) - native.bind( - name = "gcovr", - actual = "@com_github_gcovr_gcovr//:gcovr", - ) +def _com_github_fmtlib_fmt(): + _repository_impl( + name = "com_github_fmtlib_fmt", + build_file = "@envoy//bazel/external:fmtlib.BUILD", + ) + native.bind( + name = "fmtlib", + actual = "@com_github_fmtlib_fmt//:fmtlib", + ) -def com_github_lightstep_lightstep_tracer_cpp(repository = ""): - genrule_repository( - name = "com_github_lightstep_lightstep_tracer_cpp", - urls = [ - "https://github.com/lightstep/lightstep-tracer-cpp/releases/download/v0_36/lightstep-tracer-cpp-0.36.tar.gz", - ], - sha256 = "f7477e67eca65f904c0b90a6bfec46d58cccfc998a8e75bc3259b6e93157ff84", - strip_prefix = "lightstep-tracer-cpp-0.36", - patches = [ - repository + "//bazel/external:lightstep-missing-header.patch", - ], - genrule_cmd_file = repository + "//bazel/external:lightstep.genrule_cmd", - build_file = repository + "//bazel/external:lightstep.BUILD", - ) - native.bind( - name="lightstep", - actual="@com_github_lightstep_lightstep_tracer_cpp//:lightstep", - ) +def _com_github_gabime_spdlog(): + _repository_impl( + name = "com_github_gabime_spdlog", + build_file = "@envoy//bazel/external:spdlog.BUILD", + ) + native.bind( + name = "spdlog", + actual = "@com_github_gabime_spdlog//:spdlog", + ) -def com_github_tencent_rapidjson(repository = ""): - native.new_git_repository( - name = "com_github_tencent_rapidjson", - remote = "https://github.com/tencent/rapidjson", - commit = "f54b0e47a08782a6131cc3d60f94d038fa6e0a51", # v1.1.0 - build_file = repository + "//bazel/external:rapidjson.BUILD", - ) - native.bind( - name = "rapidjson", - actual = "@com_github_tencent_rapidjson//:rapidjson", - ) +def _com_github_gcovr_gcovr(): + _repository_impl( + name = "com_github_gcovr_gcovr", + build_file = "@envoy//bazel/external:gcovr.BUILD", + ) + native.bind( + name = "gcovr", + actual = "@com_github_gcovr_gcovr//:gcovr", + ) -def com_github_nodejs_http_parser(repository = ""): - native.new_git_repository( - name = "com_github_nodejs_http_parser", - remote = "https://github.com/nodejs/http-parser", - commit = "feae95a3a69f111bc1897b9048d9acbc290992f9", # v2.7.1 - build_file = repository + "//bazel/external:http-parser.BUILD", - ) - native.bind( - name = "http_parser", - actual = "@com_github_nodejs_http_parser//:http_parser", - ) +def _com_github_lightstep_lightstep_tracer_cpp(): + location = REPOSITORY_LOCATIONS[ + "com_github_lightstep_lightstep_tracer_cpp"] + genrule_repository( + name = "com_github_lightstep_lightstep_tracer_cpp", + urls = location["urls"], + sha256 = location["sha256"], + strip_prefix = location["strip_prefix"], + patches = [ + "@envoy//bazel/external:lightstep-missing-header.patch", + ], + genrule_cmd_file = "@envoy//bazel/external:lightstep.genrule_cmd", + build_file = "@envoy//bazel/external:lightstep.BUILD", + ) + native.bind( + name = "lightstep", + actual = "@com_github_lightstep_lightstep_tracer_cpp//:lightstep", + ) -def com_google_googletest(): - native.git_repository( - name = "com_google_googletest", - remote = "https://github.com/google/googletest", - commit = "43863938377a9ea1399c0596269e0890b5c5515a", - ) - native.bind( - name = "googletest", - actual = "@com_google_googletest//:gtest", - ) +def _com_github_tencent_rapidjson(): + _repository_impl( + name = "com_github_tencent_rapidjson", + build_file = "@envoy//bazel/external:rapidjson.BUILD", + ) + native.bind( + name = "rapidjson", + actual = "@com_github_tencent_rapidjson//:rapidjson", + ) -def com_google_protobuf(): - # TODO(htuch): This can switch back to a point release http_archive at the next - # release (> 3.4.1), we need HEAD proto_library support and - # https://github.com/google/protobuf/pull/3761. - native.http_archive( - name = "com_google_protobuf", - strip_prefix = "protobuf-c4f59dcc5c13debc572154c8f636b8a9361aacde", - sha256 = "5d4551193416861cb81c3bc0a428f22a6878148c57c31fb6f8f2aa4cf27ff635", - url = "https://github.com/google/protobuf/archive/c4f59dcc5c13debc572154c8f636b8a9361aacde.tar.gz", - ) - # Needed for cc_proto_library, Bazel doesn't support aliases today for repos, - # see https://groups.google.com/forum/#!topic/bazel-discuss/859ybHQZnuI and - # https://github.com/bazelbuild/bazel/issues/3219. - native.http_archive( - name = "com_google_protobuf_cc", - strip_prefix = "protobuf-c4f59dcc5c13debc572154c8f636b8a9361aacde", - sha256 = "5d4551193416861cb81c3bc0a428f22a6878148c57c31fb6f8f2aa4cf27ff635", - url = "https://github.com/google/protobuf/archive/c4f59dcc5c13debc572154c8f636b8a9361aacde.tar.gz", - ) - native.bind( - name = "protobuf", - actual = "@com_google_protobuf//:protobuf", - ) - native.bind( - name = "protoc", - actual = "@com_google_protobuf_cc//:protoc", - ) +def _com_github_nodejs_http_parser(): + _repository_impl( + name = "com_github_nodejs_http_parser", + build_file = "@envoy//bazel/external:http-parser.BUILD", + ) + native.bind( + name = "http_parser", + actual = "@com_github_nodejs_http_parser//:http_parser", + ) -def subpar(): - # I'd love to name this `com_github_google_subpar`, but something in the Subpar - # code assumes its repository name is just `subpar`. - native.git_repository( - name = "subpar", - remote = "https://github.com/google/subpar", - commit = "eb23aa7a5361cabc02464476dd080389340a5522", # HEAD - ) +def _com_google_googletest(): + _repository_impl("com_google_googletest") + native.bind( + name = "googletest", + actual = "@com_google_googletest//:gtest", + ) + +def _com_github_abseil_abseil_cpp(): + _repository_impl("com_github_abseil_abseil_cpp") + native.bind( + name = "abseil_base", + actual = "@com_github_abseil_cpp//absl/base:base", + ) + +def _com_google_protobuf(): + _repository_impl("com_google_protobuf") + + # Needed for cc_proto_library, Bazel doesn't support aliases today for repos, + # see https://groups.google.com/forum/#!topic/bazel-discuss/859ybHQZnuI and + # https://github.com/bazelbuild/bazel/issues/3219. + location = REPOSITORY_LOCATIONS["com_google_protobuf"] + native.http_archive(name = "com_google_protobuf_cc", **location) + native.bind( + name = "protobuf", + actual = "@com_google_protobuf//:protobuf", + ) + native.bind( + name = "protoc", + actual = "@com_google_protobuf_cc//:protoc", + ) diff --git a/bazel/repository_locations.bzl b/bazel/repository_locations.bzl index b5f0059a419f..37abf3dadf7f 100644 --- a/bazel/repository_locations.bzl +++ b/bazel/repository_locations.bzl @@ -1,7 +1,80 @@ -REPO_LOCATIONS = { - "jinja2": "https://github.com/pallets/jinja.git", - "grpc_transcoding": "https://github.com/grpc-ecosystem/grpc-httpjson-transcoding.git", - "data-plane-api": "https://github.com/envoyproxy/data-plane-api.git", - "markupsafe": "https://github.com/pallets/markupsafe.git", - "abseil_cpp": "https://github.com/abseil/abseil-cpp", -} +REPOSITORY_LOCATIONS = dict( + com_github_abseil_abseil_cpp = dict( + commit = "6de53819a7173bd446156237a37f53464b7732cc", + remote = "https://github.com/abseil/abseil-cpp", + ), + com_github_bombela_backward = dict( + commit = "cd1c4bd9e48afe812a0e996d335298c455afcd92", # v1.3 + remote = "https://github.com/bombela/backward-cpp", + ), + com_github_cyan4973_xxhash = dict( + commit = "50a564c33c36b3f0c83f027dd21c25cba2967c72", # v0.6.3 + remote = "https://github.com/Cyan4973/xxHash", + ), + com_github_eile_tclap = dict( + commit = "3627d9402e529770df9b0edf2aa8c0e0d6c6bb41", # tclap-1-2-1-release-final + remote = "https://github.com/eile/tclap", + ), + com_github_fmtlib_fmt = dict( + sha256 = "10a9f184d4d66f135093a08396d3b0a0ebe8d97b79f8b3ddb8559f75fe4fcbc3", + strip_prefix = "fmt-4.0.0", + urls = ["https://github.com/fmtlib/fmt/releases/download/4.0.0/fmt-4.0.0.zip"], + ), + com_github_gabime_spdlog = dict( + sha256 = "eb5beb4e53f4bfff5b32eb4db8588484bdc15a17b90eeefef3a9fc74fec1d83d", + strip_prefix = "spdlog-0.14.0", + urls = ["https://github.com/gabime/spdlog/archive/v0.14.0.tar.gz"], + ), + com_github_gcovr_gcovr = dict( + commit = "c0d77201039c7b119b18bc7fb991564c602dd75d", + remote = "https://github.com/gcovr/gcovr", + ), + com_github_lightstep_lightstep_tracer_cpp = dict( + sha256 = "f7477e67eca65f904c0b90a6bfec46d58cccfc998a8e75bc3259b6e93157ff84", + strip_prefix = "lightstep-tracer-cpp-0.36", + urls = ["https://github.com/lightstep/lightstep-tracer-cpp/releases/download/v0_36/lightstep-tracer-cpp-0.36.tar.gz"], + ), + com_github_nodejs_http_parser = dict( + commit = "feae95a3a69f111bc1897b9048d9acbc290992f9", # v2.7.1 + remote = "https://github.com/nodejs/http-parser", + ), + com_github_pallets_jinja = dict( + commit = "d78a1b079cd985eea7d636f79124ab4fc44cb538", # 2.9.6 + remote = "https://github.com/pallets/jinja", + ), + com_github_pallets_markupsafe = dict( + commit = "d2a40c41dd1930345628ea9412d97e159f828157", # 1.0 + remote = "https://github.com/pallets/markupsafe", + ), + com_github_tencent_rapidjson = dict( + commit = "f54b0e47a08782a6131cc3d60f94d038fa6e0a51", # v1.1.0 + remote = "https://github.com/tencent/rapidjson", + ), + com_google_googletest = dict( + commit = "43863938377a9ea1399c0596269e0890b5c5515a", + remote = "https://github.com/google/googletest", + ), + com_google_protobuf = dict( + sha256 = "0cc6607e2daa675101e9b7398a436f09167dffb8ca0489b0307ff7260498c13c", + strip_prefix = "protobuf-3.5.0", + urls = ["https://github.com/google/protobuf/archive/v3.5.0.tar.gz"], + ), + envoy_api = dict( + commit = "12c3240c5e3354358e53b58df558ae78468f219f", + remote = "https://github.com/envoyproxy/data-plane-api", + ), + grpc_httpjson_transcoding = dict( + commit = "e4f58aa07b9002befa493a0a82e10f2e98b51fc6", + remote = "https://github.com/grpc-ecosystem/grpc-httpjson-transcoding", + ), + io_bazel_rules_go = dict( + commit = "4374be38e9a75ff5957c3922adb155d32086fe14", + remote = "https://github.com/bazelbuild/rules_go", + ), + # I'd love to name this `com_github_google_subpar`, but something in the Subpar + # code assumes its repository name is just `subpar`. + subpar = dict( + commit = "eb23aa7a5361cabc02464476dd080389340a5522", # HEAD + remote = "https://github.com/google/subpar", + ), +) diff --git a/ci/README.md b/ci/README.md index 71a081bd01cd..d6273bf2f8d6 100644 --- a/ci/README.md +++ b/ci/README.md @@ -82,6 +82,7 @@ The `./ci/run_envoy_docker.sh './ci/do_ci.sh '` targets are: * `bazel.tsan` — build and run tests under `-c dbg --config=clang-tsan` with clang-5.0. * `check_format`— run `clang-format` 5.0 and `buildifier` on entire source tree. * `fix_format`— run and enforce `clang-format` 5.0 and `buildifier` on entire source tree. +* `doc`— build documentation tree in `generated/docs`. # Testing changes to the build image as a developer diff --git a/ci/do_ci.sh b/ci/do_ci.sh index facb6da9f9ca..8922c9edbe46 100755 --- a/ci/do_ci.sh +++ b/ci/do_ci.sh @@ -37,6 +37,14 @@ function bazel_debug_binary_build() { } if [[ "$1" == "bazel.release" ]]; then + # The release build step still runs during tag events. Avoid rebuilding for no reason. + # TODO(mattklein123): Consider moving this into its own "build". + if [[ -n "$CIRCLE_TAG" ]] + then + echo 'Ignoring build for git tag event' + exit 0 + fi + setup_gcc_toolchain echo "bazel release build with tests..." bazel_release_binary_build @@ -153,6 +161,9 @@ elif [[ "$1" == "check_format" ]]; then cd "${ENVOY_SRCDIR}" ./tools/check_format.py check exit 0 +elif [[ "$1" == "docs" ]]; then + docs/publish.sh + exit 0 else echo "Invalid do_ci.sh target, see ci/README.md for valid targets." exit 1 diff --git a/ci/do_circle_ci.sh b/ci/do_circle_ci.sh index a9aa2720ecf8..69854e365ddd 100755 --- a/ci/do_circle_ci.sh +++ b/ci/do_circle_ci.sh @@ -2,12 +2,6 @@ set -e -if [ -n "$CIRCLE_TAG" ] -then - echo 'Ignoring build for git tag event' - exit 0 -fi - # bazel uses jgit internally and the default circle-ci .gitconfig says to # convert https://github.com to ssh://git@github.com, which jgit does not support. mv ~/.gitconfig ~/.gitconfig_save diff --git a/ci/run_envoy_docker.sh b/ci/run_envoy_docker.sh index 16f47692315d..d463165c8a7d 100755 --- a/ci/run_envoy_docker.sh +++ b/ci/run_envoy_docker.sh @@ -22,4 +22,5 @@ fi mkdir -p "${ENVOY_DOCKER_BUILD_DIR}" # Since we specify an explicit hash, docker-run will pull from the remote repo if missing. docker run --rm -t -i -u "${USER}":"${USER_GROUP}" -v "${ENVOY_DOCKER_BUILD_DIR}":/build \ - -v "$PWD":/source -e NUM_CPUS "${IMAGE_NAME}":"${IMAGE_ID}" /bin/bash -lc "cd source && $*" + -v "$PWD":/source -e NUM_CPUS --cap-add SYS_PTRACE "${IMAGE_NAME}":"${IMAGE_ID}" \ + /bin/bash -lc "cd source && $*" diff --git a/docs/Doxyfile b/docs/Doxyfile deleted file mode 100644 index e3dff7830195..000000000000 --- a/docs/Doxyfile +++ /dev/null @@ -1,2427 +0,0 @@ -# Doxyfile 1.8.11 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "Envoy" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = _doxygen/ - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = ../include - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, -# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. - -FILE_PATTERNS = - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse-libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /