Skip to content

Commit

Permalink
bump: update to version 1.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
TendTo committed Jun 13, 2024
1 parent 3036ac1 commit b2a28e7
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 6 deletions.
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
26 changes: 25 additions & 1 deletion docs/doxygen_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ Doxygen rule for Bazel.
## doxygen

<pre>
doxygen(<a href="#doxygen-name">name</a>, <a href="#doxygen-srcs">srcs</a>, <a href="#doxygen-project_name">project_name</a>, <a href="#doxygen-project_brief">project_brief</a>, <a href="#doxygen-configurations">configurations</a>, <a href="#doxygen-doxyfile_template">doxyfile_template</a>, <a href="#doxygen-outs">outs</a>)
doxygen(<a href="#doxygen-name">name</a>, <a href="#doxygen-srcs">srcs</a>, <a href="#doxygen-project_name">project_name</a>, <a href="#doxygen-project_brief">project_brief</a>, <a href="#doxygen-project_number">project_number</a>, <a href="#doxygen-project_logo">project_logo</a>, <a href="#doxygen-project_icon">project_icon</a>,
<a href="#doxygen-use_mdfile_as_mainpage">use_mdfile_as_mainpage</a>, <a href="#doxygen-extract_private">extract_private</a>, <a href="#doxygen-html_footer">html_footer</a>, <a href="#doxygen-html_header">html_header</a>, <a href="#doxygen-filter_patterns">filter_patterns</a>,
<a href="#doxygen-use_mathjax">use_mathjax</a>, <a href="#doxygen-html_extra_stylesheet">html_extra_stylesheet</a>, <a href="#doxygen-html_extra_files">html_extra_files</a>, <a href="#doxygen-html_colorstyle">html_colorstyle</a>, <a href="#doxygen-aliases">aliases</a>, <a href="#doxygen-have_dot">have_dot</a>,
<a href="#doxygen-dot_image_format">dot_image_format</a>, <a href="#doxygen-dot_transparent">dot_transparent</a>, <a href="#doxygen-disable_index">disable_index</a>, <a href="#doxygen-full_sidebar">full_sidebar</a>, <a href="#doxygen-generate_treeview">generate_treeview</a>,
<a href="#doxygen-configurations">configurations</a>, <a href="#doxygen-doxyfile_template">doxyfile_template</a>, <a href="#doxygen-doxygen_extra_args">doxygen_extra_args</a>, <a href="#doxygen-outs">outs</a>)
</pre>

Generates documentation using Doxygen.
Expand Down Expand Up @@ -46,8 +50,28 @@ doxygen(
| <a id="doxygen-srcs"></a>srcs | A list of source files to generate documentation for. | none |
| <a id="doxygen-project_name"></a>project_name | The name of the project. | `None` |
| <a id="doxygen-project_brief"></a>project_brief | A brief description of the project. | `None` |
| <a id="doxygen-project_number"></a>project_number | The version number of the project. | `None` |
| <a id="doxygen-project_logo"></a>project_logo | The path to the project logo. | `None` |
| <a id="doxygen-project_icon"></a>project_icon | The path to the project icon. | `None` |
| <a id="doxygen-use_mdfile_as_mainpage"></a>use_mdfile_as_mainpage | The path to the markdown file to use as the main page. | `None` |
| <a id="doxygen-extract_private"></a>extract_private | Whether to extract private members. | `None` |
| <a id="doxygen-html_footer"></a>html_footer | The path to the HTML footer file. | `None` |
| <a id="doxygen-html_header"></a>html_header | The path to the HTML header file. | `None` |
| <a id="doxygen-filter_patterns"></a>filter_patterns | A list of filter patterns. Enables alteration of the input files before they are parsed by doxygen. | `[]` |
| <a id="doxygen-use_mathjax"></a>use_mathjax | Whether to use MathJax. | `None` |
| <a id="doxygen-html_extra_stylesheet"></a>html_extra_stylesheet | A list of extra stylesheets. | `[]` |
| <a id="doxygen-html_extra_files"></a>html_extra_files | A list of extra files. | `[]` |
| <a id="doxygen-html_colorstyle"></a>html_colorstyle | The color style to use for HTML. | `None` |
| <a id="doxygen-aliases"></a>aliases | A list of aliases. | `[]` |
| <a id="doxygen-have_dot"></a>have_dot | Whether to use dot. | `None` |
| <a id="doxygen-dot_image_format"></a>dot_image_format | The image format to use for dot. | `None` |
| <a id="doxygen-dot_transparent"></a>dot_transparent | Whether to use transparent backgrounds for dot. | `None` |
| <a id="doxygen-disable_index"></a>disable_index | Whether to disable the index. | `None` |
| <a id="doxygen-full_sidebar"></a>full_sidebar | Whether to use a full sidebar. | `None` |
| <a id="doxygen-generate_treeview"></a>generate_treeview | Whether to generate a tree view. | `None` |
| <a id="doxygen-configurations"></a>configurations | A list of additional configuration parameters to pass to Doxygen. | `[]` |
| <a id="doxygen-doxyfile_template"></a>doxyfile_template | The template file to use to generate the Doxyfile. The following substitutions are available:<br> - `# {{INPUT}}`: Subpackage directory in the sandbox.<br> - `# {{ADDITIONAL PARAMETERS}}`: Additional parameters given in the `configurations` attribute.<br> - `# {{OUTPUT DIRECTORY}}`: The directory provided in the `outs` attribute. | `"@doxygen//:Doxyfile.template"` |
| <a id="doxygen-doxygen_extra_args"></a>doxygen_extra_args | Extra arguments to pass to the doxygen executable. | `[]` |
| <a id="doxygen-outs"></a>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"]` |


0 comments on commit b2a28e7

Please sign in to comment.