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

Fixed Fortran Doxygen warnings (#3017)

Browse Source 
Fixes Fortran doxygen warnings, #2998
This commit is contained in:
Scot Breitenfeld 2023-05-26 08:29:38 -05:00 committed by GitHub
parent 25457d369d
commit e08c822c6f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 106 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doxygen/aliases
View File

@ -384,4 +384,6 @@ ALIASES += fortran_file="Pointer to filename the async subroutine is being calle
ALIASES += fortran_func="Pointer to function name the async subroutine is being called in, func must be null character terminated"
ALIASES += fortran_line="Line number the async subroutine is being called at"
ALIASES += fortran_plist_id="Property list identifier"
ALIASES += fortran_es_id="Event set identifier"
ALIASES += fortran_vol_name="Connector name"

65
fortran/src/H5Aff.F90
View File

@ -96,12 +96,12 @@ MODULE H5A
! Interface for the function used to pass the C pointer of the buffer
! to the C H5Awrite routine
INTERFACE
INTEGER FUNCTION h5awrite_f_c(attr_id, mem_type_id, buf) BIND(C, NAME='h5awrite_f_c')
INTEGER FUNCTION h5awrite_f_c(attr_id, memtype_id, buf) BIND(C, NAME='h5awrite_f_c')
IMPORT :: c_ptr
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: attr_id
INTEGER(HID_T), INTENT(IN) :: mem_type_id
INTEGER(HID_T), INTENT(IN) :: memtype_id
TYPE(C_PTR), VALUE :: buf
END FUNCTION h5awrite_f_c
END INTERFACE
@ -109,12 +109,12 @@ MODULE H5A
! Interface for the function used to pass the C pointer of the buffer
! to the C H5Aread routine
INTERFACE
INTEGER FUNCTION h5aread_f_c(attr_id, mem_type_id, buf) BIND(C, NAME='h5aread_f_c')
INTEGER FUNCTION h5aread_f_c(attr_id, memtype_id, buf) BIND(C, NAME='h5aread_f_c')
IMPORT :: c_ptr
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: attr_id
INTEGER(HID_T), INTENT(IN) :: mem_type_id
INTEGER(HID_T), INTENT(IN) :: memtype_id
TYPE(C_PTR), VALUE :: buf
END FUNCTION h5aread_f_c
END INTERFACE
@ -207,7 +207,7 @@ CONTAINS
!! \param type_id Attribute datatype identifier
!! \param space_id Attribute dataspace identifier
!! \param attr_id Attribute identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param acpl_id Attribute creation property list identifier
!! \param aapl_id Attribute access property list identifier
@ -582,7 +582,7 @@ CONTAINS
!! \brief Closes the specified attribute.
!!
!! \param attr_id Attribute identifier
!! \param hdferr \fortran_error
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Aclose()
!!
@ -608,7 +608,7 @@ CONTAINS
!! \brief Asynchronously closes the specified attribute.
!!
!! \param attr_id Attribute identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -778,6 +778,7 @@ CONTAINS
!! \param obj_name Name of object, relative to location, whose attribute is to be renamed
!! \param old_attr_name Prior attribute name
!! \param new_attr_name New attribute name
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list identifier
!! \param file \fortran_file
@ -890,7 +891,7 @@ CONTAINS
!! \param obj_id Identifier for object to which attribute is attached
!! \param attr_name Name of attribute to open
!! \param attr_id Attribute identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param aapl_id Attribute access property list
!! \param file \fortran_file
@ -1154,7 +1155,7 @@ CONTAINS
!! \li H5_ITER_N_F - Number of iteration orders
!! \param n Attribute’s position in index.
!! \param attr_id Attribute identifier.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param aapl_id Attribute access property list.
!! \param lapl_id Link access property list.
@ -1506,7 +1507,7 @@ CONTAINS
!! \param type_id Attribute datatype identifier
!! \param space_id Attribute dataspace identifier
!! \param attr An attribute identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param acpl_id Attribute creation property list identifier (Currently not used.)
!! \param aapl_id Attribute access property list identifier (Currently not used.)
@ -1646,7 +1647,7 @@ CONTAINS
!! \param attr_exists Pointer to attribute exists status. It should be declared INTEGER(C_INT) and initialized
!! to zero (false) for portability. It will return one when true. LOGICAL(C_BOOL) is also
!! acceptable but may encounter atypical anomalies. It should be initialized to false when used.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -1761,7 +1762,7 @@ CONTAINS
!! \param obj_name Object name either relative to loc_id, absolute from the file’s root group, or '. '(a dot)
!! \param attr_name Attribute name
!! \param attr_exists Pointer to attribute exists status, must be of type LOGICAL(C_BOOL) and initialize to .FALSE.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list identifier
!! \param file \fortran_file
@ -1891,7 +1892,7 @@ CONTAINS
!! \param obj_name Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot)
!! \param attr_name Attribute name
!! \param attr_id Attribute identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param aapl_id Attribute access property list (Currently unused; should be passed in as H5P_DEFAULT.)
!! \param lapl_id Link access property list identifier
@ -2011,7 +2012,7 @@ CONTAINS
!! \param loc_id Location or object identifier; may be dataset or group
!! \param old_attr_name Prior attribute name
!! \param new_attr_name New attribute name
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -2074,7 +2075,7 @@ CONTAINS
!! \param attr_id Identifier of an attribute to read.
!! \param memtype_id Identifier of the attribute datatype (in memory).
!! \param buf Buffer for data to be read.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -2083,10 +2084,10 @@ CONTAINS
!! See C API: @ref H5Aread_async()
!!
SUBROUTINE h5aread_async_f(attr_id, mem_type_id, buf, es_id, hdferr, file, func, line)
SUBROUTINE h5aread_async_f(attr_id, memtype_id, buf, es_id, hdferr, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: attr_id
INTEGER(HID_T), INTENT(IN) :: mem_type_id
INTEGER(HID_T), INTENT(IN) :: memtype_id
TYPE(C_PTR) , INTENT(IN) :: buf
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER , INTENT(OUT) :: hdferr
@ -2099,7 +2100,7 @@ CONTAINS
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER FUNCTION H5Aread_async(file, func, line, attr_id, mem_type_id, buf, es_id) &
INTEGER FUNCTION H5Aread_async(file, func, line, attr_id, memtype_id, buf, es_id) &
BIND(C,NAME='H5Aread_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
@ -2108,7 +2109,7 @@ CONTAINS
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: attr_id
INTEGER(HID_T), VALUE :: mem_type_id
INTEGER(HID_T), VALUE :: memtype_id
TYPE(C_PTR) , VALUE :: buf
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Aread_async
@ -2118,7 +2119,7 @@ CONTAINS
IF (PRESENT(func)) func_default = func
IF (PRESENT(line)) line_default = INT(line, C_INT)
hdferr = H5Aread_async(file_default, func_default, line_default, attr_id, mem_type_id, buf, es_id)
hdferr = H5Aread_async(file_default, func_default, line_default, attr_id, memtype_id, buf, es_id)
END SUBROUTINE h5aread_async_f
@ -2130,7 +2131,7 @@ CONTAINS
!! \param attr_id Identifier of an attribute to read.
!! \param memtype_id Identifier of the attribute datatype (in memory).
!! \param buf Data to be written.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -2139,10 +2140,10 @@ CONTAINS
!! See C API: @ref H5Awrite_async()
!!
SUBROUTINE h5awrite_async_f(attr_id, mem_type_id, buf, es_id, hdferr, file, func, line)
SUBROUTINE h5awrite_async_f(attr_id, memtype_id, buf, es_id, hdferr, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: attr_id
INTEGER(HID_T), INTENT(IN) :: mem_type_id
INTEGER(HID_T), INTENT(IN) :: memtype_id
TYPE(C_PTR) , INTENT(IN) :: buf
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER , INTENT(OUT) :: hdferr
@ -2155,7 +2156,7 @@ CONTAINS
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER FUNCTION H5Awrite_async(file, func, line, attr_id, mem_type_id, buf, es_id) &
INTEGER FUNCTION H5Awrite_async(file, func, line, attr_id, memtype_id, buf, es_id) &
BIND(C,NAME='H5Awrite_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
@ -2164,7 +2165,7 @@ CONTAINS
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: attr_id
INTEGER(HID_T), VALUE :: mem_type_id
INTEGER(HID_T), VALUE :: memtype_id
TYPE(C_PTR) , VALUE :: buf
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Awrite_async
@ -2174,7 +2175,7 @@ CONTAINS
IF (PRESENT(func)) func_default = func
IF (PRESENT(line)) line_default = INT(line, C_INT)
hdferr = H5Awrite_async(file_default, func_default, line_default, attr_id, mem_type_id, buf, es_id)
hdferr = H5Awrite_async(file_default, func_default, line_default, attr_id, memtype_id, buf, es_id)
END SUBROUTINE h5awrite_async_f
@ -2300,14 +2301,14 @@ CONTAINS
END SUBROUTINE h5awrite_char_scalar_fix
SUBROUTINE h5awrite_ptr(attr_id, mem_type_id, buf, hdferr)
SUBROUTINE h5awrite_ptr(attr_id, memtype_id, buf, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: attr_id
INTEGER(HID_T), INTENT(IN) :: mem_type_id
INTEGER(HID_T), INTENT(IN) :: memtype_id
TYPE(C_PTR), INTENT(IN), TARGET :: buf
INTEGER, INTENT(OUT) :: hdferr
hdferr = H5Awrite_f_c(attr_id, mem_type_id, buf)
hdferr = H5Awrite_f_c(attr_id, memtype_id, buf)
END SUBROUTINE h5awrite_ptr
@ -2338,14 +2339,14 @@ CONTAINS
END SUBROUTINE h5aread_char_scalar_fix
SUBROUTINE h5aread_ptr(attr_id, mem_type_id, buf, hdferr)
SUBROUTINE h5aread_ptr(attr_id, memtype_id, buf, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: attr_id
INTEGER(HID_T), INTENT(IN) :: mem_type_id
INTEGER(HID_T), INTENT(IN) :: memtype_id
TYPE(C_PTR), INTENT(INOUT) :: buf
INTEGER, INTENT(OUT) :: hdferr
hdferr = H5Aread_f_c(attr_id, mem_type_id, buf)
hdferr = H5Aread_f_c(attr_id, memtype_id, buf)
END SUBROUTINE h5aread_ptr

14
fortran/src/H5Dff.F90
View File

@ -287,7 +287,7 @@ CONTAINS
!! \param type_id Dataset datatype identifier
!! \param space_id Dataset dataspace identifier
!! \param dset_id Dataset identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param dcpl_id Dataset creation property list
!! \param lcpl_id Link creation property list
@ -422,7 +422,7 @@ CONTAINS
!! \param loc_id File or group identifier
!! \param name Dataset name
!! \param dset_id Dataset identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param dapl_id Dataset access property list
!! \param file \fortran_file
@ -515,7 +515,7 @@ CONTAINS
!! \brief Asynchronously closes a dataset.
!!
!! \param dset_id Dataset identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -659,7 +659,7 @@ CONTAINS
!!
!! \param dataset_id Dataset identifier
!! \param fsize Array containing the new magnitude of each dimension
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -1363,7 +1363,7 @@ CONTAINS
!!
!! \param dataset_id Dataset identifier.
!! \param dataspace_id Dataspace identifier.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -1485,7 +1485,7 @@ CONTAINS
!! \param dset_id Identifier of the dataset read from.
!! \param mem_type_id Identifier of the memory datatype.
!! \param buf Buffer to receive data read from file.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param mem_space_id Identifier of the memory dataspace.
!! \param file_space_id Identifier of dataset's dataspace in the file. (Default: H5S_ALL_F)
@ -1552,7 +1552,7 @@ CONTAINS
!! \param dset_id Identifier of the dataset to write to.
!! \param mem_type_id Identifier of the memory datatype.
!! \param buf Buffer with data to be written to the file.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param mem_space_id Identifier of the memory dataspace.
!! \param file_space_id Identifier of the dataset's dataspace in the file.

16
fortran/src/H5ESff.F90
View File

@ -44,7 +44,7 @@ CONTAINS
!!
!! \brief Creates an event set.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5EScreate()
@ -72,7 +72,7 @@ CONTAINS
!!
!! \brief Retrieves number of events in an event set.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param count The number of events in the event set
!! \param hdferr \fortran_error
!!
@ -102,7 +102,7 @@ CONTAINS
!!
!! \brief Retrieves the next operation counter to be assigned in an event set.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param counter The number of events in the event set
!! \param hdferr \fortran_error
!!
@ -133,7 +133,7 @@ CONTAINS
!!
!! \brief Waits for operations in event set to complete.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param timeout The number of events in the event set
!! \param num_in_progress The number of operations still in progress
!! \param err_occurred Flag if an operation in the event set failed
@ -175,7 +175,7 @@ CONTAINS
!!
!! \brief Attempt to cancel operations in an event set.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param num_not_canceled The number of events not canceled
!! \param err_occurred Status indicating if error is present in the event set
!! \param hdferr \fortran_error
@ -214,7 +214,7 @@ CONTAINS
!!
!! \brief Checks for failed operations.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param err_occurred Status indicating if error is present in the event set
!! \param hdferr \fortran_error
!!
@ -250,7 +250,7 @@ CONTAINS
!!
!! \brief Retrieves the number of failed operations.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param num_errs Number of errors
!! \param hdferr \fortran_error
!!
@ -282,7 +282,7 @@ CONTAINS
!!
!! \brief Terminates access to an event set.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5ESclose()

10
fortran/src/H5Fff.F90
View File

@ -127,7 +127,7 @@ CONTAINS
!! \li H5F_ACC_TRUNC_F
!! \li H5F_ACC_EXCL_F
!! \param file_id File identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param creation_prp File creation property list identifier
!! \param access_prp File access property list identifier
@ -234,7 +234,7 @@ CONTAINS
!! \param scope Specifies the scope of the flushing action. Possible values are:
!! \li H5F_SCOPE_GLOBAL_F
!! \li H5F_SCOPE_LOCAL_F
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -418,7 +418,7 @@ CONTAINS
!! \li H5F_ACC_RDWR_F
!! \li H5F_ACC_RDONLY_F
!! \param file_id File identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param access_prp File access property list identifier
!! \param file \fortran_file
@ -515,7 +515,7 @@ CONTAINS
!!
!! \param file_id Identifier of a file for which an additional identifier is required.
!! \param ret_file_id New file identifier.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -724,7 +724,7 @@ CONTAINS
!! \brief Asynchronously closes HDF5 file.
!!
!! \param file_id File identifier
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func

15
fortran/src/H5Gff.F90
View File

@ -261,7 +261,7 @@ CONTAINS
!! \param loc_id Location identifier.
!! \param name Group name at the specified location.
!! \param grp_id Group identifier.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param size_hint A parameter indicating the number of bytes to reserve for the names that will appear in the group.
!! Set to OBJECT_NAMELEN_DEFAULT_F if using any of the optional parameters lcpl_id, gcpl_id,
@ -420,7 +420,7 @@ CONTAINS
!! \param loc_id Location identifier.
!! \param name Name of the group to open.
!! \param grp_id Group identifier.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param gapl_id Group access property list identifier.
!! \param file \fortran_file
@ -509,7 +509,7 @@ CONTAINS
!! \brief Asynchronously closes the specified group.
!!
!! \param grp_id Group identifier.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -1076,7 +1076,7 @@ CONTAINS
!!
!! \param loc_id Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute.
!! \param ginfo Derived type in which group information is returned.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -1234,7 +1234,7 @@ CONTAINS
!! \param order Order of the count in the index.
!! \param n Position in the index of the group for which information is retrieved.
!! \param ginfo Derived type in which group information is returned.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list.
!! \param file \fortran_file
@ -1414,9 +1414,12 @@ CONTAINS
!! \param loc_id File or group identifier.
!! \param name Name of group containing group for which information is to be retrieved.
!! \param ginfo Derived type in which group information is returned.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list.
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Gget_info_by_name_async()
!!

17
fortran/src/H5Lff.F90
View File

@ -180,7 +180,7 @@ CONTAINS
!!
!! \param loc_id Identifier of the file or group containing the object.
!! \param name Name of the link to delete.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list identifier.
!! \param file \fortran_file
@ -198,7 +198,7 @@ CONTAINS
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
INTEGER , OPTIONAL, INTENT(IN) :: line
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
@ -298,7 +298,7 @@ CONTAINS
!! \param target_path Path to the target object, which is not required to exist.
!! \param link_loc_id The file or group identifier for the new link.
!! \param link_name The name of the new link.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list identifier.
!! \param lapl_id Link access property list identifier.
@ -430,7 +430,7 @@ CONTAINS
!! \param obj_name Name of the target object, which must already exist.
!! \param link_loc_id The file or group identifier for the new link.
!! \param link_name The name of the new link.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list identifier.
!! \param lapl_id Link access property list identifier.
@ -644,7 +644,7 @@ CONTAINS
!! \li H5_ITER_NATIVE_F - No particular order, whatever is fastest
!! \li H5_ITER_N_F - Number of iteration orders
!! \param n Link for which to retrieve information.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list.
!! \param file \fortran_file
@ -768,7 +768,7 @@ CONTAINS
!! \param link_exists Pointer to link exists status. It should be declared INTEGER(C_INT) and initialized
!! to zero (false) for portability. It will return one when true. LOGICAL(C_BOOL) is also
!! acceptable but may encounter atypical anomalies. It should be initialized to false when used.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list identifier.
!! \param file \fortran_file
@ -1373,8 +1373,11 @@ CONTAINS
!! in \p return_value for H5Literate_async_f(), so \p return_value should
!! not be used for determining the return state of the callback routine.
!!
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Literate_async()
!!

19
fortran/src/H5Off.F90
View File

@ -266,7 +266,7 @@ CONTAINS
!! \param loc_id File or group identifier.
!! \param name Path to the object, relative to loc_id.
!! \param obj_id Object identifier for the opened object.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Access property list identifier for the link pointing to the object.
!! \param file \fortran_file
@ -357,11 +357,14 @@ CONTAINS
!!
!! \brief Asynchronously closes an object in an HDF5 file.
!!
!! \param object_id Object identifier.
!! \param es_id \es_id
!! \param object_id Object identifier
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Oclose_async_f()
!! See C API: @ref H5Oclose_async()
!!
SUBROUTINE h5oclose_async_f(object_id, es_id, hdferr, file, func, line)
IMPLICIT NONE
@ -370,7 +373,7 @@ CONTAINS
INTEGER , INTENT(OUT) :: hdferr
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
INTEGER , OPTIONAL, INTENT(IN) :: line
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
@ -497,7 +500,7 @@ CONTAINS
!! \param dst_name Name to be assigned to the new copy.
!! \param ocpypl_id Object copy property list.
!! \param lcpl_id Link creation property list for the new hard link.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
@ -845,7 +848,7 @@ CONTAINS
!! \param order Order of iteration within index, NOTE: zero-based.
!! \param n Object to open.
!! \param obj_id An object identifier for the opened object.
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!!
!! \param lapl_id Link access property list.
@ -1120,7 +1123,7 @@ CONTAINS
!! \param loc_id File or group identifier specifying location of group in which object is located.
!! \param name Name of group, relative to loc_id.
!! \param object_info Pointer to buffer returning object information, points to variable of datatype TYPE(C_H5O_INFO_T).
!! \param es_id \es_id
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list.
!! \param fields Flags specifying the fields to include in object_info.

42
fortran/src/H5VLff.F90
View File

@ -52,10 +52,10 @@ CONTAINS
!!
!! \brief Registers a new VOL connector as a member of the virtual object layer class by name.
!!
!! \param name Connector name.
!! \param vol_id VOL connector identifier if successful; otherwise returns H5I_INVALID_HID_F.
!! \param name \fortran_vol_name
!! \param vol_id VOL connector identifier if successful; otherwise returns H5I_INVALID_HID_F
!! \param hdferr \fortran_error
!! \param vipl_id VOL initialization property list identifier.
!! \param vipl_id VOL initialization property list identifier
!!
!! See C API: @ref H5VLregister_connector_by_name()
!!
@ -94,10 +94,10 @@ CONTAINS
!!
!! \brief Registers a new VOL connector by value.
!!
!! \param connector_value Connector value.
!! \param vol_id VOL connector identifier if successful; otherwise returns H5I_INVALID_HID_F.
!! \param connector_value Connector value
!! \param vol_id VOL connector identifier if successful; otherwise returns H5I_INVALID_HID_F
!! \param hdferr \fortran_error
!! \param vipl_id VOL initialization property list identifier.
!! \param vipl_id VOL initialization property list identifier
!!
!! See C API: @ref H5VLregister_connector_by_value()
!!
@ -134,8 +134,8 @@ CONTAINS
!!
!! \brief Determines whether a VOL class has been registered or not ccording to a specified connector name.
!!
!! \param name Connector name.
!! \param registered State of VOL class registration.
!! \param name \fortran_vol_name
!! \param registered State of VOL class registration
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5VLis_connector_registered_by_name()
@ -171,9 +171,9 @@ CONTAINS
!!
!! \brief Determines whether a VOL class has been registered or not according to a specified connector value (ID).
!!
!! \param value ConneConnector value.
!! \param registered State of VOL class registration.
!! \param hdferr Retu\fortran_error
!! \param value Connector value
!! \param registered State of VOL class registration
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5VLis_connector_registered_by_value()
!!
@ -205,7 +205,7 @@ CONTAINS
!!
!! \brief Retrieves the ID for a registered VOL connector.
!!
!! \param obj_id Object id.
!! \param obj_id Object id
!! \param vol_id Connector id.
!! \param hdferr \fortran_error
!!
@ -238,7 +238,7 @@ CONTAINS
!!
!! \brief Retrieves the ID for a registered VOL connector.
!!
!! \param name Connector name.
!! \param name \fortran_vol_name
!! \param vol_id Connector id.
!! \param hdferr \fortran_error
!!
@ -275,8 +275,8 @@ CONTAINS
!!
!! \brief Retrieves the ID for a registered VOL connector.
!!
!! \param value CConnector value.
!! \param vol_id Connector id.
!! \param value Connector value
!! \param vol_id Connector id
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5VLget_connector_id_by_value()
@ -308,10 +308,10 @@ CONTAINS
!!
!! \brief Retrieves a connector name for a VOL.
!!
!! \param obj_id Object identifier or file identifier.
!! \param name Connector name.
!! \param obj_id Object identifier or file identifier
!! \param name \fortran_vol_name
!! \param hdferr \fortran_error
!! \param name_len Maximum length of the name to retrieve.
!! \param name_len Maximum length of the name to retrieve
!!
!! See C API: @ref H5VLget_connector_name()
!!
@ -355,7 +355,7 @@ CONTAINS
!!
!! \brief Closes a VOL connector ID.
!!
!! \param vol_id A valid identifier of the connectory to unregister.
!! \param vol_id A valid identifier of the connectory to unregister
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5VLclose()
@ -381,8 +381,8 @@ CONTAINS
!!
!! \brief Removes a VOL connector ID from the library.
!!
!! \param plugin_id A valid identifier of the connector to unregister..
!! \param hdferr Ret\fortran_error
!! \param plugin_id A valid identifier of the connector to unregister
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5VLunregister_connector()
!!