mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-04-12 17:31:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Removed the file, func, line args in the _async APIs fpr doxygen (#2179)

Browse Source 
* 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>
This commit is contained in:
Scot Breitenfeld 2022-10-25 12:41:38 -05:00 committed by GitHub
parent 23e237e728
commit 7d1997ff7b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 354 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/codespell.yml vendored
View File

@ -11,5 +11,5 @@ jobs:
- uses: actions/checkout@v2
- uses: codespell-project/actions-codespell@master
with:
skip: ./bin/trace,./hl/tools/h5watch/h5watch.c,./tools/test/h5jam/tellub.c,./config/sanitizer/LICENSE
skip: ./bin/trace,./hl/tools/h5watch/h5watch.c,./tools/test/h5jam/tellub.c,./config/sanitizer/LICENSE,./tools/test/h5repack/testfiles/*.dat
ignore_words_list: isnt,inout,nd,parms,parm,ba,offsetP,ser,ois,had,fiter,fo,clude,refere,minnum,offsetp,creat,ans:,eiter,lastr,ans,isn't,ifset,sur,trun,dne,tthe,hda,filname,te,htmp,minnum,ake,gord,numer,ro,oce

2
configure.ac
View File

@ -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_HAVE_SUBFILING_VFD H5_HAVE_IOC_VFD'
DX_INIT_DOXYGEN([HDF5], [./doxygen/Doxyfile], [hdf5lib_docs])
fi

2
doxygen/CMakeLists.txt
View File

@ -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_HAVE_SUBFILING_VFD H5_HAVE_IOC_VFD")
# This configure and individual custom targets work together
# Replace variables inside @@ with the current values

4
fortran/src/H5Aff.F90
View File

@ -78,7 +78,7 @@ MODULE H5A
PRIVATE h5awrite_char_scalar, h5awrite_ptr
PRIVATE h5aread_char_scalar, h5aread_ptr
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTERFACE h5awrite_f
MODULE PROCEDURE h5awrite_char_scalar
! This is the preferred way to call h5awrite
@ -1332,7 +1332,7 @@ CONTAINS
END SUBROUTINE H5Arename_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>

6
fortran/src/H5Dff.F90
View File

@ -103,7 +103,7 @@ MODULE H5D
MODULE PROCEDURE h5dset_extent_f
END INTERFACE
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTERFACE h5dwrite_f
MODULE PROCEDURE h5dwrite_reference_obj
@ -584,7 +584,7 @@ CONTAINS
END SUBROUTINE h5dcreate_anon_f
#if H5_DOXYGEN_FORTRAN
#if H5_DOXYGEN
!>
!! \ingroup FH5D
!!
@ -1094,7 +1094,7 @@ CONTAINS
END SUBROUTINE H5Dvlen_reclaim_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5D
!!

2
fortran/src/H5Fff.F90
View File

@ -44,7 +44,7 @@ MODULE H5F
! Number of objects opened in H5open_f
INTEGER(SIZE_T) :: H5OPEN_NUM_OBJ
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTERFACE
INTEGER(C_INT) FUNCTION h5fis_accessible(name, &
access_prp_default) BIND(C,NAME='H5Fis_accessible')

6
fortran/src/H5Pff.F90
View File

@ -52,7 +52,7 @@ MODULE H5P
PRIVATE h5pregister_integer, h5pregister_ptr
PRIVATE h5pinsert_integer, h5pinsert_char, h5pinsert_ptr
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTERFACE h5pset_fapl_multi_f
MODULE PROCEDURE h5pset_fapl_multi_l
@ -2662,7 +2662,7 @@ CONTAINS
END SUBROUTINE h5pset_family_offset_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5P
@ -4177,7 +4177,7 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_chunk_cache_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5P
!!

18
fortran/src/H5Rff.F90
View File

@ -79,7 +79,7 @@ MODULE H5R
MODULE PROCEDURE h5rget_object_type_obj_f
END INTERFACE
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTERFACE h5rget_region_f
MODULE PROCEDURE h5rget_region_ptr_f ! F2003
@ -178,7 +178,7 @@ CONTAINS
!! \li H5G_TYPE_F
!! \param hdferr \fortran_error
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
SUBROUTINE h5rget_object_type_f(&
#else
SUBROUTINE h5rget_object_type_obj_f(&
@ -204,7 +204,7 @@ CONTAINS
ref_f = ref%ref
hdferr = h5rget_object_type_obj_c(dset_id, ref_f, obj_type )
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5rget_object_type_f
#else
END SUBROUTINE h5rget_object_type_obj_f
@ -260,7 +260,7 @@ CONTAINS
!!
!! See C API: @ref H5Rget_region()
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
SUBROUTINE h5rget_region_f(&
#else
SUBROUTINE h5rget_region_ptr_f(&
@ -274,7 +274,7 @@ CONTAINS
hdferr = h5rget_region_ptr_c(dset_id, ref, space_id)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5rget_region_f
#else
END SUBROUTINE h5rget_region_ptr_f
@ -373,7 +373,7 @@ CONTAINS
!! \param hdferr \fortran_error
!! \param space_id Dataspace identifier that describes selected region.
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!! See C API: @ref H5Rcreate_object()
!!
SUBROUTINE h5rcreate_f(&
@ -397,7 +397,7 @@ CONTAINS
IF(PRESENT(space_id)) space_id_c = space_id
hdferr = h5rcreate_ptr_c(ref, loc_id, name, namelen, ref_type, space_id_c)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5rcreate_f
#else
END SUBROUTINE h5rcreate_ptr_f
@ -566,7 +566,7 @@ CONTAINS
!!\param size The size of the name buffer, returning 0 (zero) if no name is associated with the identifier.
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!! See C API: @ref H5Rget_name()
!!
SUBROUTINE h5rget_name_f(&
@ -591,7 +591,7 @@ CONTAINS
IF(PRESENT(size)) size = size_default
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5rget_name_f
#else
END SUBROUTINE h5rget_name_ptr_f

10
fortran/src/H5Tff.F90
View File

@ -51,7 +51,7 @@ MODULE H5T
TYPE(C_PTR) :: p !< Pointer to VL data
END TYPE hvl_t
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTERFACE h5tenum_insert_f
MODULE PROCEDURE h5tenum_insert_f03
@ -2088,7 +2088,7 @@ CONTAINS
!! \param value Pointer to the value of the new member.
!! \param hdferr \fortran_error
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!! See C API: @ref H5Tenum_insert()
!!
SUBROUTINE h5tenum_insert_f(&
@ -2118,7 +2118,7 @@ CONTAINS
namelen = LEN(name)
hdferr = h5tenum_insert_ptr_c(type_id, name, namelen, value)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tenum_insert_f
#else
END SUBROUTINE h5tenum_insert_f03
@ -2136,7 +2136,7 @@ CONTAINS
!! \param value Value of the new member.
!! \param hdferr \fortran_error
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!! See C API: @ref H5Tenum_insert()
!!
SUBROUTINE h5tenum_insert_f(type_id, name, value, hdferr)
@ -2163,7 +2163,7 @@ CONTAINS
namelen = LEN(name)
hdferr = h5tenum_insert_c(type_id, name, namelen, value)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tenum_insert_f
#else
END SUBROUTINE h5tenum_insert_f90

2
fortran/src/H5f90global.F90
View File

@ -172,7 +172,7 @@ MODULE H5GLOBAL
INTEGER(HID_T) :: H5T_FORTRAN_S1 !< H5T_FORTRAN_S1
INTEGER(HID_T) :: H5T_C_S1 !< H5T_C_S1
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTEGER, PARAMETER :: NUM_NATIVE_INTEGER_KIND = 5
! INTEGER*1, INTEGER*2, INTEGER*4, INTEGER*8, INTEGER*16
INTEGER(HID_T), DIMENSION(1:NUM_NATIVE_INTEGER_KIND) :: H5T_NATIVE_INTEGER_KIND

26
hl/fortran/src/H5LTff.F90
View File

@ -35,7 +35,7 @@
#include <H5config_f.inc>
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
MODULE H5LT
#else
MODULE H5LT_CONST
@ -45,7 +45,7 @@ MODULE H5LT_CONST
USE h5fortran_types
USE hdf5
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTERFACE h5ltmake_dataset_f
MODULE PROCEDURE h5ltmake_dataset_f_ptr
@ -130,7 +130,7 @@ CONTAINS
! Make/Read dataset functions
!-------------------------------------------------------------------------
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5LT
!!
@ -173,13 +173,13 @@ CONTAINS
namelen = LEN(dset_name)
errcode = h5ltmake_dataset_c(loc_id,namelen,dset_name,rank,dims,type_id,buf)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5ltmake_dataset_f
#else
END SUBROUTINE h5ltmake_dataset_f_ptr
#endif
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5LT
!!
@ -215,7 +215,7 @@ CONTAINS
INTEGER, INTENT(in) :: rank
INTEGER(hsize_t), DIMENSION(*), INTENT(in) :: dims
INTEGER(hid_t), INTENT(in) :: type_id
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
TYPE(TYPE), INTENT(in), DIMENSION(*,*,...) :: buf
#else
INTEGER, INTENT(in), DIMENSION(*), TARGET :: buf
@ -227,7 +227,7 @@ CONTAINS
f_ptr = C_LOC(buf(1))
namelen = LEN(dset_name)
errcode = h5ltmake_dataset_c(loc_id,namelen,dset_name,rank,dims,type_id,f_ptr)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5ltmake_dataset_f
#else
END SUBROUTINE h5ltmake_dataset_f_int1
@ -375,7 +375,7 @@ CONTAINS
END SUBROUTINE h5ltmake_dataset_f_int7
#endif
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5LT
!!
@ -411,13 +411,13 @@ CONTAINS
namelen = LEN(dset_name)
errcode = h5ltread_dataset_c(loc_id,namelen,dset_name,type_id, buf)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5ltread_dataset_f
#else
END SUBROUTINE h5ltread_dataset_f_ptr
#endif
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5LT
!!
@ -450,7 +450,7 @@ CONTAINS
CHARACTER(LEN=*), INTENT(in) :: dset_name
INTEGER(hid_t), INTENT(in) :: type_id
INTEGER(hsize_t), DIMENSION(*), INTENT(in) :: dims
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
TYPE(TYPE), INTENT(inout), DIMENSION(*,*,...) :: buf
#else
INTEGER, INTENT(inout), DIMENSION(*), TARGET :: buf
@ -464,7 +464,7 @@ CONTAINS
namelen = LEN(dset_name)
errcode = h5ltread_dataset_c(loc_id,namelen,dset_name,type_id,f_ptr)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5ltread_dataset_f
#else
END SUBROUTINE h5ltread_dataset_f_int1
@ -1845,7 +1845,7 @@ CONTAINS
END SUBROUTINE h5ltpath_valid_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END MODULE H5LT
#else
END MODULE H5LT_CONST

54
hl/fortran/src/H5TBff.F90
View File

@ -33,7 +33,7 @@
! This is needed for Windows based operating systems.
!
#include "H5config_f.inc"
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
MODULE H5TB
#else
MODULE H5TB_CONST
@ -44,7 +44,7 @@
USE hdf5
INTERFACE h5tbwrite_field_name_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
MODULE PROCEDURE h5tbwrite_field_name_f
#else
MODULE PROCEDURE h5tbwrite_field_name_f_int
@ -53,7 +53,7 @@
END INTERFACE
INTERFACE h5tbread_field_name_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
MODULE PROCEDURE h5tbread_field_name_f
#else
MODULE PROCEDURE h5tbread_field_name_f_int
@ -62,7 +62,7 @@
END INTERFACE
INTERFACE h5tbwrite_field_index_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
MODULE PROCEDURE h5tbwrite_field_index_f
#else
MODULE PROCEDURE h5tbwrite_field_index_f_int
@ -71,7 +71,7 @@
END INTERFACE
INTERFACE h5tbread_field_index_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
MODULE PROCEDURE h5tbread_field_index_f
#else
MODULE PROCEDURE h5tbread_field_index_f_int
@ -80,7 +80,7 @@
END INTERFACE
INTERFACE h5tbinsert_field_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
MODULE PROCEDURE h5tbinsert_field_f
#else
MODULE PROCEDURE h5tbinsert_field_f_int
@ -89,7 +89,7 @@
END INTERFACE
#ifndef H5_DOXYGEN_FORTRAN
#ifndef H5_DOXYGEN
INTERFACE h5tbmake_table_f
MODULE PROCEDURE h5tbmake_table_f90
@ -218,7 +218,7 @@ CONTAINS
!!
!! See C API: @ref H5TBmake_table()
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
SUBROUTINE h5tbmake_table_f(&
#else
SUBROUTINE h5tbmake_table_f90(&
@ -307,7 +307,7 @@ CONTAINS
type_size, field_offset, field_types, chunk_size, compress, char_len_field_names, &
max_char_size_field_names, field_names)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tbmake_table_f
#else
END SUBROUTINE h5tbmake_table_f90
@ -337,7 +337,7 @@ CONTAINS
!!
!! See C API: @ref H5TBmake_table()
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
SUBROUTINE h5tbmake_table_f(&
#else
SUBROUTINE h5tbmake_table_ptr_f(&
@ -435,7 +435,7 @@ CONTAINS
type_size, field_offset, field_types, chunk_size, fill_data, compress, char_len_field_names, &
max_char_size_field_names, field_names, data)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tbmake_table_f
#else
END SUBROUTINE h5tbmake_table_ptr_f
@ -510,7 +510,7 @@ CONTAINS
END SUBROUTINE h5tbread_table_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5TB
!!
@ -547,7 +547,7 @@ CONTAINS
INTEGER(hsize_t), INTENT(in) :: start
INTEGER(hsize_t), INTENT(in) :: nrecords
INTEGER(size_t), INTENT(in) :: type_size
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
TYPE(TYPE), INTENT(in), DIMENSION(*) :: buf
#else
INTEGER, INTENT(in), DIMENSION(*), TARGET :: buf
@ -563,7 +563,7 @@ CONTAINS
errcode = h5tbwrite_field_name_c(loc_id,namelen,dset_name,namelen1,field_name,&
start,nrecords,type_size,f_ptr)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tbwrite_field_name_f
#else
END SUBROUTINE h5tbwrite_field_name_f_int
@ -602,7 +602,7 @@ CONTAINS
END SUBROUTINE h5tbwrite_field_name_f_string
#endif
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5TB
!!
@ -640,7 +640,7 @@ CONTAINS
INTEGER(hsize_t), INTENT(in) :: start
INTEGER(hsize_t), INTENT(in) :: nrecords
INTEGER(size_t), INTENT(in) :: type_size
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
TYPE(TYPE), INTENT(INOUT), DIMENSION(*):: buf
#else
INTEGER, INTENT(INOUT), DIMENSION(*), TARGET :: buf
@ -658,7 +658,7 @@ CONTAINS
errcode = h5tbread_field_name_c(loc_id,namelen,dset_name,namelen1,field_name,&
start,nrecords,type_size,f_ptr)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tbread_field_name_f
#else
END SUBROUTINE h5tbread_field_name_f_int
@ -696,7 +696,7 @@ CONTAINS
END SUBROUTINE h5tbread_field_name_f_string
#endif
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5TB
!!
@ -733,7 +733,7 @@ CONTAINS
INTEGER(hsize_t), INTENT(in) :: start
INTEGER(hsize_t), INTENT(in) :: nrecords
INTEGER(size_t), INTENT(in) :: type_size
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
INTEGER, INTENT(in), DIMENSION(*) :: buf
#else
INTEGER, INTENT(in), DIMENSION(*), TARGET :: buf
@ -749,7 +749,7 @@ CONTAINS
errcode = h5tbwrite_field_index_c(loc_id,namelen,dset_name,field_index,&
start,nrecords,type_size,f_ptr)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tbwrite_field_index_f
#else
END SUBROUTINE h5tbwrite_field_index_f_int
@ -784,7 +784,7 @@ CONTAINS
END SUBROUTINE h5tbwrite_field_index_f_string
#endif
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5TB
!!
@ -821,7 +821,7 @@ CONTAINS
INTEGER(hsize_t), INTENT(in) :: start
INTEGER(hsize_t), INTENT(in) :: nrecords
INTEGER(size_t), INTENT(in) :: type_size
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
TYPE(TYPE), INTENT(INOUT), DIMENSION(*) :: buf
#else
INTEGER, INTENT(INOUT), DIMENSION(*), TARGET :: buf
@ -835,7 +835,7 @@ CONTAINS
errcode = h5tbread_field_index_c(loc_id,namelen,dset_name,field_index,&
start,nrecords,type_size,f_ptr)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tbread_field_index_f
#else
END SUBROUTINE h5tbread_field_index_f_int
@ -870,7 +870,7 @@ CONTAINS
END SUBROUTINE h5tbread_field_index_f_string
#endif
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5TB
!!
@ -903,7 +903,7 @@ CONTAINS
CHARACTER(LEN=*), INTENT(in) :: field_name
INTEGER(hid_t), INTENT(in) :: field_type
INTEGER, INTENT(in) :: position
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
TYPE(TYPE), INTENT(in), DIMENSION(*) :: buf
#else
INTEGER, INTENT(in), DIMENSION(*), TARGET :: buf
@ -922,7 +922,7 @@ CONTAINS
errcode = h5tbinsert_field_c(loc_id,namelen,dset_name,namelen1,field_name,&
field_type,position,f_ptr)
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END SUBROUTINE h5tbinsert_field_f
#else
END SUBROUTINE h5tbinsert_field_f_int
@ -1128,7 +1128,7 @@ CONTAINS
END SUBROUTINE h5tbget_field_info_f
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END MODULE H5TB
#else
END MODULE H5TB_CONST

61
src/H5Apublic.h
View File

@ -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

57
src/H5Dpublic.h
View File

@ -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.

17
src/H5ESpublic.h
View File

@ -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);
/**

20
src/H5Fpublic.h
View File

@ -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
*

28
src/H5Gpublic.h
View File

@ -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 */

28
src/H5Lpublic.h
View File

@ -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
*

23
src/H5Mpublic.h
View File

@ -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

31
src/H5Opublic.h
View File

@ -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
/**
*-------------------------------------------------------------------------

13
src/H5Rpublic.h
View File

@ -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 */

13
src/H5Tpublic.h
View File

@ -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
*

4
src/H5VLmodule.h
View File

@ -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