From b2a28e784b9fc56008b7d5ebbb0c688fbfb6cabe Mon Sep 17 00:00:00 2001 From: Ernesto Casablanca Date: Thu, 13 Jun 2024 12:16:42 +0200 Subject: [PATCH] bump: update to version 1.1.1 --- CHANGELOG.md | 7 +++++-- MODULE.bazel | 2 +- README.md | 4 ++-- docs/doxygen_doc.md | 26 +++++++++++++++++++++++++- 4 files changed, 33 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ace78d9..74da1bf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Correctly use `project_name` and `project_brief` in the macro - Unfreeze default list in macro -## [NEXT.VERSION] +## [1.1.1] ### Added @@ -35,6 +35,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Remove superfluous `\` before the `\n` in the `doxygen` configurations list formatting +## [NEXT.VERSION] + [1.0.0]: https://github.com/TendTo/rules_doxygen/tree/1.0.0 [1.1.0]: https://github.com/TendTo/rules_doxygen/compare/1.0.0...1.1.0 -[NEXT.VERSION]: https://github.com/TendTo/rules_doxygen/compare/1.1.0...HEAD +[1.1.1]: https://github.com/TendTo/rules_doxygen/compare/1.1.0...1.1.1 +[NEXT.VERSION]: https://github.com/TendTo/rules_doxygen/compare/1.1.1...HEAD diff --git a/MODULE.bazel b/MODULE.bazel index 18ee486..7d55126 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -1,5 +1,5 @@ """rules_doxygen module""" -module(name = "rules_doxygen", version = "1.1.0", compatibility_level = 1) +module(name = "rules_doxygen", version = "1.1.1", compatibility_level = 1) bazel_dep(name = "platforms", version = "0.0.5") bazel_dep(name = "stardoc", version = "0.6.2", dev_dependency = True) diff --git a/README.md b/README.md index 48cb8be..082ff36 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ This repository contains a Starlark implementation of Doxygen rules in Bazel. Add the following to your _MODULE.bazel_: ```bzl -bazel_dep(name = "rules_doxygen", version = "1.1.0", dev_dependency = True) +bazel_dep(name = "rules_doxygen", version = "1.1.1", dev_dependency = True) ``` If you don't want to depend on the [Bazel package registry](https://bazel.build/external/bazelbuild/rules_pkg) or you want to use a not-yet-published version of this module, you can use an archive override by adding the following lines below the `bazel_dep` rule in your _MODULE.bazel_ file: ```bzl -bazel_dep(name = "rules_doxygen", version = "1.1.0", dev_dependency = True) +bazel_dep(name = "rules_doxygen", version = "1.1.1", dev_dependency = True) archive_override( module_name = "rules_doxygen", urls = "https://github.com/TendTo/rules_doxygen/archive/refs/heads/main.tar.gz", diff --git a/docs/doxygen_doc.md b/docs/doxygen_doc.md index 512fc67..504c381 100644 --- a/docs/doxygen_doc.md +++ b/docs/doxygen_doc.md @@ -7,7 +7,11 @@ Doxygen rule for Bazel. ## doxygen 
-doxygen(name, srcs, project_name, project_brief, configurations, doxyfile_template, outs)
+doxygen(name, srcs, project_name, project_brief, project_number, project_logo, project_icon,
+        use_mdfile_as_mainpage, extract_private, html_footer, html_header, filter_patterns,
+        use_mathjax, html_extra_stylesheet, html_extra_files, html_colorstyle, aliases, have_dot,
+        dot_image_format, dot_transparent, disable_index, full_sidebar, generate_treeview,
+        configurations, doxyfile_template, doxygen_extra_args, outs)
Generates documentation using Doxygen. @@ -46,8 +50,28 @@ doxygen( | 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` | | 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"]` |