Removed the file, func, line args in the _async APIs fpr doxygen

configure.ac

@@ -1260,7 +1260,7 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then
   DOXYGEN_SEARCHENGINE_URL=
   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_FORTRAN H5_HAVE_SUBFILING_VFD H5_HAVE_IOC_VFD'
+  DOXYGEN_PREDEFINED='H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN H5_DOXYGEN_FORTRAN H5_HAVE_SUBFILING_VFD H5_HAVE_IOC_VFD'
 
   DX_INIT_DOXYGEN([HDF5], [./doxygen/Doxyfile], [hdf5lib_docs])
 fi

doxygen/CMakeLists.txt

@@ -29,7 +29,7 @@ if (DOXYGEN_FOUND)
   set (DOXYGEN_SEARCHENGINE_URL)
   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_FORTRAN H5_HAVE_SUBFILING_VFD H5_HAVE_IOC_VFD")
+  set (DOXYGEN_PREDEFINED "H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN H5_DOXYGEN_FORTRAN H5_HAVE_SUBFILING_VFD H5_HAVE_IOC_VFD")
 
 # This configure and individual custom targets work together
   # Replace variables inside @@ with the current values

src/H5Apublic.h

@@ -94,8 +94,12 @@ H5_DLL herr_t H5Aclose(hid_t attr_id);
  * \ingroup ASYNC
  * \async_variant_of{H5Aclose}
  */
-H5_DLL herr_t H5Aclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t attr_id,
-                             hid_t es_id);
+H5_DLL herr_t H5Aclose_async(
+#ifndef H5_DOXYGEN
+                             const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t attr_id, hid_t es_id);
+#endif
 /* --------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -142,9 +146,13 @@ H5_DLL hid_t H5Acreate2(hid_t loc_id, const char *attr_name, hid_t type_id, hid_
  * \ingroup ASYNC
  * \async_variant_of{H5Acreate}
  */
-H5_DLL hid_t H5Acreate_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
-                             const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id,
-                             hid_t aapl_id, hid_t es_id);
+H5_DLL hid_t H5Acreate_async(
+#ifndef H5_DOXYGEN
+                             const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id, hid_t aapl_id,
+    hid_t es_id);
+#endif
 /*--------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -190,10 +198,13 @@ H5_DLL hid_t H5Acreate_by_name(hid_t loc_id, const char *obj_name, const char *a
  * \ingroup ASYNC
  * \async_variant_of{H5Acreate_by_name}
  */
-H5_DLL hid_t H5Acreate_by_name_async(const char *app_file, const char *app_func, unsigned app_line,
-                                     hid_t loc_id, const char *obj_name, const char *attr_name, hid_t type_id,
-                                     hid_t space_id, hid_t acpl_id, hid_t aapl_id, hid_t lapl_id,
-                                     hid_t es_id);
+H5_DLL hid_t H5Acreate_by_name_async(
+#ifndef H5_DOXYGEN
+                                     const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *obj_name, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id,
+    hid_t aapl_id, hid_t lapl_id, hid_t es_id);
+#endif
 /*-------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -310,8 +321,12 @@ H5_DLL htri_t H5Aexists(hid_t obj_id, const char *attr_name);
  * \ingroup ASYNC
  * \async_variant_of{H5Aexists}
  */
-H5_DLL herr_t H5Aexists_async(const char *app_file, const char *app_func, unsigned app_line, hid_t obj_id,
-                              const char *attr_name, hbool_t *exists, hid_t es_id);
+H5_DLL herr_t H5Aexists_async(
+#ifndef H5_DOXYGEN
+                              const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t obj_id, const char *attr_name, hbool_t *exists, hid_t es_id);
+#endif
 /*-------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -348,9 +363,12 @@ H5_DLL htri_t H5Aexists_by_name(hid_t obj_id, const char *obj_name, const char *
  * \ingroup ASYNC
  * \async_variant_of{H5Aexists_by_name}
  */
-H5_DLL herr_t H5Aexists_by_name_async(const char *app_file, const char *app_func, unsigned app_line,
-                                      hid_t loc_id, const char *obj_name, const char *attr_name,
-                                      hbool_t *exists, hid_t lapl_id, hid_t es_id);
+H5_DLL herr_t H5Aexists_by_name_async(
+#ifndef H5_DOXYGEN
+                                      const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *obj_name, const char *attr_name, hbool_t *exists, hid_t lapl_id, hid_t es_id);
+#endif
 /*-------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -735,8 +753,12 @@ H5_DLL hid_t H5Aopen(hid_t obj_id, const char *attr_name, hid_t aapl_id);
  * \ingroup ASYNC
  * \async_variant_of{H5Aopen}
  */
