rules_doxygen

Bazel rules for generating code documentation with Doxygen.

Setup

MODULE.bazel

http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_doxygen",
    # ...
    # ...
    # See releases page
)

register_toolchains(
    "@rules_doxygen//doxygen/toolchain",
)

Rules

• doxygen
• doxygen_runner
• doxygen_toolchain

---

---

doxygen

load("@rules_doxygen//doxygen:defs.bzl", "doxygen")

doxygen(name, data, config, 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
data	Additional source files to add to the Doxygen action.	List of labels	optional	[]
config	The doxygen config file.	Label	optional	"@rules_doxygen//doxygen:config"
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

load("@rules_doxygen//doxygen:defs.bzl", "doxygen_runner")

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	"@rules_doxygen//doxygen:config"

doxygen_toolchain

load("@rules_doxygen//doxygen:defs.bzl", "doxygen_toolchain")

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