summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Tf.c
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2015-07-14 15:31:15 (GMT)
committerScot Breitenfeld <brtnfld@hdfgroup.org>2015-07-14 15:31:15 (GMT)
commit50c000fb49a34be4b5e600be9c4fc7bdea298860 (patch)
treede34af2939f89a53fea6e7d9d07461f4d8b60b09 /fortran/src/H5Tf.c
parentf50c602b01c0c40ce0bf3725f230b87e6826f967 (diff)
downloadhdf5-50c000fb49a34be4b5e600be9c4fc7bdea298860.zip
hdf5-50c000fb49a34be4b5e600be9c4fc7bdea298860.tar.gz
hdf5-50c000fb49a34be4b5e600be9c4fc7bdea298860.tar.bz2
[svn-r27377] Cleaned-up comment formatting:
sed -e 's/^ \*[ ]*\([A-Z]\)\([a-z]\)/ * \1\2/g' H5Zf.c | sed -e 's/^ \*[ ]*\([a-z]\)/ * \1/g' | sed -e 's/^ \*[ ]*\([0-9]\)/ * \1/g'
Diffstat (limited to 'fortran/src/H5Tf.c')
-rw-r--r--fortran/src/H5Tf.c560
1 files changed, 280 insertions, 280 deletions
diff --git a/fortran/src/H5Tf.c b/fortran/src/H5Tf.c
index 7103ca2..8481cbc 100644
--- a/fortran/src/H5Tf.c
+++ b/fortran/src/H5Tf.c
@@ -1,6 +1,6 @@
/****h* H5Tf/H5Tf
* PURPOSE
- * This file contains C stubs for H5T Fortran APIs
+ * This file contains C stubs for H5T Fortran APIs
*
* COPYRIGHT
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
@@ -30,17 +30,17 @@
* PURPOSE
* Call H5Topen2 to open a datatype
* INPUTS
- * loc_id - file or group identifier
- * name - name of the datatype within file or group
- * namelen - name length
- * tapl_id - datatype access property list identifier
+ * loc_id - file or group identifier
+ * name - name of the datatype within file or group
+ * namelen - name length
+ * tapl_id - datatype access property list identifier
* OUTPUTS
- * type_id - dataset identifier
+ * type_id - dataset identifier
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Saturday, August 14, 1999
+ * Saturday, August 14, 1999
* HISTORY
*
* SOURCE
@@ -82,18 +82,18 @@ done:
* PURPOSE
* Call H5Tcommit2 to commit a datatype
* INPUTS
- * loc_id - file or group identifier
- * name - name of the datatype within file or group
- * namelen - name length
- * type_id - dataset identifier
- * lcpl_id - Link creation property list
- * tcpl_id - Datatype creation property list
- * tapl_id - Datatype access property list
+ * loc_id - file or group identifier
+ * name - name of the datatype within file or group
+ * namelen - name length
+ * type_id - dataset identifier
+ * lcpl_id - Link creation property list
+ * tcpl_id - Datatype creation property list
+ * tapl_id - Datatype access property list
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Saturday, August 14, 1999
+ * Saturday, August 14, 1999
* HISTORY
*
* - Added passing optional parameters for version 1.8
@@ -130,12 +130,12 @@ done:
* PURPOSE
* Call H5Tclose to close the datatype
* INPUTS
- * type_id - identifier of the datatype to be closed
+ * type_id - identifier of the datatype to be closed
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Saturday, August 14, 1999
+ * Saturday, August 14, 1999
* HISTORY
*
* SOURCE
@@ -160,14 +160,14 @@ h5tclose_c ( hid_t_f *type_id )
* PURPOSE
* Call H5Tcopy to copy a datatype
* INPUTS
- * type_id - identifier of the datatype to be copied
+ * type_id - identifier of the datatype to be copied
* OUTPUTS
- * new_type_id - identifier of the new datatype
+ * new_type_id - identifier of the new datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Saturday, August 14, 1999
+ * Saturday, August 14, 1999
* HISTORY
*
* SOURCE
@@ -194,15 +194,15 @@ h5tcopy_c ( hid_t_f *type_id , hid_t_f *new_type_id)
* PURPOSE
* Call H5Tequal to copy a datatype
* INPUTS
- * type1_id - datatype identifier
- * type2_id - datatype identifier
+ * type1_id - datatype identifier
+ * type2_id - datatype identifier
* OUTPUTS
- * c_flag - flag; indicates if two datatypes are equal or not.
+ * c_flag - flag; indicates if two datatypes are equal or not.
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Tuesday, February 22, 2000
+ * Tuesday, February 22, 2000
* HISTORY
*
* SOURCE
@@ -293,17 +293,17 @@ h5tget_class_c ( hid_t_f *type_id , int_f *classtype)
* PURPOSE
* Call H5Tget_order to determine byte order
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * order; possible values are:
+ * order; possible values are:
* H5T_ORDER_LE_F (0)
* H5T_ORDER_BE_F (1)
* H5T_ORDER_VAX_F (2)
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Saturday, August 14, 1999
+ * Saturday, August 14, 1999
* HISTORY
*
* SOURCE
@@ -337,16 +337,16 @@ h5tget_order_c ( hid_t_f *type_id , int_f *order)
* PURPOSE
* Call H5Tset_order to set byte order
* INPUTS
- * type_id - identifier of the dataspace
- * order; possible values are:
+ * type_id - identifier of the dataspace
+ * order; possible values are:
* H5T_ORDER_LE_F (0)
* H5T_ORDER_BE_F (1)
* H5T_ORDER_VAX_F (2)
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Saturday, August 14, 1999
+ * Saturday, August 14, 1999
* HISTORY
*
* SOURCE
@@ -378,14 +378,14 @@ h5tset_order_c ( hid_t_f *type_id , int_f *order)
* PURPOSE
* Call H5Tget_size to get size of the datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * size (in bytes)
+ * size (in bytes)
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Saturday, August 14, 1999
+ * Saturday, August 14, 1999
* HISTORY
*
* SOURCE
@@ -413,14 +413,14 @@ h5tget_size_c ( hid_t_f *type_id , size_t_f *size)
* PURPOSE
* Call H5Tget_size to get size of the datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * size (in bytes)
+ * size (in bytes)
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Saturday, August 14, 1999
+ * Saturday, August 14, 1999
* HISTORY
*
* SOURCE
@@ -449,14 +449,14 @@ h5tset_size_c ( hid_t_f *type_id , size_t_f *size)
* PURPOSE
* Call H5Tget_precision to get precision of the datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * precision - number of significant bits
+ * precision - number of significant bits
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Tuesday, January 25, 2000
+ * Tuesday, January 25, 2000
* HISTORY
*
* SOURCE
@@ -484,13 +484,13 @@ h5tget_precision_c ( hid_t_f *type_id , size_t_f *precision)
* PURPOSE
* Call H5Tset_precision to set precision of the datatype
* INPUTS
- * type_id - identifier of the dataspace
- * precision - number of significant bits
+ * type_id - identifier of the dataspace
+ * precision - number of significant bits
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Tuesday, January 25, 2000
+ * Tuesday, January 25, 2000
* HISTORY
*
* SOURCE
@@ -518,16 +518,16 @@ h5tset_precision_c ( hid_t_f *type_id , size_t_f *precision)
* h5tget_offset_c
* PURPOSE
* Call H5Tget_offset to get bit offset of the first
- * significant bit of the datatype
+ * significant bit of the datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * offset - bit offset of the first significant bit
+ * offset - bit offset of the first significant bit
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Tuesday, January 25, 2000
+ * Tuesday, January 25, 2000
* HISTORY
*
* SOURCE
@@ -555,15 +555,15 @@ h5tget_offset_c ( hid_t_f *type_id , size_t_f *offset)
* h5tset_offset_c
* PURPOSE
* Call H5Tset_offset to set bit offset of the first
- * significant bit of the datatype
+ * significant bit of the datatype
* INPUTS
- * type_id - identifier of the dataspace
- * offset - bit offset of the first significant bit
+ * type_id - identifier of the dataspace
+ * offset - bit offset of the first significant bit
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Tuesday, January 25, 2000
+ * Tuesday, January 25, 2000
* HISTORY
*
* SOURCE
@@ -591,18 +591,18 @@ h5tset_offset_c ( hid_t_f *type_id , size_t_f *offset)
* h5tget_pad_c
* PURPOSE
* Call H5Tget_pad to get the padding type of the least and
- * most-significant bit padding
+ * most-significant bit padding
*
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * lsbpad - padding type of the least significant bit
- * msbpad - padding type of the least significant bit
+ * lsbpad - padding type of the least significant bit
+ * msbpad - padding type of the least significant bit
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -631,20 +631,20 @@ h5tget_pad_c ( hid_t_f *type_id , int_f * lsbpad, int_f * msbpad)
* NAME
* h5tset_pad_c
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* PURPOSE
* Call H5Tset_pad to set the padding type of the least and
- * most-significant bit padding
+ * most-significant bit padding
*
* INPUTS
- * type_id - identifier of the dataspace
- * lsbpad - padding type of the least significant bit
- * msbpad - padding type of the least significant bit
+ * type_id - identifier of the dataspace
+ * lsbpad - padding type of the least significant bit
+ * msbpad - padding type of the least significant bit
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -674,14 +674,14 @@ h5tset_pad_c ( hid_t_f *type_id, int_f * lsbpad, int_f* msbpad )
* PURPOSE
* Call H5Tget_sign to get sign type for an integer type
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * sign - sign type for an integer type
+ * sign - sign type for an integer type
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -709,13 +709,13 @@ h5tget_sign_c ( hid_t_f *type_id , int_f *sign)
* PURPOSE
* Call H5Tset_sign to set sign type for an integer type
* INPUTS
- * type_id - identifier of the dataspace
- * sign - sign type for an integer typ
+ * type_id - identifier of the dataspace
+ * sign - sign type for an integer typ
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -744,19 +744,19 @@ h5tset_sign_c ( hid_t_f *type_id , int_f* sign)
* h5tget_fields_c
* PURPOSE
* Call H5Tget_fields to get floating point datatype
- * bit field information
+ * bit field information
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * epos - exponent bit-position
- * esize - size of exponent in bits
- * mpos - mantissa bit-position
- * msize - size of mantissa in bits
+ * epos - exponent bit-position
+ * esize - size of exponent in bits
+ * mpos - mantissa bit-position
+ * msize - size of mantissa in bits
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Thursday, January 27, 2000
+ * Thursday, January 27, 2000
* HISTORY
*
* SOURCE
@@ -788,18 +788,18 @@ h5tget_fields_c ( hid_t_f *type_id , size_t_f *spos, size_t_f *epos, size_t_f* e
* h5tset_fields_c
* PURPOSE
* Call H5Tset_fields to set floating point datatype
- * bit field information
+ * bit field information
* INPUTS
- * type_id - identifier of the dataspace
- * epos - exponent bit-position
- * esize - size of exponent in bits
- * mpos - mantissa bit-position
- * msize - size of mantissa in bits
+ * type_id - identifier of the dataspace
+ * epos - exponent bit-position
+ * esize - size of exponent in bits
+ * mpos - mantissa bit-position
+ * msize - size of mantissa in bits
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -832,16 +832,16 @@ h5tset_fields_c ( hid_t_f *type_id, size_t_f *spos, size_t_f *epos, size_t_f* es
* h5tget_ebias_c
* PURPOSE
* Call H5Tget_ebias to get exponent bias of a
- * floating-point type of the datatype
+ * floating-point type of the datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * ebias - exponent bias of a floating-point type of the datatype
+ * ebias - exponent bias of a floating-point type of the datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Xiangyang Su
- * Friday, January 27, 2000
+ * Friday, January 27, 2000
* HISTORY
*
* SOURCE
@@ -869,15 +869,15 @@ h5tget_ebias_c ( hid_t_f *type_id , size_t_f *ebias)
* h5tset_ebias_c
* PURPOSE
* Call H5Tset_ebias to set exponent bias of a
- * floating-point type of the datatype
+ * floating-point type of the datatype
* INPUTS
- * type_id - identifier of the dataspace
- * ebias - exponent bias of a floating-point type of the datatyp
+ * type_id - identifier of the dataspace
+ * ebias - exponent bias of a floating-point type of the datatyp
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Xiangyang Su
- * Friday, January 27, 2000
+ * Friday, January 27, 2000
* HISTORY
*
* SOURCE
@@ -906,16 +906,16 @@ h5tset_ebias_c ( hid_t_f *type_id , size_t_f *ebias)
* h5tget_norm_c
* PURPOSE
* Call H5Tget_norm to get mantissa normalization
- * of a floating-point datatype
+ * of a floating-point datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * norm - mantissa normalization of a floating-point type
+ * norm - mantissa normalization of a floating-point type
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Xiangyang Su
- * Friday, January 27, 2000
+ * Friday, January 27, 2000
* HISTORY
*
* SOURCE
@@ -943,15 +943,15 @@ h5tget_norm_c ( hid_t_f *type_id , int_f *norm)
* h5tset_norm_c
* PURPOSE
* Call H5Tset_norm to set mantissa normalization of
- * floating-point type of the datatype
+ * floating-point type of the datatype
* INPUTS
- * type_id - identifier of the dataspace
- * norm - mantissa normalization of a floating-point type
+ * type_id - identifier of the dataspace
+ * norm - mantissa normalization of a floating-point type
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Xiangyang Su
- * Friday, January 27, 2000
+ * Friday, January 27, 2000
* HISTORY
*
* SOURCE
@@ -980,18 +980,18 @@ h5tset_norm_c ( hid_t_f *type_id , int_f *norm)
* h5tget_inpad_c
* PURPOSE
* Call H5Tget_inpad to get the padding type for
- * unused bits in floating-point datatypes
+ * unused bits in floating-point datatypes
*
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * padtype - padding type for
- * unused bits in floating-point datatype
+ * padtype - padding type for
+ * unused bits in floating-point datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -1018,20 +1018,20 @@ h5tget_inpad_c ( hid_t_f *type_id , int_f * padtype)
* NAME
* h5tset_inpad_c
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* PURPOSE
* Call H5Tset_inpad to set the padding type
- * unused bits in floating-point datatype
+ * unused bits in floating-point datatype
*
* INPUTS
- * type_id - identifier of the dataspace
- * padtype - padding type for unused bits
- * in floating-point datatypes
+ * type_id - identifier of the dataspace
+ * padtype - padding type for unused bits
+ * in floating-point datatypes
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -1060,17 +1060,17 @@ h5tset_inpad_c ( hid_t_f *type_id, int_f * padtype)
* h5tget_cset_c
* PURPOSE
* Call H5Tget_cset to get character set
- * type of a string datatype
+ * type of a string datatype
*
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * cset - character set type of a string datatype
+ * cset - character set type of a string datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -1097,19 +1097,19 @@ h5tget_cset_c ( hid_t_f *type_id , int_f * cset)
* NAME
* h5tset_cset_c
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* PURPOSE
* Call H5Tset_cset to set character set
- * type of a string datatype
+ * type of a string datatype
*
* INPUTS
- * type_id - identifier of the dataspace
- * cset - character set type of a string datatype
+ * type_id - identifier of the dataspace
+ * cset - character set type of a string datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -1138,16 +1138,16 @@ h5tset_cset_c ( hid_t_f *type_id, int_f * cset)
* h5tget_strpad_c
* PURPOSE
* Call H5Tget_strpad to get string padding method
- * for a string datatype
+ * for a string datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * strpad - string padding method for a string datatype
+ * strpad - string padding method for a string datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -1173,19 +1173,19 @@ h5tget_strpad_c ( hid_t_f *type_id , int_f * strpad)
* NAME
* h5tset_strpad_c
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* PURPOSE
* Call H5Tset_strpad to set string padding method
- * for a string datatype
+ * for a string datatype
*
* INPUTS
- * type_id - identifier of the dataspace
- * strpad - string padding method for a string datatype
+ * type_id - identifier of the dataspace
+ * strpad - string padding method for a string datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -1214,16 +1214,16 @@ h5tset_strpad_c ( hid_t_f *type_id, int_f * strpad)
* h5tget_nmembers_c
* PURPOSE
* Call H5Tget_nmembers to get number of fields
- * in a compound datatype
+ * in a compound datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * num_members - number of fields in a compound datatype
+ * num_members - number of fields in a compound datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Thursday, February 3, 2000
+ * Thursday, February 3, 2000
* HISTORY
*
* SOURCE
@@ -1249,19 +1249,19 @@ h5tget_nmembers_c ( hid_t_f *type_id , int_f * num_members)
* h5tget_member_name_c
* PURPOSE
* Call H5Tget_member_name to get name
- * of a compound datatype
+ * of a compound datatype
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * member_name - name of a field of a compound datatype
+ * member_name - name of a field of a compound datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Thursday, February 3, 2000
+ * Thursday, February 3, 2000
* HISTORY
- * Elena Pourmal
- * Added namelen parameter to return length of the name to Fortran user
+ * Elena Pourmal
+ * Added namelen parameter to return length of the name to Fortran user
* SOURCE
*/
@@ -1290,15 +1290,15 @@ h5tget_member_name_c ( hid_t_f *type_id ,int_f* idx, _fcd member_name, int_f *na
* h5tget_member_index_c
* PURPOSE
* Call H5Tget_member_index to get an index of
- * the specified datatype filed or member.
+ * the specified datatype filed or member.
* INPUTS
- * type_id - datatype identifier
- * name - name of the datatype within file or group
- * namelen - name length
+ * type_id - datatype identifier
+ * name - name of the datatype within file or group
+ * namelen - name length
* OUTPUTS
- * index - 0-based index
+ * index - 0-based index
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
* Thursday, September 26, 2002
@@ -1341,19 +1341,19 @@ DONE:
* h5tget_member_offset_c
* PURPOSE
* Call H5Tget_member_offset to get byte offset of the
- * beginning of a field within a compound datatype with
- * respect to the beginning of the compound data type datum
+ * beginning of a field within a compound datatype with
+ * respect to the beginning of the compound data type datum
* INPUTS
- * type_id - identifier of the dataspace
- * member_no - Number of the field whose offset is requested
+ * type_id - identifier of the dataspace
+ * member_no - Number of the field whose offset is requested
* OUTPUTS
- * offset - byte offset of the the beginning of the field of
- * a compound datatype
+ * offset - byte offset of the the beginning of the field of
+ * a compound datatype
* RETURNS
- * always 0
+ * always 0
* AUTHOR
* XIANGYANG SU
- * Thursday, February 3, 2000
+ * Thursday, February 3, 2000
* HISTORY
*
* SOURCE
@@ -1377,16 +1377,16 @@ h5tget_member_offset_c ( hid_t_f *type_id ,int_f* member_no, size_t_f * offset)
* h5tget_array_dims_c
* PURPOSE
* Call H5Tget_array_dims2 to get
- * dimensions of array datatype
+ * dimensions of array datatype
* INPUTS
- * type_id - identifier of the array datatype
+ * type_id - identifier of the array datatype
* OUTPUTS
- * dims - dimensions(sizes of dimensions) of the array
+ * dims - dimensions(sizes of dimensions) of the array
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Thursday, November 16, 2000
+ * Thursday, November 16, 2000
* HISTORY
*
* SOURCE
@@ -1420,16 +1420,16 @@ DONE:
* h5tget_array_ndims_c
* PURPOSE
* Call H5Tget_array_ndims to get number
- * of dimensions of array datatype
+ * of dimensions of array datatype
* INPUTS
- * type_id - identifier of the array datatype
+ * type_id - identifier of the array datatype
* OUTPUTS
- * ndims - number of dimensions of the array
+ * ndims - number of dimensions of the array
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Thursday, November 16, 2000
+ * Thursday, November 16, 2000
* HISTORY
*
* SOURCE
@@ -1457,16 +1457,16 @@ h5tget_array_ndims_c ( hid_t_f *type_id , int_f * ndims)
* h5tget_super_c
* PURPOSE
* Call H5Tget_super to get base datatype from which
- * datatype was derived
+ * datatype was derived
* INPUTS
- * type_id - identifier of the array datatype
+ * type_id - identifier of the array datatype
* OUTPUTS
- * base_type_id - base datatype identifier
+ * base_type_id - base datatype identifier
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Thursday, November 16, 2000
+ * Thursday, November 16, 2000
* HISTORY
*
* SOURCE
@@ -1495,14 +1495,14 @@ h5tget_super_c ( hid_t_f *type_id , hid_t_f *base_type_id)
* h5tget_member_type_c
* PURPOSE
* Call H5Tget_member_type to get the identifier of a copy of
- * the datatype of the field
+ * the datatype of the field
* INPUTS
- * type_id - identifier of the datatype
- * field_idx - Field index (0-based) of the field type to retrieve
+ * type_id - identifier of the datatype
+ * field_idx - Field index (0-based) of the field type to retrieve
* OUTPUTS
- * datatype - identifier of a copy of the datatype of the field
+ * datatype - identifier of a copy of the datatype of the field
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
* Thursday, February 3, 2000
@@ -1531,10 +1531,10 @@ h5tget_member_type_c ( hid_t_f *type_id ,int_f* field_idx, hid_t_f * datatype)
* PURPOSE
* Call H5Tcreate to create a datatype
* INPUTS
- * cls - class type
- * size - size of the class memeber
+ * cls - class type
+ * size - size of the class memeber
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
* Thursday, February 17, 2000
@@ -1643,12 +1643,12 @@ h5tpack_c(hid_t_f * type_id)
* PURPOSE
* Call H5Tarray_create2 to create array datatype
* INPUTS
- * base_id - identifier of array base datatype
- * rank - array's rank
- * dims - Size of new member array
- * type_id - identifier of the array datatype
+ * base_id - identifier of array base datatype
+ * rank - array's rank
+ * dims - Size of new member array
+ * type_id - identifier of the array datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
* Thursday, November 16, 2000
@@ -1692,7 +1692,7 @@ DONE:
* parent_id - Datatype identifier for the base datatype
* OUTPUTS
* new_type_id - datatype identifier for the new
- * enumeration datatype
+ * enumeration datatype
* RETURNS
* 0 on success, -1 on failure
* AUTHOR
@@ -1767,17 +1767,17 @@ h5tenum_insert_c(hid_t_f *type_id, _fcd name, int_f* namelen, int_f* value)
* h5tenum_nameof_c
* PURPOSE
* Call H5Tenum_nameof to find the symbol name that corresponds to
- * the specified value of the enumeration datatype type
+ * the specified value of the enumeration datatype type
* INPUTS
- * type_id - identifier of the datatype
- * namelen - length of the name
- * value - value of the enumeration datatype
- * Output: name - Name of the enumeration datatype
+ * type_id - identifier of the datatype
+ * namelen - length of the name
+ * value - value of the enumeration datatype
+ * Output: name - Name of the enumeration datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Thursday, February 3, 2000
+ * Thursday, February 3, 2000
* HISTORY
*
* SOURCE
@@ -1811,17 +1811,17 @@ h5tenum_nameof_c(hid_t_f *type_id, int_f* value, _fcd name, size_t_f* namelen)
* h5tenum_valueof_c
* PURPOSE
* Call H5Tenum_valueof to find the value of that corresponds to
- * the specified name of the enumeration datatype type
+ * the specified name of the enumeration datatype type
* INPUTS
- * type_id - identifier of the datatype
- * name - Name of the enumeration datatype
- * namelen - length of name
- * Output: value - value of the enumeration datatype
+ * type_id - identifier of the datatype
+ * name - Name of the enumeration datatype
+ * namelen - length of name
+ * Output: value - value of the enumeration datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Thursday, February 3, 2000
+ * Thursday, February 3, 2000
* HISTORY
*
* SOURCE
@@ -1851,16 +1851,16 @@ h5tenum_valueof_c(hid_t_f *type_id, _fcd name, int_f* namelen, int_f* value)
* h5tget_member_value_c
* PURPOSE
* Call H5Tget_member_value to get the value of an
- * enumeration datatype member
+ * enumeration datatype member
* INPUTS
- * type_id - identifier of the datatype
- * member_no - Number of the enumeration datatype member.
- * Output: value - value of the enumeration datatype
+ * type_id - identifier of the datatype
+ * member_no - Number of the enumeration datatype member.
+ * Output: value - value of the enumeration datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Thursday, February 3, 2000
+ * Thursday, February 3, 2000
* HISTORY
*
* SOURCE
@@ -1886,19 +1886,19 @@ h5tget_member_value_c(hid_t_f *type_id, int_f* member_no, int_f* value)
* NAME
* h5tset_tag_c
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* PURPOSE
* Call H5Tset_tag to set an opaque datatype tag
* INPUTS
- * type_id - identifier of the dataspace
- * tag - Unique ASCII string with which the opaque
- * datatype is to be tagged
- * namelen - length of tag
+ * type_id - identifier of the dataspace
+ * tag - Unique ASCII string with which the opaque
+ * datatype is to be tagged
+ * namelen - length of tag
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
- * Wednesday, January 26, 2000
+ * Wednesday, January 26, 2000
* HISTORY
*
* SOURCE
@@ -1929,11 +1929,11 @@ h5tset_tag_c(hid_t_f* type_id, _fcd tag, int_f* namelen)
* INPUTS
* type_id - identifier of the datatype
* OUTPUTS
- * tag - Unique ASCII string with which the opaque
- * datatype is to be tagged
- * taglen - length of tag
+ * tag - Unique ASCII string with which the opaque
+ * datatype is to be tagged
+ * taglen - length of tag
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* XIANGYANG SU
* Wednesday, January 26, 2000
@@ -1965,14 +1965,14 @@ h5tget_tag_c(hid_t_f* type_id, _fcd tag, size_t_f* tag_size, int_f* taglen)
* PURPOSE
* Call H5Tvlen_create to create VL dtatype
* INPUTS
- * type_id - identifier of the base datatype
+ * type_id - identifier of the base datatype
* OUTPUTS
- * vltype_id - identifier of the VL datatype
+ * vltype_id - identifier of the VL datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Wednesday, October 23, 2002
+ * Wednesday, October 23, 2002
* HISTORY
*
* SOURCE
@@ -1997,17 +1997,17 @@ h5tvlen_create_c(hid_t_f* type_id, hid_t_f *vltype_id)
* h5tis_variable_str_c
* PURPOSE
* Call H5Tis_variable_str to detrmine if the datatype
- * is a variable string.
+ * is a variable string.
* INPUTS
- * type_id - identifier of the dataspace
+ * type_id - identifier of the dataspace
* OUTPUTS
- * flag - 0 if not VL str, 1 if is not
- * and negative on failure.
+ * flag - 0 if not VL str, 1 if is not
+ * and negative on failure.
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
- * Wednesday, March 12 , 2003
+ * Wednesday, March 12 , 2003
* HISTORY
*
* SOURCE
@@ -2034,13 +2034,13 @@ h5tis_variable_str_c ( hid_t_f *type_id , int_f *flag )
* Call H5Tget_member_class to detrmine ithe class of the compound
* datatype member
* INPUTS
- * type_id - identifier of the dataspace
- * member_no - member's index
+ * type_id - identifier of the dataspace
+ * member_no - member's index
* OUTPUTS
- * class - member's class
- * and negative on failure.
+ * class - member's class
+ * and negative on failure.
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* Elena Pourmal
* Wednesday, April 6, 2005
@@ -2073,12 +2073,12 @@ h5tget_member_class_c ( hid_t_f *type_id , int_f *member_no, int_f *cls )
* PURPOSE
* Call H5Tcommit_anon
* INPUTS
- * loc_id - file or group identifier
- * dtype_id - dataset identifier
- * tcpl_id - Datatype creation property list
- * tapl_id - Datatype access property list
+ * loc_id - file or group identifier
+ * dtype_id - dataset identifier
+ * tcpl_id - Datatype creation property list
+ * tapl_id - Datatype access property list
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
* February 25, 2008
@@ -2108,10 +2108,10 @@ h5tcommit_anon_c(hid_t_f *loc_id, hid_t_f *dtype_id,
* h5tcommitted_c
* PURPOSE
* Call H5Tcommitted
- * dtype_id - dataset identifier
+ * dtype_id - dataset identifier
* RETURNS
- * a positive value, for TRUE, if the datatype has been committed,
- * or 0 (zero), for FALSE, if the datatype has not been committed.
+ * a positive value, for TRUE, if the datatype has been committed,
+ * or 0 (zero), for FALSE, if the datatype has not been committed.
* Otherwise returns a negative value.
* AUTHOR
* M. Scot Breitenfeld
@@ -2144,10 +2144,10 @@ h5tcommitted_c(hid_t_f *dtype_id)
* buf - Buffer for the data space object to be decoded.
* OUTPUTS
*
- * obj_id - Object_id (non-negative)
+ * obj_id - Object_id (non-negative)
*
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
* April 9, 2008
@@ -2187,11 +2187,11 @@ h5tdecode_c ( _fcd buf, hid_t_f *obj_id )
* Call H5Tencode
* INPUTS
*
- * obj_id - Identifier of the object to be encoded.
+ * 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.
+ * nalloc - The size of the allocated buffer.
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
* April 9, 2008
@@ -2256,11 +2256,11 @@ h5tencode_c (_fcd buf, hid_t_f *obj_id, size_t_f *nalloc )
* PURPOSE
* Call H5Tget_create_plist
* INPUTS
- * dtype_id - Datatype identifier
+ * dtype_id - Datatype identifier
* OUTPUTS
- * dtpl_id - Datatype property list identifier
+ * dtpl_id - Datatype property list identifier
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
* April 9, 2008
@@ -2289,12 +2289,12 @@ h5tget_create_plist_c ( hid_t_f *dtype_id, hid_t_f *dtpl_id)
* Call H5Tcompiler_conv
* INPUTS
*
- * src_id - Identifier for the source datatype.
- * dst_id - Identifier for the destination datatype.
+ * src_id - Identifier for the source datatype.
+ * dst_id - Identifier for the destination datatype.
* OUTPUTS
- * c_flag - flag; TRUE for compiler conversion, FALSE for library conversion
+ * c_flag - flag; TRUE for compiler conversion, FALSE for library conversion
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M.Scot Breitenfeld
* April 9, 2008
@@ -2323,12 +2323,12 @@ h5tcompiler_conv_c ( hid_t_f *src_id, hid_t_f *dst_id, int_f *c_flag)
* Call H5Tget_native_type
* INPUTS
*
- * dtype_id - Datatype identifier for the dataset datatype.
- * direction - Direction of search.
+ * dtype_id - Datatype identifier for the dataset datatype.
+ * direction - Direction of search.
* OUTPUTS
- * native_dtype_id - The native datatype identifier for the specified dataset datatype
+ * native_dtype_id - The native datatype identifier for the specified dataset datatype
* RETURNS
- * 0 on success, -1 on failure
+ * 0 on success, -1 on failure
* AUTHOR
* M. Scot Breitenfeld
* June 18, 2008