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 /doxygen | |
| 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 'doxygen')
| -rw-r--r-- | doxygen/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | doxygen/Doxyfile.in | 2 |
2 files changed, 2 insertions, 1 deletions
diff --git a/doxygen/CMakeLists.txt b/doxygen/CMakeLists.txt index 7bfbe74..8fe3b77 100644 --- a/doxygen/CMakeLists.txt +++ b/doxygen/CMakeLists.txt @@ -30,6 +30,7 @@ if (DOXYGEN_FOUND) set (DOXYGEN_STRIP_FROM_PATH ${HDF5_SOURCE_DIR}) set (DOXYGEN_STRIP_FROM_INC_PATH ${HDF5_SOURCE_DIR}) set (DOXYGEN_PREDEFINED "H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN H5_HAVE_SUBFILING_VFD H5_HAVE_IOC_VFD H5_HAVE_MIRROR_VFD") + set (DOXYGEN_WARN_AS_ERROR ${HDF5_DOXY_WARNINGS}) # This configure and individual custom targets work together # Replace variables inside @@ with the current values diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in index b24b9f9..464e09a 100644 --- a/doxygen/Doxyfile.in +++ b/doxygen/Doxyfile.in @@ -625,7 +625,7 @@ WARN_NO_PARAMDOC = NO # a warning is encountered. # The default value is: NO. -WARN_AS_ERROR = FAIL_ON_WARNINGS +WARN_AS_ERROR = @DOXYGEN_WARN_AS_ERROR@ # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which |