Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 13 commits into from
Oct 25, 2022
Merged
2 changes: 1 addition & 1 deletion .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doxygen/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions fortran/src/H5Aff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -1332,7 +1332,7 @@ END FUNCTION H5Arename_c

END SUBROUTINE H5Arename_f

#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN


!>
Expand Down
6 changes: 3 additions & 3 deletions fortran/src/H5Dff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -584,7 +584,7 @@ END FUNCTION h5dcreate_anon_c

END SUBROUTINE h5dcreate_anon_f

#if H5_DOXYGEN_FORTRAN
#if H5_DOXYGEN
!>
!! \ingroup FH5D
!!
Expand Down Expand Up @@ -1094,7 +1094,7 @@ END FUNCTION h5dvlen_reclaim_c

END SUBROUTINE H5Dvlen_reclaim_f

#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5D
!!
Expand Down
2 changes: 1 addition & 1 deletion fortran/src/H5Fff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
6 changes: 3 additions & 3 deletions fortran/src/H5Pff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -2662,7 +2662,7 @@ END FUNCTION h5pset_family_offset_c

END SUBROUTINE h5pset_family_offset_f

#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN

!>
!! \ingroup FH5P
Expand Down Expand Up @@ -4177,7 +4177,7 @@ END FUNCTION h5pget_chunk_cache_c

END SUBROUTINE h5pget_chunk_cache_f

#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5P
!!
Expand Down
18 changes: 9 additions & 9 deletions fortran/src/H5Rff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -178,7 +178,7 @@ END FUNCTION h5rget_region_ptr_c
!! \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(&
Expand All @@ -204,7 +204,7 @@ END FUNCTION h5rget_object_type_obj_c
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
Expand Down Expand Up @@ -260,7 +260,7 @@ END SUBROUTINE h5rget_region_region_f
!!
!! See C API: @ref H5Rget_region()
!!
#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
SUBROUTINE h5rget_region_f(&
#else
SUBROUTINE h5rget_region_ptr_f(&
Expand All @@ -274,7 +274,7 @@ SUBROUTINE h5rget_region_ptr_f(&

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
Expand Down Expand Up @@ -373,7 +373,7 @@ END SUBROUTINE h5rcreate_region_f
!! \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(&
Expand All @@ -397,7 +397,7 @@ SUBROUTINE h5rcreate_ptr_f(&
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
Expand Down Expand Up @@ -566,7 +566,7 @@ END SUBROUTINE h5rget_name_region_f
!!\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(&
Expand All @@ -591,7 +591,7 @@ SUBROUTINE h5rget_name_ptr_f(&

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
Expand Down
10 changes: 5 additions & 5 deletions fortran/src/H5Tff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -2088,7 +2088,7 @@ END SUBROUTINE h5tconvert_f
!! \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(&
Expand Down Expand Up @@ -2118,7 +2118,7 @@ END FUNCTION h5tenum_insert_ptr_c

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
Expand All @@ -2136,7 +2136,7 @@ END SUBROUTINE h5tenum_insert_f03
!! \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)
Expand All @@ -2163,7 +2163,7 @@ END FUNCTION h5tenum_insert_c

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
Expand Down
2 changes: 1 addition & 1 deletion fortran/src/H5f90global.F90
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 13 additions & 13 deletions hl/fortran/src/H5LTff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

#include <H5config_f.inc>

#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
MODULE H5LT
#else
MODULE H5LT_CONST
Expand All @@ -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
Expand Down Expand Up @@ -130,7 +130,7 @@ END FUNCTION h5ltget_attribute_c
! Make/Read dataset functions
!-------------------------------------------------------------------------

#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5LT
!!
Expand Down Expand Up @@ -173,13 +173,13 @@ SUBROUTINE h5ltmake_dataset_f_ptr( &
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
!!
Expand Down Expand Up @@ -215,7 +215,7 @@ SUBROUTINE h5ltmake_dataset_f_int1(&
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
Expand All @@ -227,7 +227,7 @@ SUBROUTINE h5ltmake_dataset_f_int1(&
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
Expand Down Expand Up @@ -375,7 +375,7 @@ SUBROUTINE h5ltmake_dataset_f_int7(loc_id, dset_name, rank, dims, &
END SUBROUTINE h5ltmake_dataset_f_int7
#endif

#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
!>
!! \ingroup FH5LT
!!
Expand Down Expand Up @@ -411,13 +411,13 @@ SUBROUTINE h5ltread_dataset_f_ptr(&

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
!!
Expand Down Expand Up @@ -450,7 +450,7 @@ SUBROUTINE h5ltread_dataset_f_int1(&
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
Expand All @@ -464,7 +464,7 @@ SUBROUTINE h5ltread_dataset_f_int1(&
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
Expand Down Expand Up @@ -1845,7 +1845,7 @@ END FUNCTION h5ltpath_valid_c

END SUBROUTINE h5ltpath_valid_f

#ifdef H5_DOXYGEN_FORTRAN
#ifdef H5_DOXYGEN
END MODULE H5LT
#else
END MODULE H5LT_CONST
Expand Down
Loading