diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2023-10-19 21:58:33 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-19 21:58:33 (GMT) |
| commit | 5844f498b03c9da5eb99c6665f4a8ff4663b190f (patch) | |
| tree | d1f0e2d676ff06300a1de769c2afcc929f734484 /release_docs | |
| parent | 5672fd817732e6a7fda3886010452bc7c8598cf8 (diff) | |
| download | hdf5-5844f498b03c9da5eb99c6665f4a8ff4663b190f.zip hdf5-5844f498b03c9da5eb99c6665f4a8ff4663b190f.tar.gz hdf5-5844f498b03c9da5eb99c6665f4a8ff4663b190f.tar.bz2 | |
Add an option to disable doxygen warn as error (#3708)
Add for both CMake and the Autotools
* HDF5_ENABLE_DOXY_WARNINGS: ON/OFF (Default: ON)
* --enable-doxygen-errors: enable/disable (Default: enable)
The default will fail compile if the doxygen parsing generates warnings.
The option can be disabled if certain versions of doxygen have parsing
issues. i.e. 1.9.5, 1.9.8.
Fixes #3398
Diffstat (limited to 'release_docs')
| -rw-r--r-- | release_docs/INSTALL_CMake.txt | 1 | ||||
| -rw-r--r-- | release_docs/RELEASE.txt | 12 |
2 files changed, 13 insertions, 0 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt index 281c9a1..c837d1c 100644 --- a/release_docs/INSTALL_CMake.txt +++ b/release_docs/INSTALL_CMake.txt @@ -859,6 +859,7 @@ HDF5_ENABLE_ANALYZER_TOOLS "enable the use of Clang tools" HDF5_ENABLE_SANITIZERS "execute the Clang sanitizer" OFF HDF5_ENABLE_FORMATTERS "format source files" OFF HDF5_DIMENSION_SCALES_NEW_REF "Use new-style references with dimension scale APIs" OFF +HDF5_ENABLE_DOXY_WARNINGS "Enable fail if doxygen parsing has warnings." ON ---------------- HDF5 Advanced Test Options --------------------- if (BUILD_TESTING) diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index 83c20b0..d2411d9 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -47,6 +47,18 @@ New Features Configuration: ------------- + - Added new options for CMake and Autotools to control the Doxygen + warnings as errors setting. + + * HDF5_ENABLE_DOXY_WARNINGS: ON/OFF (Default: ON) + * --enable-doxygen-errors: enable/disable (Default: enable) + + The default will fail compile if the doxygen parsing generates warnings. + The option can be disabled if certain versions of doxygen have parsing + issues. i.e. 1.9.5, 1.9.8. + + Addresses GitHub issue #3398 + - Added support for AOCC and classic Flang w/ the Autotools * Adds a config/clang-fflags options file to support Flang |