Skip to content

Commit 30e2694

Browse files
committed
docs: update documentation
1 parent 9d1baf6 commit 30e2694

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/doxygen_doc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ doxygen(
122122
| <a id="doxygen-name"></a>name | A name for the target. | none |
123123
| <a id="doxygen-srcs"></a>srcs | A list of source files to generate documentation for. | none |
124124
| <a id="doxygen-dot_executable"></a>dot_executable | Label of the doxygen executable. Make sure it is also added to the `srcs` of the macro | `None` |
125-
| <a id="doxygen-configurations"></a>configurations | A list of additional configuration parameters to pass to Doxygen. | `[]` |
126-
| <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"` |
125+
| <a id="doxygen-configurations"></a>configurations | A list of additional configuration parameters to pass to Doxygen. | `None` |
126+
| <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. | `None` |
127127
| <a id="doxygen-doxygen_extra_args"></a>doxygen_extra_args | Extra arguments to pass to the doxygen executable. | `[]` |
128128
| <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"]` |
129129
| <a id="doxygen-doxyfile_encoding"></a>doxyfile_encoding | This tag specifies the encoding used for all characters in the configuration file that follow. | `None` |

docs/extensions_doc.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ doxygen_repository(
7575
<pre>
7676
doxygen_extension = use_extension("@rules_doxygen//:extensions.bzl", "doxygen_extension")
7777
doxygen_extension.configuration(<a href="#doxygen_extension.configuration-executable">executable</a>, <a href="#doxygen_extension.configuration-platform">platform</a>, <a href="#doxygen_extension.configuration-sha256">sha256</a>, <a href="#doxygen_extension.configuration-version">version</a>)
78+
doxygen_extension.repository()
7879
</pre>
7980

8081
Module extension for declaring the doxygen configurations to use.
@@ -234,4 +235,13 @@ use_repo(doxygen_extension, "doxygen")
234235
| <a id="doxygen_extension.configuration-sha256"></a>sha256 | The sha256 hash of the doxygen archive. If not specified, an all-zero hash will be used. | String | optional | `""` |
235236
| <a id="doxygen_extension.configuration-version"></a>version | The version of doxygen to use. If set to `0.0.0`, the doxygen executable will be assumed to be available from the PATH. Mutually exclusive with `executable`. | String | optional | `""` |
236237

238+
<a id="doxygen_extension.repository"></a>
239+
240+
### repository
241+
242+
**Attributes**
243+
244+
| Name | Description | Type | Mandatory | Default |
245+
| :------------- | :------------- | :------------- | :------------- | :------------- |
246+
237247

0 commit comments

Comments
 (0)