summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Pff.F90
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2022-09-07 22:11:20 (GMT)
committerGitHub <noreply@github.com>2022-09-07 22:11:20 (GMT)
commit99f17c727166ab88a36280ee93a197de5555412c (patch)
tree793820b86a6924b564443f5201786d9a4b96367e /fortran/src/H5Pff.F90
parent1804e0e0c45ed468ad602dd7af80d44b89160e0e (diff)
downloadhdf5-99f17c727166ab88a36280ee93a197de5555412c.zip
hdf5-99f17c727166ab88a36280ee93a197de5555412c.tar.gz
hdf5-99f17c727166ab88a36280ee93a197de5555412c.tar.bz2
Doxygen Fortran (#2062)
Diffstat (limited to 'fortran/src/H5Pff.F90')
-rw-r--r--fortran/src/H5Pff.F907564
1 files changed, 2394 insertions, 5170 deletions
diff --git a/fortran/src/H5Pff.F90 b/fortran/src/H5Pff.F90
index 96080ce..dbae328 100644
--- a/fortran/src/H5Pff.F90
+++ b/fortran/src/H5Pff.F90
@@ -1,10 +1,13 @@
-!****h* ROBODoc/H5Pff
-!
-! NAME
-! H5P
-!
-! PURPOSE
-! This file contains Fortran interfaces for H5P functions.
+!> @defgroup FH5P Fortran Property List (H5P) Interface
+!!
+!! @see H5P, C-API
+!!
+!! @see @ref H5P_UG, User Guide
+!!
+
+!> @ingroup FH5P
+!!
+!! @brief This module contains Fortran interfaces for H5P functions.
!
! COPYRIGHT
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
@@ -32,7 +35,6 @@
! If you add a new H5P function you must add the function name to the
! Windows dll file 'hdf5_fortrandll.def.in' in the fortran/src directory.
! This is needed for Windows based operating systems.
-!*****
#include <H5config_f.inc>
@@ -50,6 +52,8 @@ MODULE H5P
PRIVATE h5pregister_integer, h5pregister_ptr
PRIVATE h5pinsert_integer, h5pinsert_char, h5pinsert_ptr
+#ifndef H5_DOXYGEN_FORTRAN
+
INTERFACE h5pset_fapl_multi_f
MODULE PROCEDURE h5pset_fapl_multi_l
MODULE PROCEDURE h5pset_fapl_multi_s
@@ -176,58 +180,40 @@ MODULE H5P
END FUNCTION h5pinsert_c
END INTERFACE
+#endif
+
CONTAINS
-!****s* H5P/h5pcreate_f
-! NAME
-! h5pcreate_f
-!
-! PURPOSE
-! Creates a new property as an instance of a property
-! list class.
-!
-! INPUTS
-! class - type of the property class to be created.
-! Possible values are:
-! H5P_OBJECT_CREATE_F
-! H5P_FILE_CREATE_F
-! H5P_FILE_ACCESS_F
-! H5P_DATASET_CREATE_F
-! H5P_DATASET_ACCESS_F
-! H5P_DATASET_XFER_F
-! H5P_FILE_MOUNT_F
-! H5P_GROUP_CREATE_F
-! H5P_GROUP_ACCESS_F
-! H5P_DATATYPE_CREATE_F
-! H5P_DATATYPE_ACCESS_F
-! H5P_STRING_CREATE_F
-! H5P_ATTRIBUTE_CREATE _F
-! H5P_OBJECT_COPY_F
-! H5P_LINK_CREATE_F
-! H5P_LINK_ACCESS_F
-!
-! OUTPUTS
-! prp_id - property list identifier
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Creates a new property as an instance of a property list class.
+!!
+!! \param class Type of the property class to be created. Possible values are:
+!! \li H5P_OBJECT_CREATE_F
+!! \li H5P_FILE_CREATE_F
+!! \li H5P_FILE_ACCESS_F
+!! \li H5P_DATASET_CREATE_F
+!! \li H5P_DATASET_ACCESS_F
+!! \li H5P_DATASET_XFER_F
+!! \li H5P_FILE_MOUNT_F
+!! \li H5P_GROUP_CREATE_F
+!! \li H5P_GROUP_ACCESS_F
+!! \li H5P_DATATYPE_CREATE_F
+!! \li H5P_DATATYPE_ACCESS_F
+!! \li H5P_STRING_CREATE_F
+!! \li H5P_ATTRIBUTE_CREATE _F
+!! \li H5P_OBJECT_COPY_F
+!! \li H5P_LINK_CREATE_F
+!! \li H5P_LINK_ACCESS_F
+!! \param prp_id Property list identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pcreate_f(class, prp_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: class
INTEGER(HID_T), INTENT(OUT) :: prp_id
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pcreate_c(class, prp_id) &
BIND(C,NAME='h5pcreate_c')
@@ -241,47 +227,21 @@ CONTAINS
hdferr = h5pcreate_c(class, prp_id)
END SUBROUTINE h5pcreate_f
-!****s* H5P/h5pset_preserve_f
-! NAME
-! h5pset_preserve_f
-!
-! PURPOSE
-! Sets the dataset transfer property list status to
-! TRUE or FALSE for initializing compound datatype
-! members during write/read operations.
-!
-! INPUTS
-! prp_id - property list identifier
-! flag - status flag
-!
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! OPTIONAL PARAMETERS
-! NONE
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Datatype of the flag parameter is changed from
-! INTEGER to LOGICAL June 4, 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the dataset transfer property list status to TRUE or FALSE for initializing
+!! compound datatype members during write/read operations.
+!!
+!! \param prp_id Property list identifier.
+!! \param flag Status flag.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_preserve_f(prp_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- LOGICAL, INTENT(IN) :: flag ! TRUE/FALSE flag to set the dataset
- ! transfer property for partila writing/reading
- ! compound datatype
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ LOGICAL, INTENT(IN) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: flag_c
INTERFACE
@@ -298,44 +258,20 @@ CONTAINS
hdferr = h5pset_preserve_c(prp_id, flag_c)
END SUBROUTINE h5pset_preserve_f
-!****s* H5P/h5pget_preserve_f
-! NAME
-! h5pget_preserve_f
-!
-! PURPOSE
-! Checks status of the dataset transfer property list.
-!
-! INPUTS
-! prp_id - property list identifier
-!
-! OUTPUTS
-! flag - status flag
-! hdferr - error code
-! Success: 0
-! Failure: -1
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Datatype of the flag parameter is changed from
-! INTEGER to LOGICAL
-! June 4, 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Checks status of the dataset transfer property list.
+!!
+!! \param prp_id Property list identifier.
+!! \param flag Status flag.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_preserve_f(prp_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- LOGICAL, INTENT(OUT) :: flag ! TRUE/FALSE flag. Shows status of the dataset's
- ! transfer property for partial writing/reading
- ! compound datatype
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ LOGICAL, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: flag_c
INTERFACE
@@ -353,40 +289,20 @@ CONTAINS
IF(flag_c .EQ. 1) flag = .TRUE.
END SUBROUTINE h5pget_preserve_f
-!****s* H5P/h5pget_class_f
-! NAME
-! h5pget_class_f
-!
-! PURPOSE
-! Returns the property list class for a property list.
-!
-! INPUTS
-! prp_id - property list identifier
-!
-! OUTPUTS
-! classtype - property list class
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns the property list class for a property list.
+!!
+!! \param prp_id Property list identifier.
+!! \param classtype Property list class.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_class_f(prp_id, classtype, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(OUT) :: classtype ! The type of the property list
- ! to be created.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(OUT) :: classtype
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_class_c(prp_id, classtype) &
@@ -401,39 +317,20 @@ CONTAINS
hdferr = h5pget_class_c(prp_id, classtype)
END SUBROUTINE h5pget_class_f
-!****s* H5P/h5pcopy_f
-! NAME
-! h5pcopy_f
-!
-! PURPOSE
-! Copies an existing property list to create a new
-! property list
-!
-! INPUTS
-! prp_id - property list identifier
-! OUTPUTS
-! new_prp_id - new property list identifier
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Copies an existing property list to create a new property list
+!!
+!! \param prp_id Property list identifier.
+!! \param new_prp_id New property list identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pcopy_f(prp_id, new_prp_id, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(OUT) :: new_prp_id ! Identifier of property list
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(OUT) :: new_prp_id
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pcopy_c(prp_id, new_prp_id) &
@@ -448,37 +345,18 @@ CONTAINS
hdferr = h5pcopy_c(prp_id, new_prp_id)
END SUBROUTINE h5pcopy_f
-!****s* H5P/h5pclose_f
-! NAME
-! h5pclose_f
-!
-! PURPOSE
-! Terminates access to a property list.
-!
-! INPUTS
-! prp_id - identifier of the property list to
-! terminate access to.
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Terminates access to a property list.
+!!
+!! \param prp_id Identifier of the property list to terminate access to.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pclose_f(prp_id, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pclose_c(prp_id) &
BIND(C,NAME='h5pclose_c')
@@ -491,43 +369,23 @@ CONTAINS
hdferr = h5pclose_c(prp_id)
END SUBROUTINE h5pclose_f
-!****s* H5P/h5pset_chunk_f
-! NAME
-! h5pset_chunk_f
-!
-! PURPOSE
-! Sets the size of the chunks used to store
-! a chunked layout dataset.
-!
-! INPUTS
-! prp_id - dataset creation property list identifier
-! ndims - number of dimensions for each chunk
-! dims - array with dimension sizes for each chunk
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the size of the chunks used to store
+!! a chunked layout dataset.
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param ndims Number of dimensions for each chunk.
+!! \param dims Array with dimension sizes for each chunk.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_chunk_f(prp_id, ndims, dims, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: ndims ! Number of chunk dimensions
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: ndims
INTEGER(HSIZE_T), DIMENSION(ndims), INTENT(IN) :: dims
- ! Array containing sizes of
- ! chunk dimensions
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_chunk_c(prp_id, ndims, dims) &
BIND(C,NAME='h5pset_chunk_c')
@@ -542,45 +400,22 @@ CONTAINS
hdferr = h5pset_chunk_c(prp_id, ndims, dims)
END SUBROUTINE h5pset_chunk_f
-!****s* H5P/h5pget_chunk_f
-! NAME
-! h5pget_chunk_f
-!
-! PURPOSE
-! Retrieves the size of chunks for the raw data of a
-! chunked layout dataset
-!
-! INPUTS
-! prp_id - property list identifier
-! ndims - size of dims array
-! OUTPUTS
-! dims - array with dimension sizes for each chunk
-! hdferr - error code
-! Success: number of chunk dimensions
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the size of chunks for the raw data of a chunked layout dataset
+!!
+!! \param prp_id Property list identifier.
+!! \param ndims Size of dims array.
+!! \param dims Array with dimension sizes for each chunk.
+!! \param hdferr Returns number of chunk dimensions if successful and -1 if fails.
+!!
SUBROUTINE h5pget_chunk_f(prp_id, ndims, dims, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: ndims ! Number of chunk dimensions to
- ! to return
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: ndims
INTEGER(HSIZE_T), DIMENSION(ndims), INTENT(OUT) :: dims
- ! Array containing sizes of
- ! chunk dimensions
- INTEGER, INTENT(OUT) :: hdferr ! Error code:
- ! number of chunk dimensions on success,
- ! -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_chunk_c(prp_id, ndims, dims) &
@@ -596,39 +431,20 @@ CONTAINS
hdferr = h5pget_chunk_c(prp_id, ndims, dims)
END SUBROUTINE h5pget_chunk_f
-!****s* H5P/h5pset_deflate_f
-! NAME
-! h5pset_deflate_f
-!
-! PURPOSE
-! Sets compression method and compression level.
-!
-! INPUTS
-! prp_id - property list identifier
-! level - compression level
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets compression method and compression level.
+!!
+!! \param prp_id Property list identifier.
+!! \param level Compression level.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_deflate_f(prp_id, level, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: level ! Compression level
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: level
+ INTEGER, INTENT(OUT) :: hdferr
! INTEGER, EXTERNAL :: h5pset_deflate_c
! MS FORTRAN needs explicit interface for C functions called here.
@@ -646,51 +462,28 @@ CONTAINS
END SUBROUTINE h5pset_deflate_f
-!****s* H5P/h5pget_version_f
-! NAME
-! h5pget_version_f
-!
-! PURPOSE
-! Retrieves the version information of various objects
-! for a file creation property list
-!
-! INPUTS
-! prp_id - file createion property list identifier
-! OUTPUTS
-! boot - super block version number
-! freelist - global freelist version number
-! stab - symbol table version number
-! shhdr - shared object header version number
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the version information of various objects for a file creation property list.
+!!
+!! \param prp_id File createion property list identifier.
+!! \param boot Super block version number.
+!! \param freelist Global freelist version number.
+!! \param stab Symbol table version number.
+!! \param shhdr Shared object header version number.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_version_f(prp_id, boot, freelist, &
stab, shhdr, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, DIMENSION(:), INTENT(OUT) :: boot ! Array to put boot
- ! block version number
- INTEGER, DIMENSION(:), INTENT(OUT) :: freelist ! Array to put global
- ! Freelist version number
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, DIMENSION(:), INTENT(OUT) :: boot
+ INTEGER, DIMENSION(:), INTENT(OUT) :: freelist
- INTEGER, DIMENSION(:), INTENT(OUT) :: stab ! Array to put symbol
- ! table version number
- INTEGER, DIMENSION(:), INTENT(OUT) :: shhdr ! Array to put shared
- ! object header version number
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, DIMENSION(:), INTENT(OUT) :: stab
+ INTEGER, DIMENSION(:), INTENT(OUT) :: shhdr
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_version_c(prp_id, boot, freelist, stab, shhdr) &
@@ -708,39 +501,20 @@ CONTAINS
hdferr = h5pget_version_c(prp_id, boot, freelist, stab, shhdr)
END SUBROUTINE h5pget_version_f
-!****s* H5P/h5pset_userblock_f
-! NAME
-! h5pset_userblock_f
-!
-! PURPOSE
-! Sets user block size
-!
-! INPUTS
-! prp_id - file creation property list to modify
-! size - size of the user-block in bytes
-!
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets user block size.
+!!
+!! \param prp_id File creation property list to modify.
+!! \param size Size of the user-block in bytes.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_userblock_f (prp_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HSIZE_T), INTENT(IN) :: size ! Size of the user-block in bytes
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HSIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_userblock_c(prp_id, size) &
BIND(C,NAME='h5pset_userblock_c')
@@ -754,41 +528,20 @@ CONTAINS
hdferr = h5pset_userblock_c(prp_id, size)
END SUBROUTINE h5pset_userblock_f
-!****s* H5P/h5pget_userblock_f
-! NAME
-! h5pget_userblock_f
-!
-! PURPOSE
-! Gets user block size.
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! OUTPUTS
-!
-! block_size - size of the user block in bytes
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets user block size.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param block_size Size of the user block in bytes.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_userblock_f(prp_id, block_size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HSIZE_T), INTENT(OUT) :: block_size ! Size of the
- ! user-block in bytes
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HSIZE_T), INTENT(OUT) :: block_size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_userblock_c(prp_id, block_size) &
BIND(C,NAME='h5pget_userblock_c')
@@ -801,44 +554,22 @@ CONTAINS
hdferr = h5pget_userblock_c(prp_id, block_size)
END SUBROUTINE h5pget_userblock_f
-!****s* H5P/h5pset_sizes_f
-! NAME
-! h5pset_sizes_f
-!
-! PURPOSE
-! Sets the byte size of the offsets and lengths used
-! to address objects in an HDF5 file.
-!
-! INPUTS
-! prp_id - file creation property list identifier
-! sizeof_addr - size of an object offset in bytes
-! sizeof_size - size of an object length in bytes
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the byte size of the offsets and lengths used to address objects in an HDF5 file.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param sizeof_addr Size of an object offset in bytes.
+!! \param sizeof_size Size of an object length in bytes.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_sizes_f (prp_id, sizeof_addr, sizeof_size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(SIZE_T), INTENT(IN) :: sizeof_addr ! Size of an object
- ! offset in bytes
- INTEGER(SIZE_T), INTENT(IN) :: sizeof_size ! Size of an object
- ! length in bytes
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(SIZE_T), INTENT(IN) :: sizeof_addr
+ INTEGER(SIZE_T), INTENT(IN) :: sizeof_size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_sizes_c(prp_id, sizeof_addr, sizeof_size) &
BIND(C,NAME='h5pset_sizes_c')
@@ -853,44 +584,22 @@ CONTAINS
hdferr = h5pset_sizes_c(prp_id, sizeof_addr, sizeof_size)
END SUBROUTINE h5pset_sizes_f
-!****s* H5P/h5pget_sizes_f
-! NAME
-! h5pget_sizes_f
-!
-! PURPOSE
-! Retrieves the size of the offsets and lengths used
-! in an HDF5 file
-!
-! INPUTS
-! prp_id - file creation property list identifier
-! OUTPUTS
-!
-! sizeof_addr - size of an object offset in bytes
-! sizeof_size - size of an object length in bytes
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the size of the offsets and lengths used in an HDF5 file
+!!
+!! \param prp_id File Creation property list identifier.
+!! \param sizeof_addr Size of an object offset in bytes.
+!! \param sizeof_size Size of an object length in bytes.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_sizes_f(prp_id, sizeof_addr, sizeof_size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(SIZE_T), INTENT(OUT) :: sizeof_addr ! Size of an object
- ! offset in bytes
- INTEGER(SIZE_T), INTENT(OUT) :: sizeof_size ! Size of an object
- ! length in bytes
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(SIZE_T), INTENT(OUT) :: sizeof_addr
+ INTEGER(SIZE_T), INTENT(OUT) :: sizeof_size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_sizes_c(prp_id, sizeof_addr, sizeof_size) &
BIND(C,NAME='h5pget_sizes_c')
@@ -905,43 +614,22 @@ CONTAINS
hdferr = h5pget_sizes_c(prp_id, sizeof_addr, sizeof_size)
END SUBROUTINE h5pget_sizes_f
-!****s* H5P/h5pset_sym_k_f
-! NAME
-! h5pset_sym_k_f
-!
-! PURPOSE
-! Sets the size of parameters used to control the
-!symbol table nodes
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! ik - symbol table tree rank
-! lk - symbol table node size
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the size of parameters used to control the symbol table nodes.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param ik Symbol table tree rank.
+!! \param lk Symbol table node size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_sym_k_f (prp_id, ik, lk, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: ik ! Symbol table tree rank
- INTEGER, INTENT(IN) :: lk ! Symbol table node size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: ik
+ INTEGER, INTENT(IN) :: lk
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_sym_k_c(prp_id, ik, lk) &
BIND(C,NAME='h5pset_sym_k_c')
@@ -955,43 +643,22 @@ CONTAINS
hdferr = h5pset_sym_k_c(prp_id, ik, lk)
END SUBROUTINE h5pset_sym_k_f
-!****s* H5P/h5pget_sym_k_f
-! NAME
-! h5pget_sym_k_f
-!
-! PURPOSE
-! Retrieves the size of the symbol table B-tree 1/2 rank
-! and the symbol table leaf node 1/2 size.
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! OUTPUTS
-!
-! ik - symbol table tree 1/2 rank
-! lk - symbol table node 1/2 size
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param ik Symbol table tree 1/2 rank.
+!! \param lk Symbol table node 1/2 size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_sym_k_f(prp_id, ik, lk, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: ik ! Symbol table tree rank
- INTEGER, INTENT(OUT) :: lk ! Symbol table node size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: ik
+ INTEGER, INTENT(OUT) :: lk
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_sym_k_c(prp_id, ik, lk) &
BIND(C,NAME='h5pget_sym_k_c')
@@ -1005,41 +672,20 @@ CONTAINS
hdferr = h5pget_sym_k_c(prp_id, ik, lk)
END SUBROUTINE h5pget_sym_k_f
-!****s* H5P/h5pset_istore_k_f
-! NAME
-! h5pset_istore_k_f
-!
-! PURPOSE
-! Sets the size of the parameter used to control the
-! B-trees for indexing chunked datasets
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! ik - 1/2 rank of chunked storage B-tree
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the size of the parameter used to control the B-trees for indexing chunked datasets
+!!
+!! \param prp_id File creation property list identifier.
+!! \param ik 1/2 rank of chunked storage B-tree.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_istore_k_f (prp_id, ik, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: ik ! 1/2 rank of chunked storage B-tree
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: ik
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_istore_k_c(prp_id, ik) &
BIND(C,NAME='h5pset_istore_k_c')
@@ -1053,40 +699,20 @@ CONTAINS
hdferr = h5pset_istore_k_c(prp_id, ik)
END SUBROUTINE h5pset_istore_k_f
-!****s* H5P/h5pget_istore_k_f
-! NAME
-! h5pget_istore_k_f
-!
-! PURPOSE
-! Queries the 1/2 rank of an indexed storage B-tree.
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! OUTPUTS
-!
-! ik - 1/2 rank of chunked storage B-tree
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the 1/2 rank of an indexed storage B-tree.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param ik Rank of chunked storage B-tree.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_istore_k_f(prp_id, ik, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: ik ! 1/2 rank of chunked storage B-tree
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: ik
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_istore_k_c(prp_id, ik) &
BIND(C,NAME='h5pget_istore_k_c')
@@ -1100,41 +726,20 @@ CONTAINS
hdferr = h5pget_istore_k_c(prp_id, ik)
END SUBROUTINE h5pget_istore_k_f
-!****s* H5P/h5pget_driver_f
-! NAME
-! h5pget_driver_f
-!
-! PURPOSE
-! Returns low-lever driver identifier.
-!
-! INPUTS
-!
-! prp_id - file access or data transfer property
-! list identifier.
-! OUTPUTS
-!
-! driver - low-level driver identifier
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns low-lever driver identifier.
+!!
+!! \param prp_id File access or data transfer property list identifier.
+!! \param driver Low-level driver identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_driver_f(prp_id, driver, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(OUT) :: driver ! Low-level file driver identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(OUT) :: driver
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_driver_c(prp_id, driver) &
BIND(C,NAME='h5pget_driver_c')
@@ -1148,38 +753,18 @@ CONTAINS
hdferr = h5pget_driver_c(prp_id, driver)
END SUBROUTINE h5pget_driver_f
-!****s* H5P/h5pset_fapl_stdio_f
-! NAME
-! h5pset_fapl_stdio_f
-!
-! PURPOSE
-! Sets the standard I/O driver.
-!
-! INPUTS
-!
-! prp_id - file access property list identifier
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the standard I/O driver.
+!!
+!! \param prp_id File access property list identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_stdio_f (prp_id, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_fapl_stdio_c(prp_id) &
BIND(C,NAME='h5pset_fapl_stdio_c')
@@ -1192,162 +777,46 @@ CONTAINS
hdferr = h5pset_fapl_stdio_c(prp_id)
END SUBROUTINE h5pset_fapl_stdio_f
-!****s* H5P/h5pget_stdio_f
-! NAME
-! h5pget_stdio_f
-!
-! PURPOSE
-! NOT AVAILABLE
-!
-! INPUTS
-!
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! SOURCE
-! SUBROUTINE h5pget_stdio_f (prp_id, io, hdferr)
-!
-! IMPLICIT NONE
-! INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-! INTEGER, INTENT(OUT) :: io ! value indicates that the file
- !access property list is set to
- !the stdio driver
-! INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
-! INTEGER, EXTERNAL :: h5pget_stdio_c
-! hdferr = h5pget_stdio_c(prp_id, io)
-! END SUBROUTINE h5pget_stdio_f
-
-!****s* H5P/h5pset_fapl_sec2_f
-! NAME
-! h5pset_fapl_sec2_f
-!
-! PURPOSE
-! Sets the sec2 driver.
-!
-! INPUTS
-!
-! prp_id - file access property list identifier
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the sec2 driver.
+!!
+!! \param prp_id File access property list identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_sec2_f (prp_id, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_fapl_sec2_c(prp_id) &
BIND(C,NAME='h5pset_fapl_sec2_c')
IMPORT :: HID_T
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
+ INTEGER(HID_T), INTENT(IN) :: prp_id
END FUNCTION h5pset_fapl_sec2_c
END INTERFACE
hdferr = h5pset_fapl_sec2_c(prp_id)
END SUBROUTINE h5pset_fapl_sec2_f
-!****s* H5P/h5pget_sec2_f
-! NAME
-! h5pget_sec2_f
-!
-! PURPOSE
-! NOT AVAILABLE
-!
-! INPUTS
-!
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! SOURCE! SUBROUTINE h5pget_sec2_f (prp_id, sec2, hdferr)
-! IMPLICIT NONE
-! INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-! INTEGER, INTENT(OUT) :: sec2 ! value indicates whether the file
- !driver uses the functions declared
- !in the unistd.h file
-! INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
-! INTEGER, EXTERNAL :: h5pget_sec2_c
-! hdferr = h5pget_sec2_c(prp_id, sec2)
-! END SUBROUTINE h5pget_sec2_f
-
-!****s* H5P/h5pset_alignment_f
-! NAME
-! h5pset_alignment_f
-!
-! PURPOSE
-! Sets alignment properties of a file access property list.
-!
-! INPUTS
-!
-! prp_id - file access property list identifier
-! threshold - threshold value
-! alignment - alignment value
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets alignment properties of a file access property list.
+!!
+!! \param prp_id File access property list identifier.
+!! \param threshold Threshold value.
+!! \param alignment Alignment value.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_alignment_f(prp_id, threshold, alignment, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HSIZE_T), INTENT(IN) :: threshold ! Threshold value
- INTEGER(HSIZE_T), INTENT(IN) :: alignment ! alignment value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HSIZE_T), INTENT(IN) :: threshold
+ INTEGER(HSIZE_T), INTENT(IN) :: alignment
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_alignment_c(prp_id, threshold, alignment) &
BIND(C,NAME='h5pset_alignment_c')
@@ -1362,42 +831,22 @@ CONTAINS
hdferr = h5pset_alignment_c(prp_id, threshold, alignment)
END SUBROUTINE h5pset_alignment_f
-!****s* H5P/h5pget_alignment_f
-! NAME
-! h5pget_alignment_f
-!
-! PURPOSE
-! Retrieves the current settings for alignment
-! properties from a file access property list.
-!
-! INPUTS
-! prp_id - file access property list identifier
-!
-! OUTPUTS
-! threshold - threshold value
-! alignment - alignment value
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the current settings for alignment properties from a file access property list.
+!!
+!! \param prp_id File access property list identifier.
+!! \param threshold Threshold value.
+!! \param alignment Alignment value.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_alignment_f(prp_id, threshold, alignment, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HSIZE_T), INTENT(OUT) :: threshold ! Threshold value
- INTEGER(HSIZE_T), INTENT(OUT) :: alignment ! alignment value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HSIZE_T), INTENT(OUT) :: threshold
+ INTEGER(HSIZE_T), INTENT(OUT) :: alignment
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_alignment_c(prp_id, threshold, alignment) &
BIND(C,NAME='h5pget_alignment_c')
@@ -1412,44 +861,22 @@ CONTAINS
hdferr = h5pget_alignment_c(prp_id, threshold, alignment)
END SUBROUTINE h5pget_alignment_f
-!****s* H5P/h5pset_fapl_core_f
-! NAME
-! h5pset_fapl_core_f
-!
-! PURPOSE
-! Modifies the file access property list to use the
-! H5FD_CORE driver.
-!
-! INPUTS
-! prp_id - file access property list identifier
-! increment - size, in bytes, of memory increments
-! backing_store - boolean flag indicating whether to write
-! the file contents to disk when the file is closed.
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Modifies the file access property list to use the H5FD_CORE driver.
+!!
+!! \param prp_id File access property list identifier.
+!! \param increment Size, in bytes, of memory increments.
+!! \param backing_store Boolean flag indicating whether to write the file contents to disk when the file is closed.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_core_f(prp_id, increment, backing_store, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(SIZE_T), INTENT(IN) :: increment ! File block size in bytes.
- LOGICAL, INTENT(IN) :: backing_store ! Flag to indicate that
- ! entire file contents are flushed to a file
- ! with the same name as this core file.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(SIZE_T), INTENT(IN) :: increment
+ LOGICAL, INTENT(IN) :: backing_store
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: backing_store_flag
INTERFACE
INTEGER FUNCTION h5pset_fapl_core_c(prp_id, increment, backing_store_flag) &
@@ -1466,44 +893,22 @@ CONTAINS
hdferr = h5pset_fapl_core_c(prp_id, increment, backing_store_flag)
END SUBROUTINE h5pset_fapl_core_f
-!****s* H5P/h5pget_fapl_core_f
-! NAME
-! h5pget_fapl_core_f
-!
-! PURPOSE
-! Queries core file driver properties.
-!
-! INPUTS
-! prp_id - file access property list identifier
-! OUTPUTS
-!
-! increment - size, in bytes, of memory increments
-! backing_store - boolean flag indicating whether to write
-! the file contents to disk when the file is closed.
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries core file driver properties.
+!!
+!! \param prp_id File access property list identifier.
+!! \param increment Size, in bytes, of memory increments.
+!! \param backing_store Boolean flag indicating whether to write the file contents to disk when the file is closed.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_fapl_core_f(prp_id, increment, backing_store, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(SIZE_T), INTENT(OUT) :: increment ! File block size in bytes.
- LOGICAL, INTENT(OUT) :: backing_store ! Flag to indicate that
- ! entire file contents are flushed to a file
- ! with the same name as this core file.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(SIZE_T), INTENT(OUT) :: increment
+ LOGICAL, INTENT(OUT) :: backing_store
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: backing_store_flag
INTERFACE
@@ -1522,44 +927,22 @@ CONTAINS
IF (backing_store_flag .EQ. 1) backing_store =.TRUE.
END SUBROUTINE h5pget_fapl_core_f
-!****s* H5P/ h5pset_fapl_family_f
-! NAME
-! h5pset_fapl_family_f
-!
-! PURPOSE
-! Sets the file access property list to use the family driver.
-!
-! INPUTS
-! prp_id - file access property list identifier
-! memb_size - size in bytes of each file member
-! memb_plist - identifier of the file access property
-! list to be used for each family member
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the file access property list to use the family driver.
+!!
+!! \param prp_id File access property list identifier.
+!! \param memb_size Size in bytes of each file member.
+!! \param memb_plist Identifier of the file access property list to be used for each family member.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_family_f(prp_id, memb_size, memb_plist , hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HSIZE_T), INTENT(IN) :: memb_size ! Logical size, in bytes,
- ! of each family member
- INTEGER(HID_T), INTENT(IN) :: memb_plist ! Identifier of the file
- ! access property list for
- ! each member of the family
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HSIZE_T), INTENT(IN) :: memb_size
+ INTEGER(HID_T), INTENT(IN) :: memb_plist
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_fapl_family_c(prp_id, memb_size, memb_plist) &
BIND(C,NAME='h5pset_fapl_family_c')
@@ -1574,43 +957,22 @@ CONTAINS
hdferr = h5pset_fapl_family_c(prp_id, memb_size, memb_plist)
END SUBROUTINE h5pset_fapl_family_f
-!****s* H5P/h5pget_fapl_family_f
-! NAME
-! h5pget_fapl_family_f
-!
-! PURPOSE
-! Returns file access property list information.
-!
-! INPUTS
-! prp_id - file access property list identifier
-! OUTPUTS
-! memb_size - size in bytes of each file member
-! memb_plist - identifier of the file access property
-! list to be used for each family member
-! hdferr - error code
-! Success: 0
-! Failure: -1
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns file access property list information.
+!!
+!! \param prp_id File access property list identifier.
+!! \param memb_size Size in bytes of each file member.
+!! \param memb_plist Identifier of the file access property list to be used for each family member.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_fapl_family_f(prp_id, memb_size, memb_plist , hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HSIZE_T), INTENT(OUT) :: memb_size ! Logical size, in bytes,
- ! of each family member
- INTEGER(HID_T), INTENT(OUT) :: memb_plist ! Identifier of the file
- ! access property list for
- ! each member of the family
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HSIZE_T), INTENT(OUT) :: memb_size
+ INTEGER(HID_T), INTENT(OUT) :: memb_plist
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_fapl_family_c(prp_id, memb_size, memb_plist) &
BIND(C,NAME='h5pget_fapl_family_c')
@@ -1625,52 +987,26 @@ CONTAINS
hdferr = h5pget_fapl_family_c(prp_id, memb_size, memb_plist)
END SUBROUTINE h5pget_fapl_family_f
-!****s* H5P/h5pset_cache_f
-! NAME
-! h5pset_cache_f
-!
-! PURPOSE
-! Sets the meta data cache and raw data chunk
-! cache parameters
-!
-! INPUTS
-!
-! prp_id - file access property list identifier
-! mdc_nelmts - number of elements (objects) in the meta
-! data cache
-! rdcc_nelmts - number of elements (objects) in the raw
-! data chunk cache
-! rdcc_nbytes - total size of the raw data chunk cache, in bytes
-! rdcc_w0 - preemption policy (0 or 1)
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the meta data cache and raw data chunk cache parameters
+!!
+!! \param prp_id File access property list identifier.
+!! \param mdc_nelmts Number of elements (objects) in the metadata cache.
+!! \param rdcc_nelmts Number of elements (objects) in the raw data chunk cache.
+!! \param rdcc_nbytes Total size of the raw data chunk cache, in bytes.
+!! \param rdcc_w0 Preemption policy (0 or 1).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_cache_f(prp_id, mdc_nelmts,rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: mdc_nelmts ! Number of elements (objects)
- ! in the meta data cache
- INTEGER(SIZE_T), INTENT(IN) :: rdcc_nelmts ! Number of elements (objects)
- ! in the meta data cache
- INTEGER(SIZE_T), INTENT(IN) :: rdcc_nbytes ! Total size of the raw data
- ! chunk cache, in bytes
- REAL, INTENT(IN) :: rdcc_w0 ! Preemption policy
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: mdc_nelmts
+ INTEGER(SIZE_T), INTENT(IN) :: rdcc_nelmts
+ INTEGER(SIZE_T), INTENT(IN) :: rdcc_nbytes
+ REAL, INTENT(IN) :: rdcc_w0
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_cache_c(prp_id,mdc_nelmts,rdcc_nelmts,rdcc_nbytes,rdcc_w0) &
BIND(C,NAME='h5pset_cache_c')
@@ -1687,54 +1023,26 @@ CONTAINS
hdferr = h5pset_cache_c(prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes, rdcc_w0 )
END SUBROUTINE h5pset_cache_f
-!****s* H5P/h5pget_cache_f
-! NAME
-! h5pget_cache_f
-!
-! PURPOSE
-! Queries the meta data cache and raw data chunk cache
-! parameters.
-!
-! INPUTS
-! prp_id - file access property list identifier
-!
-! OUTPUTS
-! mdc_nelmts - number of elements (objects) in the meta
-! data cache
-! rdcc_nelmts - number of elements (objects) in the raw
-! data chunk cache
-! rdcc_nbytes - total size of the raw data chunk cache, in bytes
-! rdcc_w0 - preemption policy (0 or 1)
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Bug fix: type of the rdcc_nelmts parameter should be INTEGER
-! instead of INTEGER(SIZE_T) October 10, 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the meta data cache and raw data chunk cache parameters.
+!!
+!! \param prp_id File access property list identifier.
+!! \param mdc_nelmts Number of elements (objects) in the metadata cache.
+!! \param rdcc_nelmts Number of elements (objects) in the raw data chunk cache.
+!! \param rdcc_nbytes Total size of the raw data chunk cache, in bytes.
+!! \param rdcc_w0 Preemption policy (0 or 1).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_cache_f(prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: mdc_nelmts ! Number of elements (objects)
- ! in the meta data cache
- INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nelmts ! Number of elements (objects)
- ! in the meta data cache
- INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nbytes ! Total size of the raw data
- ! chunk cache, in bytes
- REAL, INTENT(OUT) :: rdcc_w0 ! Preemption policy
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: mdc_nelmts
+ INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nelmts
+ INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nbytes
+ REAL, INTENT(OUT) :: rdcc_w0
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_cache_c(prp_id,mdc_nelmts,rdcc_nelmts,rdcc_nbytes,rdcc_w0) &
BIND(C,NAME='h5pget_cache_c')
@@ -1751,52 +1059,26 @@ CONTAINS
hdferr = h5pget_cache_c(prp_id, mdc_nelmts,rdcc_nelmts, rdcc_nbytes, rdcc_w0 )
END SUBROUTINE h5pget_cache_f
-!****s* H5P/h5pset_fapl_split_f
-! NAME
-! h5pset_fapl_split_f
-!
-! PURPOSE
-! Emulates the old split file driver.
-!
-! INPUTS
-!
-! prp_id - file access property list identifier
-! meta_ext - name of the extension for the metafile
-! filename
-! meta_plist - identifier of the meta file access property
-! list
-! raw_ext - name extension for the raw file filename
-! raw_plist - identifier of the raw file access property list
-!
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Emulates the old split file driver.
+!!
+!! \param prp_id File access property list identifier.
+!! \param meta_ext Name of the extension for the metafile filename.
+!! \param meta_plist Identifier of the meta file access property list.
+!! \param raw_ext Name extension for the raw file filename.
+!! \param raw_plist Identifier of the raw file access property list.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_split_f(prp_id, meta_ext, meta_plist, raw_ext, raw_plist, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: meta_ext ! Name of the extension for
- ! the metafile filename
- INTEGER(HID_T), INTENT(IN) :: meta_plist ! Identifier of the meta file
- ! access property list
- CHARACTER(LEN=*), INTENT(IN) :: raw_ext ! Name extension for the raw file filename
- INTEGER(HID_T), INTENT(IN) :: raw_plist ! Identifier of the raw file
- ! access property list
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: meta_ext
+ INTEGER(HID_T), INTENT(IN) :: meta_plist
+ CHARACTER(LEN=*), INTENT(IN) :: raw_ext
+ INTEGER(HID_T), INTENT(IN) :: raw_plist
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: meta_len, raw_len
INTERFACE
INTEGER FUNCTION h5pset_fapl_split_c(prp_id,meta_len,meta_ext,meta_plist,raw_len,raw_ext,raw_plist) &
@@ -1818,94 +1100,20 @@ CONTAINS
hdferr = h5pset_fapl_split_c(prp_id,meta_len,meta_ext,meta_plist,raw_len,raw_ext,raw_plist)
END SUBROUTINE h5pset_fapl_split_f
-!****s* H5P/h5pget_split_f
-! NAME
-! h5pget_split_f
-!
-! PURPOSE
-! NOT AVAILABLE
-!
-! INPUTS
-!
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! SOURCE
-! SUBROUTINE h5pget_split_f(prp_id, meta_ext_size, meta_ext, meta_plist,raw_ext_size,&
-! raw_ext, raw_plist, hdferr)
-! IMPLICIT NONE
-! INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-! INTEGER(SIZE_T), INTENT(IN) :: meta_ext_size ! Number of characters of the meta
- ! file extension to be copied to the
- ! meta_ext buffer
-
-! CHARACTER(LEN=*), INTENT(OUT) :: meta_ext !Name of the extension for
- !the metafile filename
-! INTEGER(HID_T), INTENT(OUT) :: meta_plist ! Identifier of the meta file
- ! access property list
-! INTEGER(SIZE_T), INTENT(IN) :: raw_ext_size ! Number of characters of the raw
- ! file extension to be copied to the
- ! raw_ext buffer
-! CHARACTER(LEN=*), INTENT(OUT) :: raw_ext !Name extension for the raw file filename
-! INTEGER(HID_T), INTENT(OUT) :: raw_plist !Identifier of the raw file
- !access property list
-! INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
-
-! INTEGER, EXTERNAL :: h5pget_split_c
-! hdferr = h5pget_split_c(prp_id, meta_ext_size, meta_ext, meta_plist, &
-! raw_ext_size, raw_ext, raw_plist )
-! END SUBROUTINE h5pget_split_f
-
-!****s* H5P/h5pset_gc_references_f
-! NAME
-! h5pset_gc_references_f
-!
-! PURPOSE
-! Sets garbage collecting references flag.
-!
-! INPUTS
-!
-! prp_id - file access property list identifier
-! gc_reference - flag for setting garbage collection on
-! and off (1 or 0)
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets garbage collecting references flag.
+!!
+!! \param prp_id File access property list identifier.
+!! \param gc_reference Flag for setting garbage collection on and off (1 or 0).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_gc_references_f (prp_id, gc_reference, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: gc_reference ! The flag for garbage collecting
- ! references for the file
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: gc_reference
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_gc_references_c(prp_id, gc_reference) &
BIND(C,NAME='h5pset_gc_references_c')
@@ -1919,42 +1127,20 @@ CONTAINS
hdferr = h5pset_gc_references_c(prp_id, gc_reference)
END SUBROUTINE h5pset_gc_references_f
-!****s* H5P/h5pget_gc_references_f
-! NAME
-! h5pget_gc_references_f
-!
-! PURPOSE
-! Returns garbage collecting references setting.
-!
-! INPUTS
-!
-! prp_id - file access property list identifier
-! OUTPUTS
-!
-! gc_reference - flag for setting garbage collection on
-! and off (1 or 0)
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns garbage collecting references setting.
+!!
+!! \param prp_id File access property list identifier.
+!! \param gc_reference Flag for setting garbage collection on and off (1 or 0)
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_gc_references_f(prp_id, gc_reference, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: gc_reference ! The flag for garbage collecting
- ! references for the file
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: gc_reference
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_gc_references_c(prp_id, gc_reference) &
BIND(C,NAME='h5pget_gc_references_c')
@@ -1968,49 +1154,25 @@ CONTAINS
hdferr = h5pget_gc_references_c(prp_id, gc_reference)
END SUBROUTINE h5pget_gc_references_f
-!****s* H5P/h5pset_layout_f
-! NAME
-! h5pset_layout_f
-!
-! PURPOSE
-! Sets the type of storage used store the raw data
-! for a dataset.
-!
-! INPUTS
-!
-! prp_id - data creation property list identifier
-! layout - type of storage layout for raw data
-! possible values are:
-! H5D_COMPACT_F
-! H5D_CONTIGUOUS_F
-! H5D_CHUNKED_F
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the type of storage used store the raw data
+!! for a dataset.
+!!
+!! \param prp_id Data creation property list identifier.
+!! \param layout Type of storage layout for raw data. Possible values are:
+!! \li H5D_COMPACT_F
+!! \li H5D_CONTIGUOUS_F
+!! \li H5D_CHUNKED_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_layout_f (prp_id, layout, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: layout ! Type of storage layout for raw data
- ! possible values are:
- ! H5D_COMPACT_F
- ! H5D_CONTIGUOUS_F
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: layout
! H5D_CHUNKED_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_layout_c(prp_id, layout) &
BIND(C,NAME='h5pset_layout_c')
@@ -2024,48 +1186,24 @@ CONTAINS
hdferr = h5pset_layout_c(prp_id, layout)
END SUBROUTINE h5pset_layout_f
-!****s* H5P/h5pget_layout_f
-! NAME
-! h5pget_layout_f
-!
-! PURPOSE
-! Returns the layout of the raw data for a dataset.
-!
-! INPUTS
-!
-! prp_id - data creation property list identifier
-! OUTPUTS
-!
-! layout - type of storage layout for raw data
-! possible values are:
-! H5D_COMPACT_F
-! H5D_CONTIGUOUS_F
-! H5D_CHUNKED_F
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns the layout of the raw data for a dataset.
+!!
+!! \param prp_id Data creation property list identifier.
+!! \param layout Type of storage layout for raw data. Possible values are:
+!! \li H5D_COMPACT_F
+!! \li H5D_CONTIGUOUS_F
+!! \li H5D_CHUNKED_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_layout_f (prp_id, layout, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: layout ! Type of storage layout for raw data
- ! possible values are:
- ! H5D_COMPACT_F(0)
- ! H5D_CONTIGUOUS_F(1)
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: layout
! H5D_CHUNKED_F(2)
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_layout_c(prp_id, layout) &
BIND(C,NAME='h5pget_layout_c')
@@ -2079,44 +1217,26 @@ CONTAINS
hdferr = h5pget_layout_c(prp_id, layout)
END SUBROUTINE h5pget_layout_f
-!****s* H5P/h5pset_filter_f
-! NAME
-! h5pset_filter_f
-!
-! PURPOSE
-! Adds a filter to the filter pipeline.
-!
-! INPUTS
-!
-! prp_id - data creation or transfer property list
-! identifier
-! filter - filter to be added to the pipeline
-! flags - bit vector specifying certain general
-! properties of the filter
-! cd_nelmts - number of elements in cd_values
-! cd_values - auxiliary data for the filter
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! February, 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Adds a filter to the filter pipeline.
+!!
+!! \param prp_id Data creation or transfer property list identifier.
+!! \param filter Filter to be added to the pipeline.
+!! \param flags Bit vector specifying certain general properties of the filter.
+!! \param cd_nelmts Number of elements in cd_values.
+!! \param cd_values Auxiliary data for the filter.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_filter_f(prp_id, filter, flags, cd_nelmts, cd_values, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: filter ! Filter to be added to the pipeline.
- INTEGER, INTENT(IN) :: flags ! Bit vector specifying certain general
- ! properties of the filter.
- INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts ! Number of elements in cd_values.
- INTEGER, DIMENSION(*), INTENT(IN) :: cd_values ! Auxiliary data for the filter.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: filter
+ INTEGER, INTENT(IN) :: flags
+ INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts
+ INTEGER, DIMENSION(*), INTENT(IN) :: cd_values
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_filter_c(prp_id, filter, flags, cd_nelmts, cd_values) &
BIND(C,NAME='h5pset_filter_c')
@@ -2133,41 +1253,20 @@ CONTAINS
hdferr = h5pset_filter_c(prp_id, filter, flags, cd_nelmts, cd_values )
END SUBROUTINE h5pset_filter_f
-!****s* H5P/h5pget_nfilters_f
-! NAME
-! h5pget_nfilters_f
-!
-! PURPOSE
-! Returns the number of filters in the pipeline.
-!
-! INPUTS
-!
-! prp_id - data creation or transfer property list
-! identifier
-! OUTPUTS
-!
-! nfilters - number of filters in the pipeline
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns the number of filters in the pipeline.
+!!
+!! \param prp_id Data creation or transfer property list identifier.
+!! \param nfilters Number of filters in the pipeline.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_nfilters_f (prp_id, nfilters, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: nfilters ! The number of filters in the pipeline
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: nfilters
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_nfilters_c(prp_id, nfilters) &
BIND(C,NAME='h5pget_nfilters_c')
@@ -2181,60 +1280,32 @@ CONTAINS
hdferr = h5pget_nfilters_c(prp_id, nfilters)
END SUBROUTINE h5pget_nfilters_f
-!****s* H5P/h5pget_filter_f
-! NAME
-! h5pget_filter_f
-!
-! PURPOSE
-! Returns information about a filter in a pipeline
-!
-! INPUTS
-!
-! prp_id - data creation or transfer property list
-! identifier
-! filter_number - sequence number within the filter
-! pipeline of the filter for which
-! information is sought
-! OUTPUTS
-!
-! filter_id - filter identification number
-! flags - bit vector specifying certain general
-! properties of the filter
-! cd_nelmts - number of elements in cd_values
-! cd_values - auxiliary data for the filter
-! namelen - number of characters in the name buffer
-! name - buffer to retrieve filter name
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns information about a filter in a pipeline
+!!
+!! \param prp_id Data creation or transfer property list identifier.
+!! \param filter_number Sequence number within the filter pipeline of the filter for which information is sought.
+!! \param filter_id Filter identification number.
+!! \param flags Bitbit vector specifying certain general properties of the filter.
+!! \param cd_nelmts Number of elements in cd_values.
+!! \param cd_values Auxiliary data for the filter.
+!! \param namelen Number of characters in the name buffer.
+!! \param name Buffer to retrieve filter name.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_id, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: filter_number ! Sequence number within the filter
- ! pipeline of the filter for which
- ! information is sought
- INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values ! Auxiliary data for the filter.
- INTEGER, INTENT(OUT) :: flags ! Bit vector specifying certain general
- ! properties of the filter.
- INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts ! Number of elements in cd_values.
- INTEGER(SIZE_T), INTENT(IN) :: namelen ! Anticipated number of characters in name.
- CHARACTER(LEN=*), INTENT(OUT) :: name ! Name of the filter
- INTEGER, INTENT(OUT) :: filter_id ! Filter identification number
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
-
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: filter_number
+ INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values
+ INTEGER, INTENT(OUT) :: flags
+ INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts
+ INTEGER(SIZE_T), INTENT(IN) :: namelen
+ CHARACTER(LEN=*), INTENT(OUT) :: name
+ INTEGER, INTENT(OUT) :: filter_id
+ INTEGER, INTENT(OUT) :: hdferr
! INTEGER, EXTERNAL :: h5pget_filter_c
! MS FORTRAN needs explicit interface for C functions called here.
@@ -2261,50 +1332,24 @@ CONTAINS
cd_values, namelen, name, filter_id )
END SUBROUTINE h5pget_filter_f
-!****s* H5P/h5pset_external_f
-! NAME
-! h5pset_external_f
-!
-! PURPOSE
-! Adds an external file to the list of external files.
-!
-! INPUTS
-!
-! prp_id - dataset creation property list identifier
-! name - name of external file
-! offset - offset in bytes from the beginning of the
-! file to the location in the file
-! where the data starts
-! bytes - size of the external file data.
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Changed type of 'offset' from integer to off_t -- MSB January 9, 2012
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Adds an external file to the list of external files.
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param name Name of external file.
+!! \param offset Offset in bytes from the beginning of the file to the location in the file where the data starts.
+!! \param bytes Size of the external file data.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_external_f(prp_id, name, offset, bytes, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of an external file
- INTEGER(OFF_T), INTENT(IN) :: offset ! Offset, in bytes, from the beginning
- ! of the file to the location in the file
- ! where the data starts.
- INTEGER(HSIZE_T), INTENT(IN) :: bytes ! Number of bytes reserved in the
- ! file for the data
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(OFF_T), INTENT(IN) :: offset
+ INTEGER(HSIZE_T), INTENT(IN) :: bytes
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: namelen
INTERFACE
@@ -2325,42 +1370,20 @@ CONTAINS
hdferr = h5pset_external_c(prp_id, name, namelen, offset, bytes)
END SUBROUTINE h5pset_external_f
-!****s* H5P/h5pget_external_count_f
-! NAME
-! h5pget_external_count_f
-!
-! PURPOSE
-! Returns the number of external files for a dataset.
-!
-! INPUTS
-!
-! prp_id - dataset creation property list identifier
-! OUTPUTS
-!
-! count - number of external files for the
-! specified dataset
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns the number of external files for a dataset.
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param count Number of external files for the specified dataset.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_external_count_f (prp_id, count, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: count ! Number of external files for the
- ! Specified dataset
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: count
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_external_count_c(prp_id, count) &
BIND(C,NAME='h5pget_external_count_c')
@@ -2374,56 +1397,28 @@ CONTAINS
hdferr = h5pget_external_count_c(prp_id, count)
END SUBROUTINE h5pget_external_count_f
-!****s* H5P/h5pget_external_f
-! NAME
-! h5pget_external_f
-!
-! PURPOSE
-! Returns information about an external file.
-!
-! INPUTS
-!
-! prp_id - dataset creation property list identifier
-! OUTPUTS
-!
-! idx - external file index
-! name_size - maximum size of name array
-! name - name of the external file
-! name - name of external file
-! offset - offset in bytes from the beginning of the
-! file to the location in the file
-! where the data starts
-! bytes - size of the external file data
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Changed type of 'offset' from integer to off_t -- MSB January 9, 2012
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns information about an external file.
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param idx External file index.
+!! \param name_size Maximum size of name array.
+!! \param name Name of the external file.
+!! \param offset Offset in bytes from the beginning of the file to the location in the file where the data starts.
+!! \param bytes Size of the external file data.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_external_f(prp_id, idx, name_size, name, offset,bytes, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: idx ! External file index.
- INTEGER(SIZE_T), INTENT(IN) :: name_size ! Maximum length of name array
- CHARACTER(LEN=*), INTENT(OUT) :: name ! Name of an external file
- INTEGER(OFF_T), INTENT(OUT) :: offset ! Offset, in bytes, from the beginning
- ! of the file to the location in the file
- ! where the data starts.
- INTEGER(HSIZE_T), INTENT(OUT) :: bytes ! Number of bytes reserved in the
- ! file for the data
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: idx
+ INTEGER(SIZE_T), INTENT(IN) :: name_size
+ CHARACTER(LEN=*), INTENT(OUT) :: name
+ INTEGER(OFF_T), INTENT(OUT) :: offset
+ INTEGER(HSIZE_T), INTENT(OUT) :: bytes
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_external_c(prp_id, idx, name_size, name, offset, bytes) &
BIND(C,NAME='h5pget_external_c')
@@ -2442,46 +1437,24 @@ CONTAINS
hdferr = h5pget_external_c(prp_id, idx, name_size, name, offset, bytes)
END SUBROUTINE h5pget_external_f
-!****s* H5P/h5pset_btree_ratios_f
-! NAME
-! h5pset_btree_ratios_f
-!
-! PURPOSE
-! Sets B-tree split ratios for a dataset transfer
-! property list.
-!
-! INPUTS
-!
-! prp_id - the dataset transfer property list
-! identifier
-! left - the B-tree split ratio for left-most nodes
-! middle - the B-tree split ratio for all other nodes
-! right - the B-tree split ratio for right-most nodes
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets B-tree split ratios for a dataset transfer property list.
+!!
+!! \param prp_id The dataset transfer property list identifier.
+!! \param left The B-tree split ratio for left-most nodes.
+!! \param middle The B-tree split ratio for all other nodes.
+!! \param right The B-tree split ratio for right-most nodes.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_btree_ratios_f(prp_id, left, middle, right, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- REAL, INTENT(IN) :: left ! The B-tree split ratio for left-most nodes.
- REAL, INTENT(IN) :: middle ! The B-tree split ratio for all other nodes
- REAL, INTENT(IN) :: right ! The B-tree split ratio for right-most
- ! nodes and lone nodes.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ REAL, INTENT(IN) :: left
+ REAL, INTENT(IN) :: middle
+ REAL, INTENT(IN) :: right
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_btree_ratios_c(prp_id, left, middle, right) &
BIND(C,NAME='h5pset_btree_ratios_c')
@@ -2497,46 +1470,24 @@ CONTAINS
hdferr = h5pset_btree_ratios_c(prp_id, left, middle, right)
END SUBROUTINE h5pset_btree_ratios_f
-!****s* H5P/h5pget_btree_ratios_f
-! NAME
-! h5pget_btree_ratios_f
-!
-! PURPOSE
-! Gets B-tree split ratios for a dataset transfer property list
-!
-! INPUTS
-!
-! prp_id - the dataset transfer property list
-! identifier
-! OUTPUTS
-!
-! left - the B-tree split ratio for left-most nodes
-! middle - the B-tree split ratio for all other nodes
-! right - the B-tree split ratio for right-most nodes
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets B-tree split ratios for a dataset transfer property list
+!!
+!! \param prp_id The dataset transfer property list identifier.
+!! \param left The B-tree split ratio for left-most nodes.
+!! \param middle The B-tree split ratio for all other nodes.
+!! \param right The B-tree split ratio for right-most nodes.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_btree_ratios_f(prp_id, left, middle, right, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- REAL, INTENT(OUT) :: left ! The B-tree split ratio for left-most nodes.
- REAL, INTENT(OUT) :: middle ! The B-tree split ratio for all other nodes
- REAL, INTENT(OUT) :: right ! The B-tree split ratio for right-most
- ! nodes and lone nodes.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ REAL, INTENT(OUT) :: left
+ REAL, INTENT(OUT) :: middle
+ REAL, INTENT(OUT) :: right
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_btree_ratios_c(prp_id, left, middle, right) &
BIND(C,NAME='h5pget_btree_ratios_c')
@@ -2552,46 +1503,25 @@ CONTAINS
hdferr = h5pget_btree_ratios_c(prp_id, left, middle, right)
END SUBROUTINE h5pget_btree_ratios_f
-!****s* H5P/h5pget_fclose_degree_f
-! NAME
-! h5pget_fclose_degree_f
-!
-! PURPOSE
-! Returns the degree for the file close behavior.
-!
-! INPUTS
-!
-! fapl_id - File access property list identifier
-! OUTPUTS
-!
-! degree - Possible values are:
-! H5F_CLOSE_DEFAULT_F
-! H5F_CLOSE_WEAK_F
-! H5F_CLOSE_SEMI_F
-! H5F_CLOSE_STRONG_F
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! September 26, 2002
-!
-! HISTORY
-!
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns the degree for the file close behavior.
+!!
+!! \param fapl_id File access property list identifier.
+!! \param degree Possible values are:
+!! \li H5F_CLOSE_DEFAULT_F
+!! \li H5F_CLOSE_WEAK_F
+!! \li H5F_CLOSE_SEMI_F
+!! \li H5F_CLOSE_STRONG_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_fclose_degree_f(fapl_id, degree, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: fapl_id ! File Access Property list identifier
- INTEGER, INTENT(OUT) :: degree ! Possible values are:
- ! H5F_CLOSE_DEFAULT_F
- ! H5F_CLOSE_WEAK_F
- ! H5F_CLOSE_SEMI_F
- ! H5F_CLOSE_STRONG_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: fapl_id
+ INTEGER, INTENT(OUT) :: degree
+ ! H5F_CLOSE_STRONG_F
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_fclose_degree_c(fapl_id, degree) &
BIND(C,NAME='h5pget_fclose_degree_c')
@@ -2605,42 +1535,25 @@ CONTAINS
hdferr = h5pget_fclose_degree_c(fapl_id, degree)
END SUBROUTINE h5pget_fclose_degree_f
-!****s* H5P/h5pset_fclose_degree_f
-! NAME
-! h5pset_fclose_degree_f
-!
-! PURPOSE
-! Sets the degree for the file close behavior.
-!
-! INPUTS
-!
-! fapl_id - file access property list identifier
-! degree - Possible values are:
-! H5F_CLOSE_DEFAULT_F
-! H5F_CLOSE_WEAK_F
-! H5F_CLOSE_SEMI_F
-! H5F_CLOSE_STRONG_F
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! September 26, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the degree for the file close behavior.
+!!
+!! \param fapl_id File access property list identifier.
+!! \param degree Possible values are:
+!! \li H5F_CLOSE_DEFAULT_F
+!! \li H5F_CLOSE_WEAK_F
+!! \li H5F_CLOSE_SEMI_F
+!! \li H5F_CLOSE_STRONG_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fclose_degree_f(fapl_id, degree, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: fapl_id ! File Access Property list identifier
- INTEGER, INTENT(IN) :: degree ! Possible values are:
- ! H5F_CLOSE_DEFAULT_F
- ! H5F_CLOSE_WEAK_F
- ! H5F_CLOSE_SEMI_F
- ! H5F_CLOSE_STRONG_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: fapl_id
+ INTEGER, INTENT(IN) :: degree
+ ! H5F_CLOSE_STRONG_F
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_fclose_degree_c(fapl_id, degree) &
BIND(C,NAME='h5pset_fclose_degree_c')
@@ -2654,38 +1567,22 @@ CONTAINS
hdferr = h5pset_fclose_degree_c(fapl_id, degree)
END SUBROUTINE h5pset_fclose_degree_f
-!****s* H5P/h5pequal_f
-! NAME
-! h5pequal_f
-!
-! PURPOSE
-! Checks if two property lists are equal
-!
-! INPUTS
-!
-! plist1_id - property list identifier
-! plist2_id - property list identifier
-! OUTPUTS
-!
-! flag - flag, possible values
-! .TRUE. or .FALSE.
-! hdferr: - error code
-! Success: 0
-! Failure: -1, flag is set to .FALSE.
-!
-! AUTHOR
-! Elena Pourmal
-! September 30, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Checks if two property lists are equal
+!!
+!! \param plist1_id Property list identifier.
+!! \param plist2_id Property list identifier.
+!! \param flag Flag, Possible values: .TRUE. or .FALSE.
+!! \param hdferr: \fortran_error and flag is set to .FALSE.
+!!
SUBROUTINE h5pequal_f(plist1_id, plist2_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist1_id ! Property list identifier
- INTEGER(HID_T), INTENT(IN) :: plist2_id ! Property list identifier
- LOGICAL, INTENT(OUT) :: flag ! Flag
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist1_id
+ INTEGER(HID_T), INTENT(IN) :: plist2_id
+ LOGICAL, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: c_flag
INTERFACE
@@ -2704,36 +1601,20 @@ CONTAINS
IF (c_flag .GT. 0) flag = .TRUE.
END SUBROUTINE h5pequal_f
-!****s* H5P/h5pset_buffer_f
-! NAME
-! h5pset_buffer_f
-!
-! PURPOSE
-! Sets sixe for conversion buffer
-!
-! INPUTS
-! plist_id - data transfer property list identifier
-! size - buffer size
-! OUTPUTS
-!
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 2, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets sixe for conversion buffer
+!!
+!! \param plist_id Data transfer property list identifier.
+!! \param size Buffer size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_buffer_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Data transfer property list identifier
- INTEGER(HSIZE_T), INTENT(IN) :: size ! Buffer size in bytes;
- ! buffer is allocated and freed by
- ! the library.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(HSIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_buffer_c(plist_id, size) &
@@ -2748,37 +1629,20 @@ CONTAINS
hdferr = h5pset_buffer_c(plist_id, size)
END SUBROUTINE h5pset_buffer_f
-!****s* H5P/h5pget_buffer_f
-! NAME
-! h5pget_buffer_f
-!
-! PURPOSE
-! Gets size for conversion buffer
-!
-! INPUTS
-!
-! plist_id - data transfer property list identifier
-! OUTPUTS
-!
-! size - buffer size
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 2, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets size for conversion buffer
+!!
+!! \param plist_id Data transfer property list identifier.
+!! \param size Buffer size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_buffer_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Data transfer property list identifier
- INTEGER(HSIZE_T), INTENT(OUT) :: size ! Buffer size in bytes;
- ! buffer is allocated and freed by
- ! the library.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(HSIZE_T), INTENT(OUT) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_buffer_c(plist_id, size) &
@@ -2793,44 +1657,25 @@ CONTAINS
hdferr = h5pget_buffer_c(plist_id, size)
END SUBROUTINE h5pget_buffer_f
-!****s* H5P/h5pfill_value_defined_f
-! NAME
-! h5pfill_value_defined_f
-!
-! PURPOSE
-! Check if fill value is defined.
-!
-! INPUTS
-!
-! plist_id - dataset creation property list identifier
-! OUTPUTS
-!
-! flag - fill value status flag
-! Possible values are:
-! H5D_FILL_VALUE_ERROR_F
-! H5D_FILL_VALUE_UNDEFINED_F
-! H5D_FILL_VALUE_DEFAULT_F
-! H5D_FILL_VALUE_USER_DEFINED_F
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 4, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Check if fill value is defined.
+!!
+!! \param plist_id Dataset creation property list identifier.
+!! \param flag Fill value status flag. Possible values are:
+!! \li H5D_FILL_VALUE_ERROR_F
+!! \li H5D_FILL_VALUE_UNDEFINED_F
+!! \li H5D_FILL_VALUE_DEFAULT_F
+!! \li H5D_FILL_VALUE_USER_DEFINED_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pfill_value_defined_f(plist_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property list identifier
- INTEGER, INTENT(OUT) :: flag ! Fill value status flag
- ! H5D_FILL_VALUE_ERROR_F
- ! H5D_FILL_VALUE_UNDEFINED_F
- ! H5D_FILL_VALUE_DEFAULT_F
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER, INTENT(OUT) :: flag
! H5D_FILL_VALUE_USER_DEFINED_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pfill_value_defined_c(plist_id, flag) &
BIND(C,NAME='h5pfill_value_defined_c')
@@ -2844,45 +1689,25 @@ CONTAINS
hdferr = h5pfill_value_defined_c(plist_id, flag)
END SUBROUTINE h5pfill_value_defined_f
-!****s* H5P/h5pset_alloc_time_f
-! NAME
-! h5pset_alloc_time_f
-!
-! PURPOSE
-! Set space allocation time for dataset during creation.
-!
-! INPUTS
-!
-! plist_id - dataset creation property list identifier
-! flag - allocation time flag:
-! H5D_ALLOC_TIME_ERROR_F
-! H5D_ALLOC_TIME_DEFAULT_F
-! H5D_ALLOC_TIME_EARLY_F
-! H5D_ALLOC_TIME_LATE_F
-! H5D_ALLOC_TIME_INCR_F
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 4, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Set space allocation time for dataset during creation.
+!!
+!! \param plist_id Dataset creation property list identifier.
+!! \param flag Allocation time flag: Possible values are:
+!! \li H5D_ALLOC_TIME_ERROR_F
+!! \li H5D_ALLOC_TIME_DEFAULT_F
+!! \li H5D_ALLOC_TIME_EARLY_F
+!! \li H5D_ALLOC_TIME_LATE_F
+!! \li H5D_ALLOC_TIME_INCR_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_alloc_time_f(plist_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property list identifier
- INTEGER, INTENT(IN) :: flag ! Allocation time flag:
- ! H5D_ALLOC_TIME_ERROR_F
- ! H5D_ALLOC_TIME_DEFAULT_F
- ! H5D_ALLOC_TIME_EARLY_F
- ! H5D_ALLOC_TIME_LATE_F
- ! H5D_ALLOC_TIME_INCR_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER, INTENT(IN) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_alloc_time_c(plist_id, flag) &
@@ -2897,45 +1722,25 @@ CONTAINS
hdferr = h5pset_alloc_time_c(plist_id, flag)
END SUBROUTINE h5pset_alloc_time_f
-!****s* H5P/h5pget_alloc_time_f
-! NAME
-! h5pget_alloc_time_f
-!
-! PURPOSE
-! Get space allocation time for dataset during creation.
-!
-! INPUTS
-!
-! plist_id - dataset creation property list identifier
-! OUTPUTS
-!
-! flag - allocation time flag:
-! H5D_ALLOC_TIME_ERROR_F
-! H5D_ALLOC_TIME_DEFAULT_F
-! H5D_ALLOC_TIME_EARLY_F
-! H5D_ALLOC_TIME_LATE_F
-! H5D_ALLOC_TIME_INCR_F
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 4, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Get space allocation time for dataset during creation.
+!!
+!! \param plist_id Dataset creation property list identifier.
+!! \param flag Allocation time flag. Possible values are:
+!! \li H5D_ALLOC_TIME_ERROR_F
+!! \li H5D_ALLOC_TIME_DEFAULT_F
+!! \li H5D_ALLOC_TIME_EARLY_F
+!! \li H5D_ALLOC_TIME_LATE_F
+!! \li H5D_ALLOC_TIME_INCR_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_alloc_time_f(plist_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property list identifier
- INTEGER, INTENT(OUT) :: flag ! Allocation time flag:
- ! H5D_ALLOC_TIME_ERROR_F
- ! H5D_ALLOC_TIME_DEFAULT_F
- ! H5D_ALLOC_TIME_EARLY_F
- ! H5D_ALLOC_TIME_LATE_F
- ! H5D_ALLOC_TIME_INCR_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_alloc_time_c(plist_id, flag) &
@@ -2950,41 +1755,23 @@ CONTAINS
hdferr = h5pget_alloc_time_c(plist_id, flag)
END SUBROUTINE h5pget_alloc_time_f
-!****s* H5P/h5pset_fill_time_f
-! NAME
-! h5pset_fill_time_f
-!
-! PURPOSE
-! Set fill value writing time for dataset
-!
-! INPUTS
-!
-! plist_id - dataset creation property list identifier
-! flag - fill time flag:
-! H5D_FILL_TIME_ERROR_F
-! H5D_FILL_TIME_ALLOC_F
-! H5D_FILL_TIME_NEVER_F
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 4, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Set fill value writing time for dataset
+!!
+!! \param plist_id Dataset creation property list identifier.
+!! \param flag Fill time flag: Possible values are:
+!! \li H5D_FILL_TIME_ERROR_F
+!! \li H5D_FILL_TIME_ALLOC_F
+!! \li H5D_FILL_TIME_NEVER_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fill_time_f(plist_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property list identifier
- INTEGER, INTENT(IN) :: flag ! Fill time flag:
- ! H5D_FILL_TIME_ERROR_F
- ! H5D_FILL_TIME_ALLOC_F
- ! H5D_FILL_TIME_NEVER_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER, INTENT(IN) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_fill_time_c(plist_id, flag) &
@@ -2999,42 +1786,24 @@ CONTAINS
hdferr = h5pset_fill_time_c(plist_id, flag)
END SUBROUTINE h5pset_fill_time_f
-!****s* H5P/h5pget_fill_time_f
-! NAME
-! h5pget_fill_time_f
-!
-! PURPOSE
-! Get fill value writing time for dataset
-!
-! INPUTS
-!
-! plist_id - dataset creation property list identifier
-! OUTPUTS
-!
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-! OPTIONAL PARAMETERS
-!
-! flag - fill time flag:
-! H5D_FILL_TIME_ERROR_F
-! H5D_FILL_TIME_ALLOC_F
-! H5D_FILL_TIME_NEVER_F
-! AUTHOR
-! Elena Pourmal
-! October 4, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Get fill value writing time for dataset
+!!
+!! \param plist_id Dataset creation property list identifier.
+!!
+!! \param flag Fill time flag. Possible values are:
+!! \li H5D_FILL_TIME_ERROR_F
+!! \li H5D_FILL_TIME_ALLOC_F
+!! \li H5D_FILL_TIME_NEVER_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_fill_time_f(plist_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property list identifier
- INTEGER, INTENT(OUT) :: flag ! Fill time flag:
- ! H5D_FILL_TIME_ERROR_F
- ! H5D_FILL_TIME_ALLOC_F
- ! H5D_FILL_TIME_NEVER_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_fill_time_c(plist_id, flag) &
@@ -3049,35 +1818,20 @@ CONTAINS
hdferr = h5pget_fill_time_c(plist_id, flag)
END SUBROUTINE h5pget_fill_time_f
-!****s* H5P/ h5pset_meta_block_size_f
-! NAME
-! h5pset_meta_block_size_f
-!
-! PURPOSE
-! Sets the minimum size of metadata block allocations
-!
-! INPUTS
-!
-! plist_id - file access property list identifier
-! size - metadata block size
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 7, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the minimum size of metadata block allocations
+!!
+!! \param plist_id File access property list identifier.
+!! \param size Metadata block size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_meta_block_size_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier
- INTEGER(HSIZE_T), INTENT(IN) :: size ! Block size in bytes;
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(HSIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_meta_block_size_c(plist_id, size) &
BIND(C,NAME='h5pset_meta_block_size_c')
@@ -3091,35 +1845,20 @@ CONTAINS
hdferr = h5pset_meta_block_size_c(plist_id, size)
END SUBROUTINE h5pset_meta_block_size_f
-!****s* H5P/h5pget_meta_block_size_f
-! NAME
-! h5pget_meta_block_size_f
-!
-! PURPOSE
-! Gets the minimum size of metadata block allocations
-!
-! INPUTS
-!
-! plist_id - file access property list identifier
-! OUTPUTS
-!
-! size - metadata block size
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 7, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets the minimum size of metadata block allocations
+!!
+!! \param plist_id File access property list identifier.
+!! \param size Metadata block size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_meta_block_size_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier
- INTEGER(HSIZE_T), INTENT(OUT) :: size ! Block size in bytes;
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(HSIZE_T), INTENT(OUT) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_meta_block_size_c(plist_id, size) &
BIND(C,NAME='h5pget_meta_block_size_c')
@@ -3133,35 +1872,20 @@ CONTAINS
hdferr = h5pget_meta_block_size_c(plist_id, size)
END SUBROUTINE h5pget_meta_block_size_f
-!****s* H5P/h5pset_sieve_buf_size_f
-! NAME
-! h5pset_sieve_buf_size_f
-!
-! PURPOSE
-! Sets the maximum size of the data sieve buffer
-!
-! INPUTS
-!
-! plist_id - file access property list identifier
-! size - sieve buffer size
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 7, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the maximum size of the data sieve buffer
+!!
+!! \param plist_id File access property list identifier.
+!! \param size Sieve buffer size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_sieve_buf_size_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier
- INTEGER(SIZE_T), INTENT(IN) :: size ! Buffer size in bytes;
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_sieve_buf_size_c(plist_id, size) &
BIND(C,NAME='h5pset_sieve_buf_size_c')
@@ -3175,35 +1899,20 @@ CONTAINS
hdferr = h5pset_sieve_buf_size_c(plist_id, size)
END SUBROUTINE h5pset_sieve_buf_size_f
-!****s* H5P/h5pget_sieve_buf_size_f
-! NAME
-! h5pget_sieve_buf_size_f
-!
-! PURPOSE
-! Gets the maximum size of the data sieve buffer
-!
-! INPUTS
-!
-! plist_id - file access property list identifier
-! OUTPUTS
-!
-! size - sieve buffer size
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 7, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets the maximum size of the data sieve buffer
+!!
+!! \param plist_id File access property list identifier.
+!! \param size Sieve buffer size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_sieve_buf_size_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier
- INTEGER(SIZE_T), INTENT(OUT) :: size ! Buffer size in bytes
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(SIZE_T), INTENT(OUT) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_sieve_buf_size_c(plist_id, size) &
BIND(C,NAME='h5pget_sieve_buf_size_c')
@@ -3217,35 +1926,20 @@ CONTAINS
hdferr = h5pget_sieve_buf_size_c(plist_id, size)
END SUBROUTINE h5pget_sieve_buf_size_f
-!****s* H5P/h5pset_small_data_block_size_f
-! NAME
-! h5pset_small_data_block_size_f
-!
-! PURPOSE
-! Sets the minimum size of "small" raw data block
-!
-! INPUTS
-!
-! plist_id - file access property list identifier
-! size - small raw data block size
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 7, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the minimum size of "small" raw data block
+!!
+!! \param plist_id File access property list identifier.
+!! \param size Small raw data block size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_small_data_block_size_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier
- INTEGER(HSIZE_T), INTENT(IN) :: size ! Small raw data block size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(HSIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_small_data_block_size_c(plist_id, size) &
BIND(C,NAME='h5pset_small_data_block_size_c')
@@ -3259,35 +1953,20 @@ CONTAINS
hdferr = h5pset_small_data_block_size_c(plist_id, size)
END SUBROUTINE h5pset_small_data_block_size_f
-!****s* H5P/h5pget_small_data_block_size_f
-! NAME
-! h5pget_small_data_block_size_f
-!
-! PURPOSE
-! Gets the minimum size of "small" raw data block
-!
-! INPUTS
-!
-! plist_id - file access property list identifier
-! OUTPUTS
-!
-! size - small raw data block size
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 7, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets the minimum size of "small" raw data block
+!!
+!! \param plist_id File access property list identifier.
+!! \param size Small raw data block size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_small_data_block_size_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier
- INTEGER(HSIZE_T), INTENT(OUT) :: size ! Small raw data block size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(HSIZE_T), INTENT(OUT) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_small_data_block_size_c(plist_id, size) &
BIND(C,NAME='h5pget_small_data_block_size_c')
@@ -3301,35 +1980,20 @@ CONTAINS
hdferr = h5pget_small_data_block_size_c(plist_id, size)
END SUBROUTINE h5pget_small_data_block_size_f
-!****s* H5P/h5pset_hyper_vector_size_f
-! NAME
-! h5pset_hyper_vector_size_f
-!
-! PURPOSE
-! Set the number of "I/O" vectors (vector size)
-!
-! INPUTS
-!
-! plist_id - dataset transfer property list identifier
-! size - vector size
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 7, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Set the number of "I/O" vectors (vector size)
+!!
+!! \param plist_id Dataset transfer property list identifier.
+!! \param size Vector size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_hyper_vector_size_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset transfer property list identifier
- INTEGER(SIZE_T), INTENT(IN) :: size ! Vector size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_hyper_vector_size_c(plist_id, size) &
BIND(C,NAME='h5pset_hyper_vector_size_c')
@@ -3343,35 +2007,20 @@ CONTAINS
hdferr = h5pset_hyper_vector_size_c(plist_id, size)
END SUBROUTINE h5pset_hyper_vector_size_f
-!****s* H5P/ h5pget_hyper_vector_size_f
-! NAME
-! h5pget_hyper_vector_size_f
-!
-! PURPOSE
-! Get the number of "I/O" vectors (vector size)
-!
-! INPUTS
-!
-! plist_id - dataset transfer property list identifier
-! OUTPUTS
-!
-! size - vector size
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 7, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Get the number of "I/O" vectors (vector size)
+!!
+!! \param plist_id Dataset transfer property list identifier.
+!! \param size Vector size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_hyper_vector_size_f(plist_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset transfer property list identifier
- INTEGER(SIZE_T), INTENT(OUT) :: size ! Vector size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER(SIZE_T), INTENT(OUT) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_hyper_vector_size_c(plist_id, size) &
BIND(C,NAME='h5pget_hyper_vector_size_c')
@@ -3385,37 +2034,22 @@ CONTAINS
hdferr = h5pget_hyper_vector_size_c(plist_id, size)
END SUBROUTINE h5pget_hyper_vector_size_f
-!****s* H5P/h5pexist_f
-! NAME
-! h5pexist_f
-!
-! PURPOSE
-! Queries whether a property name exists in a property list or class.
-!
-! INPUTS
-!
-! prp_id - property list identifier to query
-! name - name of property to check for
-! OUTPUTS
-!
-! flag - logical flag
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries whether a property name exists in a property list or class.
+!!
+!! \param prp_id Property list identifier to query.
+!! \param name Name of property to check for.
+!! \param flag Logical flag.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pexist_f(prp_id, name, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
- LOGICAL, INTENT(OUT) :: flag ! .TRUE. if exists, .FALSE. otherwise
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ LOGICAL, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTERFACE
@@ -3438,41 +2072,22 @@ CONTAINS
ENDIF
END SUBROUTINE h5pexist_f
-!****s* H5P/h5pget_size_f
-!
-! NAME
-! h5pget_size_f
-!
-! PURPOSE
-! Queries the size of a property value in bytes.
-!
-! INPUTS
-!
-! prp_id - property list identifier to query
-! name - name of property to query
-! OUTPUTS
-!
-! size - size of property in bytes
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! HISTORY
-!
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the size of a property value in bytes.
+!!
+!! \param prp_id Property list identifier to query.
+!! \param name Name of property to query.
+!! \param size Size of property in bytes.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_size_f(prp_id, name, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to query
- INTEGER(SIZE_T), INTENT(OUT) :: size ! Size in bytes
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T), INTENT(OUT) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTERFACE
@@ -3491,35 +2106,20 @@ CONTAINS
hdferr = h5pget_size_c(prp_id, name , name_len, size)
END SUBROUTINE h5pget_size_f
-!****s* H5P/h5pget_npros_f
-! NAME
-! h5pget_npros_f
-!
-! PURPOSE
-! Queries number of properties in property list or class
-!
-! INPUTS
-!
-! prp_id - iproperty list identifier to query
-! OUTPUTS
-!
-! nprops - number of properties in property object
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries number of properties in property list or class
+!!
+!! \param prp_id Iproperty list identifier to query.
+!! \param nprops Number of properties in property object.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_nprops_f(prp_id, nprops, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(SIZE_T), INTENT(OUT) :: nprops ! Number of properties
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(SIZE_T), INTENT(OUT) :: nprops
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_nprops_c(prp_id, nprops) &
BIND(C,NAME='h5pget_nprops_c')
@@ -3532,43 +2132,24 @@ CONTAINS
hdferr = h5pget_nprops_c(prp_id, nprops)
END SUBROUTINE h5pget_nprops_f
-!****s* H5P/h5pget_class_name_f
-! NAME
-! h5pget_class_name_f
-!
-! PURPOSE
-! Queries the name of a class.
-!
-! INPUTS
-!
-! prp_id - property list identifier to query
-! OUTPUTS
-!
-! name - name of a class
-! size - Actual length of the class name
-! NOTE: If provided buffer "name" is smaller,
-! than name will be truncated to fit into
-! provided user buffer.
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! HISTORY
-! Returned the size of name as an argument
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the name of a class.
+!!
+!! \param prp_id Property list identifier to query.
+!! \param name Name of a class.
+!! \param size Actual length of the class name.
+!! NOTE: If provided buffer "name" is smaller, than name will be
+!! truncated to fit into provided user buffer.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_class_name_f(prp_id, name, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(OUT) :: name ! Buffer to retrieve class name
- INTEGER, INTENT(OUT) :: size ! Actual length of the class name
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(OUT) :: name
+ INTEGER, INTENT(OUT) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTERFACE
@@ -3591,36 +2172,20 @@ CONTAINS
END SUBROUTINE h5pget_class_name_f
-!****s* H5P/h5pget_class_parent_f
-! NAME
-! h5pget_class_parent_f
-!
-! PURPOSE
-! Retrieves the parent class of a generic property class.
-!
-! INPUTS
-!
-! prp_id - property list identifier to query
-! OUTPUTS
-!
-! parent_id - identifier of the parent class
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the parent class of a generic property class.
+!!
+!! \param prp_id Property list identifier to query.
+!! \param parent_id Identifier of the parent class.
+!! \param hdferr: \fortran_error
+!!
SUBROUTINE h5pget_class_parent_f(prp_id, parent_id, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(OUT) :: parent_id ! Parent class property list
- ! identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(OUT) :: parent_id
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_class_parent_c(prp_id, parent_id) &
BIND(C,NAME='h5pget_class_parent_c')
@@ -3633,37 +2198,22 @@ CONTAINS
hdferr = h5pget_class_parent_c(prp_id, parent_id)
END SUBROUTINE h5pget_class_parent_f
-!****s* H5P/h5pisa_class_f
-! NAME
-! h5pisa_class_f
-!
-! PURPOSE
-! Determines whether a property list is a member of a class.
-!
-! INPUTS
-!
-! plist - property list identifier
-! pclass - identifier of the property class
-! OUTPUTS
-!
-! flag - .TRUE. if a member, .FALSE. otherwise
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Determines whether a property list is a member of a class.
+!!
+!! \param plist Property list identifier.
+!! \param pclass Identifier of the property class.
+!! \param flag TRUE. if a member, .FALSE. otherwise.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pisa_class_f(plist, pclass, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist ! Property list identifier
- INTEGER(HID_T), INTENT(IN) :: pclass ! Class identifier
- LOGICAL, INTENT(OUT) :: flag ! logical flag
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist
+ INTEGER(HID_T), INTENT(IN) :: pclass
+ LOGICAL, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pisa_class_c(plist, pclass) &
BIND(C,NAME='h5pisa_class_c')
@@ -3681,38 +2231,22 @@ CONTAINS
ENDIF
END SUBROUTINE h5pisa_class_f
-!****s* H5P/h5pcopy_prop_f
-! NAME
-! h5pcopy_prop_f
-!
-! PURPOSE
-! Copies a property from one list or class to another.
-!
-! INPUTS
-!
-! dst_id - Identifier of the destination property list
-! src_id - Identifier of the source property list
-! name - name of the property to copy
-! OUTPUTS
-!
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Copies a property from one list or class to another.
+!!
+!! \param dst_id Identifier of the destination property list.
+!! \param src_id Identifier of the source property list.
+!! \param name Name of the property to copy.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pcopy_prop_f(dst_id, src_id, name, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: dst_id ! Destination property list
- ! identifier
- INTEGER(HID_T), INTENT(IN) :: src_id ! Source property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Property name
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: dst_id
+ INTEGER(HID_T), INTENT(IN) :: src_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTERFACE
@@ -3731,36 +2265,20 @@ CONTAINS
hdferr = h5pcopy_prop_c(dst_id, src_id, name , name_len)
END SUBROUTINE h5pcopy_prop_f
-!****s* H5P/h5premove_f
-! NAME
-! h5premove_f
-!
-! PURPOSE
-! Removes a property from a property list.
-
-!
-! INPUTS
-!
-! plid - Property list identofoer
-! name - name of the property to remove
-! OUTPUTS
-!
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Removes a property from a property list.
+!!
+!! \param plid Property list identofoer.
+!! \param name Name of the property to remove.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5premove_f(plid, name, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plid ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to remove
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plid
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTERFACE
@@ -3778,35 +2296,20 @@ CONTAINS
hdferr = h5premove_c(plid, name , name_len)
END SUBROUTINE h5premove_f
-!****s* H5P/h5punregister_f
-! NAME
-! h5punregister_f
-!
-! PURPOSE
-! Removes a property from a property list class.
-!
-! INPUTS
-!
-! class - Property list class identifier
-! name - name of the property to remove
-! OUTPUTS
-!
-! hdferr: - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Removes a property from a property list class.
+!!
+!! \param class Property list class identifier.
+!! \param name Name of the property to remove.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5punregister_f(class, name, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: class ! property list class identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! name of property to remove
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: class
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTERFACE
@@ -3824,33 +2327,18 @@ CONTAINS
hdferr = h5punregister_c(class, name , name_len)
END SUBROUTINE h5punregister_f
-!****s* H5P/h5pclose_class_f
-! NAME
-! h5pclose_class_f
-!
-! PURPOSE
-! Closes an existing property list class.
-!
-! INPUTS
-!
-! class - Property list class identifier
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Closes an existing property list class.
+!!
+!! \param class Property list class identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pclose_class_f(class, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: class ! Property list class identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: class
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pclose_class_c(class) &
BIND(C,NAME='h5pclose_class_c')
@@ -3862,31 +2350,18 @@ CONTAINS
hdferr = h5pclose_class_c(class)
END SUBROUTINE h5pclose_class_f
-!****s* H5P/h5pset_shuffle_f
-! NAME
-! h5pset_shuffle_f
-!
-! PURPOSE
-! Sets shuffling filter
-!
-! INPUTS
-! prp_id - dataset creation property list identifier
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! March 12, 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets shuffling filter
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_shuffle_f(prp_id, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_shuffle_c(prp_id) &
BIND(C,NAME='h5pset_shuffle_c')
@@ -3899,36 +2374,22 @@ CONTAINS
END SUBROUTINE h5pset_shuffle_f
-!****s* H5P/h5pset_edc_check_f
-! NAME
-! h5pset_edc_check_f
-!
-! PURPOSE
-! Enables/disables error detecting
-!
-! INPUTS
-!
-! prp_id - dataset creation property list identifier
-! flag - EDC flag; possible values:
-! H5Z_DISABLE_EDC_F
-! H5Z_ENABLE_EDC_F
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! March 13, 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Enables/disables error detecting
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param flag EDC flag. Possible values:
+!! \li H5Z_DISABLE_EDC_F
+!! \li H5Z_ENABLE_EDC_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_edc_check_f(prp_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: flag ! Checksum filter flag
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_edc_check_c(prp_id, flag) &
BIND(C,NAME='h5pset_edc_check_c')
@@ -3942,38 +2403,22 @@ CONTAINS
END SUBROUTINE h5pset_edc_check_f
-!****s* H5P/h5pget_edc_check_f
-! NAME
-! h5pget_edc_check_f
-!
-! PURPOSE
-! Queries error detecting
-!
-! INPUTS
-!
-! prp_id - dataset creation property list identifier
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! March 13, 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Determines whether error-detection is enabled for dataset reads.
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param flag EDC flag; possible values:
+!! \li H5Z_DISABLE_EDC_F
+!! \li H5Z_ENABLE_EDC_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_edc_check_f(prp_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset transfer property list identifier
- INTEGER, INTENT(OUT) :: flag ! Checksum filter flag
- ! May have one of the following values:
- ! H5Z_ERROR_EDC_F
- ! H5Z_DISABLE_EDC_F
- ! H5Z_ENABLE_EDC_F
- ! H5Z_NO_EDC_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_edc_check_c(prp_id, flag) &
BIND(C,NAME='h5pget_edc_check_c')
@@ -3987,33 +2432,18 @@ CONTAINS
END SUBROUTINE h5pget_edc_check_f
-!****s* H5P/h5pset_fletcher32_f
-! NAME
-! h5pset_fletcher32_f
-!
-! PURPOSE
-! Sets Fletcher32 checksum of EDC for a dataset creation
-! property list.
-!
-! INPUTS
-!
-! prp_id - dataset creation property list identifier
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! March 13, 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets Fletcher32 checksum of EDC for a dataset creation property list.
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fletcher32_f(prp_id, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_fletcher32_c(prp_id) &
BIND(C,NAME='h5pset_fletcher32_c')
@@ -4026,34 +2456,20 @@ CONTAINS
END SUBROUTINE h5pset_fletcher32_f
-!****s* H5P/ h5pset_family_offset_f
-! NAME
-! h5pset_family_offset_f
-!
-! PURPOSE
-! Sets offset for family file driver.
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! offset - file offset
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! 19 March 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets offset for family file driver.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param offset File offset.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_family_offset_f(prp_id, offset, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HSIZE_T), INTENT(IN) :: offset ! Offset in bytes
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HSIZE_T), INTENT(IN) :: offset
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_family_offset_c(prp_id, offset) &
BIND(C,NAME='h5pset_family_offset_c')
@@ -4067,30 +2483,47 @@ CONTAINS
END SUBROUTINE h5pset_family_offset_f
-!****s* H5P/h5pset_fapl_multi_l
-! NAME
-! h5pset_fapl_multi_l
-!
-! PURPOSE
-! Sets up use of the multi-file driver.
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! mem_map - mapping array
-! memb_fapl - property list for each memory usage type
-! memb_name - names of member file
-! relax - flag
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! 20 March 2003
-!
-! Fortran90 Interface:
+#ifdef H5_DOXYGEN_FORTRAN
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets up use of the multi-file driver.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param memb_map Mapping array.
+!! \param memb_fapl Property list for each memory usage type.
+!! \param memb_name Names of member file.
+!! \param memb_addr Offsets within the virtual address space, from 0 (zero) to HADDR_MAX_F, at which each type of data storage begins.
+!! \param relax Flag.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pset_fapl_multi_l(prp_id, memb_map, memb_fapl, memb_name, memb_addr, relax, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, DIMENSION(*), INTENT(IN) :: memb_map
+ INTEGER(HID_T), DIMENSION(*), INTENT(IN) :: memb_fapl
+ CHARACTER(LEN=*), DIMENSION(*), INTENT(IN) :: memb_name
+ REAL, DIMENSION(*), INTENT(IN) :: memb_addr
+ LOGICAL, INTENT(IN) :: relax
+ INTEGER, INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pset_fapl_multi_l
+
+#else
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets up use of the multi-file driver.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param memb_map Mapping array.
+!! \param memb_fapl Property list for each memory usage type.
+!! \param memb_name Names of member file.
+!! \param memb_addr Offsets within the virtual address space, from 0 (zero) to HADDR_MAX_F, at which each type of data storage begins.
+!! \param relax Flag.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_multi_l(prp_id, memb_map, memb_fapl, memb_name, memb_addr, relax, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: prp_id
@@ -4100,7 +2533,6 @@ CONTAINS
REAL, DIMENSION(*), INTENT(IN) :: memb_addr
LOGICAL, INTENT(IN) :: relax
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER, DIMENSION(1:H5FD_MEM_NTYPES_F) :: lenm
INTEGER :: maxlen
INTEGER :: flag = 0
@@ -4113,7 +2545,7 @@ CONTAINS
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier
+ INTEGER(HID_T), INTENT(IN) :: prp_id
INTEGER, DIMENSION(*), INTENT(IN) :: memb_map
INTEGER(HID_T), DIMENSION(*), INTENT(IN) :: memb_fapl
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: memb_name
@@ -4132,34 +2564,20 @@ CONTAINS
hdferr = h5pset_fapl_multi_c(prp_id, memb_map, memb_fapl, memb_name, lenm, maxlen, memb_addr, flag)
END SUBROUTINE h5pset_fapl_multi_l
-!****s* H5P/h5pset_fapl_multi_s
-! NAME
-! h5pset_fapl_multi_s
-!
-! PURPOSE
-! Sets up use of the multi-file driver.
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! relax - flag
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! 31 March 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets up use of the multi-file driver.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param relax Flag.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_multi_s(prp_id, relax, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier
+ INTEGER(HID_T), INTENT(IN) :: prp_id
LOGICAL, INTENT(IN) :: relax
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: flag
INTERFACE
@@ -4167,7 +2585,7 @@ CONTAINS
BIND(C,NAME='h5pset_fapl_multi_sc')
IMPORT :: HID_T
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier
+ INTEGER(HID_T), INTENT(IN) :: prp_id
INTEGER, INTENT(IN) :: flag
END FUNCTION h5pset_fapl_multi_sc
END INTERFACE
@@ -4176,52 +2594,37 @@ CONTAINS
hdferr = h5pset_fapl_multi_sc(prp_id, flag)
END SUBROUTINE h5pset_fapl_multi_s
-!****s* H5P/h5pget_fapl_multi_f
-! NAME
-! h5pget_fapl_multi_f
-!
-! PURPOSE
-! Sets up use of the multi-file driver.
-!
-! INPUTS
-!
-! prp_id - file creation property list identifier
-! OUTPUTS
-!
-! mem_map - mapping array
-! memb_fapl - property list for each memory usage type
-! memb_name - names of member file
-! relax - flag
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! OPTIONAL PARAMETERS
-! maxlen_out - maximum length for memb_name array element
-!
-! AUTHOR
-! Elena Pourmal
-! 24 March 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets up use of the multi-file driver.
+!!
+!! \param prp_id File creation property list identifier.
+!! \param memb_map Mapping array.
+!! \param memb_fapl Property list for each memory usage type.
+!! \param memb_name Names of member file.
+!! \param memb_addr Offsets within the virtual address space, from 0 (zero) to HADDR_MAX_F, at which each type of data storage begins.
+!! \param relax Flag.
+!! \param hdferr \fortran_error
+!! \param maxlen_out Maximum length for memb_name array element.
+!!
SUBROUTINE h5pget_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, memb_addr, relax, hdferr, maxlen_out)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier
+ INTEGER(HID_T), INTENT(IN) :: prp_id
INTEGER, DIMENSION(*), INTENT(OUT) :: memb_map
INTEGER(HID_T), DIMENSION(*), INTENT(OUT) :: memb_fapl
CHARACTER(LEN=*), DIMENSION(*), INTENT(OUT) :: memb_name
REAL, DIMENSION(*), INTENT(OUT) :: memb_addr
INTEGER, OPTIONAL, INTENT(OUT) :: maxlen_out
LOGICAL, INTENT(OUT) :: relax
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
+
INTEGER, DIMENSION(1:H5FD_MEM_NTYPES_F) :: lenm
INTEGER :: maxlen
INTEGER :: c_maxlen_out
INTEGER :: flag
INTEGER :: i
-!
+
INTERFACE
INTEGER FUNCTION h5pget_fapl_multi_c(prp_id, memb_map, memb_fapl, memb_name, lenm, &
maxlen, memb_addr, flag, c_maxlen_out) &
@@ -4229,7 +2632,7 @@ CONTAINS
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier
+ INTEGER(HID_T), INTENT(IN) :: prp_id
INTEGER, DIMENSION(*), INTENT(OUT) :: memb_map
INTEGER(HID_T), DIMENSION(*), INTENT(OUT) :: memb_fapl
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(OUT) :: memb_name
@@ -4251,51 +2654,32 @@ CONTAINS
IF(flag .EQ. 0) relax = .FALSE.
IF(PRESENT(maxlen_out)) maxlen_out = c_maxlen_out
END SUBROUTINE h5pget_fapl_multi_f
-!****s* H5P/h5pset_szip_f
-! NAME
-! h5pset_szip_f
-!
-! PURPOSE
-! Sets up use of szip compression
-!
-! INPUTS
-!
-! prp_id - dataset creation property list identifier
-! options_mask - A bit-mask conveying the desired SZIP options.
-! Current valid values in Fortran are:
-! H5_SZIP_EC_OM_F
-! H5_SZIP_NN_OM_F
-! pixels_per_block - szip parameters
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! April 10 2003
-!
-! Fortran90 Interface:
+#endif
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets up use of szip compression
+!!
+!! \param prp_id Dataset creation property list identifier.
+!! \param options_mask A bit-mask conveying the desired SZIP options. Current valid values in Fortran are:
+!! \li H5_SZIP_EC_OM_F
+!! \li H5_SZIP_NN_OM_F
+!! \param pixels_per_block Szip parameters.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_szip_f(prp_id, options_mask, pixels_per_block, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property
- ! list identifier
- INTEGER, INTENT(IN) :: options_mask ! A bit-mask conveying the desired
- ! SZIP options
- ! Current valid values in Fortran are:
- ! H5_SZIP_EC_OM_F
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: options_mask
! H5_SZIP_NN_OM_F
- INTEGER, INTENT(IN) :: pixels_per_block ! The number of pixels or data elements
- ! in each data block
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(IN) :: pixels_per_block
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_szip_c(prp_id, options_mask, pixels_per_block) &
BIND(C,NAME='h5pset_szip_c')
IMPORT :: HID_T
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier
+ INTEGER(HID_T), INTENT(IN) :: prp_id
INTEGER, INTENT(IN) :: options_mask
INTEGER, INTENT(IN) :: pixels_per_block
END FUNCTION h5pset_szip_c
@@ -4304,39 +2688,20 @@ CONTAINS
END SUBROUTINE h5pset_szip_f
-!****s* H5P/h5pall_filters_avail_f
-! NAME
-! h5pall_filters_avail_f
-!
-! PURPOSE
-! Checks if all filters set in the dataset creation
-! property list are available
-!
-! INPUTS
-!
-! prp_id - data creation property list identifier
-! OUTPUTS
-!
-! flag - .TRUE. if all filters are available
-! .FALSE. otherwise
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! April 10 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Checks if all filters set in the dataset creation property list are available.
+!!
+!! \param prp_id Data creation property list identifier.
+!! \param flag .TRUE. if all filters are available, .FALSE. otherwise.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pall_filters_avail_f(prp_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property
- ! list identifier
- LOGICAL, INTENT(OUT) :: flag ! .TRUE. if all filters are available
- ! .FALSE. otherwise
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ LOGICAL, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: status
INTERFACE
@@ -4354,48 +2719,30 @@ CONTAINS
END SUBROUTINE h5pall_filters_avail_f
-!****s* H5P/h5pget_filter_by_id_f
-! NAME
-! h5pget_filter_by_id_f
-!
-! PURPOSE
-! Returns information about a filter in a pipeline
-!
-! INPUTS
-!
-! prp_id - data creation or transfer property list
-! identifier
-! OUTPUTS
-!
-! filter_id - filter identifier
-! flags - bit vector specifying certain general
-! properties of the filter
-! cd_nelmts - number of elements in cd_values
-! cd_values - auxiliary data for the filter
-! namelen - number of characters in the name buffer
-! name - buffer to retrieve filter name
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! April 10 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns information about a filter in a pipeline
+!!
+!! \param prp_id Data creation or transfer property list identifier.
+!! \param filter_id Filter identifier.
+!! \param flags Bit vector specifying certain general properties of the filter.
+!! \param cd_nelmts Number of elements in cd_values.
+!! \param cd_values Auxiliary data for the filter.
+!! \param namelen Number of characters in the name buffer.
+!! \param name Buffer to retrieve filter name.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_filter_by_id_f(prp_id, filter_id, flags, cd_nelmts, cd_values, namelen, name, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: filter_id ! Filter identifier
- INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts ! Number of elements in cd_values.
- INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values ! Auxiliary data for the filter.
- INTEGER, INTENT(OUT) :: flags ! Bit vector specifying certain general
- ! properties of the filter.
- INTEGER(SIZE_T), INTENT(IN) :: namelen ! Anticipated number of characters in name.
- CHARACTER(LEN=*), INTENT(OUT) :: name ! Name of the filter
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: filter_id
+ INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts
+ INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values
+ INTEGER, INTENT(OUT) :: flags
+ INTEGER(SIZE_T), INTENT(IN) :: namelen
+ CHARACTER(LEN=*), INTENT(OUT) :: name
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_filter_by_id_c(prp_id, filter_id, flags, cd_nelmts, &
cd_values, namelen, name) &
@@ -4417,43 +2764,26 @@ CONTAINS
cd_values, namelen, name)
END SUBROUTINE h5pget_filter_by_id_f
-!****s* H5P/h5pmodify_filter_f
-! NAME
-! h5pmodify_filter_f
-!
-! PURPOSE
-! Adds a filter to the filter pipeline.
-!
-! INPUTS
-!
-! prp_id - data creation or transfer property list
-! identifier
-! filter - filter to be modified
-! flags - bit vector specifying certain general
-! properties of the filter
-! cd_nelmts - number of elements in cd_values
-! cd_values - auxiliary data for the filter
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Elena Pourmal
-! April 10 2003
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Adds a filter to the filter pipeline.
+!!
+!! \param prp_id Data creation or transfer property list identifier.
+!! \param filter Filter to be modified.
+!! \param flags Bit vector specifying certain general properties of the filter.
+!! \param cd_nelmts Number of elements in cd_values.
+!! \param cd_values Auxiliary data for the filter.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, cd_values, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: filter ! Filter to be modified
- INTEGER, INTENT(IN) :: flags ! Bit vector specifying certain general
- ! properties of the filter
- INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts ! Number of elements in cd_values
- INTEGER, DIMENSION(*), INTENT(IN) :: cd_values ! Auxiliary data for the filter
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: filter
+ INTEGER, INTENT(IN) :: flags
+ INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts
+ INTEGER, DIMENSION(*), INTENT(IN) :: cd_values
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pmodify_filter_c(prp_id, filter, flags, cd_nelmts, cd_values) &
BIND(C,NAME='h5pmodify_filter_c')
@@ -4470,36 +2800,20 @@ CONTAINS
hdferr = h5pmodify_filter_c(prp_id, filter, flags, cd_nelmts, cd_values )
END SUBROUTINE h5pmodify_filter_f
-!****s* H5P/h5premove_filter_f
-! NAME
-! h5premove_filter_f
-!
-! PURPOSE
-! Delete one or more filters from the filter pipeline.
-!
-! INPUTS
-!
-! prp_id - data creation or transfer property list
-! identifier
-! filter - filter to be removed
-! OUTPUTS
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! Quincey Koziol
-! January 27 2004
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Delete one or more filters from the filter pipeline.
+!!
+!! \param prp_id Data creation or transfer property list identifier.
+!! \param filter Filter to be removed.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5premove_filter_f(prp_id, filter, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property list
- ! identifier
- INTEGER, INTENT(IN) :: filter ! Filter to be removed
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: filter
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5premove_filter_c(prp_id, filter) &
BIND(C,NAME='h5premove_filter_c')
@@ -4513,41 +2827,22 @@ CONTAINS
hdferr = h5premove_filter_c(prp_id, filter)
END SUBROUTINE h5premove_filter_f
-!****s* H5P/H5Pget_attr_phase_change_f
-! NAME
-! H5Pget_attr_phase_change_f
-!
-! PURPOSE
-! Retrieves attribute storage phase change thresholds
-!
-! INPUTS
-!
-! ocpl_id - Object (dataset or group) creation property list identifier
-! OUTPUTS
-!
-! max_compact - Maximum number of attributes to be stored in compact storage
-! (Default: 8)
-! min_dense - Minimum number of attributes to be stored in dense storage
-! (Default: 6)
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! January, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves attribute storage phase change thresholds
+!!
+!! \param ocpl_id Object (dataset or group) creation property list identifier.
+!! \param max_compact Maximum number of attributes to be stored in compact storage (Default: 8).
+!! \param min_dense Minimum number of attributes to be stored in dense storage (Default: 6).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: ocpl_id ! Object (dataset or group) creation property list identifier
- INTEGER, INTENT(OUT) :: max_compact ! Maximum number of attributes to be stored in compact storage
- ! (Default: 8)
- INTEGER, INTENT(OUT) :: min_dense ! Minimum number of attributes to be stored in dense storage
- ! (Default: 6)
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: ocpl_id
+ INTEGER, INTENT(OUT) :: max_compact
+ INTEGER, INTENT(OUT) :: min_dense
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_attr_phase_change_c(ocpl_id, max_compact, min_dense) &
BIND(C,NAME='h5pget_attr_phase_change_c')
@@ -4563,35 +2858,20 @@ CONTAINS
hdferr = h5pget_attr_phase_change_c(ocpl_id, max_compact, min_dense)
END SUBROUTINE h5pget_attr_phase_change_f
-!****s* H5P/H5Pset_attr_creation_order_f
-! NAME
-! H5Pset_attr_creation_order_f
-!
-! PURPOSE
-! Sets tracking and indexing of attribute creation order
-!
-! INPUTS
-!
-! ocpl_id - Object creation property list identifier
-! crt_order_flags - Flags specifying whether to track and index attribute creation order
-! OUTPUTS
-!
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! January, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets tracking and indexing of attribute creation order
+!!
+!! \param ocpl_id Object creation property list identifier.
+!! \param crt_order_flags Flags specifying whether to track and index attribute creation order.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_attr_creation_order_f(ocpl_id, crt_order_flags , hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: ocpl_id ! Object (dataset or group) creation property list identifier
- INTEGER, INTENT(IN) :: crt_order_flags ! Flags specifying whether to track and index attribute creation order
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: ocpl_id
+ INTEGER, INTENT(IN) :: crt_order_flags
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION H5Pset_attr_creation_order_c(ocpl_id, crt_order_flags) &
BIND(C,NAME='h5pset_attr_creation_order_c')
@@ -4606,37 +2886,20 @@ CONTAINS
hdferr = H5Pset_attr_creation_order_c(ocpl_id, crt_order_flags)
END SUBROUTINE h5pset_attr_creation_order_f
-!****s* H5P/H5Pset_shared_mesg_nindexes_f
-! NAME
-! H5Pset_shared_mesg_nindexes_f
-!
-! PURPOSE
-! Sets number of shared object header message indexes
-!
-! INPUTS
-!
-! plist_id - file creation property list
-! nindexes - Number of shared object header message indexes to be available in files created with this property list
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! January, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets number of shared object header message indexes
+!!
+!! \param plist_id File creation property list.
+!! \param nindexes Number of shared object header message indexes to be available in files created with this property list.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_shared_mesg_nindexes_f( plist_id, nindexes, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File creation property list
- INTEGER, INTENT(IN) :: nindexes ! Number of shared object header message indexes
- ! available in files created WITH this property list
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
-!
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER, INTENT(IN) :: nindexes
+ INTEGER, INTENT(OUT) :: hdferr
! MS FORTRAN needs explicit interface for C functions called here.
!
INTERFACE
@@ -4654,41 +2917,24 @@ CONTAINS
END SUBROUTINE h5pset_shared_mesg_nindexes_f
-!****s* H5P/H5Pset_shared_mesg_index_f
-! NAME
-! H5Pset_shared_mesg_index_f
-!
-! PURPOSE
-! Configures the specified shared object header message index
-!
-! INPUTS
-!
-! fcpl_id - File creation property list identifier.
-! index_num - Index being configured.
-! mesg_type_flags - Types of messages that should be stored in this index.
-! min_mesg_size - Minimum message size.
-!
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! January, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Configures the specified shared object header message index
+!!
+!! \param fcpl_id File creation property list identifier.
+!! \param index_num Index being configured.
+!! \param mesg_type_flags Types of messages that should be stored in this index.
+!! \param min_mesg_size Minimum message size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_shared_mesg_index_f(fcpl_id, index_num, mesg_type_flags, min_mesg_size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: fcpl_id ! file creation property list
- INTEGER, INTENT(IN) :: index_num ! Index being configured.
- INTEGER, INTENT(IN) :: mesg_type_flags ! Types of messages that should be stored in this index.
- INTEGER, INTENT(IN) :: min_mesg_size ! Minimum message size.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
-!
+ INTEGER(HID_T), INTENT(IN) :: fcpl_id
+ INTEGER, INTENT(IN) :: index_num
+ INTEGER, INTENT(IN) :: mesg_type_flags
+ INTEGER, INTENT(IN) :: min_mesg_size
+ INTEGER, INTENT(OUT) :: hdferr
! MS FORTRAN needs explicit interface for C functions called here.
!
INTERFACE
@@ -4707,37 +2953,20 @@ CONTAINS
END SUBROUTINE h5pset_shared_mesg_index_f
-!****s* H5P/H5Pget_attr_creation_order_f
-! NAME
-! H5Pget_attr_creation_order_f
-!
-! PURPOSE
-! Retrieves tracking and indexing settings for attribute creation order
-!
-! INPUTS
-!
-! ocpl_id - Object (group or dataset) creation property list identifier
-!
-! OUTPUTS
-!
-! crt_order_flags - Flags specifying whether to track and index attribute creation order
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves tracking and indexing settings for attribute creation order
+!!
+!! \param ocpl_id Object (group or dataset) creation property list identifier.
+!! \param crt_order_flags Flags specifying whether to track and index attribute creation order.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_attr_creation_order_f(ocpl_id, crt_order_flags, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: ocpl_id ! Object (group or dataset) creation property list identifier
- INTEGER, INTENT(OUT) :: crt_order_flags ! Flags specifying whether to track and index attribute creation order
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
-!
+ INTEGER(HID_T), INTENT(IN) :: ocpl_id
+ INTEGER, INTENT(OUT) :: crt_order_flags
+ INTEGER, INTENT(OUT) :: hdferr
! MS FORTRAN needs explicit interface for C functions called here.
!
INTERFACE
@@ -4754,39 +2983,24 @@ CONTAINS
END SUBROUTINE h5pget_attr_creation_order_f
-!****s* H5P/H5Pget_libver_bounds_f
-! NAME
-! H5Pget_libver_bounds_f
-!
-! PURPOSE
-! Retrieves the lower and upper bounds on the HDF5 library release versions that indirectly
-! determine the object format versions used when creating objects in the file.
-!
-! INPUTS
-!
-! fapl_id - File access property list identifier
-! low - The earliest version of the library that will be used for writing objects.
-! high - The latest version of the library that will be used for writing objects.
-!
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 10, 2020
-!
-! Fortran Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the lower and upper bounds on the HDF5 library release versions that indirectly
+!! determine the object format versions used when creating objects in the file.
+!!
+!! \param fapl_id File access property list identifier.
+!! \param low The earliest version of the library that will be used for writing objects.
+!! \param high The latest version of the library that will be used for writing objects.
+!! \param hdferr \fortran_error
+!!
+!! Fortran Interface:
SUBROUTINE h5pget_libver_bounds_f(fapl_id, low, high, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: fapl_id ! File access property list identifier
- INTEGER, INTENT(OUT) :: low ! The earliest version of the library that will be used for writing objects.
- INTEGER, INTENT(OUT) :: high ! The latest version of the library that will be used for writing objects.
- INTEGER, INTENT(OUT) :: hdferr ! Error code: 0 on success and -1 on failure
-!*****
-! Local variables
+ INTEGER(HID_T), INTENT(IN) :: fapl_id
+ INTEGER, INTENT(OUT) :: low
+ INTEGER, INTENT(OUT) :: high
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER(ENUM_T) :: low_c, high_c
INTEGER(C_INT) :: hdferr_c
!
@@ -4813,38 +3027,22 @@ CONTAINS
END SUBROUTINE h5pget_libver_bounds_f
-!****s* H5P/H5Pset_libver_bounds_f
-! NAME
-! H5Pset_libver_bounds_f
-!
-! PURPOSE
-! Sets bounds on library versions, and indirectly format versions, to be used when creating objects.
-!
-! INPUTS
-!
-! fapl_id - File access property list identifier
-! low - The earliest version of the library that will be used for writing objects.
-! high - The latest version of the library that will be used for writing objects.
-!
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 18, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets bounds on library versions, and indirectly format versions, to be used when creating objects.
+!!
+!! \param fapl_id File access property list identifier.
+!! \param low The earliest version of the library that will be used for writing objects.
+!! \param high The latest version of the library that will be used for writing objects.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_libver_bounds_f(fapl_id, low, high, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: fapl_id ! File access property list identifier
- INTEGER, INTENT(IN) :: low ! The earliest version of the library that will be used for writing objects.
- INTEGER, INTENT(IN) :: high ! The latest version of the library that will be used for writing objects.
- INTEGER, INTENT(OUT) :: hdferr ! Error code: 0 on success and -1 on failure
-!*****
-! Local variables
+ INTEGER(HID_T), INTENT(IN) :: fapl_id
+ INTEGER, INTENT(IN) :: low
+ INTEGER, INTENT(IN) :: high
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER(C_INT) :: hdferr_c
!
! MS FORTRAN needs explicit interface for C functions called here.
@@ -4867,36 +3065,20 @@ CONTAINS
END SUBROUTINE h5pset_libver_bounds_f
-!****s* H5P/H5Pset_link_creation_order_f
-! NAME
-! H5Pset_link_creation_order_f
-!
-! PURPOSE
-! Sets creation order tracking and indexing for links in a group.
-!
-! INPUTS
-!
-! gcpl_id - Group creation property list identifier
-! crt_order_flags - Creation order flag(s)
-!
-! OUTPUTS
-!
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 18, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets creation order tracking and indexing for links in a group.
+!!
+!! \param gcpl_id Group creation property list identifier.
+!! \param crt_order_flags Creation order flag(s).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_link_creation_order_f(gcpl_id, crt_order_flags, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: gcpl_id ! File access property list identifier
- INTEGER, INTENT(IN) :: crt_order_flags ! Creation order flag(s)
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: gcpl_id
+ INTEGER, INTENT(IN) :: crt_order_flags
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_link_creation_order_c(gcpl_id, crt_order_flags) &
BIND(C,NAME='h5pset_link_creation_order_c')
@@ -4912,37 +3094,22 @@ CONTAINS
END SUBROUTINE h5pset_link_creation_order_f
-!****s* H5P/H5Pget_link_phase_change_f
-! NAME
-! H5Pget_link_phase_change_f
-!
-! PURPOSE
-! Queries the settings for conversion between compact and dense groups.
-!
-! INPUTS
-!
-! gcpl_id - Group creation property list identifier
-! OUTPUTS
-!
-! max_compact - Maximum number of attributes to be stored in compact storage
-! min_dense - Minimum number of attributes to be stored in dense storage
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 20, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the settings for conversion between compact and dense groups.
+!!
+!! \param gcpl_id Group creation property list identifier.
+!! \param max_compact Maximum number of attributes to be stored in compact storage.
+!! \param min_dense Minimum number of attributes to be stored in dense storage.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_link_phase_change_f(gcpl_id, max_compact, min_dense, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
- INTEGER, INTENT(OUT) :: max_compact ! Maximum number of attributes to be stored in compact storage
- INTEGER, INTENT(OUT) :: min_dense ! Minimum number of attributes to be stored in dense storage
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: gcpl_id
+ INTEGER, INTENT(OUT) :: max_compact
+ INTEGER, INTENT(OUT) :: min_dense
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_link_phase_change_c(gcpl_id, max_compact, min_dense) &
BIND(C,NAME='h5pget_link_phase_change_c')
@@ -4958,37 +3125,20 @@ CONTAINS
hdferr = h5pget_link_phase_change_c(gcpl_id, max_compact, min_dense)
END SUBROUTINE h5pget_link_phase_change_f
-!****s* H5P/H5Pget_obj_track_times_f
-! NAME
-! H5Pget_obj_track_times_f
-!
-! PURPOSE
-! Returns whether times are tracked for an object.
-!
-! INPUTS
-!
-! plist_id - property list id
-! flag - object timestamp setting
-! .TRUE.,.FALSE.
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 22, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns whether times are tracked for an object.
+!!
+!! \param plist_id Property list id.
+!! \param flag Object timestamp setting, .TRUE. or .FALSE.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_obj_track_times_f(plist_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property
- ! list identifier
- LOGICAL, INTENT(OUT) :: flag ! Object timestamp setting
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ LOGICAL, INTENT(OUT) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: status
!
! MS FORTRAN needs explicit interface for C functions called here.
@@ -4997,7 +3147,7 @@ CONTAINS
INTEGER FUNCTION h5pget_obj_track_times_c(plist_id, status) &
BIND(C,NAME='h5pget_obj_track_times_c')
IMPORT :: HID_T
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File creation property list identifier
+ INTEGER(HID_T), INTENT(IN) :: plist_id
INTEGER, INTENT(OUT) :: status
END FUNCTION h5pget_obj_track_times_c
END INTERFACE
@@ -5007,52 +3157,20 @@ CONTAINS
END SUBROUTINE h5pget_obj_track_times_f
-!****s* H5P/H5Pset_obj_track_times_f
-! NAME
-! H5Pset_obj_track_times_f
-!
-! PURPOSE
-! Set whether the birth, access, modification & change times for
-! an object are stored.
-!
-! Birth time is the time the object was created. Access time is
-! the last time that metadata or raw data was read from this
-! object. Modification time is the last time the data for
-! this object was changed (either writing raw data to a dataset
-! or inserting/modifying/deleting a link in a group). Change
-! time is the last time the metadata for this object was written
-! (adding/modifying/deleting an attribute on an object, extending
-! the size of a dataset, etc).
-!
-! If these times are not tracked, they will be reported as
-! 12:00 AM UDT, Jan. 1, 1970 (i.e. 0 seconds past the UNIX
-! epoch) when queried.
-!
-! INPUTS
-!
-! plist_id - property list id
-! flag - object timestamp setting
-! .TRUE.,.FALSE.
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 22, 2008
-!
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Set whether the birth, access, modification & change times for an object are stored.
+!!
+!! \param plist_id Property list id.
+!! \param flag Object timestamp setting, .TRUE. or .FALSE.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_obj_track_times_f(plist_id, flag, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property
- ! list identifier
- LOGICAL, INTENT(IN) :: flag ! Object timestamp setting
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ LOGICAL, INTENT(IN) :: flag
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: status
!
! MS FORTRAN needs explicit interface for C functions called here.
@@ -5062,7 +3180,7 @@ CONTAINS
BIND(C,NAME='h5pset_obj_track_times_c')
IMPORT :: HID_T
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! File creation property list identifier
+ INTEGER(HID_T), INTENT(IN) :: plist_id
INTEGER, INTENT(IN) :: status
END FUNCTION h5pset_obj_track_times_c
END INTERFACE
@@ -5074,41 +3192,20 @@ CONTAINS
END SUBROUTINE h5pset_obj_track_times_f
-!****s* H5P/H5Pset_create_inter_group_f
-! NAME
-! H5Pset_create_inter_group_f
-!
-! PURPOSE
-! Specifies in property list whether to create missing intermediate groups.
-!
-! INPUTS
-!
-! lcpl_id - Link creation property list identifier
-! crt_intermed_group - crt_intermed_group specifying whether
-! to create intermediate groups upon the creation
-! of an object
-! OUTPUTS
-!
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 22, 2008
-!
-! HISTORY
-! The long subroutine name (>31) on older f90 compilers causes problems
-! so had to shorten the name
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Specifies in property list whether to create missing intermediate groups.
+!!
+!! \param lcpl_id Link creation property list identifier.
+!! \param crt_intermed_group Specifies whether to create intermediate groups upon the creation of an object.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_create_inter_group_f(lcpl_id, crt_intermed_group, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: lcpl_id ! Link creation property list identifier
- INTEGER, INTENT(IN) :: crt_intermed_group ! specifying whether to create intermediate groups
- ! upon the creation of an object
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: lcpl_id
+ INTEGER, INTENT(IN) :: crt_intermed_group
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_create_inter_group_c(lcpl_id, crt_intermed_group) &
BIND(C,NAME='h5pset_create_inter_group_c')
@@ -5123,36 +3220,20 @@ CONTAINS
END SUBROUTINE h5pset_create_inter_group_f
-!****s* H5P/H5Pget_link_creation_order_f
-! NAME
-! H5Pget_link_creation_order_f
-!
-! PURPOSE
-! Queries whether link creation order is tracked and/or indexed in a group.
-!
-! INPUTS
-!
-! gcpl_id - Group creation property list identifier
-!
-! OUTPUTS
-!
-! crt_order_flags - Creation order flag(s)
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 3, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries whether link creation order is tracked and/or indexed in a group.
+!!
+!! \param gcpl_id Group creation property list identifier.
+!! \param crt_order_flags Creation order flag(s).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_link_creation_order_f(gcpl_id, crt_order_flags, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
- INTEGER, INTENT(OUT) :: crt_order_flags ! Creation order flag(s)
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: gcpl_id
+ INTEGER, INTENT(OUT) :: crt_order_flags
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_link_creation_order_c(gcpl_id, crt_order_flags) &
BIND(C,NAME='h5pget_link_creation_order_c')
@@ -5168,39 +3249,22 @@ CONTAINS
END SUBROUTINE h5pget_link_creation_order_f
-!****s* H5P/H5Pset_char_encoding_f
-! NAME
-! H5Pset_char_encoding_f
-!
-! PURPOSE
-! Sets the character encoding used to encode a string.
-!
-! INPUTS
-!
-! plist_id - Property list identifier
-! encoding - Valid values for encoding are:
-! H5T_CSET_ASCII_F -> US ASCII
-! H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
-!
-! OUTPUTS
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 3, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the character encoding used to encode a string.
+!!
+!! \param plist_id Property list identifier.
+!! \param encoding Valid values for encoding are:
+!! \li H5T_CSET_ASCII_F -> US ASCII
+!! \li H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_char_encoding_f(plist_id, encoding, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Property list identifier
- INTEGER, INTENT(IN) :: encoding ! String encoding character set:
- ! H5T_CSET_ASCII_F -> US ASCII
- ! H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ INTEGER, INTENT(IN) :: encoding
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_char_encoding_c(plist_id, encoding) &
BIND(C,NAME='h5pset_char_encoding_c')
@@ -5216,41 +3280,23 @@ CONTAINS
END SUBROUTINE h5pset_char_encoding_f
-!****s* H5P/H5Pget_char_encoding_f
-! NAME
-! H5Pget_char_encoding_f
-!
-! PURPOSE
-! Retrieves the character encoding used to create a string
-!
-! INPUTS
-!
-! plist_id - Property list identifier
-!
-! OUTPUTS
-!
-! encoding - Valid values for encoding are:
-! H5T_CSET_ASCII_F -> US ASCII
-! H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 3, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the character encoding used to create a string
+!!
+!! \param plist_id Property list identifier.
+!! \param encoding Valid values for encoding are:
+!! \li H5T_CSET_ASCII_F -> US ASCII
+!! \li H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_char_encoding_f(plist_id, encoding, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Property list identifier
+ INTEGER(HID_T), INTENT(IN) :: plist_id
- INTEGER, INTENT(OUT) :: encoding ! Valid values for encoding are:
- ! H5T_CSET_ASCII_F -> US ASCII
- ! H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: encoding
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_char_encoding_c(plist_id, encoding) &
BIND(C,NAME='h5pget_char_encoding_c')
@@ -5266,43 +3312,22 @@ CONTAINS
END SUBROUTINE h5pget_char_encoding_f
-!****s* H5P/h5pset_copy_object_f
-! NAME
-! h5pset_copy_object_f
-!
-! PURPOSE
-! Sets properties to be used when an object is copied.
-!
-! INPUTS
-!
-! ocp_plist_id - Object copy property list identifier
-! copy_options - Copy option(s) to be set
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 3, 2008
-!
-! HISTORY
-!
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets properties to be used when an object is copied.
+!!
+!! \param ocp_plist_id Object copy property list identifier.
+!! \param copy_options Copy option(s) to be set.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_copy_object_f(ocp_plist_id, copy_options, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: ocp_plist_id ! Object copy property list identifier
- INTEGER, INTENT(IN) :: copy_options ! Copy option(s) to be set, valid options are:
- ! H5O_COPY_SHALLOW_HIERARCHY_F
- ! H5O_COPY_EXPAND_SOFT_LINK_F
- ! H5O_COPY_EXPAND_EXT_LINK_F
+ INTEGER(HID_T), INTENT(IN) :: ocp_plist_id
+ INTEGER, INTENT(IN) :: copy_options
! H5O_COPY_EXPAND_REFERENCE_F
! H5O_COPY_WITHOUT_ATTR_FLAG_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_copy_object_c(ocp_plist_id, copy_options) &
BIND(C,NAME='h5pset_copy_object_c')
@@ -5315,43 +3340,22 @@ CONTAINS
hdferr = h5pset_copy_object_c(ocp_plist_id, copy_options)
END SUBROUTINE h5pset_copy_object_f
-!****s* H5P/h5pget_copy_object_f
-! NAME
-! h5pget_copy_object_f
-!
-! PURPOSE
-! Retrieves the properties to be used when an object is copied.
-!
-! INPUTS
-!
-! ocp_plist_id - Object copy property list identifier
-! OUTPUTS
-!
-! copy_options - Copy option(s) to be get
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 3, 2008
-!
-! HISTORY
-!
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the properties to be used when an object is copied.
+!!
+!! \param ocp_plist_id Object copy property list identifier.
+!! \param copy_options Copy option(s) to be get.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_copy_object_f(ocp_plist_id, copy_options, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: ocp_plist_id ! Object copy property list identifier
- INTEGER, INTENT(OUT) :: copy_options ! Valid copy options returned are:
- ! H5O_COPY_SHALLOW_HIERARCHY_F
- ! H5O_COPY_EXPAND_SOFT_LINK_F
- ! H5O_COPY_EXPAND_EXT_LINK_F
+ INTEGER(HID_T), INTENT(IN) :: ocp_plist_id
+ INTEGER, INTENT(OUT) :: copy_options
! H5O_COPY_EXPAND_REFERENCE_F
! H5O_COPY_WITHOUT_ATTR_FLAG_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_copy_object_c(ocp_plist_id, copy_options) &
BIND(C,NAME='h5pget_copy_object_c')
@@ -5364,43 +3368,25 @@ CONTAINS
hdferr = h5pget_copy_object_c(ocp_plist_id, copy_options)
END SUBROUTINE h5pget_copy_object_f
-!****s* H5P/h5pget_data_transform_f
-! NAME
-! h5pget_data_transform_f
-!
-! PURPOSE
-! Retrieves a data transform expression.
-!
-! INPUTS
-!
-! plist_id - Identifier of the property list or class
-! OUTPUTS
-!
-! expression - buffer to hold transform expression
-! hdferr - Error code
-! Success: Actual length of the expression
-! If provided buffer "expression" is
-! smaller, than expression will be
-! truncated to fit into
-! provided user buffer
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 19, 2008
-!
-! HISTORY
-!
-! Should hdferr return just 0 or 1 and add another argument for the size?
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves a data transform expression.
+!!
+!! \param plist_id Identifier of the property list or class.
+!! \param expression Buffer to hold transform expression.
+!! \param hdferr Error code:
+!! Success: Actual length of the expression. If provided buffer "expression" is
+!! smaller, than expression will be truncated to fit into provided user buffer.
+!! Failure: -1
+!! \param size Registered size of the transform expression.
+!!
SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Identifier of the property list or class
- CHARACTER(LEN=*), INTENT(OUT) :: expression ! Buffer to hold transform expression
- INTEGER(SIZE_T), INTENT(OUT), OPTIONAL :: size ! Registered size of the transform expression
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ CHARACTER(LEN=*), INTENT(OUT) :: expression
+ INTEGER(SIZE_T), INTENT(OUT), OPTIONAL :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: expression_len
INTEGER(SIZE_T) :: size_default
@@ -5426,35 +3412,20 @@ SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size)
END SUBROUTINE h5pget_data_transform_f
-!****s* H5P/h5pset_data_transform_f
-! NAME
-! h5pset_data_transform_f
-!
-! PURPOSE
-! Sets a data transform expression.
-!
-! INPUTS
-!
-! plist_id - Identifier of the property list or class
-! expression - Buffer to hold transform expression
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 19, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets a data transform expression.
+!!
+!! \param plist_id Identifier of the property list or class.
+!! \param expression Buffer to hold transform expression.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_data_transform_f(plist_id, expression, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist_id ! Identifier of the property list or class
- CHARACTER(LEN=*), INTENT(IN) :: expression ! Buffer to hold transform expression
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: plist_id
+ CHARACTER(LEN=*), INTENT(IN) :: expression
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: expression_len
INTERFACE
@@ -5474,35 +3445,20 @@ SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size)
END SUBROUTINE h5pset_data_transform_f
-!****s* H5P/H5Pget_local_heap_size_hint_f
-! NAME
-! H5Pget_local_heap_size_hint_f
-!
-! PURPOSE
-! Queries the local heap size hint for original-style groups.
-!
-! INPUTS
-!
-! gcpl_id - Group creation property list identifier
-! OUTPUTS
-!
-! size_hint - Hint for size of local heap
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the local heap size hint for original-style groups.
+!!
+!! \param gcpl_id Group creation property list identifier.
+!! \param size_hint Hint for size of local heap.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_local_heap_size_hint_f(gcpl_id, size_hint, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
- INTEGER(SIZE_T), INTENT(OUT) :: size_hint ! Hint for size of local heap
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: gcpl_id
+ INTEGER(SIZE_T), INTENT(OUT) :: size_hint
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_local_heap_size_hint_c(gcpl_id, size_hint) &
BIND(C,NAME='h5pget_local_heap_size_hint_c')
@@ -5517,40 +3473,22 @@ SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size)
END SUBROUTINE h5pget_local_heap_size_hint_f
-!****s* H5P/H5Pget_est_link_info_f
-! NAME
-! H5Pget_est_link_info_f
-!
-! PURPOSE
-! Queries data required to estimate required local heap or object header size.
-!
-! INPUTS
-!
-! gcpl_id - Group creation property list identifier
-! OUTPUTS
-!
-! est_num_entries - Estimated number of links to be inserted into group
-! est_name_len - Estimated average length of link names
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! HISTORY
-!
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries data required to estimate required local heap or object header size.
+!!
+!! \param gcpl_id Group creation property list identifier.
+!! \param est_num_entries Estimated number of links to be inserted into group.
+!! \param est_name_len Estimated average length of link names.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_est_link_info_f(gcpl_id, est_num_entries, est_name_len, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
- INTEGER, INTENT(OUT) :: est_num_entries ! Estimated number of links to be inserted into group
- INTEGER, INTENT(OUT) :: est_name_len ! Estimated average length of link names
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: gcpl_id
+ INTEGER, INTENT(OUT) :: est_num_entries
+ INTEGER, INTENT(OUT) :: est_name_len
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_est_link_info_c(gcpl_id, est_num_entries, est_name_len) &
BIND(C,NAME='h5pget_est_link_info_c')
@@ -5566,35 +3504,20 @@ SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size)
END SUBROUTINE h5pget_est_link_info_f
-!****s* H5P/H5Pset_local_heap_size_hint_f
-! NAME
-! H5Pset_local_heap_size_hint_f
-!
-! PURPOSE
-! Sets the local heap size hint for original-style groups.
-!
-! INPUTS
-!
-! gcpl_id - Group creation property list identifier
-! size_hint - Hint for size of local heap
-! OUTPUTS
-!
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the local heap size hint for original-style groups.
+!!
+!! \param gcpl_id Group creation property list identifier.
+!! \param size_hint Hint for size of local heap.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_local_heap_size_hint_f(gcpl_id, size_hint, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
- INTEGER(SIZE_T), INTENT(IN) :: size_hint ! Hint for size of local heap
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: gcpl_id
+ INTEGER(SIZE_T), INTENT(IN) :: size_hint
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_local_heap_size_hint_c(gcpl_id, size_hint) &
BIND(C,NAME='h5pset_local_heap_size_hint_c')
@@ -5609,37 +3532,22 @@ SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size)
END SUBROUTINE h5pset_local_heap_size_hint_f
-!****s* H5P/h5pset_est_link_info_f
-! NAME
-! h5pset_est_link_info_f
-!
-! PURPOSE
-! Sets estimated number of links and length of link names in a group.
-!
-! INPUTS
-!
-! gcpl_id - Group creation property list identifier
-! est_num_entries - Estimated number of links to be inserted into group
-! est_name_len - Estimated average length of link names
-! OUTPUTS
-!
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets estimated number of links and length of link names in a group.
+!!
+!! \param gcpl_id Group creation property list identifier.
+!! \param est_num_entries Estimated number of links to be inserted into group.
+!! \param est_name_len Estimated average length of link names.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_est_link_info_f(gcpl_id, est_num_entries, est_name_len, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
- INTEGER, INTENT(IN) :: est_num_entries ! Estimated number of links to be inserted into group
- INTEGER, INTENT(IN) :: est_name_len ! Estimated average length of link names
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: gcpl_id
+ INTEGER, INTENT(IN) :: est_num_entries
+ INTEGER, INTENT(IN) :: est_name_len
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_est_link_info_c(gcpl_id, est_num_entries, est_name_len) &
BIND(C,NAME='h5pset_est_link_info_c')
@@ -5655,37 +3563,22 @@ SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size)
END SUBROUTINE h5pset_est_link_info_f
-!****s* H5P/h5pset_link_phase_change_f
-! NAME
-! h5pset_link_phase_change_f
-!
-! PURPOSE
-! Sets the parameters for conversion between compact and dense groups.
-!
-! INPUTS
-!
-! gcpl_id - Group creation property list identifier
-! max_compact - Maximum number of attributes to be stored in compact storage
-! min_dense - Minimum number of attributes to be stored in dense storage
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the parameters for conversion between compact and dense groups.
+!!
+!! \param gcpl_id Group creation property list identifier.
+!! \param max_compact Maximum number of attributes to be stored in compact storage.
+!! \param min_dense Minimum number of attributes to be stored in dense storage.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_link_phase_change_f(gcpl_id, max_compact, min_dense, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
- INTEGER, INTENT(IN) :: max_compact ! Maximum number of attributes to be stored in compact storage
- INTEGER, INTENT(IN) :: min_dense ! Minimum number of attributes to be stored in dense storage
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: gcpl_id
+ INTEGER, INTENT(IN) :: max_compact
+ INTEGER, INTENT(IN) :: min_dense
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_link_phase_change_c(gcpl_id, max_compact, min_dense) &
BIND(C,NAME='h5pset_link_phase_change_c')
@@ -5700,39 +3593,24 @@ SUBROUTINE h5pset_link_phase_change_f(gcpl_id, max_compact, min_dense, hdferr)
hdferr = h5pset_link_phase_change_c(gcpl_id, max_compact, min_dense)
END SUBROUTINE h5pset_link_phase_change_f
-!****s* H5P/h5pset_fapl_direct_f
-! NAME
-! h5pset_fapl_direct_f
-!
-! PURPOSE
-! Sets up use of the direct I/O driver.
-!
-! INPUTS
-!
-! fapl_id - File access property list identifier
-! alignment - Required memory alignment boundary
-! block_size - File system block size
-! cbuf_size - Copy buffer size
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets up use of the direct I/O driver.
+!!
+!! \param fapl_id File access property list identifier.
+!! \param alignment Required memory alignment boundary.
+!! \param block_size File system block size.
+!! \param cbuf_size Copy buffer size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: fapl_id ! File access property list identifier
- INTEGER(SIZE_T), INTENT(IN) :: alignment ! Required memory alignment boundary!
- INTEGER(SIZE_T), INTENT(IN) :: block_size ! File system block size
- INTEGER(SIZE_T), INTENT(IN) :: cbuf_size ! Copy buffer size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: fapl_id
+ INTEGER(SIZE_T), INTENT(IN) :: alignment
+ INTEGER(SIZE_T), INTENT(IN) :: block_size
+ INTEGER(SIZE_T), INTENT(IN) :: cbuf_size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_fapl_direct_c(fapl_id, alignment, block_size, cbuf_size) &
BIND(C,NAME='h5pset_fapl_direct_c')
@@ -5748,39 +3626,24 @@ SUBROUTINE h5pset_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdfer
hdferr = H5Pset_fapl_direct_c(fapl_id, alignment, block_size, cbuf_size)
END SUBROUTINE h5pset_fapl_direct_f
-!****s* H5P/h5pget_fapl_direct_f
-! NAME
-! h5pget_fapl_direct_f
-!
-! PURPOSE
-! Gets up use of the direct I/O driver.
-!
-! INPUTS
-!
-! fapl_id - File access property list identifier
-! OUTPUTS
-!
-! alignment - Required memory alignment boundary
-! block_size - File system block size
-! cbuf_size - Copy buffer size
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets up use of the direct I/O driver.
+!!
+!! \param fapl_id File access property list identifier.
+!! \param alignment Required memory alignment boundary.
+!! \param block_size File system block size.
+!! \param cbuf_size Copy buffer size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: fapl_id ! File access property list identifier
- INTEGER(SIZE_T), INTENT(OUT) :: alignment ! Required memory alignment boundary!
- INTEGER(SIZE_T), INTENT(OUT) :: block_size ! File system block size
- INTEGER(SIZE_T), INTENT(OUT) :: cbuf_size ! Copy buffer size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: fapl_id
+ INTEGER(SIZE_T), INTENT(OUT) :: alignment
+ INTEGER(SIZE_T), INTENT(OUT) :: block_size
+ INTEGER(SIZE_T), INTENT(OUT) :: cbuf_size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_fapl_direct_c(fapl_id, alignment, block_size, cbuf_size) &
BIND(C,NAME='h5pget_fapl_direct_c')
@@ -5794,43 +3657,25 @@ SUBROUTINE h5pset_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdfer
END INTERFACE
hdferr = H5Pget_fapl_direct_c(fapl_id, alignment, block_size, cbuf_size)
+
END SUBROUTINE h5pget_fapl_direct_f
-!****s* H5P/H5Pset_attr_phase_change_f
-! NAME
-! H5Pset_attr_phase_change_f
-!
-! PURPOSE
-! Sets attribute storage phase change thresholds.
-!
-! INPUTS
-!
-! ocpl_id - Object (dataset or group) creation property list identifier
-! OUTPUTS
-!
-! max_compact - Maximum number of attributes to be stored in compact storage
-! (Default: 8)
-! min_dense - Minimum number of attributes to be stored in dense storage
-! (Default: 6)
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! January, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets attribute storage phase change thresholds.
+!!
+!! \param ocpl_id Object (dataset or group) creation property list identifier.
+!! \param max_compact Maximum number of attributes to be stored in compact storage, (Default: 8).
+!! \param min_dense Minimum number of attributes to be stored in dense storage, (Default: 6).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: ocpl_id ! Object (dataset or group) creation property list identifier
- INTEGER, INTENT(IN) :: max_compact ! Maximum number of attributes to be stored in compact storage
- !(Default: 8)
- INTEGER, INTENT(IN) :: min_dense ! Minimum number of attributes to be stored in dense storage
- ! (Default: 6)
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: ocpl_id
+ INTEGER, INTENT(IN) :: max_compact
+ INTEGER, INTENT(IN) :: min_dense
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_attr_phase_change_c(ocpl_id, max_compact, min_dense) &
BIND(C,NAME='h5pset_attr_phase_change_c')
@@ -5845,32 +3690,20 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
hdferr = h5pset_attr_phase_change_c(ocpl_id, max_compact, min_dense)
-
END SUBROUTINE h5pset_attr_phase_change_f
-!****s* H5P/H5Pset_nbit_f
-! NAME
-! H5Pset_nbit_f
-!
-! PURPOSE
-! Sets up the use of the N-Bit filter.
-!
-! Inputs:
-! plist_id - Dataset creation property list identifier.
-!
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets up the use of the N-Bit filter.
+!!
+!! \param plist_id Dataset creation property list identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_nbit_f(plist_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: plist_id
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION H5Pset_nbit_c(plist_id) &
BIND(C,NAME='h5pset_nbit_c')
@@ -5884,37 +3717,25 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_nbit_f
-!****s* H5P/h5pset_scaleoffset_f
-! NAME
-! h5pset_scaleoffset_f
-!
-! PURPOSE
-! Sets up the use of the scale-offset filter.
-!
-! Inputs:
-! plist_id - Dataset creation property list identifier.
-! scale_type - Flag indicating compression method. Valid values:
-! H5Z_SO_FLOAT_DSCALE_F
-! H5Z_SO_FLOAT_ESCALE_F
-! H5Z_SO_INT_F
-!
-! scale_factor - Parameter related to scale.
-!
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 21, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets up the use of the scale-offset filter.
+!!
+!! \param plist_id Dataset creation property list identifier.
+!! \param scale_type Flag indicating compression method. Valid values:
+!! \li H5Z_SO_FLOAT_DSCALE_F
+!! \li H5Z_SO_FLOAT_ESCALE_F
+!! \li H5Z_SO_INT_F
+!! \param scale_factor Parameter related to scale.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_scaleoffset_f(plist_id, scale_type, scale_factor, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: plist_id
INTEGER , INTENT(IN) :: scale_type
INTEGER , INTENT(IN) :: scale_factor
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pset_scaleoffset_c(plist_id, scale_type, scale_factor) &
@@ -5931,39 +3752,20 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_scaleoffset_f
-!****s* H5P/h5pset_nlinks_f
-! NAME
-! h5pset_nlinks_f
-!
-! PURPOSE
-! Sets maximum number of soft or user-defined link traversals.
-!
-! INPUTS
-!
-! lapl_id - File access property list identifier
-! nlinks - Maximum number of links to traverse
-!
-! OUTPUTS
-!
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 24, 2008
-!
-! HISTORY
-!
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets maximum number of soft or user-defined link traversals.
+!!
+!! \param lapl_id File access property list identifier.
+!! \param nlinks Maximum number of links to traverse.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_nlinks_f(lapl_id, nlinks, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: lapl_id ! File access property list identifier
- INTEGER(SIZE_T), INTENT(IN) :: nlinks ! Maximum number of links to traverse
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: lapl_id
+ INTEGER(SIZE_T), INTENT(IN) :: nlinks
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_nlinks_c(lapl_id, nlinks) &
BIND(C,NAME='h5pset_nlinks_c')
@@ -5978,36 +3780,20 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_nlinks_f
-!****s* H5P/h5pget_nlinks_f
-! NAME
-! h5pget_nlinks_f
-!
-! PURPOSE
-! Gets maximum number of soft or user-defined link traversals.
-!
-! INPUTS
-!
-! lapl_id - File access property list identifier
-! nlinks - Maximum number of links to traverse
-!
-! OUTPUTS
-!
-! hdferr - error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! March 24, 2008
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets maximum number of soft or user-defined link traversals.
+!!
+!! \param lapl_id File access property list identifier.
+!! \param nlinks Maximum number of links to traverse.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_nlinks_f(lapl_id, nlinks, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: lapl_id ! File access property list identifier
- INTEGER(SIZE_T), INTENT(OUT) :: nlinks ! Maximum number of links to traverse
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: lapl_id
+ INTEGER(SIZE_T), INTENT(OUT) :: nlinks
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_nlinks_c(lapl_id, nlinks) &
BIND(C,NAME='h5pget_nlinks_c')
@@ -6022,41 +3808,20 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_nlinks_f
-!****s* H5P/H5Pget_create_inter_group_f
-! NAME
-! H5Pget_create_inter_group_f
-!
-! PURPOSE
-! Determines whether property is set to enable creating missing intermediate groups.
-!
-! INPUTS
-!
-! lcpl_id - Link creation property list identifier
-! crt_intermed_group - Specifying whether to create intermediate groups upon
-! the creation of an object
-! OUTPUTS
-!
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! April 4, 2008
-!
-! HISTORY
-!
-! The long subroutine name (>31) on older f90 compilers causes problems
-! so the name was shortened
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Determines whether property is set to enable creating missing intermediate groups.
+!!
+!! \param lcpl_id Link creation property list identifier.
+!! \param crt_intermed_group Specifying whether to create intermediate groups upon the creation of an object.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_create_inter_group_f(lcpl_id, crt_intermed_group, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: lcpl_id ! Link creation property list identifier
- INTEGER, INTENT(IN) :: crt_intermed_group ! Flag specifying whether to create intermediate groups
- ! upon creation of an object
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: lcpl_id
+ INTEGER, INTENT(IN) :: crt_intermed_group
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_create_inter_group_c(lcpl_id, crt_intermed_group) &
BIND(C,NAME='h5pget_create_inter_group_c')
@@ -6071,59 +3836,39 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_create_inter_group_f
-!****s* H5P/H5Pset_chunk_cache_f
-! NAME
-! H5Pset_chunk_cache_f
-!
-! PURPOSE
-! Set the number of objects in the meta data cache and the
-! maximum number of chunks and bytes in the raw data chunk cache.
-! Once set, these values will override the values in the file access
-! property list. Each of these values can be individually unset
-! (or not set at all) by passing the macros:
-! H5D_CHUNK_CACHE_NSLOTS_DFLT_F,
-! H5D_CHUNK_CACHE_NBYTES_DFLT_F, and/or
-! H5D_CHUNK_CACHE_W0_DFLT_F
-! as appropriate.
-!
-! The RDCC_W0 value should be between 0 and 1 inclusive and
-! indicates how much chunks that have been fully read or fully
-! written are favored for preemption. A value of zero means
-! fully read or written chunks are treated no differently than
-! other chunks (the preemption is strictly LRU) while a value
-! of one means fully read chunks are always preempted before
-! other chunks.
-!
-! INPUTS
-!
-! dapl_id - Dataset access property list identifier.
-! rdcc_nslots - The number of chunk slots in the raw data chunk cache for this dataset.
-! rdcc_nbytes - The total size of the raw data chunk cache for this dataset.
-! rdcc_w0 - The chunk preemption policy for this dataset.
-! OUTPUTS
-!
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! April 13, 2009
-!
-! HISTORY
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Set the number of objects in the meta data cache and the maximum number of chunks and bytes in the raw data chunk cache.
+!! Once set, these values will override the values in the file access
+!! property list. Each of these values can be individually unset
+!! (or not set at all) by passing the macros:
+!! H5D_CHUNK_CACHE_NSLOTS_DFLT_F,
+!! H5D_CHUNK_CACHE_NBYTES_DFLT_F, and/or
+!! H5D_CHUNK_CACHE_W0_DFLT_F
+!! as appropriate.
+!!
+!! The RDCC_W0 value should be between 0 and 1 inclusive and
+!! indicates how much chunks that have been fully read or fully
+!! written are favored for preemption. A value of zero means
+!! fully read or written chunks are treated no differently than
+!! other chunks (the preemption is strictly LRU) while a value
+!! of one means fully read chunks are always preempted before
+!! other chunks.
+!!
+!! \param dapl_id Dataset access property list identifier.
+!! \param rdcc_nslots The number of chunk slots in the raw data chunk cache for this dataset.
+!! \param rdcc_nbytes The total size of the raw data chunk cache for this dataset.
+!! \param rdcc_w0 The chunk preemption policy for this dataset.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_chunk_cache_f(dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: dapl_id ! Dataset access property list identifier.
- INTEGER(SIZE_T), INTENT(IN) :: rdcc_nslots ! The number of chunk slots in the raw data
- ! chunk cache for this dataset.
- INTEGER(SIZE_T), INTENT(IN) :: rdcc_nbytes ! The total size of the raw data chunk cache
- ! for this dataset.
- REAL, INTENT(IN) :: rdcc_w0 ! The chunk preemption policy for this dataset.
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: dapl_id
+ INTEGER(SIZE_T), INTENT(IN) :: rdcc_nslots
+ INTEGER(SIZE_T), INTENT(IN) :: rdcc_nbytes
+ REAL, INTENT(IN) :: rdcc_w0
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_chunk_cache_c(dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0) &
@@ -6141,47 +3886,24 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_chunk_cache_f
-!****s* H5P/H5Pget_chunk_cache_f
-! NAME
-! H5Pget_chunk_cache_f
-!
-! PURPOSE
-! Retrieves the maximum possible number of elements in the meta
-! data cache and the maximum possible number of elements and
-! bytes and the RDCC_W0 value in the raw data chunk cache. Any
-! (or all) arguments may be null pointers in which case the
-! corresponding datum is not returned. If these properties have
-! not been set on this property list, the default values for a
-! file access property list are returned.
-!
-! INPUTS
-!
-! dapl_id - Dataset access property list identifier.
-! OUTPUTS
-!
-! rdcc_nslots - Number of chunk slots in the raw data chunk cache hash table.
-! rdcc_nbytes - Total size of the raw data chunk cache, in bytes.
-! rdcc_w0 - Preemption policy.
-! hdferr - Error code
-! Success: 0
-! Failure: -1
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! April 13, 2009
-!
-! HISTORY
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the raw data chunk cache parameters.
+!!
+!! \param dapl_id Dataset access property list identifier.
+!! \param rdcc_nslots Number of chunk slots in the raw data chunk cache hash table.
+!! \param rdcc_nbytes Total size of the raw data chunk cache, in bytes.
+!! \param rdcc_w0 Preemption policy.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_chunk_cache_f(dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: dapl_id ! Dataset access property list identifier.
- INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nslots ! Number of chunk slots in the raw data chunk cache hash table.
- INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nbytes ! Total size of the raw data chunk cache, in bytes.
- REAL, INTENT(OUT) :: rdcc_w0 ! Preemption policy.
- INTEGER, INTENT(OUT) :: hdferr ! Error code:
- ! 0 on success and -1 on failure
-!*****
+ INTEGER(HID_T), INTENT(IN) :: dapl_id
+ INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nslots
+ INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nbytes
+ REAL, INTENT(OUT) :: rdcc_w0
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_chunk_cache_c(dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0) &
BIND(C,NAME='h5pget_chunk_cache_c')
@@ -6198,59 +3920,288 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_chunk_cache_f
-!
-!****s* H5P (F03)/h5pset_fill_value_f_F90
-!
-! NAME
-! h5pset_fill_value_f
-!
-! PURPOSE
-! Sets fill value for a dataset creation property list
-!
-! Inputs:
-! prp_id - Property list identifier
-! type_id - Datatype identifier of fill value datatype (in memory)
-! fillvalue - Fillvalue
-!
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-!
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Added the recommended way of passing fillvalue
-! and that is by passing the C address, all other
-! ways are obsolete and should be avoided. June, 2008 MSB
-!
-! NOTES
-! h5pset(get)fill_value_f function is overloaded to support
-! INTEGER, REAL, DOUBLE PRECISION and CHARACTER dtatypes.
-!
-! Fortran90 Interface:
-!! SUBROUTINE h5pset_fill_value_f(prp_id, type_id, fillvalue, hdferr)
-!! IMPLICIT NONE
-!! INTEGER(HID_T), INTENT(IN) :: prp_id
-!! INTEGER(HID_T), INTENT(IN) :: type_id
-!! TYPE(VOID) , INTENT(IN) :: fillvalue
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
+#ifdef H5_DOXYGEN_FORTRAN
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets fill value for a dataset creation property list
+!!
+!! \note \fortran_approved
+!!
+!! \param prp_id Property list identifier.
+!! \param type_id Datatype identifier of fill value datatype (in memory).
+!! \param fillvalue Fillvalue.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pset_fill_value_f(prp_id, type_id, fillvalue, hdferr)
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ TYPE(C_PTR) , INTENT(IN) :: fillvalue
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pset_fill_value_f
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets fill value for a dataset creation property list
+!!
+!! \note \fortran_approved
+!!
+!! \param prp_id Property list identifier.
+!! \param type_id Datatype identifier of fill value datatype (in memory).
+!! \param fillvalue Fillvalue.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pget_fill_value_f(prp_id, type_id, fillvalue, hdferr)
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ TYPE(C_PTR) , INTENT(IN) :: fillvalue
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pget_fill_value_f
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets fill value for a dataset creation property list
+!!
+!! \note \fortran_obsolete
+!!
+!! \param prp_id Property list identifier.
+!! \param type_id Datatype identifier of fill value datatype (in memory).
+!! \param fillvalue Fillvalue.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pset_fill_value_f(prp_id, type_id, fillvalue, hdferr)
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ TYPE(TYPE) , INTENT(IN) :: fillvalue
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pset_fill_value_f
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets fill value for a dataset creation property list.
+!!
+!! \note \fortran_obsolete
+!!
+!! \param prp_id Property list identifier.
+!! \param type_id Datatype identifier of fill value datatype (in memory).
+!! \param fillvalue Fillvalue.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pget_fill_value_f(prp_id, type_id, fillvalue, hdferr)
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ TYPE(TYPE) , INTENT(OUT) :: fillvalue
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pget_fill_value_f
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets a property list value.
+!!
+!! \note \fortran_approved
+!!
+!! \param prp_id Property list identifier to modify.
+!! \param name Name of property to modify.
+!! \param value Pointer to value to set the property to.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pset_f(prp_id, name, value, hdferr)
+ INTEGER(HID_T) , INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ TYPE(C_PTR) , INTENT(IN) :: value
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pset_f
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets a property list value.
+!!
+!! \note \fortran_obsolete
+!!
+!! \param prp_id Property list identifier to modify.
+!! \param name Name of property to modify.
+!! \param value Property value, supported types are:
+!! \li INTEGER
+!! \li REAL
+!! \li DOUBLE PRECISION
+!! \li CHARACTER(LEN=*)
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pset_f(prp_id, name, value, hdferr)
+ INTEGER(HID_T) , INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER , INTENT(IN) :: value
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pset
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets a property list value.
+!!
+!! \note \fortran_obsolete
+!!
+!! \param prp_id Property list identifier to modify.
+!! \param name Name of property to modify.
+!! \param value Property value, supported types are:
+!! \li INTEGER
+!! \li REAL
+!! \li DOUBLE PRECISION
+!! \li CHARACTER(LEN=*)
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pset_f(prp_id, name, value, hdferr)
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER, INTENT(IN) :: value
+ INTEGER, INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pset_f
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the value of a property.
+!!
+!! \note \fortran_approved
+!!
+!! \param prp_id Property list identifier to modify.
+!! \param name Name of property to get.
+!! \param value Pointer to a location to which to copy the value of of the property.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pget_f(prp_id, name, value, hdferr)
+ INTEGER(HID_T) , INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ TYPE(C_PTR) , INTENT(OUT) :: value
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pget_f
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the value of a property.
+!!
+!! \note \fortran_obsolete
+!!
+!! \param prp_id Property list identifier to modify.
+!! \param name Name of property to get.
+!! \param value Property value, supported types are:
+!! \li INTEGER
+!! \li REAL
+!! \li DOUBLE PRECISION
+!! \li CHARACTER(LEN=*)
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pget_f(prp_id, name, value, hdferr)
+ INTEGER(HID_T) , INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER , INTENT(OUT) :: value
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pget_f
+!>
+!! \ingroup FH5P
+!!
+!! \brief Registers a permanent property with a property list class.
+!!
+!! \note \fortran_approved
+!!
+!! \param class Property list class identifier.
+!! \param name Name of property to register.
+!! \param size Size of the property value.
+!! \param value Pointer to value to set the property to.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pregister_f(class, name, size, value, hdferr)
+ INTEGER(HID_T) , INTENT(IN) :: class
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T) , INTENT(IN) :: size
+ TYPE(C_PTR) , INTENT(IN) :: value
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pregister_f
+!>
+!! \ingroup FH5P
+!!
+!! \brief Registers a permanent property with a property list class.
+!!
+!! \note \fortran_obsolete
+!!
+!! \param class Property list class identifier.
+!! \param name Name of property to register.
+!! \param size Size of the property value.
+!! \param value Property value, supported types are:
+!! \li INTEGER
+!! \li REAL
+!! \li DOUBLE PRECISION
+!! \li CHARACTER(LEN=*)
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pregister_f(class, name, size, value, hdferr)
+ INTEGER(HID_T) , INTENT(IN) :: class
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T) , INTENT(IN) :: size
+ TYPE(TYPE) , INTENT(IN) :: value
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pregister_f
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Registers a temporary property with a property list class.
+!!
+!! \note \fortran_approved
+!!
+!! \param plist Property list class identifier.
+!! \param name Name of property to insert.
+!! \param size Size of the property value.
+!! \param value Pointer to new value pointer for the property being modified.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pinsert_f(plist, name, size, value, hdferr)
+ INTEGER(HID_T) , INTENT(IN) :: plist
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T) , INTENT(IN) :: size
+ TYPE(C_PTR) , INTENT(IN) :: value
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pinsert_f
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Registers a temporary property with a property list class.
+!!
+!! \note \fortran_obsolete
+!!
+!! \param plist Property list class identifier.
+!! \param name Name of property to insert.
+!! \param size Size of the property value.
+!! \param value Property value, supported types are:
+!! \li INTEGER
+!! \li REAL
+!! \li DOUBLE PRECISION
+!! \li CHARACTER(LEN=*)
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5pinsert_f(plist, name, size, value, hdferr)
+ IMPLICIT NONE
+ INTEGER(HID_T) , INTENT(IN) :: plist
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T) , INTENT(IN) :: size
+ TYPE(TYPE) , INTENT(IN) :: value
+ INTEGER , INTENT(OUT) :: hdferr
+ END SUBROUTINE h5pinsert_f
+#else
SUBROUTINE h5pset_fill_value_integer(prp_id, type_id, fillvalue, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of
- ! of fillvalue datatype
- ! (in memory)
- INTEGER, INTENT(IN), TARGET :: fillvalue ! Fillvalue
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ INTEGER, INTENT(IN), TARGET :: fillvalue
+ INTEGER, INTENT(OUT) :: hdferr
TYPE(C_PTR) :: f_ptr ! C address
f_ptr = C_LOC(fillvalue)
@@ -6258,57 +4209,13 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
hdferr = h5pset_fill_value_c(prp_id, type_id, f_ptr)
END SUBROUTINE h5pset_fill_value_integer
-!
-!****s* H5P (F03)/h5pget_fill_value_f_F90
-!
-! NAME
-! h5pget_fill_value_f
-!
-! PURPOSE
-! Gets fill value for a dataset creation property list
-!
-! Inputs:
-! prp_id - Property list identifier
-! type_id - Datatype identifier of fill value datatype (in memory)
-!
-! Outputs:
-! fillvalue - Fillvalue
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-!
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Added the recommended way of passing fillvalue
-! and that is by passing the C address, all other
-! ways are obsolete and should be avoided. June, 2008 MSB
-!
-! NOTES
-! h5pget(get)fill_value_f function is overloaded to support
-! INTEGER, REAL, DOUBLE PRECISION and CHARACTER dtatypes.
-!
-! Fortran90 Interface:
-!! SUBROUTINE h5pget_fill_value_f(prp_id, type_id, fillvalue, hdferr)
-!! INTEGER(HID_T), INTENT(IN) :: prp_id
-!! INTEGER(HID_T), INTENT(IN) :: type_id
-!! TYPE(VOID) , INTENT(OUT) :: fillvalue
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
SUBROUTINE h5pget_fill_value_integer(prp_id, type_id, fillvalue, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of
- ! of fillvalue datatype
- ! (in memory)
- INTEGER, INTENT(OUT), TARGET :: fillvalue ! Fillvalue
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ INTEGER, INTENT(OUT), TARGET :: fillvalue
+ INTEGER, INTENT(OUT) :: hdferr
TYPE(C_PTR) :: f_ptr ! C address
f_ptr = C_LOC(fillvalue)
@@ -6319,12 +4226,10 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
SUBROUTINE h5pset_fill_value_char(prp_id, type_id, fillvalue, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of
- ! of fillvalue datatype
- ! (in memory)
- CHARACTER(LEN=1), INTENT(IN), TARGET :: fillvalue ! Fillvalue
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ CHARACTER(LEN=1), INTENT(IN), TARGET :: fillvalue
+ INTEGER, INTENT(OUT) :: hdferr
TYPE(C_PTR) :: f_ptr ! C address
f_ptr = C_LOC(fillvalue(1:1))
@@ -6334,12 +4239,10 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
SUBROUTINE h5pget_fill_value_char(prp_id, type_id, fillvalue, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of
- ! of fillvalue datatype
- ! (in memory)
- CHARACTER(LEN=*), INTENT(OUT) :: fillvalue ! Fillvalue
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ CHARACTER(LEN=*), INTENT(OUT) :: fillvalue
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: i
CHARACTER(LEN=1), ALLOCATABLE, DIMENSION(:), TARGET :: chr
@@ -6365,155 +4268,35 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
DEALLOCATE(chr)
END SUBROUTINE h5pget_fill_value_char
-!
-!****s* H5P (F03)/h5pset_fill_value_f_F03
-!
-! NAME
-! h5pset_fill_value_f
-!
-! PURPOSE
-! Sets fill value for a dataset creation property list
-!
-! Inputs:
-! prp_id - Property list identifier
-! type_id - Datatype identifier of fill value datatype (in memory)
-! fillvalue - Fillvalue
-!
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-!
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Added the recommended way of passing fillvalue
-! and that is by passing the C address, all other
-! ways are obsolete and should be avoided. June, 2008 MSB
-!
-! NOTES
-! h5pset(get)fill_value_f function is overloaded to support
-! INTEGER, REAL, DOUBLE PRECISION and CHARACTER dtatypes.
-!
-! Fortran2003 Interface:
-!! SUBROUTINE h5pset_fill_value_f(prp_id, type_id, fillvalue, hdferr)
-!! INTEGER(HID_T), INTENT(IN) :: prp_id
-!! INTEGER(HID_T), INTENT(IN) :: type_id
-!! TYPE(C_PTR) , INTENT(IN) :: fillvalue
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
SUBROUTINE h5pset_fill_value_ptr(prp_id, type_id, fillvalue, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of
- ! of fillvalue datatype
- ! (in memory)
- TYPE(C_PTR), INTENT(IN) :: fillvalue ! Fillvalue
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ TYPE(C_PTR), INTENT(IN) :: fillvalue
+ INTEGER, INTENT(OUT) :: hdferr
hdferr = h5pset_fill_value_c(prp_id, type_id, fillvalue)
END SUBROUTINE h5pset_fill_value_ptr
-!
-!****s* H5P (F03)/h5pget_fill_value_f_F03
-!
-! NAME
-! h5pget_fill_value_f
-!
-! PURPOSE
-! Gets fill value for a dataset creation property list
-!
-! Inputs:
-! prp_id - Property list identifier
-! type_id - Datatype identifier of fill value datatype (in memory)
-!
-! Outputs:
-! fillvalue - Fillvalue
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-!
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 14, 2001
-!
-! Added the recommended way of passing fillvalue
-! and that is by passing the C address, all other
-! ways are obsolete and should be avoided. June, 2008 MSB
-!
-! NOTES
-! h5pget(get)fill_value_f function is overloaded to support
-! INTEGER, REAL, DOUBLE PRECISION and CHARACTER dtatypes.
-!
-! Fortran2003 Interface:
-!! SUBROUTINE h5pget_fill_value_f(prp_id, type_id, fillvalue, hdferr)
-!! INTEGER(HID_T), INTENT(IN) :: prp_id
-!! INTEGER(HID_T), INTENT(IN) :: type_id
-!! TYPE(C_PTR) :: fillvalue
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
-
SUBROUTINE h5pget_fill_value_ptr(prp_id, type_id, fillvalue, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of
- ! of fillvalue datatype
- ! (in memory)
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
TYPE(C_PTR) :: fillvalue ! Fillvalue
- INTEGER , INTENT(OUT) :: hdferr ! Error code
+ INTEGER , INTENT(OUT) :: hdferr
hdferr = h5pget_fill_value_c(prp_id, type_id, fillvalue)
END SUBROUTINE h5pget_fill_value_ptr
-!
-!****s* H5P (F03)/h5pset_f_F90
-!
-! NAME
-! h5pset_f
-!
-! PURPOSE
-! Sets a property list value
-!
-! Inputs:
-! prp_id - Property list identifier to modify
-! name - Name of property to modify
-! value - Property value, supported types are:
-! INTEGER
-! REAL
-! DOUBLE PRECISION
-! CHARACTER(LEN=*)
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
-!! SUBROUTINE h5pset_f(plid, name, value, hdferr)
-!! INTEGER(HID_T) , INTENT(IN) :: plid
-!! CHARACTER(LEN=*), INTENT(IN) :: name
-!! TYPE , INTENT(IN) :: value
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
SUBROUTINE h5pset_integer(prp_id, name, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
- INTEGER, INTENT(IN), TARGET :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER, INTENT(IN), TARGET :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
TYPE(C_PTR) :: f_ptr
@@ -6527,10 +4310,10 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
SUBROUTINE h5pset_char(prp_id, name, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
- CHARACTER(LEN=*), INTENT(IN) :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ CHARACTER(LEN=*), INTENT(IN) :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTEGER :: i
@@ -6560,44 +4343,26 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
DEALLOCATE(chr)
END SUBROUTINE h5pset_char
-!
-!****s* H5P (F03)/h5pget_f_F90
-!
-! NAME
-! h5pget_f
-!
-! PURPOSE
-! Queries the value of a property.
-!
-! Inputs:
-! prp_id - Property list identifier to modify
-! name - Name of property to get
-! value - Property value, supported types are:
-! INTEGER
-! REAL
-! DOUBLE PRECISION
-! CHARACTER(LEN=*)
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran90 Interface:
-!! SUBROUTINE h5pget_f(plid, name, value, hdferr)
-!! INTEGER(HID_T) , INTENT(IN) :: plid
-!! CHARACTER(LEN=*), INTENT(IN) :: name
-!! TYPE , INTENT(OUT) :: value
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
-
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the value of a property.
+!!
+!! \param prp_id Property list identifier to modify.
+!! \param name Name of property to get.
+!! \param value Property value, supported types are:
+!! \li INTEGER
+!! \li REAL
+!! \li DOUBLE PRECISION
+!! \li CHARACTER(LEN=*)
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_integer(prp_id, name, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
- INTEGER, INTENT(OUT), TARGET :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER, INTENT(OUT), TARGET :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
TYPE(C_PTR) :: f_ptr
@@ -6610,10 +4375,10 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
SUBROUTINE h5pget_char(prp_id, name, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
- CHARACTER(LEN=*), INTENT(OUT) :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ CHARACTER(LEN=*), INTENT(OUT) :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTEGER :: i
@@ -6640,125 +4405,58 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_char
-!
-!****s* H5P (F03)/h5pset_f_F03
-!
-! NAME
-! h5pset_f
-!
-! PURPOSE
-! Sets a property list value
-!
-! Inputs:
-! prp_id - Property list identifier to modify
-! name - Name of property to modify
-! value - Pointer to value to set the property to
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran2003 Interface:
-!! SUBROUTINE h5pset_f(plid, name, value, hdferr)
-!! INTEGER(HID_T) , INTENT(IN) :: plid
-!! CHARACTER(LEN=*), INTENT(IN) :: name
-!! TYPE(C_PTR) , INTENT(IN) :: value
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets a property list value
+!!
+!! \param prp_id Property list identifier to modify.
+!! \param name Name of property to modify.
+!! \param value Pointer to value to set the property to.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_ptr(prp_id, name, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
- TYPE(C_PTR), INTENT(IN) :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ TYPE(C_PTR), INTENT(IN) :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
name_len = LEN(name)
hdferr = h5pset_c(prp_id, name, name_len, value)
END SUBROUTINE h5pset_ptr
-!
-!****s* H5P (F03)/h5pget_f_F03
-!
-! NAME
-! h5pget_f (F03)
-!
-! PURPOSE
-! Queries the value of a property.
-!
-! Inputs:
-! prp_id - Property list identifier to modify
-! name - Name of property to get
-! value - Pointer to a location to which to copy the value of of the property
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! Fortran2003 Interface:
-!! SUBROUTINE h5pget_f(plid, name, value, hdferr)
-!! INTEGER(HID_T) , INTENT(IN) :: plid
-!! CHARACTER(LEN=*), INTENT(IN) :: name
-!! TYPE(C_PTR) , INTENT(OUT) :: value
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
+!>
+!! \ingroup FH5P
+!!
+!! \brief Queries the value of a property.
+!!
+!! \param prp_id Property list identifier to modify.
+!! \param name Name of property to get.
+!! \param value Pointer to a location to which to copy the value of of the property.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_ptr(prp_id, name, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
- TYPE(C_PTR), INTENT(OUT) :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ TYPE(C_PTR), INTENT(OUT) :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
name_len = LEN(name)
hdferr = h5pget_c(prp_id, name, name_len, value)
END SUBROUTINE h5pget_ptr
-!
-!****s* H5P (F03)/h5pregister_f_F90
-!
-! NAME
-! h5pregister
-!
-! PURPOSE
-! Registers a permanent property with a property list class.
-!
-! Inputs:
-! class - Property list class identifier
-! name - Name of property to register
-! size - Size of the property value
-! value - Property value, supported types are:
-! INTEGER
-! REAL
-! DOUBLE PRECISION
-! CHARACTER(LEN=*)
-!
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! October 10, 2002
-!
-! Fortran90 Interface:
-!! SUBROUTINE h5pregister_f(class, name, size, value, hdferr)
-!! INTEGER(HID_T) , INTENT(IN) :: class
-!! CHARACTER(LEN=*), INTENT(IN) :: name
-!! INTEGER(SIZE_T) , INTENT(IN) :: size
-!! TYPE , INTENT(IN) :: value
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
+
SUBROUTINE h5pregister_integer(class, name, size, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: class ! Property list class identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to register
- INTEGER(SIZE_T), INTENT(IN) :: size ! Size of the property value
- INTEGER, INTENT(IN), TARGET :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: class
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(IN), TARGET :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
TYPE(C_PTR) :: f_ptr
@@ -6769,14 +4467,13 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pregister_integer
-
SUBROUTINE h5pregister_char(class, name, size, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: class ! Property list class identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to register
- INTEGER(SIZE_T), INTENT(IN) :: size ! size of the property value
- CHARACTER(LEN=*), INTENT(IN) :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: class
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ CHARACTER(LEN=*), INTENT(IN) :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTEGER :: i
@@ -6804,89 +4501,27 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
hdferr = h5pregister_c(class, name, name_len, size, f_ptr)
DEALLOCATE(chr)
END SUBROUTINE h5pregister_char
-!
-!****s* H5P (F03)/h5pregister_f_F03
-!
-! NAME
-! h5pregister (F03)
-!
-! PURPOSE
-! Registers a permanent property with a property list class.
-!
-! Inputs:
-! class - Property list class identifier
-! name - Name of property to register
-! size - Size of the property value
-! value - Pointer to value to set the property to
-!
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! June 24, 2008
-!
-! Fortran2003 Interface:
-!! SUBROUTINE h5pregister_f(class, name, size, value, hdferr)
-!! INTEGER(HID_T) , INTENT(IN) :: class
-!! CHARACTER(LEN=*), INTENT(IN) :: name
-!! INTEGER(SIZE_T) , INTENT(IN) :: size
-!! TYPE(C_PTR) , INTENT(IN) :: value
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
SUBROUTINE h5pregister_ptr(class, name, size, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: class ! Property list class identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to register
- INTEGER(SIZE_T), INTENT(IN) :: size ! Size of the property value
- TYPE(C_PTR), INTENT(IN) :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: class
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ TYPE(C_PTR), INTENT(IN) :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
name_len = LEN(name)
hdferr = h5pregister_c(class, name, name_len, size, value)
END SUBROUTINE h5pregister_ptr
-!
-!****s* H5P (F03)/h5pinsert_f_F90
-!
-! NAME
-! h5pinsert (f90)
-!
-! PURPOSE
-! Registers a temporary property with a property list class.
-!
-! Inputs:
-! plist - Property list class identifier
-! name - Name of property to insert
-! size - Size of the property value
-! value - Property value, supported types are:
-! INTEGER
-! REAL
-! DOUBLE PRECISION
-! CHARACTER(LEN=*)
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-! AUTHOR
-! Elena Pourmal
-! October 10, 2002
-!
-! Fortran90 Interface:
-!! SUBROUTINE h5pinsert_f
-!! INTEGER(HID_T) , INTENT(IN) :: plist
-!! CHARACTER(LEN=*), INTENT(IN) :: name
-!! INTEGER(SIZE_T) , INTENT(IN) :: size
-!! TYPE , INTENT(IN) :: value
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
SUBROUTINE h5pinsert_integer(plist, name, size, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to insert
- INTEGER(SIZE_T), INTENT(IN) :: size ! Size of the property value
- INTEGER, INTENT(IN), TARGET :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: plist
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(IN), TARGET :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
TYPE(c_ptr) :: f_ptr
@@ -6898,11 +4533,11 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
SUBROUTINE h5pinsert_char(plist, name, size, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to insert
- INTEGER(SIZE_T), INTENT(IN) :: size ! Size of property value
- CHARACTER(LEN=*), INTENT(IN) :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: plist
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ CHARACTER(LEN=*), INTENT(IN) :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
INTEGER :: i
@@ -6933,91 +4568,45 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pinsert_char
-!
-!****s* H5P (F03)/h5pinsert_f_F03
-!
-! NAME
-! h5pinsert (f03)
-!
-! PURPOSE
-! Registers a temporary property with a property list class.
-!
-! Inputs:
-! plist - Property list class identifier
-! name - Name of property to insert
-! size - Size of the property value
-! value - Pointer to new value pointer for the property being modified
-!
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! June 24, 2008
-!
-! Fortran90 Interface:
-!! SUBROUTINE h5pinsert_f
-!! INTEGER(HID_T) , INTENT(IN) :: plist
-!! CHARACTER(LEN=*), INTENT(IN) :: name
-!! INTEGER(SIZE_T) , INTENT(IN) :: size
-!! TYPE(C_PTR) , INTENT(IN) :: value
-!! INTEGER , INTENT(OUT) :: hdferr
-!*****
SUBROUTINE h5pinsert_ptr(plist, name, size, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: plist ! Property list identifier
- CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to insert
- INTEGER(SIZE_T), INTENT(IN) :: size ! Size of property value
- TYPE(c_ptr), INTENT(IN) :: value ! Property value
- INTEGER, INTENT(OUT) :: hdferr ! Error code
+ INTEGER(HID_T), INTENT(IN) :: plist
+ CHARACTER(LEN=*), INTENT(IN) :: name
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ TYPE(c_ptr), INTENT(IN) :: value
+ INTEGER, INTENT(OUT) :: hdferr
INTEGER :: name_len
name_len = LEN(name)
hdferr = h5pinsert_c(plist, name , name_len, size, value)
END SUBROUTINE h5pinsert_ptr
-!
-!****s* H5P (F03)/h5pcreate_class_f_F03
-!
-! NAME
-! h5pcreate_class_f
-!
-! PURPOSE
-! Create a new property list class
-!
-! Inputs:
-! parent - Parent property list class identifier
-! Possible values include:
-! H5P_ROOT_F
-! H5P_FILE_CREATE_F
-! H5P_FILE_ACCESS_F
-! H5P_DATASET_CREATE_F
-! H5P_DATASET_XFER_F
-! H5P_FILE_MOUNT_F
-! name - Name of property to create
-!
-! Outputs:
-! class - Property list class identifier
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! Optional parameters:
-! H5P_cls_create_func_t (create) - Callback routine called when a property list is created
-! create_data - User pointer to any class creation information needed
-! H5P_cls_copy_func_t (copy) - Callback routine called when a property list is copied
-! copy_data - User pointer to any class copy information needed
-! H5P_cls_close_func_t (close) - Callback routine called when a property list is being closed
-! close_data - User pointer to any class close information needed
-!
-! AUTHOR
-! Elena Pourmal
-! October 9, 2002
-!
-! HISTORY
-! Added callback arguments
-! M. Scot Breitenfeld, July 3, 2008
-!
-! Fortran2003 Interface:
+
+#endif
+
+!>
+!! \ingroup FH5P
+!!
+!! \brief Create a new property list class
+!!
+!! \param parent Parent property list class identifier. Possible values include:
+!! \li H5P_ROOT_F
+!! \li H5P_FILE_CREATE_F
+!! \li H5P_FILE_ACCESS_F
+!! \li H5P_DATASET_CREATE_F
+!! \li H5P_DATASET_XFER_F
+!! \li H5P_FILE_MOUNT_F
+!! \param name Name of property to create.
+!! \param class Property list class identifier.
+!! \param hdferr \fortran_error
+!! \param create (H5P_cls_create_func_t) - Callback routine called when a property list is created.
+!! \param create_data User pointer to any class creation information needed.
+!! \param copy (H5P_cls_copy_func_t) - Callback routine called when a property list is copied.
+!! \param copy_data User pointer to any class copy information needed.
+!! \param close (H5P_cls_close_func_t) - Callback routine called when a property list is being closed.
+!! \param close_data User pointer to any class close information needed.
+!!
SUBROUTINE h5pcreate_class_f(parent, name, class, hdferr, create, create_data, &
- copy, copy_data, CLOSE, close_data)
+ copy, copy_data, close, close_data)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: parent
CHARACTER(LEN=*), INTENT(IN) :: name
@@ -7025,7 +4614,6 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
INTEGER , INTENT(OUT) :: hdferr
TYPE(C_PTR) , OPTIONAL :: create_data, copy_data, close_data
TYPE(C_FUNPTR) , OPTIONAL :: create, copy, close
-!*****
INTEGER :: name_len
TYPE(C_PTR) :: create_data_default, copy_data_default, close_data_default
TYPE(C_FUNPTR) :: create_default, copy_default, close_default
@@ -7066,36 +4654,22 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pcreate_class_f
-!
-!****s* H5P (F03)/h5pset_file_image_f_F03
-!
-! NAME
-! h5pset_file_image_f
-!
-! PURPOSE
-! Sets an initial file image in a memory buffer.
-!
-! Inputs:
-! fapl_id - File access property list identifier
-! buf_ptr - Pointer to the initial file image,
-! or C_NULL_PTR if no initial file image is desired
-! buf_len - Size of the supplied buffer, or 0 (zero) if no initial image is desired
-!
-! Outputs:
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 19, 2012
-!
-! Fortran2003 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets an initial file image in a memory buffer.
+!!
+!! \param fapl_id File access property list identifier.
+!! \param buf_ptr Pointer to the initial file image, or C_NULL_PTR if no initial file image is desired.
+!! \param buf_len Size of the supplied buffer, or 0 (zero) if no initial image is desired.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_file_image_f(fapl_id, buf_ptr, buf_len, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: fapl_id
TYPE(C_PTR) , INTENT(IN) :: buf_ptr
INTEGER(SIZE_T), INTENT(IN) :: buf_len
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pset_file_image_c(fapl_id, buf_ptr, buf_len) &
BIND(C, NAME='h5pset_file_image_c')
@@ -7110,39 +4684,20 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
hdferr = h5pset_file_image_c(fapl_id, buf_ptr, buf_len)
END SUBROUTINE h5pset_file_image_f
-!
-!****s* H5P (F03)/h5pget_file_image_f_F03
-!
-! NAME
-! h5pget_file_image_f
-!
-! PURPOSE
-! Retrieves a copy of the file image designated as the initial content and structure of a file.
-!
-! Inputs:
-! fapl_id - File access property list identifier.
-!
-! Outputs:
-! buf_ptr - Will hold either a C_NULL_PTR or a scalar of type
-! c_loc. If buf_ptr is not C_NULL_PTR, on successful
-! return, buf_ptr shall contain a C pointer to a copy
-! of the initial image provided in the last call to
-! H5Pset_file_image_f for the supplied fapl_id, or
-! buf_ptr shall contain a C_NULL_PTR if there is no
-! initial image set.
-!
-! buf_len_ptr - Contains the value of the buffer parameter for
-! the initial image in the supplied fapl_id. The value
-! will be 0 if no initial image is set.
-!
-!
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 19, 2012
-!
-! Fortran2003 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves a copy of the file image designated as the initial content and structure of a file.
+!!
+!! \param fapl_id File access property list identifier.
+!! \param buf_ptr Will hold either a C_NULL_PTR or a scalar of type c_loc. If buf_ptr is not C_NULL_PTR, on successful
+!! return, buf_ptr shall contain a C pointer to a copy of the initial image provided in the last call to
+!! H5Pset_file_image_f for the supplied fapl_id, or buf_ptr shall contain a C_NULL_PTR if there is no
+!! initial image set.
+!! \param buf_len_ptr Contains the value of the buffer parameter for the initial image in the supplied fapl_id. The value
+!! will be 0 if no initial image is set.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_file_image_f(fapl_id, buf_ptr, buf_len_ptr, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: fapl_id
@@ -7150,7 +4705,6 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
INTEGER(SIZE_T), INTENT(OUT) :: buf_len_ptr
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pget_file_image_c(fapl_id, buf_ptr, buf_len_ptr) &
BIND(C, NAME='h5pget_file_image_c')
@@ -7171,35 +4725,22 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
! *********************************************************************
#ifdef H5_HAVE_PARALLEL
-!****s* H5P/h5pset_fapl_mpio_f
-!
-! NAME
-! h5pset_fapl_mpio_f
-!
-! PURPOSE
-! Stores MPI IO communicator information to the file
-! access property list.
-!
-! INPUTS
-! prp_id - file access property list identifier
-! comm - MPI-2 communicator
-! info - MPI-2 info object
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails
-! AUTHOR
-! Elena Pourmal
-! November, 2000
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Stores MPI IO communicator information to the file access property list.
+!!
+!! \param prp_id File access property list identifier.
+!! \param comm MPI-2 communicator.
+!! \param info MPI-2 info object.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_fapl_mpio_f(prp_id, comm, info, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: comm ! MPI communicator to be used for file open
- ! as defined in MPI_FILE_OPEN of MPI-2
- INTEGER, INTENT(IN) :: info ! MPI info object to be used for file open
- ! as defined in MPI_FILE_OPEN of MPI-2
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: comm
+ INTEGER, INTENT(IN) :: info
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_fapl_mpio_c(prp_id, comm, info) &
BIND(C,NAME='h5pset_fapl_mpio_c')
@@ -7215,34 +4756,22 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_fapl_mpio_f
-!****s* H5P/h5pget_fapl_mpio_f
-!
-! NAME
-! h5pget_fapl_mpio_f
-!
-! PURPOSE
-! Returns MPI communicator information.
-!
-! INPUTS
-! prp_id - file access property list identifier
-! OUTPUTS
-! comm - MPI-2 communicator
-! info - MPI-2 info object
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! November, 2000
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns MPI communicator information.
+!!
+!! \param prp_id File access property list identifier.
+!! \param comm MPI-2 communicator.
+!! \param info MPI-2 info object.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_fapl_mpio_f(prp_id, comm, info, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: comm ! buffer to return communicator
- INTEGER, INTENT(OUT) :: info ! buffer to return info object
- ! as defined in MPI_FILE_OPEN of MPI-2
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: comm
+ INTEGER, INTENT(OUT) :: info
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_fapl_mpio_c(prp_id, comm, info) &
BIND(C,NAME='h5pget_fapl_mpio_c')
@@ -7258,34 +4787,22 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_fapl_mpio_f
-!****s* H5P/h5pset_dxpl_mpio_f
-!
-! NAME
-! h5pset_dxpl_mpio_f
-!
-! PURPOSE
-! Sets data transfer mode.
-!
-! INPUTS
-! prp_id - data transfer property list identifier
-! data_xfer_mode - transfer mode; possible values are:
-! H5FD_MPIO_INDEPENDENT_F
-! H5FD_MPIO_COLLECTIVE_F
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails
-! AUTHOR
-! Elena Pourmal
-! November, 2000
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets data transfer mode.
+!!
+!! \param prp_id Data transfer property list identifier.
+!! \param data_xfer_mode Transfer mode; possible values are:
+!! \li H5FD_MPIO_INDEPENDENT_F
+!! \li H5FD_MPIO_COLLECTIVE_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_dxpl_mpio_f(prp_id, data_xfer_mode, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(IN) :: data_xfer_mode ! Data transfer mode. Possible values are:
- ! H5FD_MPIO_INDEPENDENT_F
- ! H5FD_MPIO_COLLECTIVE_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(IN) :: data_xfer_mode
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pset_dxpl_mpio_c(prp_id, data_xfer_mode) &
BIND(C,NAME='h5pset_dxpl_mpio_c')
@@ -7299,35 +4816,22 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
hdferr = h5pset_dxpl_mpio_c(prp_id, data_xfer_mode)
END SUBROUTINE h5pset_dxpl_mpio_f
-!****s* H5P/h5pget_dxpl_mpio_f
-!
-! NAME
-! h5pget_dxpl_mpio_f
-!
-! PURPOSE
-! Returns the data transfer mode.
-!
-! INPUTS
-! prp_id - data transfer property list identifier
-! OUTPUTS
-! data_xfer_mode- transfer mode; possible values are:
-! H5FD_MPIO_INDEPENDENT_F
-! H5FD_MPIO_COLLECTIVE_F
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! November, 2000
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns the data transfer mode.
+!!
+!! \param prp_id Data transfer property list identifier.
+!! \param data_xfer_mode Transfer mode; possible values are:
+!! \li H5FD_MPIO_INDEPENDENT_F
+!! \li H5FD_MPIO_COLLECTIVE_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_dxpl_mpio_f(prp_id, data_xfer_mode, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
- INTEGER, INTENT(OUT) :: data_xfer_mode ! Data transfer mode. Possible values are:
- ! H5FD_MPIO_INDEPENDENT_F
- ! H5FD_MPIO_COLLECTIVE_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER(HID_T), INTENT(IN) :: prp_id
+ INTEGER, INTENT(OUT) :: data_xfer_mode
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5pget_dxpl_mpio_c(prp_id, data_xfer_mode) &
BIND(C,NAME='h5pget_dxpl_mpio_c')
@@ -7341,33 +4845,21 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
hdferr = h5pget_dxpl_mpio_c(prp_id, data_xfer_mode)
END SUBROUTINE h5pget_dxpl_mpio_f
-!****s* H5P/h5pget_mpio_actual_io_mode_f
-! NAME
-! h5pget_mpio_actual_io_mode_f
-!
-! PURPOSE
-! Retrieves the type of I/O that HDF5 actually performed on the last
-! parallel I/O call. This is not necessarily the type of I/O requested.
-!
-! INPUTS
-! dxpl_id - Dataset transfer property list identifier.
-! OUTPUTS
-! actual_io_mode - The type of I/O performed by this process.
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! July 27, 2012
-!
-! HISTORY
-!
-! Fortran90 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the type of I/O that HDF5 actually performed on the last
+!! parallel I/O call. This is not necessarily the type of I/O requested.
+!!
+!! \param dxpl_id Dataset transfer property list identifier.
+!! \param actual_io_mode The type of I/O performed by this process.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_mpio_actual_io_mode_f(dxpl_id, actual_io_mode, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dxpl_id
INTEGER , INTENT(OUT) :: actual_io_mode
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pget_mpio_actual_io_mode_c(dxpl_id, actual_io_mode) &
BIND(C,NAME='h5pget_mpio_actual_io_mode_c')
@@ -7384,35 +4876,23 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_mpio_actual_io_mode_f
-!****s* H5P/h5pset_all_coll_metadata_ops_f
-! NAME
-! h5pset_all_coll_metadata_ops_f
-!
-! PURPOSE
-! Sets requirement whether HDF5 metadata read operations using the access property
-! list are required to be collective or independent. If collective requirement is
-! selected, the HDF5 library will optimize the metadata reads improving performance.
-! The default setting is independent (false).
-!
-! INPUTS
-! plist_id - File access property list identifier.
-! is_collective - Indicates if metadata writes are collective or not.
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Feb, 10 2016
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets requirement whether HDF5 metadata read operations using the access property
+!! list are required to be collective or independent. If collective requirement is
+!! selected, the HDF5 library will optimize the metadata reads improving performance.
+!! The default setting is independent (false).
+!!
+!! \param plist_id File access property list identifier.
+!! \param is_collective Indicates if metadata writes are collective or not.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_all_coll_metadata_ops_f(plist_id, is_collective, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: plist_id
LOGICAL, INTENT(IN) :: is_collective
INTEGER, INTENT(OUT) :: hdferr
-!*****
LOGICAL(C_BOOL) :: c_is_collective
INTERFACE
@@ -7431,33 +4911,21 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_all_coll_metadata_ops_f
-!****s* H5P/h5pget_all_coll_metadata_ops_f
-! NAME
-! h5pget_all_coll_metadata_ops_f
-!
-! PURPOSE
-! Retrieves metadata read mode from the access property list.
-!
-! INPUTS
-! plist_id - File access property list identifier.
-! OUTPUTS
-! is_collective - Collective access setting.
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Feb, 10 2016
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves metadata read mode from the access property list.
+!!
+!! \param plist_id File access property list identifier.
+!! \param is_collective Collective access setting.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_all_coll_metadata_ops_f(plist_id, is_collective, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: plist_id
LOGICAL, INTENT(OUT) :: is_collective
INTEGER, INTENT(OUT) :: hdferr
-!*****
LOGICAL(C_BOOL) :: c_is_collective
INTERFACE
@@ -7476,32 +4944,20 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_all_coll_metadata_ops_f
-!****s* H5P/h5pset_coll_metadata_write_f
-! NAME
-! h5pset_coll_metadata_write_f
-!
-! PURPOSE
-! Sets metadata writes to collective or independent. Default setting is independent (false).
-!
-! INPUTS
-! fapl_id - File access property list identifier.
-! is_collective - Indicates if metadata writes are collective or not.
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Feb, 10 2016
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets metadata writes to collective or independent. Default setting is independent (false).
+!!
+!! \param plist_id File access property list identifier.
+!! \param is_collective Indicates if metadata writes are collective or not.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_coll_metadata_write_f(plist_id, is_collective, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: plist_id
LOGICAL, INTENT(IN) :: is_collective
INTEGER, INTENT(OUT) :: hdferr
-!*****
LOGICAL(C_BOOL) :: c_is_collective
INTERFACE
@@ -7520,33 +4976,21 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_coll_metadata_write_f
-!****s* H5P/h5pget_coll_metadata_write_f
-! NAME
-! h5pget_coll_metadata_write_f
-!
-! PURPOSE
-! Retrieves metadata write mode from the file access property list.
-!
-! INPUTS
-! plist_id - File access property list identifier.
-! OUTPUTS
-! is_collective - Collective access setting.
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Feb, 10 2016
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves metadata write mode from the file access property list.
+!!
+!! \param plist_id File access property list identifier.
+!! \param is_collective Collective access setting.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_coll_metadata_write_f(plist_id, is_collective, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: plist_id
LOGICAL, INTENT(OUT) :: is_collective
INTEGER, INTENT(OUT) :: hdferr
-!*****
LOGICAL(C_BOOL) :: c_is_collective
INTERFACE
@@ -7571,30 +5015,17 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
! V I R T U A L D A T S E T S
!
-!****s* H5P/h5pset_virtual_view_f
-! NAME
-! h5pset_virtual_view_f
-!
-! PURPOSE
-! Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.
-!
-! INPUTS
-! dapl_id - Identifier of the virtual dataset access property list.
-! view - Flag specifying the extent of the data to be included in the view.
-! Valid values are:
-! H5D_VDS_FIRST_MISSING_F
-! H5D_VDS_LAST_AVAILABLE_F
-!
-! OUTPUTS
-!
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.
+!!
+!! \param dapl_id Identifier Of the virtual dataset access property list.
+!! \param view Flag specifying the extent of the data to be included in the view. Valid values are:
+!! \li H5D_VDS_FIRST_MISSING_F
+!! \li H5D_VDS_LAST_AVAILABLE_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_virtual_view_f(dapl_id, view, hdferr)
IMPLICIT NONE
@@ -7602,7 +5033,6 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
INTEGER , INTENT(IN) :: view
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pset_virtual_view(dapl_id, view) BIND(C,NAME='H5Pset_virtual_view')
IMPORT :: HID_T, ENUM_T
@@ -7616,35 +5046,23 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_virtual_view_f
-!****s* H5P/h5pget_virtual_view_f
-! NAME
-! h5pget_virtual_view_f
-!
-! PURPOSE
-! Retrieves the view of a virtual dataset accessed with dapl_id.
-!
-! INPUTS
-! dapl_id - Dataset access property list identifier for the virtual dataset
-!
-! OUTPUTS
-! view - The flag specifying the view of the virtual dataset.
-! Valid values are:
-! H5D_VDS_FIRST_MISSING_F
-! H5D_VDS_LAST_AVAILABLE_F
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Retrieves the view of a virtual dataset accessed with dapl_id.
+!!
+!! \param dapl_id Dataset access property list identifier for the virtual dataset.
+!! \param view The flag specifying the view of the virtual dataset. Valid values are:
+!! \li H5D_VDS_FIRST_MISSING_F
+!! \li H5D_VDS_LAST_AVAILABLE_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_virtual_view_f(dapl_id, view, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dapl_id
INTEGER , INTENT(INOUT) :: view
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTEGER(ENUM_T) :: view_enum
INTERFACE
INTEGER FUNCTION h5pget_virtual_view(dapl_id, view) BIND(C,NAME='H5Pget_virtual_view')
@@ -7660,35 +5078,22 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_virtual_view_f
-!****s* H5P/h5pset_virtual_printf_gap_f
-! NAME
-! h5pset_virtual_printf_gap_f
-!
-! PURPOSE
-! Sets the maximum number of missing source files and/or datasets with the printf-style names
-! when getting the extent of an unlimited virtual dataset.
-!
-! INPUTS
-! dapl_id - Dataset access property list identifier for the virtual dataset.
-! gap_size - Maximum number of files and/or datasets allowed to be missing for determining
-! the extent of an unlimited virtual dataset with printf-style mappings.
-!
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the maximum number of missing source files and/or datasets with the printf-style names
+!! when getting the extent of an unlimited virtual dataset.
+!!
+!! \param dapl_id Dataset access property list identifier for the virtual dataset.
+!! \param gap_size Maximum number of files and/or datasets allowed to be missing for determining
+!! the extent of an unlimited virtual dataset with printf-style mappings.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_virtual_printf_gap_f(dapl_id, gap_size, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: dapl_id
INTEGER(HSIZE_T), INTENT(IN) :: gap_size
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pset_virtual_printf_gap(dapl_id, gap_size) BIND(C,NAME='H5Pset_virtual_printf_gap')
IMPORT :: HID_T, HSIZE_T
@@ -7702,36 +5107,23 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_virtual_printf_gap_f
-!****s* H5P/h5pget_virtual_printf_gap_f
-! NAME
-! h5pget_virtual_printf_gap_f
-!
-! PURPOSE
-! Returns the maximum number of missing source files and/or datasets with the
-! printf-style names when getting the extent for an unlimited virtual dataset.
-!
-! INPUTS
-! dapl_id - Dataset access property list identifier for the virtual dataset
-!
-! OUTPUTS
-! gap_size - Maximum number of the files and/or datasets allowed to be missing for
-! determining the extent of an unlimited virtual dataset with printf-style mappings.
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Returns the maximum number of missing source files and/or datasets with the
+!! printf-style names when getting the extent for an unlimited virtual dataset.
+!!
+!! \param dapl_id Dataset access property list identifier for the virtual dataset.
+!! \param gap_size Maximum Number of the files and/or datasets allowed to be missing for
+!! determining the extent of an unlimited virtual dataset with printf-style mappings.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_virtual_printf_gap_f(dapl_id, gap_size, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: dapl_id
INTEGER(HSIZE_T), INTENT(OUT) :: gap_size
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pget_virtual_printf_gap(dapl_id, gap_size) BIND(C,NAME='H5Pget_virtual_printf_gap')
IMPORT :: HID_T, HSIZE_T
@@ -7745,32 +5137,18 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_virtual_printf_gap_f
-!****s* H5P/h5pset_virtual_f
-! NAME
-! h5pset_virtual_f
-!
-! PURPOSE
-! Sets the mapping between virtual and source datasets.
-!
-! INPUTS
-! dcpl_id - The identifier of the dataset creation property list that will be
-! used when creating the virtual dataset.
-! vspace_id - The dataspace identifier with the selection within the virtual
-! dataset applied, possibly an unlimited selection.
-! src_file_name - The name of the HDF5 file where the source dataset is located.
-! src_dset_name - The path to the HDF5 dataset in the file specified by src_file_name.
-! src_space_id - The source dataset’s dataspace identifier with a selection applied, possibly an unlimited selection
-!
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails
-
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the mapping between virtual and source datasets.
+!!
+!! \param dcpl_id The identifier of the dataset creation property list that will be used when creating the virtual dataset.
+!! \param vspace_id The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection.
+!! \param src_file_name The name of the HDF5 file where the source dataset is located.
+!! \param src_dset_name The path to the HDF5 dataset in the file specified by src_file_name.
+!! \param src_space_id The source dataset’s dataspace identifier with a selection applied, possibly an unlimited selection.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_virtual_f(dcpl_id, vspace_id, src_file_name, src_dset_name, src_space_id, hdferr)
IMPLICIT NONE
@@ -7780,7 +5158,6 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
CHARACTER(LEN=*), INTENT(IN) :: src_dset_name
INTEGER(HID_T), INTENT(IN) :: src_space_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
CHARACTER(LEN=LEN_TRIM(src_file_name)+1,KIND=C_CHAR) :: c_src_file_name
CHARACTER(LEN=LEN_TRIM(src_dset_name)+1,KIND=C_CHAR) :: c_src_dset_name
@@ -7805,26 +5182,15 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pset_virtual_f
-!****s* H5P/h5pget_virtual_count_f
-! NAME
-! h5pget_virtual_count_f
-!
-! PURPOSE
-! Gets the number of mappings for the virtual dataset.
-!
-! INPUTS
-! dcpl_id - The identifier of the virtual dataset creation property list.
-!
-! OUTPUTS
-! count - The number of mappings.
-! hdferr - Returns 0 if successful and -1 if fails
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets the number of mappings for the virtual dataset.
+!!
+!! \param dcpl_id The identifier of the virtual dataset creation property list.
+!! \param count The number of mappings.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_virtual_count_f(dcpl_id, count, hdferr)
IMPLICIT NONE
@@ -7832,7 +5198,6 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
INTEGER(HID_T), INTENT(IN) :: dcpl_id
INTEGER(SIZE_T), INTENT(OUT) :: count
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER(C_INT) FUNCTION h5pget_virtual_count(dcpl_id, count) BIND(C,NAME='H5Pget_virtual_count')
IMPORT :: HID_T, SIZE_T, C_INT
@@ -7846,29 +5211,17 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_virtual_count_f
-!****s* H5P/h5pget_virtual_vspace_f
-! NAME
-! h5pget_virtual_vspace_f
-!
-! PURPOSE
-! Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.
-!
-! INPUTS
-! dcpl_id - The identifier of the virtual dataset creation property list.
-! index - Mapping index.
-! The value of index is 0 (zero) or greater and less than count (0 ≤ index < count),
-! where count is the number of mappings returned by h5pget_virtual_count.
-!
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.
+!!
+!! \param dcpl_id The identifier of the virtual dataset creation property list.
+!! \param index Mapping index. The value of index is 0 (zero) or greater and less than count (0 ≤ index < count),
+!! where count is the number of mappings returned by h5pget_virtual_count.
+!! \param ds_id Valid dataspace identifier identifier if successful; otherwise returns H5I_INVALID_HID_F.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_virtual_vspace_f(dcpl_id, index, ds_id, hdferr)
IMPLICIT NONE
@@ -7877,7 +5230,6 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
INTEGER(HID_T) , INTENT(OUT) :: ds_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER(HID_T) FUNCTION h5pget_virtual_vspace(dcpl_id, index) BIND(C,NAME='H5Pget_virtual_vspace')
IMPORT :: HID_T, SIZE_T
@@ -7894,31 +5246,17 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
END SUBROUTINE h5pget_virtual_vspace_f
-!****s* H5P/h5pget_virtual_srcspace_f
-! NAME
-! h5pget_virtual_srcspace_f
-!
-! PURPOSE
-! Gets a dataspace identifier for the selection within the source dataset used in the mapping.
-!
-! INPUTS
-! dcpl_id - The identifier of the virtual dataset creation property list.
-! index - Mapping index.
-! The value of index is 0 (zero) or greater and less than count (0 ≤ index < count),
-! where count is the number of mappings returned by h5pget_virtual_count.
-!
-!
-! OUTPUTS
-! ds_id - dataspace identifier
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets a dataspace identifier for the selection within the source dataset used in the mapping.
+!!
+!! \param dcpl_id The Identifier of the virtual dataset creation property list.
+!! \param index Mapping index.The value of index is 0 (zero) or greater and less than count (0 ≤ index < count),
+!! where count is the number of mappings returned by h5pget_virtual_count.
+!! \param ds_id Dataspace identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_virtual_srcspace_f(dcpl_id, index, ds_id, hdferr)
IMPLICIT NONE
@@ -7927,7 +5265,6 @@ SUBROUTINE h5pget_virtual_srcspace_f(dcpl_id, index, ds_id, hdferr)
INTEGER(HID_T) , INTENT(OUT) :: ds_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER(HID_T) FUNCTION h5pget_virtual_srcspace(dcpl_id, index) BIND(C,NAME='H5Pget_virtual_srcspace')
IMPORT :: HID_T, SIZE_T
@@ -7944,33 +5281,19 @@ SUBROUTINE h5pget_virtual_srcspace_f(dcpl_id, index, ds_id, hdferr)
END SUBROUTINE h5pget_virtual_srcspace_f
-!****s* H5P/h5pget_virtual_filename_f
-! NAME
-! h5pget_virtual_filename_f
-!
-! PURPOSE
-! Gets the filename of a source dataset used in the mapping.
-!
-! INPUTS
-! dcpl_id - The identifier of the virtual dataset creation property list.
-! index - Mapping index.
-! The value of index is 0 (zero) or greater and less than count (0 ≤ index < count),
-! where count is the number of mappings returned by h5pget_virtual_count.
-!
-! OUTPUTS
-! name - A buffer containing the name of the file containing the source dataset.
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! Optional parameters:
-! name_len - The size of name needed to hold the filename. (OUT)
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! Nov 2, 2015
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets the filename of a source dataset used in the mapping.
+!!
+!! \param dcpl_id The identifier of the virtual dataset creation property list.
+!! \param index Mapping index. The value of index is 0 (zero) or greater and less than count (0 ≤ index < count),
+!! where count is the number of mappings returned by h5pget_virtual_count.
+!! \param name A buffer containing the name of the file containing the source dataset.
+!! \param hdferr \fortran_error
+!! \param name_len The size of name needed to hold the filename. (OUT)
+!!
+!!
SUBROUTINE h5pget_virtual_filename_f(dcpl_id, index, name, hdferr, name_len)
IMPLICIT NONE
@@ -7979,7 +5302,6 @@ SUBROUTINE h5pget_virtual_filename_f(dcpl_id, index, name, hdferr, name_len)
CHARACTER(LEN=*), INTENT(OUT) :: name
INTEGER, INTENT(OUT) :: hdferr
INTEGER(SIZE_T), OPTIONAL :: name_len
-!*****
CHARACTER(LEN=1,KIND=C_CHAR), DIMENSION(1:LEN(name)+1), TARGET :: c_name
TYPE(C_PTR) :: f_ptr
@@ -8012,33 +5334,18 @@ SUBROUTINE h5pget_virtual_filename_f(dcpl_id, index, name, hdferr, name_len)
END SUBROUTINE h5pget_virtual_filename_f
-!****s* H5P/h5pget_virtual_dsetname_f
-! NAME
-! h5pget_virtual_dsetname_f
-!
-! PURPOSE
-! Gets the name of a source dataset used in the mapping.
-!
-! INPUTS
-! dcpl_id - The identifier of the virtual dataset creation property list.
-! index - Mapping index.
-! The value of index is 0 (zero) or greater and less than count (0 ≤ index < count),
-! where count is the number of mappings returned by h5pget_virtual_count.
-!
-! OUTPUTS
-! name - A buffer containing the name of the source dataset.
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! Optional parameters:
-! name_len - The size of name needed to hold the source dataset name. (OUT)
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! January 28, 2016
-!
-! HISTORY
-!
-! SOURCE
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets the name of a source dataset used in the mapping.
+!!
+!! \param dcpl_id The identifier of the virtual dataset creation property list.
+!! \param index Mapping index. The value of index is 0 (zero) or greater and less than count (0 ≤ index < count),
+!! where count is the number of mappings returned by h5pget_virtual_count.
+!! \param name A buffer containing the name of the source dataset.
+!! \param hdferr \fortran_error
+!! \param name_len The size of name needed to hold the source dataset name.
+!!
SUBROUTINE h5pget_virtual_dsetname_f(dcpl_id, index, name, hdferr, name_len)
IMPLICIT NONE
@@ -8047,7 +5354,6 @@ SUBROUTINE h5pget_virtual_dsetname_f(dcpl_id, index, name, hdferr, name_len)
CHARACTER(LEN=*), INTENT(OUT) :: name
INTEGER, INTENT(OUT) :: hdferr
INTEGER(SIZE_T), OPTIONAL :: name_len
-!*****
CHARACTER(LEN=1,KIND=C_CHAR), DIMENSION(1:LEN(name)+1), TARGET :: c_name
TYPE(C_PTR) :: f_ptr
@@ -8079,34 +5385,21 @@ SUBROUTINE h5pget_virtual_dsetname_f(dcpl_id, index, name, hdferr, name_len)
END SUBROUTINE h5pget_virtual_dsetname_f
-!****s* H5P (F03)/h5pget_dset_no_attrs_hint_f_F03
-!
-! NAME
-! h5pget_dset_no_attrs_hint_f
-!
-! PURPOSE
-! Gets the value of the "minimize dataset headers" value which creates
-! smaller dataset object headers when its set and no attributes are present.
-!
-! INPUTS
-! dcpl_id - Target dataset creation property list identifier.
-!
-! OUTPUTS
-! minimize - Value of the setting.
-! hdferr - error code:
-! 0 on success and -1 on failure
-!
-! AUTHOR
-! Dana Robinson
-! January 2019
-!
-! Fortran2003 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets the value of the "minimize dataset headers" value which creates
+!! smaller dataset object headers when its set and no attributes are present.
+!!
+!! \param dcpl_id Target dataset creation property list identifier.
+!! \param minimize Value of the setting.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_dset_no_attrs_hint_f(dcpl_id, minimize, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: dcpl_id
LOGICAL , INTENT(OUT) :: minimize
INTEGER , INTENT(OUT) :: hdferr
-!*****
LOGICAL(C_BOOL) :: c_minimize
INTERFACE
@@ -8125,34 +5418,21 @@ END SUBROUTINE h5pget_virtual_dsetname_f
END SUBROUTINE h5pget_dset_no_attrs_hint_f
-!****s* H5P (F03)/h5pset_dset_no_attrs_hint_f_F03
-!
-! NAME
-! h5pset_dset_no_attrs_hint_f
-!
-! PURPOSE
-! Sets the value of the "minimize dataset headers" value which creates
-! smaller dataset object headers when its set and no attributes are present.
-!
-! INPUTS
-! dcpl_id - Target dataset creation property list identifier.
-! minimize - Value of the setting.
-!
-! OUTPUTS
-! hdferr - error code:
-! 0 on success and -1 on failure
-!
-! AUTHOR
-! Dana Robinson
-! January 2019
-!
-! Fortran2003 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the value of the "minimize dataset headers" value which creates
+!! smaller dataset object headers when its set and no attributes are present.
+!!
+!! \param dcpl_id Target dataset creation property list identifier.
+!! \param minimize Value of the setting.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_dset_no_attrs_hint_f(dcpl_id, minimize, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: dcpl_id
LOGICAL , INTENT(IN) :: minimize
INTEGER , INTENT(OUT) :: hdferr
-!*****
LOGICAL(C_BOOL) :: c_minimize
INTERFACE
@@ -8171,37 +5451,22 @@ END SUBROUTINE h5pget_virtual_dsetname_f
END SUBROUTINE h5pset_dset_no_attrs_hint_f
-!****s* H5P/H5Pset_vol_f
-!
-! NAME
-! H5Pset_vol_f
-!
-! PURPOSE
-! Set the file VOL connector (VOL_ID) for a file access
-! property list (PLIST_ID)
-! INPUTS
-! plist_id - access property list identifier.
-! new_vol_id - VOL connector id.
-!
-! OUTPUTS
-! hdferr - error code:
-! 0 on success and -1 on failure
-!
-! OPTIONAL
-! new_vol_info - VOL connector info.
-!
-! AUTHOR
-! M.S. Breitenfeld
-! May 2019
-!
-! Fortran Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Set the file VOL connector (VOL_ID) for a file access property list (PLIST_ID)
+!!
+!! \param plist_id Access property list identifier.
+!! \param new_vol_id VOL connector id.
+!! \param hdferr \fortran_error
+!! \param new_vol_info VOL connector info.
+!!
SUBROUTINE h5pset_vol_f(plist_id, new_vol_id, hdferr, new_vol_info)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: plist_id
INTEGER(HID_T) , INTENT(IN) :: new_vol_id
INTEGER , INTENT(OUT) :: hdferr
TYPE(C_PTR) , OPTIONAL :: new_vol_info
-!*****
TYPE(C_PTR) :: new_vol_info_default
@@ -8222,33 +5487,20 @@ END SUBROUTINE h5pget_virtual_dsetname_f
END SUBROUTINE h5pset_vol_f
-!****s* H5P/H5Pget_vol_id_f
+!>
+!! \ingroup FH5P
+!!
+!! \brief Get the file VOL connector (VOL_ID) for a file access property list (PLIST_ID)
!
-! NAME
-! H5Pget_vol_id_f
-!
-! PURPOSE
-! Get the file VOL connector (VOL_ID) for a file access
-! property list (PLIST_ID)
-! INPUTS
-! plist_id - access property list identifier.
-!
-! OUTPUTS
-! vol_id - VOL connector id.
-! hdferr - error code:
-! 0 on success and -1 on failure
-!
-! AUTHOR
-! M.S. Breitenfeld
-! May 2019
-!
-! Fortran Interface:
+!! \param plist_id Access property list identifier.
+!! \param vol_id VOL connector id.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_vol_id_f(plist_id, vol_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: plist_id
INTEGER(HID_T) , INTENT(OUT) :: vol_id
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5pget_vol_id(plist_id, vol_id) BIND(C, NAME='H5Pget_vol_id')
@@ -8263,37 +5515,22 @@ END SUBROUTINE h5pget_virtual_dsetname_f
END SUBROUTINE h5pget_vol_id_f
-!****s* H5P (F03)/h5pget_file_locking_f_F03
-!
-! NAME
-! h5pget_file_locking_f
-!
-! PURPOSE
-! Gets the file locking properties. File locking is mainly used to help
-! enforce SWMR semantics.
-!
-! INPUTS
-! fapl_id - Target file access property list identifier.
-!
-! OUTPUTS
-! use_file_locking - Whether or not to use file locks.
-! ignore_disabled_locks - Whether or not to ignore file locks when locking
-! is disabled on a file system.
-! hdferr - error code:
-! 0 on success and -1 on failure
-!
-! AUTHOR
-! Dana Robinson
-! Summer 2020
-!
-! Fortran2003 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Gets the file locking properties. File locking is mainly used to help enforce SWMR semantics.
+!!
+!! \param fapl_id Target fileTarget file access property list identifier.
+!! \param use_file_locking Whether or not to use file locks.
+!! \param ignore_disabled_locks Whether or not to ignore file locks when locking is disabled on a file system.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pget_file_locking_f(fapl_id, use_file_locking, ignore_disabled_locks, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: fapl_id
LOGICAL , INTENT(OUT) :: use_file_locking
LOGICAL , INTENT(OUT) :: ignore_disabled_locks
INTEGER , INTENT(OUT) :: hdferr
-!*****
LOGICAL(C_BOOL) :: c_use_flag
LOGICAL(C_BOOL) :: c_ignore_flag
@@ -8315,35 +5552,22 @@ END SUBROUTINE h5pget_virtual_dsetname_f
END SUBROUTINE h5pget_file_locking_f
-!****s* H5P (F03)/h5pset_file_locking_f_F03
-!
-! NAME
-! h5pset_file_locking_f
-!
-! PURPOSE
-! Sets the file locking properties. File locking is mainly used to help
-! enforce SWMR semantics.
-!
-! INPUTS
-! fapl_id - Target file access property list identifier.
-! use_file_locking - Whether or not to use file locks.
-! ignore_disabled_locks - Whether or not to ignore file locks when locking
-! is disabled on a file system.
-! hdferr - error code:
-! 0 on success and -1 on failure
-!
-! AUTHOR
-! Dana Robinson
-! Summer 2020
-!
-! Fortran2003 Interface:
+!>
+!! \ingroup FH5P
+!!
+!! \brief Sets the file locking properties. File locking is mainly used to help enforce SWMR semantics.
+!!
+!! \param fapl_id Target file access property list identifier.
+!! \param use_file_locking Whether or not to use file locks.
+!! \param ignore_disabled_locks Whether or not to ignore file locks when locking is disabled on a file system.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5pset_file_locking_f(fapl_id, use_file_locking, ignore_disabled_locks, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: fapl_id
LOGICAL , INTENT(IN) :: use_file_locking
LOGICAL , INTENT(IN) :: ignore_disabled_locks
INTEGER , INTENT(OUT) :: hdferr
-!*****
LOGICAL(C_BOOL) :: c_use_flag
LOGICAL(C_BOOL) :: c_ignore_flag