summaryrefslogtreecommitdiffstats
path: root/src/H5Opublic.h
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/H5Opublic.h
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/H5Opublic.h')
-rw-r--r--src/H5Opublic.h31
1 files changed, 31 insertions, 0 deletions
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
/**
*-------------------------------------------------------------------------