diff --git a/.github/workflows/main-cmake.yml b/.github/workflows/main-cmake.yml index 7669bd96caa..1961acc4725 100644 --- a/.github/workflows/main-cmake.yml +++ b/.github/workflows/main-cmake.yml @@ -96,7 +96,7 @@ jobs: cpp: ON fortran: OFF java: ON - docs: OFF + docs: ON libaecfc: ON localaec: OFF zlibfc: ON @@ -179,6 +179,7 @@ jobs: -DCMAKE_TOOLCHAIN_FILE=${{ matrix.toolchain }} \ -DBUILD_SHARED_LIBS=ON \ -DHDF5_ENABLE_ALL_WARNINGS=ON \ + -DHDF5_DOXY_WARNINGS=ON \ -DHDF5_ENABLE_PARALLEL:BOOL=${{ matrix.parallel }} \ -DHDF5_BUILD_CPP_LIB:BOOL=${{ matrix.cpp }} \ -DHDF5_BUILD_FORTRAN=${{ matrix.fortran }} \ diff --git a/CMakeLists.txt b/CMakeLists.txt index 9fe0b49f045..f536a4a9126 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -961,7 +961,7 @@ if (HDF5_BUILD_DOC AND EXISTS "${HDF5_DOXYGEN_DIR}" AND IS_DIRECTORY "${HDF5_DOX # check if Doxygen is installed find_package(Doxygen) if (DOXYGEN_FOUND) - option (HDF5_ENABLE_DOXY_WARNINGS "Enable fail if doxygen parsing has warnings." ON) + option (HDF5_ENABLE_DOXY_WARNINGS "Enable fail if doxygen parsing has warnings." OFF) mark_as_advanced (HDF5_ENABLE_DOXY_WARNINGS) if (HDF5_ENABLE_DOXY_WARNINGS) set (HDF5_DOXY_WARNINGS "FAIL_ON_WARNINGS") diff --git a/configure.ac b/configure.ac index 92eff586868..27fe37c8106 100644 --- a/configure.ac +++ b/configure.ac @@ -1220,14 +1220,14 @@ AC_MSG_RESULT([$HDF5_DOXYGEN]) ## This needs to be exposed for the library info file. AC_SUBST([HDF5_DOXY_WARNINGS]) -## Default is to consider doxygen warnings as errors +## Default is to not 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]])], + [Error on HDF5 doxygen warnings [default=no]])], [DOXY_ERR=$enableval]) if test "X$DOXY_ERR" = "Xyes"; then diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox index abfb7b1c3de..1955f1fc8b8 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/doxygen/dox/LearnBasics3.dox @@ -288,7 +288,7 @@ is met, at a certain point in the future.) \section secLBContentsProg Programming Example -\subsection subsecLBContentsProgUsing Using #H5Literate, #H5Lvisit and #H5Ovisit +\subsection subsecLBContentsProgUsing Using H5Literate, H5Lvisit and H5Ovisit For example code, see the \ref HDF5Examples page. Specifically look at the \ref ExAPI. There are examples for different languages, where examples of using #H5Literate and #H5Ovisit/#H5Lvisit are included. diff --git a/doxygen/dox/PredefinedDatatypeTables.dox b/doxygen/dox/PredefinedDatatypeTables.dox index fbafa9443e0..4227b23f4e1 100644 --- a/doxygen/dox/PredefinedDatatypeTables.dox +++ b/doxygen/dox/PredefinedDatatypeTables.dox @@ -1,4 +1,6 @@ /** \page predefined_datatypes_tables HDF5 Predefined Datatypes + * + * \section sec_predefined_datatypes_tables HDF5 Predefined Datatypes * * The following datatypes are predefined in HDF5. * diff --git a/java/src/hdf/hdf5lib/callbacks/Callbacks.java b/java/src/hdf/hdf5lib/callbacks/Callbacks.java index 3d5fbd152d8..013e0ec0ae7 100644 --- a/java/src/hdf/hdf5lib/callbacks/Callbacks.java +++ b/java/src/hdf/hdf5lib/callbacks/Callbacks.java @@ -28,7 +28,7 @@ * exceptions thrown will be passed to the default callback exception * handler. * - * @defgroup JCALL HDF5 Library Java Callbacks + * @defgroup JCALLBK HDF5 Library Java Callbacks */ public interface Callbacks { } diff --git a/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java index 9958b3bbab8..2d37044b1e1 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java @@ -20,7 +20,7 @@ */ public interface H5A_iterate_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each attribute * diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java index 49323a2731f..92024f8f16a 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java @@ -18,7 +18,7 @@ */ public interface H5D_append_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each dataset access property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java index 5f779987e35..f9ea6a96b3a 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java @@ -18,7 +18,7 @@ */ public interface H5D_iterate_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each dataset element * diff --git a/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java b/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java index a8ef5df9467..a9690a55fe1 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java @@ -20,7 +20,7 @@ */ public interface H5E_walk_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each error stack element * diff --git a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java index 7342e587d9e..cf0ac0e5b78 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java +++ b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java @@ -20,7 +20,7 @@ */ public interface H5L_iterate_t extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each group * diff --git a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java index bfe8c6762ff..f0dd587d88c 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java +++ b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java @@ -20,7 +20,7 @@ */ public interface H5O_iterate_t extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each group * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java index a2358615923..e4f10ccfa33 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_cls_close_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java index b218e0cca77..bdaad5f9324 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_cls_copy_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java index 3d407d05224..0b9ced20059 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_cls_create_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java index 51a57682cea..941fd150a3e 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_iterate_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java index 2ddc980a076..33bde76df4b 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_prp_close_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java index 53caa94f920..3149d171fe1 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_prp_compare_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java index 0b2349eca36..d3d6b37365a 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_prp_copy_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java index 6065ce0bf8c..2fe33388f91 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_prp_create_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java index 4384ca74446..30192842d99 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_prp_delete_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java index 999c7b0a5d1..cfc8e314ab6 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_prp_get_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java index 893344bffeb..22728699782 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java @@ -18,7 +18,7 @@ */ public interface H5P_prp_set_func_cb extends Callbacks { /** - * @ingroup JCALL + * @ingroup JCALLBK * * application callback for each property list * diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt index f9184cf6552..6adba9f4f5b 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 de5caa8a092..115a0c1b4bc 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -896,6 +896,15 @@ Bug Fixes since HDF5-1.14.0 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