summaryrefslogtreecommitdiffstats
path: root/configure.ac
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2023-10-19 22:26:39 (GMT)
committerGitHub <noreply@github.com>2023-10-19 22:26:39 (GMT)
commit847cb427cb7100be88d78e954a02a70b10d0f5c4 (patch)
treed3822fd44413998badf4063fb5a752e55a883c87 /configure.ac
parentce864f6040c65df7909931c06ac72c18a8ce9ff7 (diff)
downloadhdf5-847cb427cb7100be88d78e954a02a70b10d0f5c4.zip
hdf5-847cb427cb7100be88d78e954a02a70b10d0f5c4.tar.gz
hdf5-847cb427cb7100be88d78e954a02a70b10d0f5c4.tar.bz2
GH issue 3398 - option to disable doxygen warn as error (#3709)
Diffstat (limited to 'configure.ac')
-rw-r--r--configure.ac25
1 files changed, 25 insertions, 0 deletions
diff --git a/configure.ac b/configure.ac
index 48fdafa..57cebc5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1207,6 +1207,30 @@ AC_ARG_ENABLE([doxygen],
AC_MSG_RESULT([$HDF5_DOXYGEN])
+## Check if they would like to enable doxygen warnings as errors
+##
+
+## This needs to be exposed for the library info file.
+AC_SUBST([HDF5_DOXY_WARNINGS])
+
+## Default is to consider doxygen warnings as errors
+DOXY_ERR=yes
+
+AC_MSG_CHECKING([if doxygen warnings as errors is enabled])
+
+AC_ARG_ENABLE([doxygen-errors],
+ [AS_HELP_STRING([--enable-doxygen-errors],
+ [Error on HDF5 doxygen warnings [default=yes]])],
+ [DOXY_ERR=$enableval])
+
+if test "X$DOXY_ERR" = "Xyes"; then
+ HDF5_DOXY_WARNINGS="FAIL_ON_WARNINGS"
+else
+ HDF5_DOXY_WARNINGS="NO"
+
+fi
+AC_MSG_RESULT([$HDF5_DOXY_WARNINGS])
+
if test "X$HDF5_DOXYGEN" = "Xyes"; then
DX_DOXYGEN_FEATURE(ON)
DX_DOT_FEATURE(OFF)
@@ -1269,6 +1293,7 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then
DOXYGEN_STRIP_FROM_PATH='$(SRCDIR)'
DOXYGEN_STRIP_FROM_INC_PATH='$(SRCDIR)'
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'
+ DOXYGEN_WARN_AS_ERROR=${HDF5_DOXY_WARNINGS}
DX_INIT_DOXYGEN([HDF5], [./doxygen/Doxyfile], [hdf5lib_docs])
fi