-H5_DLL hid_t H5Aopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t obj_id,
-                           const char *attr_name, hid_t aapl_id, hid_t es_id);
+H5_DLL hid_t H5Aopen_async(
+#ifndef H5_DOXYGEN
+                           const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t obj_id, const char *attr_name, hid_t aapl_id, hid_t es_id);
+#endif
 /*--------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -785,9 +807,13 @@ H5_DLL hid_t H5Aopen_by_idx(hid_t loc_id, const char *obj_name, H5_index_t idx_t
  * \ingroup ASYNC
  * \async_variant_of{H5Aopen_by_idx}
  */
-H5_DLL hid_t H5Aopen_by_idx_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
-                                  const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n,
-                                  hid_t aapl_id, hid_t lapl_id, hid_t es_id);
+H5_DLL hid_t H5Aopen_by_idx_async(
+#ifndef H5_DOXYGEN
+                                  const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t aapl_id,
+    hid_t lapl_id, hid_t es_id);
+#endif
 /*--------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -834,9 +860,12 @@ H5_DLL hid_t H5Aopen_by_name(hid_t loc_id, const char *obj_name, const char *att
  * \ingroup ASYNC
  * \async_variant_of{H5Aopen_by_name}
  */
-H5_DLL hid_t H5Aopen_by_name_async(const char *app_file, const char *app_func, unsigned app_line,
-                                   hid_t loc_id, const char *obj_name, const char *attr_name, hid_t aapl_id,
-                                   hid_t lapl_id, hid_t es_id);
+H5_DLL hid_t H5Aopen_by_name_async(
+#ifndef H5_DOXYGEN
+                                   const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *obj_name, const char *attr_name, hid_t aapl_id, hid_t lapl_id, hid_t es_id);
+#endif
 /*-------------------------------------------------------------------------- */
 /**
  * \ingroup H5A
@@ -873,8 +902,12 @@ H5_DLL herr_t H5Aread(hid_t attr_id, hid_t type_id, void *buf);
  * \ingroup ASYNC
  * \async_variant_of{H5Aread}
  */
-H5_DLL herr_t H5Aread_async(const char *app_file, const char *app_func, unsigned app_line, hid_t attr_id,
-                            hid_t dtype_id, void *buf, hid_t es_id);
+H5_DLL herr_t H5Aread_async(
+#ifndef H5_DOXYGEN
+                            const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t attr_id, hid_t dtype_id, void *buf, hid_t es_id);
+#endif
 /*-------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -902,16 +935,24 @@ H5_DLL herr_t H5Arename(hid_t loc_id, const char *old_name, const char *new_name
  * \ingroup ASYNC
  * \async_variant_of{H5Arename}
  */
-H5_DLL herr_t H5Arename_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
-                              const char *old_name, const char *new_name, hid_t es_id);
+H5_DLL herr_t H5Arename_async(
+#ifndef H5_DOXYGEN
+                              const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *old_name, const char *new_name, hid_t es_id);
+#endif
 /*--------------------------------------------------------------------------*/
 /**
  * \ingroup ASYNC
  * \async_variant_of{H5Arename_by_name}
  */
-H5_DLL herr_t H5Arename_by_name_async(const char *app_file, const char *app_func, unsigned app_line,
-                                      hid_t loc_id, const char *obj_name, const char *old_attr_name,
-                                      const char *new_attr_name, hid_t lapl_id, hid_t es_id);
+H5_DLL herr_t H5Arename_by_name_async(
+#ifndef H5_DOXYGEN
+                                      const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *obj_name, const char *old_attr_name, const char *new_attr_name, hid_t lapl_id,
+    hid_t es_id);
+#endif
 /*--------------------------------------------------------------------------*/
 /**
  * \ingroup H5A
@@ -946,8 +987,12 @@ H5_DLL herr_t H5Awrite(hid_t attr_id, hid_t type_id, const void *buf);
  * \ingroup ASYNC
  * \async_variant_of{H5Awrite}
  */
-H5_DLL herr_t H5Awrite_async(const char *app_file, const char *app_func, unsigned app_line, hid_t attr_id,
-                             hid_t type_id, const void *buf, hid_t es_id);
+H5_DLL herr_t H5Awrite_async(
+#ifndef H5_DOXYGEN
+                             const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t attr_id, hid_t type_id, const void *buf, hid_t es_id);
+#endif
 /*-------------------------------------------------------------------------*/
 /**
  * \ingroup H5A

src/H5Dpublic.h

@@ -320,10 +320,13 @@ H5_DLL hid_t H5Dcreate2(hid_t loc_id, const char *name, hid_t type_id, hid_t spa
  * \ingroup ASYNC
  * \async_variant_of{H5Dcreate}
  */
