diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2024-01-29 13:38:54 (GMT) |
|---|---|---|
| committer | Larry Knox <lrknox@hdfgroup.org> | 2024-02-14 21:30:28 (GMT) |
| commit | 56d9be146fb27456e4c517e49ccf920396824d71 (patch) | |
| tree | e6287952c20487797f17cea9878bd60f9d51dbfb /release_docs | |
| parent | 6ec07ffa9a096791fbb2c6735bd14cdcac24ab5d (diff) | |
| download | hdf5-56d9be146fb27456e4c517e49ccf920396824d71.zip hdf5-56d9be146fb27456e4c517e49ccf920396824d71.tar.gz hdf5-56d9be146fb27456e4c517e49ccf920396824d71.tar.bz2 | |
Fix doxygen errors (#3962)
* Switch warnings as errors to default OFF
* Enable mac docs
* Add doxygen action uses step
* Use html div around snippet
* Allow preset name to be an argument to cmake-ctest.yml
Diffstat (limited to 'release_docs')
| -rw-r--r-- | release_docs/INSTALL_CMake.txt | 2 | ||||
| -rw-r--r-- | release_docs/RELEASE.txt | 9 |
2 files changed, 10 insertions, 1 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt index 05a8582..f6ba3a1 100644 --- a/release_docs/INSTALL_CMake.txt +++ b/release_docs/INSTALL_CMake.txt @@ -872,7 +872,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_BUILD_DOC "Build documentation" OFF -HDF5_ENABLE_DOXY_WARNINGS "Enable fail if doxygen parsing has warnings." ON +HDF5_ENABLE_DOXY_WARNINGS "Enable fail if doxygen parsing has warnings." OFF ---------------- HDF5 VFD Options --------------------- HDF5_ENABLE_DIRECT_VFD "Build the Direct I/O Virtual File Driver" OFF diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index f2d26a3..28d86d6 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -230,6 +230,15 @@ Bug Fixes since HDF5-1.14.3 release Configuration ------------- + - Changed default of 'Error on HDF5 doxygen warnings' DOXYGEN_WARN_AS_ERROR option. + + The default setting of DOXYGEN_WARN_AS_ERROR to 'FAIL_ON_WARNINGS' has been changed + to 'NO'. It was decided that the setting was too aggressive and should be a user choice. + The github actions and scripts have been updated to reflect this. + + * HDF5_ENABLE_DOXY_WARNINGS: ON/OFF (Default: OFF) + * --enable-doxygen-errors: enable/disable (Default: disable) + - Removed an Autotools configure hack that causes problems on MacOS A sed line in configure.ac was added in the past to paper over some |