summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Tff.F90
diff options
context:
space:
mode:
Diffstat (limited to 'fortran/src/H5Tff.F90')
-rw-r--r--fortran/src/H5Tff.F902600
1 files changed, 802 insertions, 1798 deletions
diff --git a/fortran/src/H5Tff.F90 b/fortran/src/H5Tff.F90
index 0a11976..d32b160 100644
--- a/fortran/src/H5Tff.F90
+++ b/fortran/src/H5Tff.F90
@@ -1,10 +1,13 @@
-!****h* ROBODoc/H5T
-!
-! NAME
-! MODULE H5T
-!
-! PURPOSE
-! This file contains Fortran interfaces for H5T functions.
+!> @defgroup FH5T Fortran Datatype (H5T) Interface
+!!
+!! @see H5T, C-API
+!!
+!! @see @ref H5T_UG, User Guide
+!!
+
+!> @ingroup FH5T
+!!
+!! @brief This module contains Fortran interfaces for H5T functions.
!
! COPYRIGHT
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
@@ -33,7 +36,6 @@
! Windows dll file 'hdf5_fortrandll.def.in' in the fortran/src directory.
! This is needed for Windows based operating systems.
!
-!*****
MODULE H5T
@@ -43,53 +45,34 @@ MODULE H5T
PRIVATE h5tenum_insert_f03, h5tenum_insert_f90
-!****t* H5T/hvl_t
! Fortran2003 Derived Type:
TYPE hvl_t
- INTEGER(size_t) :: len ! Length of VL data (in base type units)
- TYPE(C_PTR) :: p ! Pointer to VL data
+ INTEGER(size_t) :: len !< Length of VL data (in base type units)
+ TYPE(C_PTR) :: p !< Pointer to VL data
END TYPE hvl_t
-!*****
+#ifndef H5_DOXYGEN_FORTRAN
INTERFACE h5tenum_insert_f
MODULE PROCEDURE h5tenum_insert_f03
MODULE PROCEDURE h5tenum_insert_f90
END INTERFACE
+#endif
+
CONTAINS
-!
-!****s* H5T/h5topen_f
-!
-! NAME
-! h5topen_f
-!
-! PURPOSE
-! Opens named datatype.
-!
-! INPUTS
-! loc_id - location identifier
-! name - a datatype name
-! OUTPUTS
-! type_id - datatype identifier
-! hdferr - Returns 0 if successful and -1 if fails
-! OPTIONAL PARAMETERS
-! tapl_id - datatype access property list identifier.
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 7, 2001
-!
-! Added optional parameter 'tapl_id' for compatibility
-! with H5Topen2. April 9, 2009.
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Opens named datatype.
+!!
+!! \param loc_id Location identifier.
+!! \param name A datatype name.
+!! \param type_id Datatype identifier.
+!! \param hdferr \fortran_error
+!! \param tapl_id Datatype access property list identifier.
+!!
SUBROUTINE h5topen_f(loc_id, name, type_id, hdferr, tapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
@@ -97,7 +80,6 @@ CONTAINS
INTEGER(HID_T), INTENT(OUT) :: type_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id
-!*****
INTEGER :: namelen ! Name length
INTEGER(HID_T) :: tapl_id_default
@@ -121,53 +103,29 @@ CONTAINS
hdferr = h5topen_c(loc_id, name, namelen, type_id, tapl_id_default)
END SUBROUTINE h5topen_f
-!
-!****s* H5T/h5tcommit_f
-!
-! NAME
-! h5tcommit_f
-!
-! PURPOSE
-! Commits a transient datatype to a file, creating a
-! new named datatype.
-!
-! INPUTS
-! loc_id - location identifier
-! name - name of the datatype to be stored
-! at the specified location
-! type_id - identifier of a datatype to be stored
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails
-! OPTIONAL PARAMETERS
-! lcpl_id - Link creation property list
-! tcpl_id - Datatype creation property list
-! tapl_id - Datatype access property list
-!
-! AUTHOR
-! Elena Pourmal
-! August 12, 1999
-!
-! HISTORY
-! - Explicit Fortran interfaces were added for
-! called C functions (it is needed for Windows
-! port). March 7, 2001
-!
-! - Added optional parameters introduced in version 1.8
-! M. Scot Breitenfeld
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Commits a transient datatype to a file, creating a new named datatype.
+!!
+!! \param loc_id Location identifier.
+!! \param name Name of the datatype to be stored at the specified location.
+!! \param type_id Identifier of a datatype to be stored.
+!! \param hdferr \fortran_error
+!! \param lcpl_id Link creation property list.
+!! \param tcpl_id Datatype creation property list.
+!! \param tapl_id Datatype access property list.
+!!
SUBROUTINE h5tcommit_f(loc_id, name, type_id, hdferr, &
lcpl_id, tcpl_id, tapl_id )
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
+ INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
- ! Datatype name within file or group
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
- INTEGER, INTENT(OUT) :: hdferr ! Error code
- INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list
- INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tcpl_id ! Datatype creation property list
- INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id ! Datatype access property list
-!*****
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ INTEGER, INTENT(OUT) :: hdferr
+ INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id
+ INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tcpl_id
+ INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id
INTEGER :: namelen ! Name length
@@ -205,36 +163,20 @@ CONTAINS
lcpl_id_default, tcpl_id_default, tapl_id_default )
END SUBROUTINE h5tcommit_f
-!
-!****s* H5T/h5tcopy_f
-!
-! NAME
-! h5tcopy_f
-!
-! PURPOSE
-! Creates a copy of existing datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! new_type_id - identifier of datatype's copy
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Creates a copy of existing datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param new_type_id Identifier of datatype&apos;s copy.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tcopy_f(type_id, new_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: new_type_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tcopy_c(type_id, new_type_id) BIND(C,NAME='h5tcopy_c')
IMPORT :: HID_T
@@ -245,39 +187,22 @@ CONTAINS
hdferr = h5tcopy_c(type_id, new_type_id)
END SUBROUTINE h5tcopy_f
-!
-!****s* H5T/h5tequal_f
-!
-! NAME
-! h5tequal_f
-!
-! PURPOSE
-! Determines whether two datatype identifiers refer
-! to the same datatype.
-!
-! INPUTS
-! type1_id - datatype identifier
-! type2_id - datatype identifier
-! OUTPUTS
-! flag - TRUE/FALSE flag to indicate
-! if two datatypes are equal
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Determines whether two datatype identifiers refer to the same datatype.
+!!
+!! \param type1_id Datatype identifier.
+!! \param type2_id Datatype identifier.
+!! \param flag TRUE/FALSE flag to indicate if two datatypes are equal.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tequal_f(type1_id, type2_id, flag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type1_id
INTEGER(HID_T), INTENT(IN) :: type2_id
LOGICAL, INTENT(OUT) :: flag
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: c_flag
INTERFACE
INTEGER FUNCTION h5tequal_c(type1_id, type2_id, c_flag) BIND(C,NAME='h5tequal_c')
@@ -293,35 +218,18 @@ CONTAINS
hdferr = h5tequal_c(type1_id, type2_id, c_flag)
IF(c_flag .GT. 0) flag = .TRUE.
END SUBROUTINE h5tequal_f
-!
-!****s* H5T/h5tclose_f
-!
-! NAME
-! h5tclose_f
-!
-! PURPOSE
-! Releases a datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Releases a datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tclose_f(type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tclose_c(type_id) BIND(C,NAME='h5tclose_c')
IMPORT :: HID_T
@@ -332,49 +240,32 @@ CONTAINS
hdferr = h5tclose_c(type_id)
END SUBROUTINE h5tclose_f
-!
-!****s* H5T/h5tget_class_f
-!
-! NAME
-! h5tget_class_f
-!
-! PURPOSE
-! Returns the datatype class identifier.
-!
-! INPUTS
-! type_id - Datatype identifier
-! OUTPUTS
-! class - Class, possible values are:
-! H5T_NO_CLASS_F (-1)
-! H5T_INTEGER_F (0)
-! H5T_FLOAT_F (1)
-! H5T_TIME_F (2)
-! H5T_STRING_F (3)
-! H5T_BITFIELD_F (4)
-! H5T_OPAQUE_F (5)
-! H5T_COMPOUND_F (6)
-! H5T_REFERENCE_F (7)
-! H5T_ENUM_F (8)
-! H5T_VLEN_F (9)
-! H5T_ARRAY_F (10)
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the datatype class identifier.
+!!
+!! \param type_id Datatype identifier.
+!! \param class Class, possible values are:
+!! \li H5T_NO_CLASS_F
+!! \li H5T_INTEGER_F
+!! \li H5T_FLOAT_F
+!! \li H5T_TIME_F
+!! \li H5T_STRING_F
+!! \li H5T_BITFIELD_F
+!! \li H5T_OPAQUE_F
+!! \li H5T_COMPOUND_F
+!! \li H5T_REFERENCE_F
+!! \li H5T_ENUM_F
+!! \li H5T_VLEN_F
+!! \li H5T_ARRAY_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_class_f(type_id, class, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: class
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_class_c(type_id, class) BIND(C,NAME='h5tget_class_c')
IMPORT :: HID_T
@@ -386,37 +277,20 @@ CONTAINS
hdferr = h5tget_class_c(type_id, class)
END SUBROUTINE h5tget_class_f
-!
-!****s* H5T/h5tget_size_f
-!
-! NAME
-! h5tget_size_f
-!
-! PURPOSE
-! Returns the size of a datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! size - datatype size
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the size of a datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param size Datatype size.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_size_f(type_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
- INTEGER(SIZE_T), INTENT(OUT) :: size ! Datatype size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ INTEGER(SIZE_T), INTENT(OUT) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_size_c(type_id, size) BIND(C,NAME='h5tget_size_c')
IMPORT :: HID_T, SIZE_T
@@ -429,38 +303,20 @@ CONTAINS
hdferr = h5tget_size_c(type_id, size)
END SUBROUTINE h5tget_size_f
-!
-!****s* H5T/h5tset_size_f
-!
-! NAME
-! h5tset_size_f
-!
-! PURPOSE
-! Sets the total size for an atomic datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! size - size of the datatype
-! 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 7, 2001
-!
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets the total size for an atomic datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param size Size of the datatype.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_size_f(type_id, size, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
- INTEGER(SIZE_T), INTENT(IN) :: size ! Datatype size
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ INTEGER(SIZE_T), INTENT(IN) :: size
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_size_c(type_id, size) BIND(C,NAME='h5tset_size_c')
IMPORT :: HID_T, SIZE_T
@@ -473,44 +329,24 @@ CONTAINS
hdferr = h5tset_size_c(type_id, size)
END SUBROUTINE h5tset_size_f
-!
-!****s* H5T/h5tget_order_f
-!
-! NAME
-! h5tget_order_f
-!
-! PURPOSE
-! Returns the byte order of an atomic datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! order - byte order for the datatype, possible
-! values are:
-! H5T_ORDER_LE_F
-! H5T_ORDER_BE_F
-! H5T_ORDER_VAX_F (not implemented yet)
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the byte order of an atomic datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param order Byte order for the datatype, possible values are:
+!! \li H5T_ORDER_LE_F
+!! \li H5T_ORDER_BE_F
+!! \li H5T_ORDER_VAX_F (not implemented yet)
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_order_f(type_id, order, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
+ INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: order
- ! Datatype byte order, possible values are:
- ! H5T_ORDER_LE_F
- ! H5T_ORDER_BE_F
! H5T_ORDER_VAX_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_order_c(type_id, order) BIND(C,NAME='h5tget_order_c')
IMPORT :: HID_T
@@ -522,43 +358,24 @@ CONTAINS
hdferr = h5tget_order_c(type_id, order)
END SUBROUTINE h5tget_order_f
-!
-!****s* H5T/h5tset_order_f
-!
-! NAME
-! h5tset_order_f
-!
-! PURPOSE
-! Sets the byte ordering of an atomic datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! order - datatype byte order Possible values are:
-! H5T_ORDER_LE_F
-! H5T_ORDER_BE_F
-! H5T_ORDER_VAX_F (not implemented yet)
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets the byte ordering of an atomic datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param order Datatype byte order Possible values are:
+!! \li H5T_ORDER_LE_F
+!! \li H5T_ORDER_BE_F
+!! \li H5T_ORDER_VAX_F (not implemented yet)
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_order_f(type_id, order, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
- INTEGER, INTENT(IN) :: order ! Datatype byte order, possible values
- ! are:
- ! H5T_ORDER_LE_F
- ! H5T_ORDER_BE_F
+ INTEGER(HID_T), INTENT(IN) :: type_id
+ INTEGER, INTENT(IN) :: order
! H5T_ORDER_VAX_F
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_order_c(type_id, order) BIND(C,NAME='h5tset_order_c')
IMPORT :: HID_T
@@ -571,37 +388,20 @@ CONTAINS
hdferr = h5tset_order_c(type_id, order)
END SUBROUTINE h5tset_order_f
-!
-!****s* H5T/h5tget_precision_f
-!
-! NAME
-! h5tget_precision_f
-!
-! PURPOSE
-! Returns the precision of an atomic datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! precision - precision of the datatype
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the precision of an atomic datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param precision Precision of the datatype.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_precision_f(type_id, PRECISION, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: precision
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_precision_c(type_id, PRECISION) BIND(C,NAME='h5tget_precision_c')
IMPORT :: HID_T, SIZE_T
@@ -614,37 +414,20 @@ CONTAINS
hdferr = h5tget_precision_c(type_id, PRECISION)
END SUBROUTINE h5tget_precision_f
-!
-!****s* H5T/h5tset_precision_f
-!
-! NAME
-! h5tset_precision_f
-!
-! PURPOSE
-! Sets the precision of an atomic datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! precision - datatype precision
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets the precision of an atomic datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param precision Datatype precision.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_precision_f(type_id, PRECISION, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: PRECISION
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_precision_c (type_id, PRECISION) BIND(C,NAME='h5tset_precision_c')
IMPORT :: HID_T, SIZE_T
@@ -657,36 +440,20 @@ CONTAINS
hdferr = h5tset_precision_c(type_id, PRECISION)
END SUBROUTINE h5tset_precision_f
-!
-!****s* H5T/h5tget_offset_f
-!
-! NAME
-! h5tget_offset_f
-!
-! PURPOSE
-! Retrieves the bit offset of the first significant bit.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! offset - offset value
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the bit offset of the first significant bit.
+!!
+!! \param type_id Datatype identifier.
+!! \param offset Offset value.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_offset_f(type_id, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: offset
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_offset_c(type_id, offset) BIND(C,NAME='h5tget_offset_c')
IMPORT :: HID_T, SIZE_T
@@ -699,36 +466,20 @@ CONTAINS
hdferr = h5tget_offset_c(type_id, offset)
END SUBROUTINE h5tget_offset_f
-!
-!****s* H5T/h5tset_offset_f
-!
-! NAME
-! h5tset_offset_f
-!
-! PURPOSE
-! Sets the bit offset of the first significant bit.
-!
-! INPUTS
-! type_id - datatype identifier
-! offset - offset value
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets the bit offset of the first significant bit.
+!!
+!! \param type_id Datatype identifier.
+!! \param offset Offset value.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_offset_f(type_id, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: offset
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_offset_c(type_id, offset) BIND(C,NAME='h5tset_offset_c')
IMPORT :: HID_T, SIZE_T
@@ -741,46 +492,27 @@ CONTAINS
hdferr = h5tset_offset_c(type_id, offset)
END SUBROUTINE h5tset_offset_f
-!
-!****s* H5T/h5tget_pad_f
-!
-! NAME
-! h5tget_pad_f
-!
-! PURPOSE
-! Retrieves the padding type of the least and
-! most -significant bit padding.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! lsbpad - least-significant bit padding type
-! msbpad - most-significant bit padding type
-! Possible values of padding type are:
-! H5T_PAD_ERROR_F
-! H5T_PAD_ZERO_F
-! H5T_PAD_ONE_F
-! H5T_PAD_BACKGROUND_F
-! H5T_PAD_NPAD_F
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the padding type of the least and most-significant bit padding.
+!!
+!! \param type_id Datatype identifier.
+!! \param lsbpad Least-significant bit padding type.
+!! \param msbpad Most-significant bit padding type. Possible values are:
+!! \li H5T_PAD_ERROR_F
+!! \li H5T_PAD_ZERO_F
+!! \li H5T_PAD_ONE_F
+!! \li H5T_PAD_BACKGROUND_F
+!! \li H5T_PAD_NPAD_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_pad_f(type_id, lsbpad, msbpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: lsbpad
INTEGER, INTENT(OUT) :: msbpad
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_pad_c(type_id, lsbpad, msbpad) BIND(C,NAME='h5tget_pad_c')
IMPORT :: HID_T
@@ -794,44 +526,27 @@ CONTAINS
hdferr = h5tget_pad_c(type_id, lsbpad, msbpad)
END SUBROUTINE h5tget_pad_f
-!
-!****s* H5T/h5tset_pad_f
-!
-! NAME
-! h5tset_pad_f
-!
-! PURPOSE
-! Sets the least and most-significant bits padding types.
-!
-! INPUTS
-! type_id - datatype identifier
-! lsbpad - least-significant bit padding type
-! msbpad - most-significant bit padding type
-! Possible values of padding type are:
-! H5T_PAD_ERROR_F = -1
-! H5T_PAD_ZERO_F = 0
-! H5T_PAD_ONE_F = 1
-! H5T_PAD_BACKGROUND_F = 2
-! H5T_PAD_NPAD_F = 3
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets the least and most-significant bits padding types.
+!!
+!! \param type_id Datatype identifier.
+!! \param lsbpad Least-significant bit padding type.
+!! \param msbpad Most-significant bit padding type. Possible values are:
+!! \li H5T_PAD_ERROR_F
+!! \li H5T_PAD_ZERO_F
+!! \li H5T_PAD_ONE_F
+!! \li H5T_PAD_BACKGROUND_F
+!! \li H5T_PAD_NPAD_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_pad_f(type_id, lsbpad, msbpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: lsbpad
INTEGER, INTENT(IN) :: msbpad
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_pad_c(type_id, lsbpad, msbpad) BIND(C,NAME='h5tset_pad_c')
IMPORT :: HID_T
@@ -845,42 +560,26 @@ CONTAINS
hdferr = h5tset_pad_c(type_id, lsbpad, msbpad)
END SUBROUTINE h5tset_pad_f
-!
-!****s* H5T/h5tget_sign_f
-!
-! NAME
-! h5tget_sign_f
-!
-! PURPOSE
-! Retrieves the sign type for an integer type.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! sign - sign type
-! Possible values are:
-! - Unsigned integer type
-! H5T_SGN_NONE_F = 0
-! - Two's complement signed integer type
-! H5T_SGN_2_F = 1
-! - error value: H5T_SGN_ERROR_F=-1
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the sign type for an integer type.
+!!
+!! \param type_id Datatype identifier.
+!! \param sign Sign type. Possible values are:
+!! \li Unsigned integer type
+!! H5T_SGN_NONE_F = 0
+!! \li Two&apos;s complement signed integer type
+!! H5T_SGN_2_F = 1
+!! \li Error value
+!! H5T_SGN_ERROR_F = -1
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_sign_f(type_id, sign, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: sign
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_sign_c(type_id, sign) BIND(C,NAME='h5tget_sign_c')
@@ -894,42 +593,26 @@ CONTAINS
hdferr = h5tget_sign_c(type_id, sign)
END SUBROUTINE h5tget_sign_f
-!
-!****s* H5T/h5tset_sign_f
-!
-! NAME
-! h5tset_sign_f
-!
-! PURPOSE
-! Sets the sign property for an integer type.
-!
-! INPUTS
-! type_id - datatype identifier
-! sign - sign type
-! Possible values are:
-! - Unsigned integer type
-! H5T_SGN_NONE_F = 0
-! - Two's complement signed integer type
-! H5T_SGN_2_F = 1
-! - error value: H5T_SGN_ERROR_F=-1
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets the sign property for an integer type.
+!!
+!! \param type_id Datatype identifier.
+!! \param sign Sign type. Possible values are:
+!! \li Unsigned integer type
+!! H5T_SGN_NONE_F = 0
+!! \li Two&apos;s complement signed integer type
+!! H5T_SGN_2_F = 1
+!! \li Error value
+!! H5T_SGN_ERROR_F = -1
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_sign_f(type_id, sign, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: sign
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_sign_c(type_id, sign) BIND(C,NAME='h5tset_sign_c')
IMPORT :: HID_T
@@ -942,34 +625,19 @@ CONTAINS
hdferr = h5tset_sign_c(type_id, sign)
END SUBROUTINE h5tset_sign_f
-!
-!****s* H5T/h5tget_fields_f
-!
-! NAME
-! h5tget_fields_f
-!
-! PURPOSE
-! Retrieves floating point datatype bit field information.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! spos - sign bit-position
-! epos - exponent bit-position
-! esize - size of exponent in bits
-! mpos - mantissa position
-! msize - size of mantissa in bits
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves floating point datatype bit field information.
+!!
+!! \param type_id Datatype identifier.
+!! \param spos Sign bit-position.
+!! \param epos Exponent bit-position.
+!! \param esize Size of exponent in bits.
+!! \param mpos Mantissa position.
+!! \param msize Size of mantissa in bits.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_fields_f(type_id, spos, epos, esize, mpos, msize, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
@@ -979,7 +647,6 @@ CONTAINS
INTEGER(SIZE_T), INTENT(OUT) :: mpos
INTEGER(SIZE_T), INTENT(OUT) :: msize
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_fields_c(type_id, spos, epos, esize, mpos, msize) &
@@ -998,34 +665,19 @@ CONTAINS
hdferr = h5tget_fields_c(type_id, spos, epos, esize, mpos, msize)
END SUBROUTINE h5tget_fields_f
-!
-!****s* H5T/h5tset_fields_f
-!
-! NAME
-! h5tset_fields_f
-!
-! PURPOSE
-! Sets locations and sizes of floating point bit fields.
-!
-! INPUTS
-! type_id - datatype identifier
-! spos - sign bit-position
-! epos - exponent bit-position
-! esize - size of exponent in bits
-! mpos - mantissa position
-! msize - size of mantissa in bits
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets locations and sizes of floating point bit fields.
+!!
+!! \param type_id Datatype identifier.
+!! \param spos Sign bit-position.
+!! \param epos Exponent bit-position.
+!! \param esize Size of exponent in bits.
+!! \param mpos Mantissa position.
+!! \param msize Size of mantissa in bits.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_fields_f(type_id, spos, epos, esize, mpos, msize, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
@@ -1035,7 +687,6 @@ CONTAINS
INTEGER(SIZE_T), INTENT(IN) :: mpos
INTEGER(SIZE_T), INTENT(IN) :: msize
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_fields_c(type_id, spos, epos, esize, mpos, msize) &
@@ -1054,36 +705,20 @@ CONTAINS
hdferr = h5tset_fields_c(type_id, spos, epos, esize, mpos, msize)
END SUBROUTINE h5tset_fields_f
-!
-!****s* H5T/h5tget_ebias_f
-!
-! NAME
-! h5tget_ebias_f
-!
-! PURPOSE
-! Retrieves the exponent bias of a floating-point type.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! ebias - datatype exponent bias
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the exponent bias of a floating-point type.
+!!
+!! \param type_id Datatype identifier.
+!! \param ebias Datatype exponent bias.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_ebias_f(type_id, ebias, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: ebias
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_ebias_c(type_id, ebias) BIND(C,NAME='h5tget_ebias_c')
@@ -1097,36 +732,20 @@ CONTAINS
hdferr = h5tget_ebias_c(type_id, ebias)
END SUBROUTINE h5tget_ebias_f
-!
-!****s* H5T/h5tset_ebias_f
-!
-! NAME
-! h5tset_ebias_f
-!
-! PURPOSE
-! Sets the exponent bias of a floating-point type.
-!
-! INPUTS
-! type_id - datatype identifier
-! ebias - datatype exponent bias
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets the exponent bias of a floating-point type.
+!!
+!! \param type_id Datatype identifier.
+!! \param ebias Datatype exponent bias.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_ebias_f(type_id, ebias, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: ebias
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_ebias_c(type_id, ebias) BIND(C,NAME='h5tset_ebias_c')
IMPORT :: HID_T, SIZE_T
@@ -1139,40 +758,23 @@ CONTAINS
hdferr = h5tset_ebias_c(type_id, ebias)
END SUBROUTINE h5tset_ebias_f
-!
-!****s* H5T/h5tget_norm_f
-!
-! NAME
-! h5tget_norm_f
-!
-! PURPOSE
-! Retrieves mantissa normalization of a floating-point
-! datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! norm - normalization types, valid values are:
-! H5T_NORM_IMPLIED_F
-! H5T_NORM_MSBSET_F
-! H5T_NORM_NONE_F
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves mantissa normalization of a floating-point datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param norm Normalization types, valid values are:
+!! \li H5T_NORM_IMPLIED_F
+!! \li H5T_NORM_MSBSET_F
+!! \li H5T_NORM_NONE_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_norm_f(type_id, norm, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: norm
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_norm_c(type_id, norm) BIND(C,NAME='h5tget_norm_c')
@@ -1186,40 +788,23 @@ CONTAINS
hdferr = h5tget_norm_c(type_id, norm)
END SUBROUTINE h5tget_norm_f
-!
-!****s* H5T/h5tset_norm_f
-!
-! NAME
-! h5tset_norm_f
-!
-! PURPOSE
-! Sets the mantissa normalization of a floating-point datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! norm - normalization types, valid values are:
-! H5T_NORM_IMPLIED_F
-! H5T_NORM_MSBSET_F
-! H5T_NORM_NONE_F
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets the mantissa normalization of a floating-point datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param norm Normalization types, valid values are:
+!! \li H5T_NORM_IMPLIED_F
+!! \li H5T_NORM_MSBSET_F
+!! \li H5T_NORM_NONE_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_norm_f(type_id, norm, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: norm
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_norm_c(type_id, norm) BIND(C,NAME='h5tset_norm_c')
IMPORT :: HID_T
@@ -1232,41 +817,23 @@ CONTAINS
hdferr = h5tset_norm_c(type_id, norm)
END SUBROUTINE h5tset_norm_f
-!
-!****s* H5T/h5tget_inpad_f
-!
-! NAME
-! h5tget_inpad_f
-!
-! PURPOSE
-! Retrieves the internal padding type for unused bits
-! in floating-point datatypes.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! padtype - padding type for unused bits
-! Possible values of padding type are:
-! H5T_PAD_ZERO_F
-! H5T_PAD_ONE_F
-! H5T_PAD_BACKGROUND_F
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the internal padding type for unused bits in floating-point datatypes.
+!!
+!! \param type_id Datatype identifier.
+!! \param padtype Padding type for unused bits. Possible values are:
+!! \li H5T_PAD_ZERO_F
+!! \li H5T_PAD_ONE_F
+!! \li H5T_PAD_BACKGROUND_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_inpad_f(type_id, padtype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: padtype
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_inpad_c(type_id, padtype) BIND(C,NAME='h5tget_inpad_c')
IMPORT :: HID_T
@@ -1279,40 +846,23 @@ CONTAINS
hdferr = h5tget_inpad_c(type_id, padtype)
END SUBROUTINE h5tget_inpad_f
-!
-!****s* H5T/h5tset_inpad_f
-!
-! NAME
-! h5tset_inpad_f
-!
-! PURPOSE
-! Fills unused internal floating point bits.
-!
-! INPUTS
-! type_id - datatype identifier
-! padtype - padding type for unused bits
-! Possible values of padding type are:
-! H5T_PAD_ZERO_F
-! H5T_PAD_ONE_F
-! H5T_PAD_BACKGROUND_F
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Fills unused internal floating point bits.
+!!
+!! \param type_id Datatype identifier.
+!! \param padtype Padding type for unused bits. Possible values are:
+!! \li H5T_PAD_ZERO_F
+!! \li H5T_PAD_ONE_F
+!! \li H5T_PAD_BACKGROUND_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_inpad_f(type_id, padtype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: padtype
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_inpad_c(type_id, padtype) BIND(C,NAME='h5tset_inpad_c')
IMPORT :: HID_T
@@ -1325,39 +875,22 @@ CONTAINS
hdferr = h5tset_inpad_c(type_id, padtype)
END SUBROUTINE h5tset_inpad_f
-!
-!****s* H5T/h5tget_cset_f
-!
-! NAME
-! h5tget_cset_f
-!
-! PURPOSE
-! Retrieves the character set type of a string datatype.
-!
-! INPUTS
-! type_id - Datatype identifier
-! OUTPUTS
-! cset - Character set type of a string datatype
-! Possible values are:
-! H5T_CSET_ASCII_F
-! H5T_CSET_UTF8_F
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the character set type of a string datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param cset Character set type of a string datatype. Possible values are:
+!! \li H5T_CSET_ASCII_F
+!! \li H5T_CSET_UTF8_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_cset_f(type_id, cset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: cset
- INTEGER, INTENT(OUT) :: hdferr ! Error code
-!*****
+ INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_cset_c(type_id, cset) BIND(C,NAME='h5tget_cset_c')
IMPORT :: HID_T
@@ -1370,39 +903,22 @@ CONTAINS
hdferr = h5tget_cset_c(type_id, cset)
END SUBROUTINE h5tget_cset_f
-!
-!****s* H5T/h5tset_cset_f
-!
-! NAME
-! h5tset_cset_f
-!
-! PURPOSE
-! Sets character set to be used.
-!
-! INPUTS
-! type_id - datatype identifier
-! cset - character set type of a string datatype
-! Possible values are:
-! H5T_CSET_ASCII_F
-! H5T_CSET_UTF8_F
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Sets character set to be used.
+!!
+!! \param type_id Datatype identifier.
+!! \param cset Character set type of a string datatype. Possible values are:
+!! \li H5T_CSET_ASCII_F
+!! \li H5T_CSET_UTF8_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_cset_f(type_id, cset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: cset
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_cset_c(type_id, cset) BIND(C,NAME='h5tset_cset_c')
IMPORT :: HID_T
@@ -1414,41 +930,24 @@ CONTAINS
hdferr = h5tset_cset_c(type_id, cset)
END SUBROUTINE h5tset_cset_f
-!
-!****s* H5T/h5tget_strpad_f
-!
-! NAME
-! h5tget_strpad_f
-!
-! PURPOSE
-! Retrieves the storage mechanism for a string datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! strpad - storage method for a string datatype
-! Possible values are:
-! H5T_STR_NULLTERM_F,
-! H5T_STR_NULLPAD_F,
-! H5T_STR_SPACEPAD_F
-! H5T_STR_ERROR_F
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the storage mechanism for a string datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param strpad Storage method for a string datatype. Possible values are:
+!! \li H5T_STR_NULLTERM_F
+!! \li H5T_STR_NULLPAD_F
+!! \li H5T_STR_SPACEPAD_F
+!! \li H5T_STR_ERROR_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_strpad_f(type_id, strpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: strpad
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_strpad_c(type_id, strpad) BIND(C,NAME='h5tget_strpad_c')
IMPORT :: HID_T
@@ -1461,41 +960,24 @@ CONTAINS
hdferr = h5tget_strpad_c(type_id, strpad)
END SUBROUTINE h5tget_strpad_f
-!
-!****s* H5T/h5tset_strpad_f
-!
-! NAME
-! h5tset_strpad_f
-!
-! PURPOSE
-! Defines the storage mechanism for character strings.
-!
-! INPUTS
-! type_id - datatype identifier
-! strpad - storage method for a string datatype
-! Possible values are:
-! H5T_STR_NULLTERM_F,
-! H5T_STR_NULLPAD_F,
-! H5T_STR_SPACEPAD_F,
-! H5T_STR_ERROR_F.
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Defines the storage mechanism for character strings.
+!!
+!! \param type_id Datatype identifier.
+!! \param strpad Storage method for a string datatype. Possible values are:
+!! \li H5T_STR_NULLTERM_F
+!! \li H5T_STR_NULLPAD_F
+!! \li H5T_STR_SPACEPAD_F
+!! \li H5T_STR_ERROR_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_strpad_f(type_id, strpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: strpad
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tset_strpad_c(type_id, strpad) BIND(C,NAME='h5tset_strpad_c')
IMPORT :: HID_T
@@ -1508,37 +990,20 @@ CONTAINS
hdferr = h5tset_strpad_c(type_id, strpad)
END SUBROUTINE h5tset_strpad_f
-!
-!****s* H5T/h5tget_nmembers_f
-!
-! NAME
-! h5tget_nmembers_f
-!
-! PURPOSE
-! Retrieves the number of fields in a compound datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! num_members - number of members
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the number of fields in a compound datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param num_members Number of members.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_nmembers_f(type_id, num_members, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: num_members
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_nmembers_c(type_id, num_members) BIND(C,NAME='h5tget_nmembers_c')
IMPORT :: HID_T
@@ -1551,32 +1016,17 @@ CONTAINS
hdferr = h5tget_nmembers_c(type_id, num_members)
END SUBROUTINE h5tget_nmembers_f
-!
-!****s* H5T/h5tget_member_name_f
-!
-! NAME
-! h5tget_member_name_f
-!
-! PURPOSE
-! Retrieves the name of a field of a compound datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! index - filed index (0-based)
-! OUTPUTS
-! member_name - buffer to hold member's name
-! namelen - name length
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the name of a field of a compound datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param index Filed index (0-based).
+!! \param member_name Buffer to hold member&apos;s name.
+!! \param namelen Name length.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_member_name_f(type_id, index, member_name, namelen, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
@@ -1584,7 +1034,6 @@ CONTAINS
CHARACTER(LEN=*), INTENT(OUT) :: member_name
INTEGER, INTENT(OUT) :: namelen
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_member_name_c(type_id, index, member_name, namelen) BIND(C,NAME='h5tget_member_name_c')
IMPORT :: C_CHAR
@@ -1600,38 +1049,22 @@ CONTAINS
hdferr = h5tget_member_name_c(type_id, index, member_name, namelen)
END SUBROUTINE h5tget_member_name_f
-!
-!****s* H5T/h5tget_member_offset_f
-!
-! NAME
-! h5tget_member_offset_f
-!
-! PURPOSE
-! Retrieves the offset of a field of a compound datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! member_no - number of the field
-! OUTPUTS
-! offset - byte offset of the requested field
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the offset of a field of a compound datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param member_no Number of the field.
+!! \param offset Byte offset of the requested field.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_member_offset_f(type_id, member_no, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER(SIZE_T), INTENT(OUT) :: offset
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_member_offset_c(type_id, member_no, offset ) BIND(C,NAME='h5tget_member_offset_c')
IMPORT :: HID_T, SIZE_T
@@ -1644,35 +1077,22 @@ CONTAINS
hdferr = h5tget_member_offset_c(type_id, member_no, offset )
END SUBROUTINE h5tget_member_offset_f
-!
-!****s* H5T/h5tget_member_index_f
-!
-! NAME
-! h5tget_member_index_f
-!
-! PURPOSE
-! Retrieves the index of a compound or enumeration datatype member.
-!
-! INPUTS
-! type_id - datatype identifier
-! name - name of the field or member whose index to
-! to be retrieved from the datatype.
-! OUTPUTS
-! index - 0-based index of the filed or member (0 to N-1)
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! September 26, 2002
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Retrieves the index of a compound or enumeration datatype member.
+!!
+!! \param type_id Datatype identifier.
+!! \param name Name of the field or member whose index to be retrieved from the datatype.
+!! \param index Based index of the filed or member (0 to N-1).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_member_index_f(type_id, name, index, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(OUT) :: index
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: namelen ! Name length
INTERFACE
@@ -1693,79 +1113,52 @@ CONTAINS
! !$!
-! !$!****s* H5T/h5tget_member_dim_f
-! !$!
-! !$! NAME
-! !$! h5tget_member_dim_f
-! !$!
-! !$! PURPOSE
-! !$! This function is not supported in hdf5-1.4.*
-! !$!
-! !$! 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 7, 2001
-! !$!
-! !$! SOURCE
+!>
+!! !$!
+!! !$! NAME
+!! !$! h5tget_member_dim_f
+!! !$!
+!! !$! PURPOSE
+!! !$! This function is not supported in hdf5-1.4.*
+!! !$!
+!! !$! 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 7, 2001
+!! !$!
+!! !$! SOURCE
! !$! SUBROUTINE h5tget_member_dims_f(type_id, field_idx,dims, field_dims, perm, hdferr)
! !$!
! !$! IMPLICIT NONE
-! !$! INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-! !$! INTEGER, INTENT(IN) :: field_idx !Field index (0-based) of
-! !$! !field_dims, perm)
-! !$! INTEGER, INTENT(OUT) :: dims !number of dimensions of the field
-! !$!
-! !$! INTEGER(SIZE_T),DIMENSION(*), INTENT(OUT) :: field_dims !buffer to store the
-! !$! !dimensions of the field
-! !$! INTEGER, DIMENSION(*), INTENT(OUT) :: perm !buffer to store the
-! !$! !permutation vector of the field
-! !$! INTEGER, INTENT(OUT) :: hdferr ! Error code
-! !$!*****!
-! !$! INTEGER, EXTERNAL :: h5tget_member_dims_c
-! !$! hdferr = h5tget_member_dims_c(type_id, field_idx, dims, field_dims, perm)
+
! !$!
! !$! END SUBROUTINE h5tget_member_dims_f
-!****s* H5T/h5tget_array_dims_f
-!
-! NAME
-! h5tget_array_dims_f
-!
-! PURPOSE
-! Returns sizes of array dimensions.
-!
-! INPUTS
-! type_id - array datatype identifier
-! OUTPUTS
-! dims - buffer to store array datatype dimensions
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns sizes of array dimensions.
+!!
+!! \param type_id Array datatype identifier.
+!! \param dims Buffer to store array datatype dimensions.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_array_dims_f(type_id, dims, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HSIZE_T),DIMENSION(*), INTENT(OUT) :: dims
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_array_dims_c(type_id, dims) BIND(C,NAME='h5tget_array_dims_c')
IMPORT :: HID_T, HSIZE_T
@@ -1779,36 +1172,20 @@ CONTAINS
END SUBROUTINE h5tget_array_dims_f
-!
-!****s* H5T/h5tget_array_ndims_f
-!
-! NAME
-! h5tget_array_ndims_f
-!
-! PURPOSE
-! Returns the rank of an array datatype.
-!
-! INPUTS
-! type_id - array datatype identifier
-! OUTPUTS
-! ndims - number of array dimensions
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the rank of an array datatype.
+!!
+!! \param type_id Array datatype identifier.
+!! \param ndims Number of array dimensions.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_array_ndims_f(type_id, ndims, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: ndims
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_array_ndims_c(type_id, ndims) BIND(C,NAME='h5tget_array_ndims_c')
IMPORT :: HID_T
@@ -1822,36 +1199,20 @@ CONTAINS
END SUBROUTINE h5tget_array_ndims_f
-!
-!****s* H5T/h5tget_super_f
-!
-! NAME
-! h5tget_super_f
-!
-! PURPOSE
-! Returns the base datatype from which a datatype is derived.
-!
-! INPUTS
-! type_id - datatype identifier
-! OUTPUTS
-! base_type_id - identifier of the base type
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the base datatype from which a datatype is derived.
+!!
+!! \param type_id Datatype identifier.
+!! \param base_type_id Identifier of the base type.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_super_f(type_id, base_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: base_type_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_super_c(type_id, base_type_id) BIND(C,NAME='h5tget_super_c')
IMPORT :: HID_T
@@ -1865,39 +1226,22 @@ CONTAINS
END SUBROUTINE h5tget_super_f
-!
-!****s* H5T/h5tget_member_type_f
-!
-! NAME
-! h5tget_member_type_f
-!
-! PURPOSE
-! Returns the datatype of the specified member.
-!
-! INPUTS
-! type_id - compound datatype identifier
-! field_idx - field index (0-based)
-!
-! OUTPUTS
-! datatype - identifier of the member's datatype
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the datatype of the specified member.
+!!
+!! \param type_id Compound datatype identifier.
+!! \param field_idx Field index (0-based).
+!! \param datatype Identifier of the member&apos;s datatype.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_member_type_f(type_id, field_idx, datatype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: field_idx
INTEGER(HID_T), INTENT(OUT) :: datatype
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_member_type_c(type_id, field_idx , datatype) &
BIND(C,NAME='h5tget_member_type_c')
@@ -1912,43 +1256,26 @@ CONTAINS
hdferr = h5tget_member_type_c(type_id, field_idx , datatype)
END SUBROUTINE h5tget_member_type_f
-!
-!****s* H5T/h5tcreate_f
-!
-! NAME
-! h5tcreate_f
-!
-! PURPOSE
-! Creates a new datatype.
-!
-! INPUTS
-! class - Datatype class can be one of:
-! H5T_COMPOUND_F
-! H5T_ENUM_F
-! H5T_OPAQUE_F
-! H5T_STRING_F
-!
-! size - Size of the datatype.
-! OUTPUTS
-! type_id - Datatype identifier.
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Creates a new datatype.
+!!
+!! \param class Datatype class can be one of:
+!! \li H5T_COMPOUND_F
+!! \li H5T_ENUM_F
+!! \li H5T_OPAQUE_F
+!! \li H5T_STRING_F
+!! \param size Size of the datatype.
+!! \param type_id Datatype identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tcreate_f(class, size, type_id, hdferr)
IMPLICIT NONE
INTEGER , INTENT(IN) :: class
INTEGER(SIZE_T), INTENT(IN) :: size
INTEGER(HID_T) , INTENT(OUT) :: type_id
INTEGER , INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tcreate_c(class, size, type_id) BIND(C,NAME='h5tcreate_c')
IMPORT :: HID_T, SIZE_T
@@ -1962,33 +1289,17 @@ CONTAINS
hdferr = h5tcreate_c(class, size, type_id)
END SUBROUTINE h5tcreate_f
-!
-!****s* H5T/h5tinsert_f
-!
-! NAME
-! h5tinsert_f
-!
-! PURPOSE
-! Adds a new member to a compound datatype.
-!
-! INPUTS
-! type_id - compound datatype identifier
-! name - name of the field to insert
-! offset - start of the member in an instance of
-! the compound datatype
-! field_id - datatype identifier of the field to insert
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Adds a new member to a compound datatype.
+!!
+!! \param type_id Compound datatype identifier.
+!! \param name Name of the field to insert.
+!! \param offset Start of the member in an instance of the compound datatype.
+!! \param field_id Datatype identifier of the field to insert.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tinsert_f(type_id, name, offset, field_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
@@ -1996,7 +1307,6 @@ CONTAINS
INTEGER(SIZE_T), INTENT(IN) :: offset
INTEGER(HID_T), INTENT(IN) :: field_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: namelen
INTERFACE
@@ -2016,34 +1326,18 @@ CONTAINS
hdferr = h5tinsert_c(type_id, name, namelen, offset, field_id )
END SUBROUTINE h5tinsert_f
-!
-!****s* H5T/h5tpack_f
-!
-! NAME
-! h5tpack_f
-!
-! PURPOSE
-! Recursively removes padding from within a compound datatype.
-!
-! INPUTS
-! type_id - compound datatype identifier
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Recursively removes padding from within a compound datatype.
+!!
+!! \param type_id Compound datatype identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tpack_f(type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tpack_c(type_id) BIND(C,NAME='h5tpack_c')
IMPORT :: HID_T
@@ -2056,45 +1350,32 @@ CONTAINS
END SUBROUTINE h5tpack_f
! !$!
-! !$!****s* H5T/h5tinsert_array_f
-! !$!
-! !$! NAME
-! !$! h5tinsert_array_f
-! !$!
-! !$! PURPOSE
-! !$! This function is not available on hdf5-1.4.*
-! !$!
-! !$! 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 7, 2001
-! !$! SOURCE
+!>
+!! !$!
+!! !$! NAME
+!! !$! h5tinsert_array_f
+!! !$!
+!! !$! PURPOSE
+!! !$! This function is not available on hdf5-1.4.*
+!! !$!
+!! !$! 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 7, 2001
+!! !$! SOURCE
! SUBROUTINE h5tinsert_array_f(parent_id,name,offset, ndims, dims, member_id, hdferr, perm)
! IMPLICIT NONE
-! INTEGER(HID_T), INTENT(IN) :: parent_id ! identifier of the parent compound datatype
-! CHARACTER(LEN=*), INTENT(IN) :: name !Name of the new member
-! INTEGER(SIZE_T), INTENT(IN) :: offset !Offset to start of new member
-! !within compound datatype
-! INTEGER, INTENT(IN) :: ndims !Dimensionality of new member.
-! !Valid values are 0 (zero) through 4 (four)
-! INTEGER(SIZE_T), DIMENSION(*), INTENT(IN) :: dims !Size of new member array
-! INTEGER(HID_T), INTENT(IN) :: member_id ! identifier of the datatype of the new member
-! INTEGER, INTENT(OUT) :: hdferr ! Error code
-! !*****!
-! INTEGER, DIMENSION(*), OPTIONAL, INTENT(IN) :: perm
-! !Pointer to buffer to store
-! !the permutation vector of the field
-! INTEGER :: namelen, sizeofperm
+
! INTEGER, EXTERNAL :: h5tinsert_array_c, h5tinsert_array_c2
! namelen = LEN(name)
! if (present(perm)) then
@@ -2105,33 +1386,17 @@ CONTAINS
!
! END SUBROUTINE h5tinsert_array_f
-!
-!****s* H5T/h5tarray_create_f
-!
-! NAME
-! h5tarray_create_f
-!
-! PURPOSE
-! Creates an array datatype object.
-!
-! INPUTS
-! base_id - datatype identifier for the array
-! base datatype
-! rank - rank of the array
-! dims - array dimension sizes
-! OUTPUTS
-! type_id - array datatype identifier
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Creates an array datatype object.
+!!
+!! \param base_id Datatype identifier for the array base datatype.
+!! \param rank Rank of the array.
+!! \param dims Array dimension sizes.
+!! \param type_id Array datatype identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tarray_create_f(base_id, rank, dims, type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: base_id
@@ -2139,7 +1404,6 @@ CONTAINS
INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: dims
INTEGER(HID_T), INTENT(OUT) :: type_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tarray_create_c(base_id, rank, dims, type_id) BIND(C,NAME='h5tarray_create_c')
IMPORT :: HID_T, HSIZE_T
@@ -2155,36 +1419,20 @@ CONTAINS
END SUBROUTINE h5tarray_create_f
-!
-!****s* H5T/h5tenum_create_f
-!
-! NAME
-! h5tenum_create_f
-!
-! PURPOSE
-! Creates a new enumeration datatype.
-!
-! INPUTS
-! parent_id - datatype identifier for base datatype
-! OUTPUTS
-! new_type_id - datatype identifier for the enumeration datatype
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Creates a new enumeration datatype.
+!!
+!! \param parent_id Datatype identifier for base datatype.
+!! \param new_type_id Datatype identifier for the enumeration datatype.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tenum_create_f(parent_id, new_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: parent_id
INTEGER(HID_T), INTENT(OUT) :: new_type_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tenum_create_c(parent_id, new_type_id) BIND(C,NAME='h5tenum_create_c')
@@ -2197,39 +1445,17 @@ CONTAINS
hdferr = h5tenum_create_c(parent_id, new_type_id)
END SUBROUTINE h5tenum_create_f
-!
-!****s* H5T/h5tenum_nameof_f
-!
-! NAME
-! h5tenum_nameof_f
-!
-! PURPOSE
-! Returns the symbol name corresponding to a specified
-! member of an enumeration datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! value - value of the enumeration datatype
-! namelen - name buffer size
-! OUTPUTS
-! name - buffer to hold symbol name
-! 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 7, 2001
-!
-! NOTE
-! According to the standard: Because an INTENT(OUT) variable is considered undefined
-! on entry to the procedure, any default initialization specified for its type will
-! be applied. So we need to blank out the "name" to be portable and eliminate any
-! characters the "name' may contain upon entry, depending on compiler implementation.
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the symbol name corresponding to a specified member of an enumeration datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param value Value of the enumeration datatype.
+!! \param namelen Name buffer size.
+!! \param name Buffer to hold symbol name.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tenum_nameof_f(type_id, value, namelen, name, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
@@ -2237,7 +1463,6 @@ CONTAINS
INTEGER(SIZE_T), INTENT(IN) :: namelen
INTEGER, INTENT(IN) :: value
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tenum_nameof_c(type_id, value, name, namelen) BIND(C,NAME='h5tenum_nameof_c')
IMPORT :: C_CHAR
@@ -2254,40 +1479,22 @@ CONTAINS
hdferr = h5tenum_nameof_c(type_id, value, name, namelen)
END SUBROUTINE h5tenum_nameof_f
-!
-!****s* H5T/h5tenum_valuof_f
-!
-! NAME
-! h5tenum_valuof_f
-!
-! PURPOSE
-! Returns the value corresponding to a specified
-! member of an enumeration datatype.
-!
-! INPUTS
-! type_id - datatype identifier
-! name - symbol name
-! OUTPUTS
-! value - value of the enumeration datatype
-! 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 7, 2001
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the value corresponding to a specified member of an enumeration datatype.
+!!
+!! \param type_id Datatype identifier.
+!! \param name Symbol name.
+!! \param value Value of the enumeration datatype.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tenum_valueof_f(type_id, name, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(OUT) :: value
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: namelen
INTERFACE
@@ -2307,38 +1514,22 @@ CONTAINS
hdferr = h5tenum_valueof_c(type_id, name, namelen, value)
END SUBROUTINE h5tenum_valueof_f
-!
-!****s* H5T/h5tget_member_value_f
-!
-! NAME
-! h5tget_member_value_f
-!
-! PURPOSE
-! Returns the value of an enumeration datatype member.
-!
-! INPUTS
-! type_id - datatype identifier
-! member_no - number of the enumeration datatype member
-! OUTPUTS
-! value - value of the enumeration datatype
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the value of an enumeration datatype member.
+!!
+!! \param type_id Datatype identifier.
+!! \param member_no Number of the enumeration datatype member.
+!! \param value Value of the enumeration datatype.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_member_value_f(type_id, member_no, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER, INTENT(OUT) :: value
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_member_value_c(type_id, member_no, value) &
BIND(C,NAME='h5tget_member_value_c')
@@ -2353,37 +1544,20 @@ CONTAINS
hdferr = h5tget_member_value_c(type_id, member_no, value)
END SUBROUTINE h5tget_member_value_f
-!
-!****s* H5T/h5tset_tag_f
-!
-! NAME
-! h5tset_tag_f
-!
-! PURPOSE
-! Tags an opaque datatype.
-!
-! INPUTS
-! type_id - identifier for opaque datatype
-! tag - unique ASCII string with which the opaque
-! datatype is to be tagged.
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Tags an opaque datatype.
+!!
+!! \param type_id Identifier for opaque datatype.
+!! \param tag Unique ASCII string with which the opaque datatype is to be tagged.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tset_tag_f(type_id, tag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: tag
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: taglen
INTERFACE
@@ -2401,39 +1575,22 @@ CONTAINS
hdferr = h5tset_tag_c(type_id, tag, taglen)
END SUBROUTINE h5tset_tag_f
-!
-!****s* H5T/h5tget_tag_f
-!
-! NAME
-! h5tget_tag_f
-!
-! PURPOSE
-! Gets the tag associated with an opaque datatype.
-!
-! INPUTS
-! type_id - identifier for opaque datatype
-! OUTPUTS
-! tag - unique ASCII string associated with opaque
-! datatype
-! taglen - Length of tag
-! 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 7, 2001
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Gets the tag associated with an opaque datatype.
+!!
+!! \param type_id Identifier for opaque datatype.
+!! \param tag Unique ASCII string associated with opaque datatype.
+!! \param taglen Length of tag.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_tag_f(type_id, tag,taglen, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(OUT) :: tag
INTEGER, INTENT(OUT) :: taglen
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER(SIZE_T):: tag_size ! Declared character length of tab
INTERFACE
INTEGER FUNCTION h5tget_tag_c(type_id, tag, tag_size, taglen) &
@@ -2452,35 +1609,20 @@ CONTAINS
hdferr = h5tget_tag_c(type_id, tag, tag_size, taglen )
END SUBROUTINE h5tget_tag_f
-!
-!****s* H5T/h5tvlen_create_f
-!
-! NAME
-! h5tvlen_create_f
-!
-! PURPOSE
-! Creates a new variable-length datatype.
-!
-! INPUTS
-! type_id - identifier iof base datatype
-! OUTPUTS
-! vltype_id - identifier for VL datatype
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! Wednesday, October 23, 2002
-!
-! NOTES
-! Only basic Fortran base datatypes are supported
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Creates a new variable-length datatype.
+!!
+!! \param type_id Identifier iof base datatype.
+!! \param vltype_id Identifier for VL datatype.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tvlen_create_f(type_id, vltype_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: vltype_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tvlen_create_c(type_id, vltype_id) BIND(C,NAME='h5tvlen_create_c')
IMPORT :: HID_T
@@ -2493,33 +1635,20 @@ CONTAINS
hdferr = h5tvlen_create_c(type_id, vltype_id)
END SUBROUTINE h5tvlen_create_f
-!
-!****s* H5T/h5tis_variable_str_f
-!
-! NAME
-! h5tis_variable_str_f
-!
-! PURPOSE
-! Determines whether a dattype is a variable string.
-!
-! INPUTS
-! type_id - datartpe identifier
-! OUTPUTS
-! status - flag to indicate if datatype
-! is a variable string ( TRUE or FALSE)
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! March 12, 2003
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Determines whether a dattype is a variable string.
+!!
+!! \param type_id Datartpe identifier.
+!! \param status Flag to indicate if datatype is a variable string ( TRUE or FALSE).
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tis_variable_str_f(type_id, status, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
LOGICAL, INTENT(OUT) :: status
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: flag ! "TRUE/FALSE/ERROR from C"
INTERFACE
@@ -2538,47 +1667,34 @@ CONTAINS
END SUBROUTINE h5tis_variable_str_f
-!
-!****s* H5T/h5tget_member_class_f
-!
-! NAME
-! h5tget_member_class_f
-!
-! PURPOSE
-! Returns datatype class of compound datatype member.
-!
-! INPUTS
-! type_id - datartpe identifier
-! member_no - index of compound datatype member
-! OUTPUTS
-! class - class type for compound dadtype member
-! Valid classes:
-! H5T_NO_CLASS_F (error)
-! H5T_INTEGER_F
-! H5T_FLOAT_F
-! H5T_TIME_F
-! H5T_STRING_F
-! H5T_BITFIELD_F
-! H5T_OPAQUE_F
-! H5T_COMPOUND_F
-! H5T_REFERENCE_F
-! H5T_ENUM_F
-! H5T_VLEN_F
-! H5T_ARRAY_F
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! Elena Pourmal
-! April 6, 2005
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns datatype class of compound datatype member.
+!!
+!! \param type_id Datartpe identifier.
+!! \param member_no Index of compound datatype member.
+!! \param class Class type for compound dadtype member. Valid classes:
+!! \li H5T_NO_CLASS_F (error)
+!! \li H5T_INTEGER_F
+!! \li H5T_FLOAT_F
+!! \li H5T_TIME_F
+!! \li H5T_STRING_F
+!! \li H5T_BITFIELD_F
+!! \li H5T_OPAQUE_F
+!! \li H5T_COMPOUND_F
+!! \li H5T_REFERENCE_F
+!! \li H5T_ENUM_F
+!! \li H5T_VLEN_F
+!! \li H5T_ARRAY_F
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_member_class_f(type_id, member_no, class, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER, INTENT(OUT) :: class
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_member_class_c(type_id, member_no, class) &
BIND(C,NAME='h5tget_member_class_c')
@@ -2594,35 +1710,17 @@ CONTAINS
END SUBROUTINE h5tget_member_class_f
-!
-!****s* H5T/h5tcommit_anon_f
-!
-! NAME
-! h5tcommit_anon_f
-!
-! PURPOSE
-! Commits a transient datatype to a file,
-! creating a new named datatype,
-! but does not link it into the file structure.
-!
-! INPUTS
-! loc_id - A file or group identifier specifying the file
-! in which the new named datatype is to be created.
-! dtype_id - A datatype identifier.
-!
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails
-! OPTIONAL PARAMETERS
-! tcpl_id - A datatype creation property list identifier.
-! (H5P_DEFAULT_F for the default property list.)
-! tapl_id - A datatype access property list identifier.
-! should always be passed as the value H5P_DEFAULT_F.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 25, 2008
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure.
+!!
+!! \param loc_id A file or group identifier specifying the file in which the new named datatype is to be created.
+!! \param dtype_id A datatype identifier.
+!! \param hdferr \fortran_error
+!! \param tcpl_id A datatype creation property list identifier (H5P_DEFAULT_F for the default property list.)
+!! \param tapl_id A datatype access property list identifier should always be passed as the value H5P_DEFAULT_F.
+!!
SUBROUTINE h5tcommit_anon_f(loc_id, dtype_id, hdferr, tcpl_id, tapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
@@ -2630,7 +1728,6 @@ CONTAINS
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tcpl_id
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id
-!*****
INTEGER(HID_T) :: tcpl_id_default
INTEGER(HID_T) :: tapl_id_default
@@ -2657,33 +1754,20 @@ CONTAINS
END SUBROUTINE h5tcommit_anon_f
-!
-!****s* H5T/h5tcommitted_f
-!
-! NAME
-! h5tcommitted_f
-!
-! PURPOSE
-! Determines whether a datatype is a named type or a transient type.
-!
-! INPUTS
-! dtype_id - A datatype identifier.
-!
-! OUTPUTS
-! committed - .TRUE., if the datatype has been committed
-! .FALSE., if the datatype has not been committed.
-! hdferr - Returns 0 if successful and -1 if fails
-! AUTHOR
-! M. Scot Breitenfeld
-! February 25, 2008
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Determines whether a datatype is a named type or a transient type.
+!!
+!! \param dtype_id A datatype identifier.
+!! \param committed .TRUE. if the datatype has been committed, and .FALSE. if the datatype has not been committed.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tcommitted_f(dtype_id, committed, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
LOGICAL, INTENT(OUT) :: committed
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tcommitted_c(dtype_id) BIND(C,NAME='h5tcommitted_c')
IMPORT :: HID_T
@@ -2706,38 +1790,27 @@ CONTAINS
END SUBROUTINE h5tcommitted_f
-!
-!****s* H5T/H5Tdecode_f
-!
-! NAME
-! H5Tdecode_f
-!
-! PURPOSE
-! Decode a binary object description of data type and return a new object handle.
-! INPUTS
-! buf - Buffer for the data space object to be decoded.
-! obj_id - Object ID
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! April 9, 2008
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Decode A binary object description of data type and return a new object handle.
+!!
+!! \param buf Buffer for the data space object to be decoded.
+!! \param obj_id Object ID.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tdecode_f(buf, obj_id, hdferr)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: buf
INTEGER(HID_T), INTENT(OUT) :: obj_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tdecode_c(buf, obj_id) BIND(C,NAME='h5tdecode_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: buf
- INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object ID
+ INTEGER(HID_T), INTENT(OUT) :: obj_id
END FUNCTION h5tdecode_c
END INTERFACE
@@ -2745,34 +1818,22 @@ CONTAINS
END SUBROUTINE h5tdecode_f
-!
-!****s* H5T/H5Tencode_f
-!
-! NAME
-! H5Tencode_f
-!
-! PURPOSE
-! Encode a data type object description into a binary buffer.
-!
-! INPUTS
-! obj_id - Identifier of the object to be encoded.
-! buf - Buffer for the object to be encoded into.
-! nalloc - The size of the allocated buffer.
-! OUTPUTS
-! nalloc - The size of the buffer needed.
-! hdferr - Returns 0 if successful and -1 if fails.
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! April 9, 2008
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Encode a data type object description into a binary buffer.
+!!
+!! \param obj_id Identifier of the object to be encoded.
+!! \param buf Buffer for the object to be encoded into.
+!! \param nalloc If set to zero, returns the size of the buffer needed. Otherwise, it sets the size of \p buf allocated.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tencode_f(obj_id, buf, nalloc, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_id
CHARACTER(LEN=*), INTENT(OUT) :: buf
INTEGER(SIZE_T), INTENT(INOUT) :: nalloc
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tencode_c(buf, obj_id, nalloc) BIND(C,NAME='h5tencode_c')
@@ -2789,32 +1850,20 @@ CONTAINS
END SUBROUTINE h5tencode_f
-!
-!****s* H5T/h5tget_create_plist_f
-!
-! NAME
-! h5tget_create_plist_f
-!
-! PURPOSE
-! Returns a copy of a datatype creation property list.
-!
-! INPUTS
-! dtype_id - Datatype identifier
-! OUTPUTS
-! dtpl_id - Datatype property list identifier
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! April 9, 2008
-!
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns a copy of a datatype creation property list.
+!!
+!! \param dtype_id Datatype identifier.
+!! \param dtpl_id Datatype property list identifier.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_create_plist_f(dtype_id, dtpl_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
INTEGER(HID_T), INTENT(OUT) :: dtpl_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_create_plist_c(dtype_id, dtpl_id) BIND(C,NAME='h5tget_create_plist_c')
IMPORT :: HID_T
@@ -2827,33 +1876,22 @@ CONTAINS
hdferr = h5tget_create_plist_c(dtype_id, dtpl_id)
END SUBROUTINE h5tget_create_plist_f
-!
-!****s* H5T/h5tcompiler_conv_f
-!
-! NAME
-! h5tcompiler_conv_f
-!
-! PURPOSE
-! Check whether the library’s default conversion is hard conversion.R
-!
-! INPUTS
-! src_id - Identifier for the source datatype.
-! dst_id - Identifier for the destination datatype.
-! OUTPUTS
-! flag - TRUE for compiler conversion, FALSE for library conversion
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! April 9, 2008
-! SOURCE
- SUBROUTINE h5tcompiler_conv_f( src_id, dst_id, flag, hdferr)
+!>
+!! \ingroup FH5T
+!!
+!! \brief Check whether the library’s default conversion is hard conversion.
+!!
+!! \param src_id Identifier for the source datatype.
+!! \param dst_id Identifier for the destination datatype.
+!! \param flag .TRUE. for compiler conversion, .FALSE. for library conversion.
+!! \param hdferr \fortran_error
+!!
+ SUBROUTINE h5tcompiler_conv_f(src_id, dst_id, flag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: src_id
INTEGER(HID_T), INTENT(IN) :: dst_id
LOGICAL, INTENT(OUT) :: flag
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: c_flag
INTERFACE
@@ -2873,39 +1911,26 @@ CONTAINS
END SUBROUTINE h5tcompiler_conv_f
-!
-!****s* H5T/h5tget_native_type_f
-!
-! NAME
-! h5tget_native_type_f
-!
-! PURPOSE
-! Returns the native datatype of a specified datatype.
-!
-! INPUTS
-! dtype_id - Datatype identifier for the dataset datatype.
-!
-! direction - Direction of search:
-! H5T_DIR_DEFAULT, default direction is inscendent,
-! H5T_DIR_ASCEND , in inscendent order,
-! H5T_DIR_DESCEND, in descendent order.
-!
-! * NOTE: In C it is defined as a structure: H5T_direction_t
-!
-! OUTPUTS
-! native_dtype_id - The native datatype identifier for the specified dataset datatype
-! hdferr - Returns 0 if successful and -1 if fails
-! AUTHOR
-! M. Scot Breitenfeld
-! June 18, 2008
-! SOURCE
+!>
+!! \ingroup FH5T
+!!
+!! \brief Returns the native datatype of a specified datatype.
+!!
+!! \param dtype_id Datatype identifier for the dataset datatype.
+!! \param direction Direction of search:
+!! H5T_DIR_DEFAULT, default direction is inscendent,
+!! H5T_DIR_ASCEND , in inscendent order,
+!! H5T_DIR_DESCEND, in descendent order.
+!! * NOTE: In C it is defined as a structure: H5T_direction_t
+!! \param native_dtype_id The native datatype identifier for the specified dataset datatype.
+!! \param hdferr \fortran_error
+!!
SUBROUTINE h5tget_native_type_f(dtype_id, direction, native_dtype_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
INTEGER, INTENT(IN) :: direction
INTEGER(HID_T), INTENT(OUT) :: native_dtype_id
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTERFACE
INTEGER FUNCTION h5tget_native_type_c(dtype_id, direction, native_dtype_id) BIND(C,NAME='h5tget_native_type_c')
IMPORT :: HID_T
@@ -2919,31 +1944,19 @@ CONTAINS
hdferr = h5tget_native_type_c(dtype_id, direction, native_dtype_id)
END SUBROUTINE h5tget_native_type_f
-!****s* H5T/H5Tconvert_f_F03
-!
-! NAME
-! H5Tconvert_f
-!
-! PURPOSE
-! Converts data from between specified datatypes.
-!
-! Inputs:
-! src_id - Identifier for the source datatype.
-! dst_id - Identifier for the destination datatype.
-! nelmts - Size of array buf.
-! buf - Array containing pre-conversion values.
-! background - Optional background buffer.
-! plist_id - Dataset transfer property list identifier.
-!
-! Outputs:
-! buf - Array containing post-conversion values.
-! hdferr - error code:
-! 0 on success and -1 on failure
-! AUTHOR
-! M. Scot Breitenfeld
-! Decemember 8, 2008
-!
-! Fortran2003 Interface:
+!>
+!! \ingroup FH5T
+!!
+!! \brief Converts data from between specified datatypes.
+!!
+!! \param src_id Identifier for the source datatype.
+!! \param dst_id Identifier for the destination datatype.
+!! \param nelmts Size of array buf.
+!! \param buf Array containing pre-conversion values.
+!! \param hdferr \fortran_error
+!! \param background Background buffer.
+!! \param plist_id Dataset transfer property list identifier.
+!!
SUBROUTINE h5tconvert_f(src_id, dst_id, nelmts, buf, hdferr, background, plist_id)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: src_id
@@ -2953,7 +1966,6 @@ CONTAINS
INTEGER , INTENT(OUT) :: hdferr
TYPE(C_PTR) , INTENT(INOUT), OPTIONAL :: background
INTEGER(HID_T) , INTENT(IN) , OPTIONAL :: plist_id
-!*****
INTEGER(HID_T) :: plist_id_default
TYPE(C_PTR) :: background_default
@@ -2981,102 +1993,94 @@ CONTAINS
hdferr = H5Tconvert_c(src_id, dst_id, nelmts, buf, background_default, plist_id_default)
END SUBROUTINE h5tconvert_f
-!
-!****s* H5T/h5tenum_insert_f90
-!
-! NAME
-! h5tenum_insert_f
-!
-! PURPOSE
-! Inserts a new enumeration datatype member.
-!
-! INPUTS
-! type_id - Datatype identifier for the enumeration datatype.
-! name - Datatype identifier.
-! value - Value of the new member.
-! 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 7, 2001
-! SOURCE
- SUBROUTINE h5tenum_insert_f90(type_id, name, value, hdferr)
+
+!>
+!! \ingroup FH5T
+!!
+!! \brief Inserts a new enumeration datatype member.
+!!
+!! \note \fortran_approved
+!!
+!! \param type_id Datatype identifier for the enumeration datatype.
+!! \param name Datatype identifier.
+!! \param value Pointer to the value of the new member.
+!! \param hdferr \fortran_error
+!!
+#ifdef H5_DOXYGEN_FORTRAN
+ SUBROUTINE h5tenum_insert_f(&
+#else
+ SUBROUTINE h5tenum_insert_f03(&
+#endif
+ type_id, name, value, hdferr)
IMPLICIT NONE
- INTEGER(HID_T), INTENT(IN) :: type_id
+ INTEGER(HID_T) , INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
- INTEGER, INTENT(IN) :: value
+ TYPE(C_PTR) , INTENT(IN) :: value
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: namelen
+
INTERFACE
- INTEGER FUNCTION h5tenum_insert_c(type_id, name, namelen, value) BIND(C,NAME='h5tenum_insert_c')
- IMPORT :: C_CHAR
+ INTEGER FUNCTION h5tenum_insert_ptr_c(type_id, name, namelen, value) &
+ BIND(C, NAME='h5tenum_insert_ptr_c')
+ IMPORT :: C_CHAR, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
- INTEGER, INTENT(IN) :: value
INTEGER :: namelen
- END FUNCTION h5tenum_insert_c
+ TYPE(C_PTR), VALUE :: value
+ END FUNCTION h5tenum_insert_ptr_c
END INTERFACE
namelen = LEN(name)
- hdferr = h5tenum_insert_c(type_id, name, namelen, value)
- END SUBROUTINE h5tenum_insert_f90
-
-!
-!****s* H5T/h5tenum_insert_f03
-!
-! NAME
-! h5tenum_insert_f
-!
-! PURPOSE
-! Inserts a new enumeration datatype member.
-!
-! INPUTS
-! type_id - Datatype identifier for the enumeration datatype.
-! name - Datatype identifier.
-! value - Pointer to the value of the new member.
-! OUTPUTS
-! hdferr - Returns 0 if successful and -1 if fails
-!
-! AUTHOR
-! M. Scot Breitenfeld
-! February 6, 2015
-!
-! HISTORY
-! F2003 implementation of function
-! SOURCE
- SUBROUTINE h5tenum_insert_f03(type_id, name, value, hdferr)
+ hdferr = h5tenum_insert_ptr_c(type_id, name, namelen, value)
+#ifdef H5_DOXYGEN_FORTRAN
+ END SUBROUTINE h5tenum_insert_f
+#else
+ END SUBROUTINE h5tenum_insert_f03
+#endif
+
+!>
+!! \ingroup FH5T
+!!
+!! \brief Inserts a new enumeration datatype member.
+!!
+!! \note \fortran_obsolete
+!!
+!! \param type_id Datatype identifier for the enumeration datatype.
+!! \param name Datatype identifier.
+!! \param value Value of the new member.
+!! \param hdferr \fortran_error
+!!
+#ifdef H5_DOXYGEN_FORTRAN
+ SUBROUTINE h5tenum_insert_f(type_id, name, value, hdferr)
+#else
+ SUBROUTINE h5tenum_insert_f90(type_id, name, value, hdferr)
+#endif
IMPLICIT NONE
- INTEGER(HID_T) , INTENT(IN) :: type_id
+ INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
- TYPE(C_PTR) , INTENT(IN) :: value
+ INTEGER, INTENT(IN) :: value
INTEGER, INTENT(OUT) :: hdferr
-!*****
INTEGER :: namelen
-
INTERFACE
- INTEGER FUNCTION h5tenum_insert_ptr_c(type_id, name, namelen, value) &
- BIND(C, NAME='h5tenum_insert_ptr_c')
- IMPORT :: C_CHAR, C_PTR
+ INTEGER FUNCTION h5tenum_insert_c(type_id, name, namelen, value) BIND(C,NAME='h5tenum_insert_c')
+ IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
+ INTEGER, INTENT(IN) :: value
INTEGER :: namelen
- TYPE(C_PTR), VALUE :: value
- END FUNCTION h5tenum_insert_ptr_c
+ END FUNCTION h5tenum_insert_c
END INTERFACE
namelen = LEN(name)
- hdferr = h5tenum_insert_ptr_c(type_id, name, namelen, value)
- END SUBROUTINE h5tenum_insert_f03
+ hdferr = h5tenum_insert_c(type_id, name, namelen, value)
+#ifdef H5_DOXYGEN_FORTRAN
+ END SUBROUTINE h5tenum_insert_f
+#else
+ END SUBROUTINE h5tenum_insert_f90
+#endif
END MODULE H5T