-H5_DLL hid_t H5Dcreate_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
-                             const char *name, hid_t type_id, hid_t space_id, hid_t lcpl_id, hid_t dcpl_id,
-                             hid_t dapl_id, hid_t es_id);
-
+H5_DLL hid_t H5Dcreate_async(
+#ifndef H5_DOXYGEN
+                             const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t lcpl_id, hid_t dcpl_id,
+    hid_t dapl_id, hid_t es_id);
+#endif
 /**
  * --------------------------------------------------------------------------
  * \ingroup H5D
@@ -398,9 +401,12 @@ H5_DLL hid_t H5Dopen2(hid_t loc_id, const char *name, hid_t dapl_id);
  * \ingroup ASYNC
  * \async_variant_of{H5Dopen}
  */
-H5_DLL hid_t H5Dopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
-                           const char *name, hid_t dapl_id, hid_t es_id);
-
+H5_DLL hid_t H5Dopen_async(
+#ifndef H5_DOXYGEN
+                           const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t loc_id, const char *name, hid_t dapl_id, hid_t es_id);
+#endif
 /**
  * --------------------------------------------------------------------------
  *\ingroup H5D
@@ -432,9 +438,12 @@ H5_DLL hid_t H5Dget_space(hid_t dset_id);
  * \ingroup ASYNC
  * \async_variant_of{H5Dget_space}
  */
-H5_DLL hid_t H5Dget_space_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id,
-                                hid_t es_id);
-
+H5_DLL hid_t H5Dget_space_async(
+#ifndef H5_DOXYGEN
+                                const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t dset_id, hid_t es_id);
+#endif
 /**
  * --------------------------------------------------------------------------
  * \ingroup H5D
@@ -901,10 +910,13 @@ H5_DLL herr_t H5Dread_multi(size_t count, hid_t dset_id[], hid_t mem_type_id[],
  * \ingroup ASYNC
  * \async_variant_of{H5Dread}
  */
-H5_DLL herr_t H5Dread_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id,
-                            hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id,
-                            void *buf /*out*/, hid_t es_id);
-
+H5_DLL herr_t H5Dread_async(
+#ifndef H5_DOXYGEN
+                            const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id,
+    void *buf /*out*/, hid_t es_id);
+#endif
 /**
  * --------------------------------------------------------------------------
  * \ingroup ASYNC
@@ -1082,10 +1094,13 @@ H5_DLL herr_t H5Dwrite_multi(size_t count, hid_t dset_id[], hid_t mem_type_id[],
  * \ingroup ASYNC
  * \async_variant_of{H5Dwrite}
  */
-H5_DLL herr_t H5Dwrite_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id,
-                             hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id,
-                             const void *buf, hid_t es_id);
-
+H5_DLL herr_t H5Dwrite_async(
+#ifndef H5_DOXYGEN
+                             const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, const void *buf,
+    hid_t es_id);
+#endif
 /**
  * --------------------------------------------------------------------------
  * \ingroup ASYNC
@@ -1379,9 +1394,12 @@ H5_DLL herr_t H5Dset_extent(hid_t dset_id, const hsize_t size[]);
  * \ingroup ASYNC
  * \async_variant_of{H5Dset_extent}
  */
-H5_DLL herr_t H5Dset_extent_async(const char *app_file, const char *app_func, unsigned app_line,
-                                  hid_t dset_id, const hsize_t size[], hid_t es_id);
-
+H5_DLL herr_t H5Dset_extent_async(
+#ifndef H5_DOXYGEN
+                                  const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t dset_id, const hsize_t size[], hid_t es_id);
+#endif
 /**
  * --------------------------------------------------------------------------
  * \ingroup H5D
@@ -1558,8 +1576,12 @@ H5_DLL herr_t H5Dclose(hid_t dset_id);
  * \ingroup ASYNC
  * \async_variant_of{H5Dclose}
  */
-H5_DLL herr_t H5Dclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id,
-                             hid_t es_id);
+H5_DLL herr_t H5Dclose_async(
+#ifndef H5_DOXYGEN
+                             const char *app_file, const char *app_func, unsigned app_line,
+#else
+    hid_t dset_id, hid_t es_id);
+#endif
 /// \cond DEV
 /* Internal API routines */
 H5_DLL herr_t H5Ddebug(hid_t dset_id);

src/H5ESpublic.h

@@ -178,6 +178,23 @@ H5_DLL hid_t H5EScreate(void);
  *
  */
 H5_DLL herr_t H5ESwait(hid_t es_id, uint64_t timeout, size_t *num_in_progress, hbool_t *err_occurred);
+
+/**
+ * \ingroup H5ES
+ *
+ * \brief Attempt to cancel operations in an event set
+ *
+ * \es_id
+ * \param[out] count The number of events not canceled
+ * \param[out] err_occurred Status indicating if error is present in the event set
+ * \returns \herr_t
+ *
+ * \details H5ESget_count() attempts to cancel operations in an event set specified
+ *          by \p es_id. H5ES_NONE is a valid value for \p es_id, but functions as a no-op.
+ *
+ * \since 1.13.0
+ *
+ */
 H5_DLL herr_t H5EScancel(hid_t es_id, size_t *num_not_canceled, hbool_t *err_occurred);
 
 /**