Skip to content

Commit 0ca326b

Browse files
committed
docs: update documentation
1 parent 3a3279e commit 0ca326b

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
- `Doxyfile` is now included in the `doxygen` rule DefaultInfo provider
1313
- Mnemonic `DoxygenBuild` added to the `ctx.run` in the `doxygen` rule
14-
- Added support by default for the `$(OUTDIR)` make variable in the `doxygen` rule
14+
- Added support by default for the `$(OUTDIR)` make variable in the `doxygen` rule [#28](https://github.com/TendTo/rules_doxygen/pull/28) (thanks to @kaycebasques)
1515
- `doxylink` example in the documentation
1616

1717
### Changed

docs/doxygen_doc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ By default, the following make variables are available:
118118
- `$(OUTDIR)`: The output directory where the documentation will be generated.
119119
- All the predefined variables indicated in the [Bazel documentation](https://bazel.build/reference/be/make-variables#predefined_variables).
120120

121-
The former is particularly useful when `doxygen` needs to generate unusual files, such as tag files.
121+
The former is particularly useful when `doxygen` needs to generate unusual files, such as [tag files](https://www.doxygen.nl/manual/config.html#cfg_generate_tagfile).
122122
For example, you can use it to generate a tag file in the output directory:
123123

124124
```bzl

doxygen/doxygen.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ def doxygen(
513513
- `$(OUTDIR)`: The output directory where the documentation will be generated.
514514
- All the predefined variables indicated in the [Bazel documentation](https://bazel.build/reference/be/make-variables#predefined_variables).
515515
516-
The former is particularly useful when `doxygen` needs to generate unusual files, such as tag files.
516+
The former is particularly useful when `doxygen` needs to generate unusual files, such as [tag files](https://www.doxygen.nl/manual/config.html#cfg_generate_tagfile).
517517
For example, you can use it to generate a tag file in the output directory:
518518
519519
```bzl

0 commit comments

Comments
 (0)