Skip to content

Commit

Permalink
docs: correct the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TendTo committed Jun 12, 2024
1 parent 2e7ad1c commit deb5837
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
3 changes: 2 additions & 1 deletion docs/doxygen_doc.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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-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-configurations">configurations</a>, <a href="#doxygen-doxyfile_template">doxyfile_template</a>, <a href="#doxygen-outs">outs</a>)
</pre>

Generates documentation using Doxygen.
Expand Down Expand Up @@ -47,6 +47,7 @@ doxygen(
| <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-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-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"]` |


3 changes: 1 addition & 2 deletions docs/extensions_doc.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ Module extension for declaring the doxygen version to use.

The resulting repository will have the following targets:
- `@doxygen//:doxygen.bzl`, containing the doxygen macro used to generate the documentation.
- `@doxygen//:Doxyfile` Doxyfile configuration file to use.
- `@doxygen//:Doxyfile.template`, Doxyfile template used to generate the Doxyfile.
- `@doxygen//:Doxyfile.template`, default Doxyfile template used to generate the Doxyfile.

### Example

Expand Down
3 changes: 1 addition & 2 deletions extensions.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ Module extension for declaring the doxygen version to use.
The resulting repository will have the following targets:
- `@doxygen//:doxygen.bzl`, containing the doxygen macro used to generate the documentation.
- `@doxygen//:Doxyfile` Doxyfile configuration file to use.
- `@doxygen//:Doxyfile.template`, Doxyfile template used to generate the Doxyfile.
- `@doxygen//:Doxyfile.template`, default Doxyfile template used to generate the Doxyfile.
### Example
Expand Down

0 comments on commit deb5837

Please sign in to comment.