Doxygen rule for Bazel.

doxygen

Generates documentation using Doxygen.

Example

# MODULE.bazel file
bazel_dep(name = "rules_doxygen", dev_dependency = True)
doxygen_extension = use_extension("@rules_doxygen//:extensions.bzl", "doxygen_extension")
use_repo(doxygen_extension, "doxygen")

# BUILD.bazel file
load("@doxygen//:doxygen.bzl", "doxygen")

doxygen(
    name = "doxygen",
    srcs = glob([
        "*.h",
        "*.cpp",
    ]),
    project_brief = "Example project for doxygen",
    project_name = "example",
)

PARAMETERS

Name	Description	Default Value
name	A name for the target.	none
srcs	A list of source files to generate documentation for.	none
project_name	The name of the project.	None
project_brief	A brief description of the project.	None
project_number	The version number of the project.	None
project_logo	The path to the project logo.	None
project_icon	The path to the project icon.	None
use_mdfile_as_mainpage	The path to the markdown file to use as the main page.	None
extract_private	Whether to extract private members.	None
html_footer	The path to the HTML footer file.	None
html_header	The path to the HTML header file.	None
filter_patterns	A list of filter patterns. Enables alteration of the input files before they are parsed by doxygen.	[]
use_mathjax	Whether to use MathJax.	None
html_extra_stylesheet	A list of extra stylesheets.	[]
html_extra_files	A list of extra files.	[]
html_colorstyle	The color style to use for HTML.	None
aliases	A list of aliases.	[]
have_dot	Whether to use dot.	None
dot_image_format	The image format to use for dot.	None
dot_transparent	Whether to use transparent backgrounds for dot.	None
disable_index	Whether to disable the index.	None
full_sidebar	Whether to use a full sidebar.	None
generate_treeview	Whether to generate a tree view.	None
javadoc_autobrief	Whether to use Javadoc-style auto brief.	None
builtin_stl_support	Whether to support the built-in standard library.	None
hide_undoc_members	Whether to hide undocumented members.	None
hide_in_body_docs	Whether to hide in body docs.	None
exclude_symbols	A list of symbols to exclude.	[]
example_path	The path to the examples. They must be added to the source files.	None
dot_executable	Label of the doxygen executable. Make sure it is also added to the srcs of the macro	None
configurations	A list of additional configuration parameters to pass to Doxygen.	[]
doxyfile_template	The template file to use to generate the Doxyfile. The following substitutions are available: - # {{INPUT}}: Subpackage directory in the sandbox. - # {{ADDITIONAL PARAMETERS}}: Additional parameters given in the configurations attribute. - # {{OUTPUT DIRECTORY}}: The directory provided in the outs attribute.	"@doxygen//:Doxyfile.template"
doxygen_extra_args	Extra arguments to pass to the doxygen executable.	[]
outs	The output folders bazel will keep. If only the html outputs is of interest, the default value will do. otherwise, a list of folders to keep is expected (e.g. [“html”, “latex”]).	["html"]
kwargs	Additional arguments to pass to the rule (e.g. visibility = ["//visibility:public"], tags = ["manual"])	none