summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Fff.F90
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-09-14 20:44:24 (GMT)
committerGitHub <noreply@github.com>2022-09-14 20:44:24 (GMT)
commit45178c87a3099a9fef8bae6f7249ca306cf89629 (patch)
treecb404581365434d641e4d6303921613ef3432bd0 /fortran/src/H5Fff.F90
parentdcf3b54b6ef3ffe2093cfae81fe80cdb2bb53047 (diff)
downloadhdf5-45178c87a3099a9fef8bae6f7249ca306cf89629.zip
hdf5-45178c87a3099a9fef8bae6f7249ca306cf89629.tar.gz
hdf5-45178c87a3099a9fef8bae6f7249ca306cf89629.tar.bz2
develop Merge doxygen from 1.12 branch (#2095)
Diffstat (limited to 'fortran/src/H5Fff.F90')
-rw-r--r--fortran/src/H5Fff.F9010
1 files changed, 7 insertions, 3 deletions
diff --git a/fortran/src/H5Fff.F90 b/fortran/src/H5Fff.F90
index c58cb9e..817dab0 100644
--- a/fortran/src/H5Fff.F90
+++ b/fortran/src/H5Fff.F90
@@ -4,6 +4,10 @@
!!
!! @see @ref H5F_UG, User Guide
!!
+
+!> @ingroup FH5F
+!!
+!! @brief This module contains Fortran interfaces for H5F functions.
!
! COPYRIGHT
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
@@ -628,7 +632,7 @@ CONTAINS
!! \param file_id Target file identifier.
!! \param buf_ptr Pointer to the buffer into which the image of the HDF5 file is to be copied.
!! \param buf_len Size of the supplied buffer.
-!! \param hdferr Error code: 0 on success and -1 on failure.
+!! \param hdferr \fortran_error
!! \param buf_size Returns the size in bytes of the buffer required to store the file image, no data will be copied.
!!
SUBROUTINE h5fget_file_image_f(file_id, buf_ptr, buf_len, hdferr, buf_size)
@@ -673,7 +677,7 @@ CONTAINS
!!
!! \param file_id Target file identifier.
!! \param minimize Value of the setting.
-!! \param hdferr Error code: 0 on success and -1 on failure.
+!! \param hdferr \fortran_error
!!
SUBROUTINE h5fget_dset_no_attrs_hint_f(file_id, minimize, hdferr)
IMPLICIT NONE
@@ -706,7 +710,7 @@ CONTAINS
!!
!! \param file_id Target file identifier.
!! \param minimize Value of the setting.
-!! \param hdferr Error code: 0 on success and -1 on failure.
+!! \param hdferr \fortran_error
!!
SUBROUTINE h5fset_dset_no_attrs_hint_f(file_id, minimize, hdferr)
IMPLICIT NONE