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