Bazel rules for generating code documentation with Doxygen.
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
# See releases for urls and checksums
http_archive(
name = "rules_doxygen",
sha256 = "{sha256}",
urls = ["https://github.com/abrisco/rules_doxygen/releases/download/{version}/rules_doxygen-v{version}.tar.gz"],
)
load("@rules_doxygen//doxygen:repositories.bzl", "rules_doxygen_dependencies", "doxygen_register_toolchains")
rules_doxygen_dependencies()
doxygen_register_toolchains()doxygen(name, config, data, output, project_name, target)
Generate documentation for C/C++ targets using doxygen.
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| name | A unique name for this target. | Name | required | |
| config | The doxygen config file. | Label | optional | //doxygen:config |
| data | Additional source files to add to the Doxygen action. | List of labels | optional | [] |
| output | The type of output to produce. | String | optional | "html" |
| project_name | An optional project name to use. If unset, the label name of target will be used. |
String | optional | "" |
| target | The C/C++ target to generate documentation for | Label | required |
doxygen_runner(name, config)
A rule defining a doxygen exectuable that runs on a config from the root of the current workspace.
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| name | A unique name for this target. | Name | required | |
| config | The doxygen config file. | Label | optional | //doxygen:config |
doxygen_toolchain(name, doxygen)
A toolchain used to power doxygen rules.
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| name | A unique name for this target. | Name | required | |
| doxygen | The doxygen binary. | Label | required |