rules_doxygen 2.6.2

Using Bzlmod with Bazel 7 or greater

# MODULE.bazel

bazel_dep(name = "rules_doxygen", version = "2.6.2", dev_dependency = True)

doxygen_extension = use_extension("@rules_doxygen//:extensions.bzl", "doxygen_extension")

# Specify the desired version of Doxygen to use
# ...

use_repo(doxygen_extension, "doxygen")

Changelog

Added

• The doxygen extension will try to automatically download the arm version of the doxygen binary on arm platform, provided it is present in the official release of the chosen version (thanks to @mutalibmohammed)

Changed

• Default doxygen version is now 1.16.1 (thanks to @mutalibmohammed)

New Contributors

• @mutalibmohammed made their first contribution in #40

Full Changelog: 2.6.1...2.6.2

rules_doxygen 2.6.1

Using Bzlmod with Bazel 7 or greater

# MODULE.bazel

bazel_dep(name = "rules_doxygen", version = "2.6.1", dev_dependency = True)

doxygen_extension = use_extension("@rules_doxygen//:extensions.bzl", "doxygen_extension")

# Specify the desired version of Doxygen to use
# ...

use_repo(doxygen_extension, "doxygen")

Changelog

Added

• doxyfile_prefix parameter to optionally allow configuring the directory into which the Doxyfile is emitted #35 (thanks to @renesas-abigail)

New Contributors

• @renesas-abigail made their first contribution in #37

Full Changelog: 2.6.0...2.6.1

rules_doxygen 2.6.0

Using Bzlmod with Bazel 7 or greater

# MODULE.bazel

bazel_dep(name = "rules_doxygen", version = "2.6.0", dev_dependency = True)

doxygen_extension = use_extension("@rules_doxygen//:extensions.bzl", "doxygen_extension")

# Specify the desired version of Doxygen to use
# ...

use_repo(doxygen_extension, "doxygen")

Changelog

Changed

• Default doxygen version is now 1.15.0
• Bump in the version of multiple dependencies, to accommodate for incompatible flags and ease future migrations
• Autogenerate documentation for the bcr
• Add 'rolling' to the CI bazel versions
• Update dependencies notification via Bazel Steward

Full Changelog: 2.5.0...2.6.0

rules_doxygen 2.5.0

Using Bzlmod with Bazel 7 or greater

# MODULE.bazel

bazel_dep(name = "rules_doxygen", version = "2.5.0", dev_dependency = True)

doxygen_extension = use_extension("@rules_doxygen//:extensions.bzl", "doxygen_extension")

# Specify the desired version of Doxygen to use
# ...

use_repo(doxygen_extension, "doxygen")

Changelog

Added

• Documenting exclude_patterns workaround #31 (thanks to @AustinSchuh)
• Documenting limitations for the automatic download of the doxygen binary in the doxygen extension rule #32 (thanks to @oxidase)
• use_default_shell_env parameter to allow the use of the default shell environment when running doxygen. Allows for better integration with the user's environment at the cost of hermeticity
• tools parameter to allow the use of additional tools when running doxygen. Allows for hermetic integration with other executables
• env parameter to allow the use of custom environment variables when running doxygen
• Example showcasing the use of a custom executable for doxygen

Changed

• Renamed _executable parameter in the doxygen rule to executable to allow its use from the doxygen macro (thanks to @mutalibmohammed)

rules_doxygen 2.4.2

Added

• Support for {{OUTDIR}} substitution in the Doxyfile #30 (thanks to @kaycebasques)

Full Changelog: 2.4.1...2.4.2

rules_doxygen 2.4.1

Added

• Doxyfile is now included in the doxygen rule DefaultInfo provider
• Mnemonic DoxygenBuild added to the ctx.run in the doxygen rule
• Added support by default for the $(OUTDIR) make variable in the doxygen rule #28 (thanks to @kaycebasques)
• doxylink example in the documentation

Changed

• Updated documentation
• More information in the progress message of the doxygen rule

Full Changelog: 2.4.0...2.4.1

rules_doxygen 2.4.0

Changed

• Default doxygen version is now 1.14.0

Full Changelog: 2.3.2...2.4.0

2.3.0

Added

• Support for dependency inclusion in the doxygen rule #24 (thanks to @oxidase)

Changed

• srcs attribute in the doxygen macro is now optional, as it defaults to []
• Updated documentation

Full Changelog: 2.2.2...2.3.0

rules_doxygen 2.2.2

Added

• CI tests for both Bazel 7 and 8

Fix

• Remove dependency on @bazel_tools//tools/build_defs/repo to support Bazel 7.0.0 #22 (thanks to @filmil)
• Remove unnecessary get_auth

Changed

• Made documentation clearer

Full Changelog: 2.2.1...2.2.2

rules_doxygen 2.2.1

Fix

• Added missing config DOT_TRANSPARENT

Changed

• Updated documentation and added example with the output substitution

Full Changelog: 2.2.0...2.2.1