Skip to content

Commit ed939fe

Browse files
committed
docs: update documentation
1 parent 769ba47 commit ed939fe

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/doxygen_doc.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,11 @@ Depending on the type of the attribute, the macro will convert it to the appropr
107107

108108
For the complete list of Doxygen configuration options, please refer to the [Doxygen documentation](https://www.doxygen.nl/manual/config.html).
109109

110+
> [!NOTE]
111+
> If not istructed otherwise, the rule will use the Doxyfile from its default `doxygen` version.
112+
> Any update could change some default values or add some flags which will be unrecognized by older `doxygen` versions, resulting in innocuous warnings.
113+
> If you want to use a specific Doxyfile, just generate one with `doxygen -g` and specify it in the `doxyfile_template` attribute.
114+
110115
### Make variables
111116

112117
There are cases where you need access to information about the build environment, such as the output directory doxygen is writing to.

doxygen/doxygen.bzl

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,11 @@ def doxygen(
502502
503503
For the complete list of Doxygen configuration options, please refer to the [Doxygen documentation](https://www.doxygen.nl/manual/config.html).
504504
505+
> [!NOTE]
506+
> If not istructed otherwise, the rule will use the Doxyfile from its default `doxygen` version.
507+
> Any update could change some default values or add some flags which will be unrecognized by older `doxygen` versions, resulting in innocuous warnings.
508+
> If you want to use a specific Doxyfile, just generate one with `doxygen -g` and specify it in the `doxyfile_template` attribute.
509+
505510
### Make variables
506511
507512
There are cases where you need access to information about the build environment, such as the output directory doxygen is writing to.

0 commit comments

Comments
 (0)