summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2022-10-25 17:41:38 (GMT)
committerGitHub <noreply@github.com>2022-10-25 17:41:38 (GMT)
commit7d1997ff7b545eed7077962fc379e6781c2ccc80 (patch)
treea5f03e607247584f04814f20a42e2cffa18a4016 /src
parent23e237e728e4961d0cb7cbea10d5f82a9731bf8c (diff)
downloadhdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.zip
hdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.tar.gz
hdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.tar.bz2
Removed the file, func, line args in the _async APIs fpr doxygen (#2179)
* Removed the: file, func, line args in the _async APIs from the doxygen arguments. Documented H5ESclean. * format fixes * fixed DOXYGEN_PREDEFINED * Fixed the #ifdet logic for doxygen, added missing multi-dataset va_args * format fixes * Use H5_DOXYGEN instead of H5_DOXYGEN_FORTRAN * reordered multidataset declarations * alt. for H5Aclose_async and H5Acreate_async * made doxgyen API into seperate blocks * updated codespell * Committing clang-format changes Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'src')
-rw-r--r--src/H5Apublic.h61
-rw-r--r--src/H5Dpublic.h57
-rw-r--r--src/H5ESpublic.h17
-rw-r--r--src/H5Fpublic.h20
-rw-r--r--src/H5Gpublic.h28
-rw-r--r--src/H5Lpublic.h28
-rw-r--r--src/H5Mpublic.h23
-rw-r--r--src/H5Opublic.h31
-rw-r--r--src/H5Rpublic.h13
-rw-r--r--src/H5Tpublic.h13
-rw-r--r--src/H5VLmodule.h4
11 files changed, 287 insertions, 8 deletions
diff --git a/src/H5Apublic.h b/src/H5Apublic.h
index 4ac6a53..ebfeea8 100644
--- a/src/H5Apublic.h
+++ b/src/H5Apublic.h
@@ -94,8 +94,12 @@ H5_DLL herr_t H5Aclose(hid_t attr_id);
* \ingroup ASYNC
* \async_variant_of{H5Aclose}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Aclose_async(hid_t attr_id, hid_t es_id);
+#endif
/* --------------------------------------------------------------------------*/
/**
* \ingroup H5A
@@ -142,9 +146,15 @@ H5_DLL hid_t H5Acreate2(hid_t loc_id, const char *attr_name, hid_t type_id, hid_
* \ingroup ASYNC
* \async_variant_of{H5Acreate}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL hid_t H5Acreate_async(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 +200,17 @@ 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}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL hid_t H5Acreate_by_name_async(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 +327,13 @@ H5_DLL htri_t H5Aexists(hid_t obj_id, const char *attr_name);
* \ingroup ASYNC
* \async_variant_of{H5Aexists}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Aexists_async(hid_t obj_id, const char *attr_name, hbool_t *exists, hid_t es_id);
+#endif
+
/*-------------------------------------------------------------------------*/
/**
* \ingroup H5A
@@ -348,9 +370,15 @@ 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}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Aexists_by_name_async(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 +763,12 @@ H5_DLL hid_t H5Aopen(hid_t obj_id, const char *attr_name, hid_t aapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Aopen}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL hid_t H5Aopen_async(hid_t obj_id, const char *attr_name, hid_t aapl_id, hid_t es_id);
+#endif
/*--------------------------------------------------------------------------*/
/**
* \ingroup H5A
@@ -785,9 +817,15 @@ 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}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL hid_t H5Aopen_by_idx_async(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 +872,15 @@ 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}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL hid_t H5Aopen_by_name_async(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 +917,12 @@ H5_DLL herr_t H5Aread(hid_t attr_id, hid_t type_id, void *buf);
* \ingroup ASYNC
* \async_variant_of{H5Aread}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Aread_async(chid_t attr_id, hid_t dtype_id, void *buf, hid_t es_id);
+#endif
/*-------------------------------------------------------------------------*/
/**
* \ingroup H5A
@@ -902,16 +950,25 @@ H5_DLL herr_t H5Arename(hid_t loc_id, const char *old_name, const char *new_name
* \ingroup ASYNC
* \async_variant_of{H5Arename}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Arename_async(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}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Arename_by_name_async(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 +1003,12 @@ H5_DLL herr_t H5Awrite(hid_t attr_id, hid_t type_id, const void *buf);
* \ingroup ASYNC
* \async_variant_of{H5Awrite}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Awrite_async(hid_t attr_id, hid_t type_id, const void *buf, hid_t es_id);
+#endif
/*-------------------------------------------------------------------------*/
/**
* \ingroup H5A
diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h
index 8040272..8baf38f 100644
--- a/src/H5Dpublic.h
+++ b/src/H5Dpublic.h
@@ -320,9 +320,14 @@ 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}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL hid_t H5Dcreate_async(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
/**
* --------------------------------------------------------------------------
@@ -398,8 +403,12 @@ H5_DLL hid_t H5Dopen2(hid_t loc_id, const char *name, hid_t dapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Dopen}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL hid_t H5Dopen_async(hid_t loc_id, const char *name, hid_t dapl_id, hid_t es_id);
+#endif
/**
* --------------------------------------------------------------------------
@@ -432,8 +441,12 @@ H5_DLL hid_t H5Dget_space(hid_t dset_id);
* \ingroup ASYNC
* \async_variant_of{H5Dget_space}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL hid_t H5Dget_space_async(hid_t dset_id, hid_t es_id);
+#endif
/**
* --------------------------------------------------------------------------
@@ -901,18 +914,28 @@ H5_DLL herr_t H5Dread_multi(size_t count, hid_t dset_id[], hid_t mem_type_id[],
* \ingroup ASYNC
* \async_variant_of{H5Dread}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Dread_async(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
* \async_variant_of{H5Dread_multi}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Dread_multi_async(const char *app_file, const char *app_func, unsigned app_line, size_t count,
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);
+#else
+H5_DLL herr_t H5Dread_multi_async(size_t count, 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
/**
* --------------------------------------------------------------------------
@@ -1082,18 +1105,28 @@ H5_DLL herr_t H5Dwrite_multi(size_t count, hid_t dset_id[], hid_t mem_type_id[],
* \ingroup ASYNC
* \async_variant_of{H5Dwrite}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Dwrite_async(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
* \async_variant_of{H5Dwrite_multi}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Dwrite_multi_async(const char *app_file, const char *app_func, unsigned app_line,
size_t count, 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);
+#else
+H5_DLL herr_t H5Dwrite_multi_async(size_t count, 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
/**
* --------------------------------------------------------------------------
@@ -1379,8 +1412,12 @@ H5_DLL herr_t H5Dset_extent(hid_t dset_id, const hsize_t size[]);
* \ingroup ASYNC
* \async_variant_of{H5Dset_extent}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Dset_extent_async(hid_t dset_id, const hsize_t size[], hid_t es_id);
+#endif
/**
* --------------------------------------------------------------------------
@@ -1558,8 +1595,12 @@ H5_DLL herr_t H5Dclose(hid_t dset_id);
* \ingroup ASYNC
* \async_variant_of{H5Dclose}
*/
+#ifndef H5_DOXYGEN
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);
+#else
+H5_DLL herr_t H5Dclose_async(hid_t dset_id, hid_t es_id);
+#endif
/// \cond DEV
/* Internal API routines */
H5_DLL herr_t H5Ddebug(hid_t dset_id);
@@ -1572,13 +1613,15 @@ H5_DLL herr_t H5Dget_chunk_index_type(hid_t did, H5D_chunk_index_t *idx_type);
/* (Must be defined _after_ the function prototype) */
/* (And must only defined when included in application code, not the library) */
#ifndef H5D_MODULE
-#define H5Dcreate_async(...) H5Dcreate_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
-#define H5Dopen_async(...) H5Dopen_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
-#define H5Dget_space_async(...) H5Dget_space_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
-#define H5Dread_async(...) H5Dread_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
-#define H5Dwrite_async(...) H5Dwrite_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
-#define H5Dset_extent_async(...) H5Dset_extent_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
-#define H5Dclose_async(...) H5Dclose_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dcreate_async(...) H5Dcreate_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dopen_async(...) H5Dopen_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dget_space_async(...) H5Dget_space_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dread_async(...) H5Dread_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dread_multi_async(...) H5Dread_multi_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dwrite_async(...) H5Dwrite_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dwrite_multi_async(...) H5Dwrite_multi_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dset_extent_async(...) H5Dset_extent_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
+#define H5Dclose_async(...) H5Dclose_async(__FILE__, __func__, __LINE__, __VA_ARGS__)
/* Define "wrapper" versions of function calls, to allow compile-time values to
* be passed in by language wrapper or library layer on top of HDF5.
diff --git a/src/H5ESpublic.h b/src/H5ESpublic.h
index 3aeb872..d99554b 100644
--- a/src/H5ESpublic.h
+++ b/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);
/**
diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h
index 6559bfa..76484f0 100644
--- a/src/H5Fpublic.h
+++ b/src/H5Fpublic.h
@@ -357,8 +357,12 @@ H5_DLL hid_t H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id, hid_
* \ingroup ASYNC
* \async_variant_of{H5Fcreate}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Fcreate_async(const char *app_file, const char *app_func, unsigned app_line,
const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Fcreate_async(const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5F
*
@@ -457,8 +461,12 @@ H5_DLL hid_t H5Fopen(const char *filename, unsigned flags, hid_t fapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Fopen}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Fopen_async(const char *app_file, const char *app_func, unsigned app_line,
const char *filename, unsigned flags, hid_t access_plist, hid_t es_id);
+#else
+H5_DLL hid_t H5Fopen_async(const char *filename, unsigned flags, hid_t access_plist, hid_t es_id);
+#endif
/**
* \ingroup H5F
*
@@ -490,8 +498,12 @@ H5_DLL hid_t H5Freopen(hid_t file_id);
* \ingroup ASYNC
* \async_variant_of{H5Freopen}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Freopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t file_id,
hid_t es_id);
+#else
+H5_DLL hid_t H5Freopen_async(hid_t file_id, hid_t es_id);
+#endif
/**
* \ingroup H5F
*
@@ -530,8 +542,12 @@ H5_DLL herr_t H5Fflush(hid_t object_id, H5F_scope_t scope);
* \ingroup ASYNC
* \async_variant_of{H5Fflush}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Fflush_async(const char *app_file, const char *app_func, unsigned app_line, hid_t object_id,
H5F_scope_t scope, hid_t es_id);
+#else
+H5_DLL herr_t H5Fflush_async(hid_t object_id, H5F_scope_t scope, hid_t es_id);
+#endif
/**
* \ingroup H5F
*
@@ -581,8 +597,12 @@ H5_DLL herr_t H5Fclose(hid_t file_id);
* \ingroup ASYNC
* \async_variant_of{H5Fclose}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Fclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t file_id,
hid_t es_id);
+#else
+H5_DLL herr_t H5Fclose_async(hid_t file_id, hid_t es_id);
+#endif
/**
* \ingroup H5F
*
diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h
index c659a83..fc63871 100644
--- a/src/H5Gpublic.h
+++ b/src/H5Gpublic.h
@@ -130,8 +130,13 @@ H5_DLL hid_t H5Gcreate2(hid_t loc_id, const char *name, hid_t lcpl_id, hid_t gcp
* \ingroup ASYNC
* \async_variant_of{H5Gcreate}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Gcreate_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Gcreate_async(hid_t loc_id, const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id,
+ hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -217,8 +222,12 @@ H5_DLL hid_t H5Gopen2(hid_t loc_id, const char *name, hid_t gapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Gopen}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Gopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *name, hid_t gapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Gopen_async(hid_t loc_id, const char *name, hid_t gapl_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -276,8 +285,12 @@ H5_DLL herr_t H5Gget_info(hid_t loc_id, H5G_info_t *ginfo);
* \ingroup ASYNC
* \async_variant_of{H5Gget_info}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Gget_info_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
H5G_info_t *ginfo /*out*/, hid_t es_id);
+#else
+H5_DLL herr_t H5Gget_info_async(hid_t loc_id, H5G_info_t *ginfo /*out*/, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -318,9 +331,14 @@ H5_DLL herr_t H5Gget_info_by_name(hid_t loc_id, const char *name, H5G_info_t *gi
* \ingroup ASYNC
* \async_variant_of{H5Gget_info_by_name}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Gget_info_by_name_async(const char *app_file, const char *app_func, unsigned app_line,
hid_t loc_id, const char *name, H5G_info_t *ginfo /*out*/,
hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Gget_info_by_name_async(hid_t loc_id, const char *name, H5G_info_t *ginfo /*out*/,
+ hid_t lapl_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -375,10 +393,16 @@ H5_DLL herr_t H5Gget_info_by_idx(hid_t loc_id, const char *group_name, H5_index_
* \ingroup ASYNC
* \async_variant_of{H5Gget_info_by_idx}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Gget_info_by_idx_async(const char *app_file, const char *app_func, unsigned app_line,
hid_t loc_id, const char *group_name, H5_index_t idx_type,
H5_iter_order_t order, hsize_t n, H5G_info_t *ginfo /*out*/,
hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Gget_info_by_idx_async(hid_t loc_id, const char *group_name, H5_index_t idx_type,
+ H5_iter_order_t order, hsize_t n, H5G_info_t *ginfo /*out*/,
+ hid_t lapl_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -464,8 +488,12 @@ H5_DLL herr_t H5Gclose(hid_t group_id);
* \ingroup ASYNC
* \async_variant_of{H5Gclose}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Gclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t group_id,
hid_t es_id);
+#else
+H5_DLL herr_t H5Gclose_async(hid_t group_id, hid_t es_id);
+#endif
/// \cond DEV
/* API Wrappers for async routines */
diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h
index ca5f6e6..7f4ac0b 100644
--- a/src/H5Lpublic.h
+++ b/src/H5Lpublic.h
@@ -294,9 +294,14 @@ H5_DLL herr_t H5Lcreate_hard(hid_t cur_loc, const char *cur_name, hid_t dst_loc,
* \ingroup ASYNC
* \async_variant_of{H5Lcreate_hard}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Lcreate_hard_async(const char *app_file, const char *app_func, unsigned app_line,
hid_t cur_loc_id, const char *cur_name, hid_t new_loc_id,
const char *new_name, hid_t lcpl_id, hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Lcreate_hard_async(hid_t cur_loc_id, const char *cur_name, hid_t new_loc_id,
+ const char *new_name, hid_t lcpl_id, hid_t lapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5L
*
@@ -366,9 +371,14 @@ H5_DLL herr_t H5Lcreate_soft(const char *link_target, hid_t link_loc_id, const c
* \ingroup ASYNC
* \async_variant_of{H5Lcreate_soft}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Lcreate_soft_async(const char *app_file, const char *app_func, unsigned app_line,
const char *link_target, hid_t link_loc_id, const char *link_name,
hid_t lcpl_id, hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Lcreate_soft_async(const char *link_target, hid_t link_loc_id, const char *link_name,
+ hid_t lcpl_id, hid_t lapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5L
*
@@ -411,8 +421,12 @@ H5_DLL herr_t H5Ldelete(hid_t loc_id, const char *name, hid_t lapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Ldelete}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Ldelete_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *name, hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Ldelete_async(hid_t loc_id, const char *name, hid_t lapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5L
*
@@ -446,9 +460,14 @@ H5_DLL herr_t H5Ldelete_by_idx(hid_t loc_id, const char *group_name, H5_index_t
* \ingroup ASYNC
* \async_variant_of{H5Ldelete_by_idx}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Ldelete_by_idx_async(const char *app_file, const char *app_func, unsigned app_line,
hid_t loc_id, const char *group_name, H5_index_t idx_type,
H5_iter_order_t order, hsize_t n, hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Ldelete_by_idx_async(hid_t loc_id, const char *group_name, H5_index_t idx_type,
+ H5_iter_order_t order, hsize_t n, hid_t lapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5L
*
@@ -652,8 +671,12 @@ H5_DLL htri_t H5Lexists(hid_t loc_id, const char *name, hid_t lapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Lexists}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Lexists_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *name, hbool_t *exists, hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Lexists_async(hid_t loc_id, const char *name, hbool_t *exists, hid_t lapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5L
*
@@ -903,9 +926,14 @@ H5_DLL herr_t H5Literate2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t ord
* \ingroup ASYNC
* \async_variant_of{H5Literate}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Literate_async(const char *app_file, const char *app_func, unsigned app_line, hid_t group_id,
H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx_p, H5L_iterate2_t op,
void *op_data, hid_t es_id);
+#else
+H5_DLL herr_t H5Literate_async(hid_t group_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx_p,
+ H5L_iterate2_t op, void *op_data, hid_t es_id);
+#endif
/**
* \ingroup TRAV
*
diff --git a/src/H5Mpublic.h b/src/H5Mpublic.h
index 0d6b1b2..1cccf9d 100644
--- a/src/H5Mpublic.h
+++ b/src/H5Mpublic.h
@@ -226,9 +226,14 @@ H5_DLL hid_t H5Mcreate(hid_t loc_id, const char *name, hid_t key_type_id, hid_t
* \ingroup ASYNC
* \async_variant_of{H5Mcreate}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Mcreate_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *name, hid_t key_type_id, hid_t val_type_id, hid_t lcpl_id,
hid_t mcpl_id, hid_t mapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Mcreate_async(hid_t loc_id, const char *name, hid_t key_type_id, hid_t val_type_id,
+ hid_t lcpl_id, hid_t mcpl_id, hid_t mapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5M
@@ -266,8 +271,12 @@ H5_DLL hid_t H5Mopen(hid_t loc_id, const char *name, hid_t mapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Mopen}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Mopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *name, hid_t mapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Mopen_async(hid_t loc_id, const char *name, hid_t mapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5M
@@ -292,8 +301,12 @@ H5_DLL herr_t H5Mclose(hid_t map_id);
* \ingroup ASYNC
* \async_variant_of{H5Mclose}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Mclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t map_id,
hid_t es_id);
+#else
+H5_DLL herr_t H5Mclose_async(hid_t map_id, hid_t es_id);
+#endif
/**
* \ingroup H5M
@@ -414,9 +427,14 @@ H5_DLL herr_t H5Mput(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t
* \ingroup ASYNC
* \async_variant_of{H5Mput}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Mput_async(const char *app_file, const char *app_func, unsigned app_line, hid_t map_id,
hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, const void *value,
hid_t dxpl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Mput_async(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id,
+ const void *value, hid_t dxpl_id, hid_t es_id);
+#endif
/**
* \ingroup H5M
@@ -455,9 +473,14 @@ H5_DLL herr_t H5Mget(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t
* \ingroup ASYNC
* \async_variant_of{H5Mget}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Mget_async(const char *app_file, const char *app_func, unsigned app_line, hid_t map_id,
hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, void *value,
hid_t dxpl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Mget_async(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id,
+ void *value, hid_t dxpl_id, hid_t es_id);
+#endif
/**
* \ingroup H5M
diff --git a/src/H5Opublic.h b/src/H5Opublic.h
index a6cea39..93472c3 100644
--- a/src/H5Opublic.h
+++ b/src/H5Opublic.h
@@ -274,8 +274,12 @@ H5_DLL hid_t H5Oopen(hid_t loc_id, const char *name, hid_t lapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Oopen}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Oopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *name, hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Oopen_async(hid_t loc_id, const char *name, hid_t lapl_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -358,9 +362,14 @@ H5_DLL hid_t H5Oopen_by_idx(hid_t loc_id, const char *group_name, H5_index_t idx
* \ingroup ASYNC
* \async_variant_of{H5Oopen_by_idx}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Oopen_by_idx_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *group_name, H5_index_t idx_type, H5_iter_order_t order,
hsize_t n, hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Oopen_by_idx_async(hid_t loc_id, const char *group_name, H5_index_t idx_type,
+ H5_iter_order_t order, hsize_t n, hid_t lapl_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -540,9 +549,14 @@ H5_DLL herr_t H5Oget_info_by_name3(hid_t loc_id, const char *name, H5O_info2_t *
* \ingroup ASYNC
* \async_variant_of{H5Oget_info_by_name}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Oget_info_by_name_async(const char *app_file, const char *app_func, unsigned app_line,
hid_t loc_id, const char *name, H5O_info2_t *oinfo /*out*/,
unsigned fields, hid_t lapl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Oget_info_by_name_async(hid_t loc_id, const char *name, H5O_info2_t *oinfo /*out*/,
+ unsigned fields, hid_t lapl_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -927,9 +941,14 @@ H5_DLL herr_t H5Ocopy(hid_t src_loc_id, const char *src_name, hid_t dst_loc_id,
* \ingroup ASYNC
* \async_variant_of{H5Ocopy}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Ocopy_async(const char *app_file, const char *app_func, unsigned app_line, hid_t src_loc_id,
const char *src_name, hid_t dst_loc_id, const char *dst_name, hid_t ocpypl_id,
hid_t lcpl_id, hid_t es_id);
+#else
+H5_DLL herr_t H5Ocopy_async(hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name,
+ hid_t ocpypl_id, hid_t lcpl_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -1335,8 +1354,12 @@ H5_DLL herr_t H5Oclose(hid_t object_id);
* \ingroup ASYNC
* \async_variant_of{H5Oclose}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Oclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t object_id,
hid_t es_id);
+#else
+H5_DLL herr_t H5Oclose_async(hid_t object_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
@@ -1375,8 +1398,12 @@ H5_DLL herr_t H5Oflush(hid_t obj_id);
* \ingroup ASYNC
* \async_variant_of{H5Oflush}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Oflush_async(const char *app_file, const char *app_func, unsigned app_line, hid_t obj_id,
hid_t es_id);
+#else
+H5_DLL herr_t H5Oflush_async(hid_t obj_id, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
* \ingroup H5O
@@ -1407,8 +1434,12 @@ H5_DLL herr_t H5Orefresh(hid_t oid);
* \ingroup ASYNC
* \async_variant_of{H5Orefresh}
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Orefresh_async(const char *app_file, const char *app_func, unsigned app_line, hid_t oid,
hid_t es_id);
+#else
+H5_DLL herr_t H5Orefresh_async(hid_t oid, hid_t es_id);
+#endif
/**
*-------------------------------------------------------------------------
diff --git a/src/H5Rpublic.h b/src/H5Rpublic.h
index ef798ea..b925aef 100644
--- a/src/H5Rpublic.h
+++ b/src/H5Rpublic.h
@@ -348,8 +348,13 @@ H5_DLL hid_t H5Ropen_object(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Ropen}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Ropen_object_async(const char *app_file, const char *app_func, unsigned app_line,
H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Ropen_object_async(unsigned app_line, H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id,
+ hid_t es_id);
+#endif
/**
* --------------------------------------------------------------------------
@@ -389,8 +394,12 @@ H5_DLL hid_t H5Ropen_region(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Ropen_region}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Ropen_region_async(const char *app_file, const char *app_func, unsigned app_line,
H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Ropen_region_async(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id, hid_t es_id);
+#endif
/**
* --------------------------------------------------------------------------
@@ -427,8 +436,12 @@ H5_DLL hid_t H5Ropen_attr(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id);
* \ingroup ASYNC
* \async_variant_of{H5Ropen_attr}
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Ropen_attr_async(const char *app_file, const char *app_func, unsigned app_line,
H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Ropen_attr_async(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id, hid_t es_id);
+#endif
/* Get type */
diff --git a/src/H5Tpublic.h b/src/H5Tpublic.h
index d1ec2bd..a15d22e 100644
--- a/src/H5Tpublic.h
+++ b/src/H5Tpublic.h
@@ -1095,8 +1095,12 @@ H5_DLL herr_t H5Tclose(hid_t type_id);
* \brief Asynchronous version of H5Tclose().
*
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Tclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t type_id,
hid_t es_id);
+#else
+H5_DLL herr_t H5Tclose_async(hid_t type_id, hid_t es_id);
+#endif
/**
* \ingroup H5T
*
@@ -1185,9 +1189,14 @@ H5_DLL herr_t H5Tcommit2(hid_t loc_id, const char *name, hid_t type_id, hid_t lc
* \brief Asynchronous version of H5Tcommit2().
*
*/
+#ifndef H5_DOXYGEN
H5_DLL herr_t H5Tcommit_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 lcpl_id, hid_t tcpl_id, hid_t tapl_id,
hid_t es_id);
+#else
+H5_DLL herr_t H5Tcommit_async(hid_t loc_id, const char *name, hid_t type_id, hid_t lcpl_id, hid_t tcpl_id,
+ hid_t tapl_id, hid_t es_id);
+#endif
/**
* --------------------------------------------------------------------------
* \ingroup H5T
@@ -1218,8 +1227,12 @@ H5_DLL hid_t H5Topen2(hid_t loc_id, const char *name, hid_t tapl_id);
* \brief Asynchronous version of H5Topen2().
*
*/
+#ifndef H5_DOXYGEN
H5_DLL hid_t H5Topen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id,
const char *name, hid_t tapl_id, hid_t es_id);
+#else
+H5_DLL hid_t H5Topen_async(hid_t loc_id, const char *name, hid_t tapl_id, hid_t es_id);
+#endif
/**
* \ingroup H5T
*
diff --git a/src/H5VLmodule.h b/src/H5VLmodule.h
index 495bdb7..d6e65db 100644
--- a/src/H5VLmodule.h
+++ b/src/H5VLmodule.h
@@ -636,7 +636,9 @@
* \todo Describe the VOL plugin life cycle.
*
* \defgroup ASYNC Asynchronous Functions
- * \brief Asynchronous Functions
+ * \brief List of the asynchronous functions.
+ * \note The argument \p es_id associated with the asynchronous APIs is the \Emph{event set id}. See H5ES for
+ *context.
*
* \defgroup H5VLDEF Definitions
* \ingroup H5VL