diff options
author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2022-10-25 17:41:38 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-25 17:41:38 (GMT) |
commit | 7d1997ff7b545eed7077962fc379e6781c2ccc80 (patch) | |
tree | a5f03e607247584f04814f20a42e2cffa18a4016 /src/H5Apublic.h | |
parent | 23e237e728e4961d0cb7cbea10d5f82a9731bf8c (diff) | |
download | hdf5-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/H5Apublic.h')
-rw-r--r-- | src/H5Apublic.h | 61 |
1 files changed, 61 insertions, 0 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 |