From b87ae2b7853a3211178405c1328c9b95e193617a Mon Sep 17 00:00:00 2001 From: Scot Breitenfeld Date: Sat, 10 Sep 2011 15:58:32 -0500 Subject: [svn-r21373] Description: Changed the robodoc keywords in the comments to the RM documentation's standards. --- fortran/src/H5Aff_F03.f90 | 4 +- fortran/src/H5Dff_F03.f90 | 24 +++++------ fortran/src/H5Eff_F03.f90 | 12 +++--- fortran/src/H5Lff_F03.f90 | 14 +++---- fortran/src/H5Off_F03.f90 | 14 +++---- fortran/src/H5Pff_F03.f90 | 100 +++++++++++++++++++++++----------------------- fortran/src/H5Rff_F03.f90 | 66 +++++++++++++++--------------- fortran/src/H5Tff_F03.f90 | 6 +-- fortran/src/H5_ff_F03.f90 | 6 +-- 9 files changed, 123 insertions(+), 123 deletions(-) diff --git a/fortran/src/H5Aff_F03.f90 b/fortran/src/H5Aff_F03.f90 index ff1ba1c..e43e457 100644 --- a/fortran/src/H5Aff_F03.f90 +++ b/fortran/src/H5Aff_F03.f90 @@ -634,12 +634,12 @@ CONTAINS ! PURPOSE ! Reads an attribute. ! -! INPUTS +! Inputs: ! attr_id - attribute identifier ! memtype_id - attribute memory type identifier ! dims - 1D array of size 7, stores sizes of the ! - buf array dimensions. -! OUTPUTS +! Outputs: ! buf - buffer to read attribute data in ! hdferr - Returns 0 if successful and -1 if fails ! AUTHOR diff --git a/fortran/src/H5Dff_F03.f90 b/fortran/src/H5Dff_F03.f90 index 0561efd..d99d31b 100644 --- a/fortran/src/H5Dff_F03.f90 +++ b/fortran/src/H5Dff_F03.f90 @@ -1129,17 +1129,17 @@ CONTAINS ! converting from file datatype and dataspace to memory ! datatype and dataspace. ! -! INPUTS +! Inputs: ! dset_id - dataset identifier ! mem_type_id - memory type identifier ! dims - 1-dim array of size 7; dims(k) has the size ! - of k-th dimension of the buf array -! OUTPUTS +! Outputs: ! buf - buffer to read data in ! hdferr: - error code ! Success: 0 ! Failure: -1 -! OPTIONAL PARAMETERS +! Optional parameters: ! mem_space_id - memory dataspace identifier ! file_space_id - file dataspace identifier ! xfer_prp - trasfer property list identifier @@ -2142,12 +2142,12 @@ CONTAINS ! are assumed to have the same datatype. ! Only one-dimesional buffers are supported. ! -! INPUTS +! Inputs: ! fill_value - fill value ! space_id - memory space selection identifier ! buf - data buffer iin memory ro apply selection to ! - of k-th dimension of the buf array -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 @@ -2193,12 +2193,12 @@ CONTAINS ! are assumed to have the same datatype. ! Only one-dimesional buffers are supported. ! -! INPUTS +! Inputs: ! fill_value - fill value ! space_id - memory space selection identifier ! buf - data buffer iin memory ro apply selection to ! - of k-th dimension of the buf array -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 @@ -2243,12 +2243,12 @@ CONTAINS ! are assumed to have the same datatype. ! Only one-dimesional buffers are supported. ! -! INPUTS +! Inputs: ! fill_value - fill value ! space_id - memory space selection identifier ! buf - data buffer iin memory ro apply selection to ! - of k-th dimension of the buf array -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 @@ -2285,14 +2285,14 @@ CONTAINS ! PURPOSE ! Reclaims VL datatype memory buffers. ! -! INPUTS +! Inputs: ! ! type_id - Identifier of the datatype. ! space_id - Identifier of the dataspace. ! plist_id - Identifier of the property list used to create the buffer. ! buf - Pointer to the buffer to be reclaimed. ! -! OUTPUTS +! Outputs: ! hdferr - error code ! Success: 0 ! Failure: -1 @@ -2301,7 +2301,7 @@ CONTAINS ! M. Scot Breitenfeld ! January 11, 2011 ! -! SOURCE +! Signature: SUBROUTINE H5Dvlen_reclaim_f(type_id, space_id, plist_id, buf, hdferr) USE ISO_C_BINDING diff --git a/fortran/src/H5Eff_F03.f90 b/fortran/src/H5Eff_F03.f90 index e9eeac9..bf4797f 100644 --- a/fortran/src/H5Eff_F03.f90 +++ b/fortran/src/H5Eff_F03.f90 @@ -66,7 +66,7 @@ CONTAINS ! PURPOSE ! Returns settings for automatic error stack traversal function and its data. ! -! INPUTS +! Inputs: ! printflag - Flag to turn automatic error printing on or off; ! possible values are: ! printon (1) @@ -75,14 +75,14 @@ CONTAINS ! func - Function to be called upon an error condition. ! client_data - Data passed to the error function ! -! OUTPUTS +! Outputs: ! hdferr - Returns 0 if successful and -1 if fails ! ! AUTHOR ! M. Scot Breitenfeld ! July 10, 2009 ! -! SOURCE +! Signature: SUBROUTINE h5eset_auto_f(printflag, hdferr, estack_id, func, client_data) USE ISO_C_BINDING INTEGER , INTENT(IN) :: printflag @@ -129,9 +129,9 @@ CONTAINS ! PURPOSE ! Returns the settings for the automatic error stack traversal function and its data. ! -! INPUTS +! Inputs: ! estack_id - Error stack identifier. H5E_DEFAULT_F indicates the current stack. -! OUTPUTS +! Outputs: ! func - The function currently set to be called upon an error condition. ! client_data - Data currently set to be passed to the error function. ! hdferr - Returns 0 if successful and -1 if fails. @@ -140,7 +140,7 @@ CONTAINS ! M. Scot Breitenfeld ! July 10, 2009 ! -! SOURCE +! Signature: SUBROUTINE h5eget_auto_f(estack_id, op, client_data, hdferr) USE ISO_C_BINDING IMPLICIT NONE diff --git a/fortran/src/H5Lff_F03.f90 b/fortran/src/H5Lff_F03.f90 index 360dc93..e1da7c1 100644 --- a/fortran/src/H5Lff_F03.f90 +++ b/fortran/src/H5Lff_F03.f90 @@ -51,7 +51,7 @@ CONTAINS ! PURPOSE ! Iterates through links in a group. ! -! INPUTS +! Inputs: ! group_id - Identifier specifying subject group ! index_type - Type of index which determines the order ! order - Order within index @@ -59,7 +59,7 @@ CONTAINS ! op - Callback function passing data regarding the link to the calling application ! op_data - User-defined pointer to data required by the application for its processing of the link ! -! OUTPUTS +! Outputs: ! idx - Position at which an interrupted iteration may be restarted ! hdferr - Error code: ! Success: 0 @@ -68,7 +68,7 @@ CONTAINS ! M. Scot Breitenfeld ! July 8, 2008 ! -! SOURCE +! Signature: SUBROUTINE h5literate_f(group_id, index_type, order, idx, op, op_data, return_value, hdferr) USE ISO_C_BINDING IMPLICIT NONE @@ -131,7 +131,7 @@ CONTAINS ! PURPOSE ! Iterates through links in a group. ! -! INPUTS +! Inputs: ! loc_id - File or group identifier specifying location of subject group ! group_name - Name of subject group ! index_type - Type of index which determines the order @@ -140,19 +140,19 @@ CONTAINS ! op - Callback function passing data regarding the link to the calling application ! op_data - User-defined pointer to data required by the application for its processing of the link ! -! OUTPUTS +! Outputs: ! idx - Position at which an interrupted iteration may be restarted ! hdferr - Error code: ! Success: 0 ! Failure: -1 -! OPTIONAL PARAMETERS +! Optional parameters: ! lapl_id - Link access property list ! ! AUTHOR ! M. Scot Breitenfeld ! Augest 18, 2008 ! -! SOURCE +! Signature: SUBROUTINE h5literate_by_name_f(loc_id, group_name, index_type, order, idx, op, op_data, return_value, hdferr, lapl_id) USE ISO_C_BINDING IMPLICIT NONE diff --git a/fortran/src/H5Off_F03.f90 b/fortran/src/H5Off_F03.f90 index 3ca3255..4233c14 100644 --- a/fortran/src/H5Off_F03.f90 +++ b/fortran/src/H5Off_F03.f90 @@ -112,7 +112,7 @@ CONTAINS ! PURPOSE ! Recursively visits all objects starting from a specified object. ! -! INPUTS +! Inputs: ! group_id - Identifier of the group at which the recursive iteration begins ! index_type - Type of index; valid values include: ! H5_INDEX_NAME_F @@ -124,7 +124,7 @@ CONTAINS ! op - Callback function passing data regarding the group to the calling application ! op_data - User-defined pointer to data required by the application for its processing of the group ! -! OUTPUTS +! Outputs: ! idx - returns the return value of the first operator that returns a positive value, or ! zero if all members were processed with no operator returning non-zero. ! hdferr - error code: @@ -133,7 +133,7 @@ CONTAINS ! M. Scot Breitenfeld ! November 19, 2008 ! -! SOURCE +! Signature: SUBROUTINE h5ovisit_f(group_id, index_type, order, op, op_data, return_value, hdferr) USE ISO_C_BINDING IMPLICIT NONE @@ -193,22 +193,22 @@ CONTAINS ! PURPOSE ! Retrieves the metadata for an object, identifying the object by location and relative name. ! -! INPUTS +! Inputs: ! loc_id - File or group identifier specifying location of group in which object ! is located. ! name - Name of group, relative to loc_id ! -! OUTPUTS NOTE: In C it is defined as a structure: H5O_info_t +! Outputs: NOTE: In C it is defined as a structure: H5O_info_t ! **** NEED TO MAKE THIS DERIVED DATATYPE **** ! hdferr - Returns 0 if successful and -1 if fails -! OPTIONAL PARAMETERS +! Optional parameters: ! lapl_id - Link access property list ! ! AUTHOR ! M. Scot Breitenfeld ! December 1, 2008 ! -! SOURCE +! Signature: SUBROUTINE h5oget_info_by_name_f(loc_id, name, & object_info, hdferr, lapl_id) ! f_corder_valid, corder, cset, data_size, hdferr, lapl_id) diff --git a/fortran/src/H5Pff_F03.f90 b/fortran/src/H5Pff_F03.f90 index a893225..cd635bc 100644 --- a/fortran/src/H5Pff_F03.f90 +++ b/fortran/src/H5Pff_F03.f90 @@ -191,11 +191,11 @@ CONTAINS ! PURPOSE ! Sets(gets) fill value for a dataset creation property list ! -! INPUTS +! Inputs: ! prp_id - dataset creation property list identifier ! type_id - datatype identifier for fill value ! fillvalue - fill value -! OUTPUTS +! Outputs: ! type_id - datatype identifier for fill value ! fillvalue - fill value ! hdferr: - error code @@ -219,7 +219,7 @@ CONTAINS ! h5pset(get)fill_value_f function is overloaded to support ! INTEGER, REAL, DOUBLE PRECISION and CHARACTER dtatypes. ! -! SOURCE +! Signature: SUBROUTINE h5pset_fill_value_integer(prp_id, type_id, fillvalue, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -382,18 +382,18 @@ CONTAINS ! PURPOSE ! Sets a property list value ! -! INPUTS +! Inputs: ! prp_id - iproperty list identifier to modify ! name - name of property to modify ! value - value to set property to -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 ! AUTHOR ! Elena Pourmal ! October 9, 2002 -! SOURCE +! Signature: SUBROUTINE h5pset_integer(prp_id, name, value, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -421,18 +421,18 @@ CONTAINS ! PURPOSE ! Sets a property list value ! -! INPUTS +! Inputs: ! prp_id - iproperty list identifier to modify ! name - name of property to modify ! value - value to set property to -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 ! AUTHOR ! Elena Pourmal ! October 9, 2002 -! SOURCE +! Signature: SUBROUTINE h5pset_real(prp_id, name, value, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -460,21 +460,21 @@ CONTAINS ! PURPOSE ! Sets a property list value ! -! INPUTS +! Inputs: ! prp_id - iproperty list identifier to modify ! name - name of property to modify ! value - value to set property to -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 -! OPTIONAL PARAMETERS +! Optional parameters: ! NONE ! ! AUTHOR ! Elena Pourmal ! October 9, 2002 -! SOURCE +! Signature: SUBROUTINE h5pset_char(prp_id, name, value, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -522,10 +522,10 @@ CONTAINS ! PURPOSE ! Gets a property list value ! -! INPUTS +! Inputs: ! prp_id - iproperty list identifier to modify ! name - name of property to modify -! OUTPUTS +! Outputs: ! value - value of property ! hdferr: - error code ! Success: 0 @@ -533,7 +533,7 @@ CONTAINS ! AUTHOR ! Elena Pourmal ! October 9, 2002 -! SOURCE +! Signature: SUBROUTINE h5pget_integer(prp_id, name, value, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -561,10 +561,10 @@ CONTAINS ! PURPOSE ! Gets a property list value ! -! INPUTS +! Inputs: ! prp_id - iproperty list identifier to modify ! name - name of property to modify -! OUTPUTS +! Outputs: ! value - value of property ! hdferr: - error code ! Success: 0 @@ -573,7 +573,7 @@ CONTAINS ! AUTHOR ! Elena Pourmal ! October 9, 2002 -! SOURCE +! Signature: SUBROUTINE h5pget_real(prp_id, name, value, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -600,10 +600,10 @@ CONTAINS ! PURPOSE ! Gets a property list value ! -! INPUTS +! Inputs: ! prp_id - iproperty list identifier to modify ! name - name of property to modify -! OUTPUTS +! Outputs: ! value - value of property ! hdferr: - error code ! Success: 0 @@ -612,7 +612,7 @@ CONTAINS ! ! Elena Pourmal ! October 9, 2002 -! SOURCE +! Signature: SUBROUTINE h5pget_char(prp_id, name, value, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -685,14 +685,14 @@ CONTAINS ! PURPOSE ! Registers a permanent property with a property list class. ! -! INPUTS +! Inputs: ! class - property list class to register ! permanent property within ! name - name of property to register ! size - size of property in bytes ! value - default value for property in newly ! created property lists -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 @@ -700,7 +700,7 @@ CONTAINS ! Elena Pourmal ! October 10, 2002 ! -! SOURCE +! Signature: SUBROUTINE h5pregister_integer(class, name, size, value, hdferr) USE ISO_C_BINDING IMPLICIT NONE @@ -729,21 +729,21 @@ CONTAINS ! PURPOSE ! Registers a permanent property with a property list class. ! -! INPUTS +! Inputs: ! class - property list class to register ! permanent property within ! name - name of property to register ! size - size of property in bytes ! value - default value for property in newly ! created property lists -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 ! AUTHOR ! Elena Pourmal ! October 10, 2002 -! SOURCE +! Signature: SUBROUTINE h5pregister_real(class, name, size, value, hdferr) USE ISO_C_BINDING IMPLICIT NONE @@ -772,14 +772,14 @@ CONTAINS ! PURPOSE ! Registers a permanent property with a property list class. ! -! INPUTS +! Inputs: ! class - property list class to register ! permanent property within ! name - name of property to register ! size - size of property in bytes ! value - default value for property in newly ! created property lists -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 @@ -787,7 +787,7 @@ CONTAINS ! Elena Pourmal ! October 10, 2002 ! -! SOURCE +! Signature: SUBROUTINE h5pregister_char(class, name, size, value, hdferr) USE ISO_C_BINDING IMPLICIT NONE @@ -834,21 +834,21 @@ CONTAINS ! PURPOSE ! Registers a permanent property with a property list class. ! -! INPUTS +! Inputs: ! class - property list class to register ! permanent property within ! name - name of property to register ! size - size of property in bytes ! value - default value for property in newly ! created property lists -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 ! AUTHOR ! M. Scot Breitenfeld ! June 24, 2008 -! SOURCE +! Signature: SUBROUTINE h5pregister_ptr(class, name, size, value, hdferr) USE ISO_C_BINDING IMPLICIT NONE @@ -873,12 +873,12 @@ CONTAINS ! PURPOSE ! Registers a temporary property with a property list class. ! -! INPUTS +! Inputs: ! plist - property list identifier ! name - name of property to insert ! size - size of property in bytes ! value - initial value for the property -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 @@ -886,7 +886,7 @@ CONTAINS ! Elena Pourmal ! October 10, 2002 ! -! SOURCE +! Signature: SUBROUTINE h5pinsert_integer(plist, name, size, value, hdferr) USE iso_c_binding IMPLICIT NONE @@ -914,20 +914,20 @@ CONTAINS ! PURPOSE ! Registers a temporary property with a property list class. ! -! INPUTS +! Inputs: ! plist - property list identifier ! permanent property within ! name - name of property to insert ! size - size of property in bytes ! value - initial value for the property -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 ! AUTHOR ! Elena Pourmal ! October 10, 2002 -! SOURCE +! Signature: SUBROUTINE h5pinsert_real(plist, name, size, value, hdferr) USE iso_c_binding IMPLICIT NONE @@ -956,20 +956,20 @@ CONTAINS ! PURPOSE ! Registers a temporary property with a property list class. ! -! INPUTS +! Inputs: ! plist - property list identifier ! permanent property within ! name - name of property to insert ! size - size of property in bytes ! value - initial value for the property -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 ! AUTHOR ! Elena Pourmal ! October 10, 2002 -! SOURCE +! Signature: SUBROUTINE h5pinsert_char(plist, name, size, value, hdferr) USE iso_c_binding IMPLICIT NONE @@ -1018,20 +1018,20 @@ CONTAINS ! PURPOSE ! Registers a temporary property with a property list class. ! -! INPUTS +! Inputs: ! plist - property list identifier ! permanent property within ! name - name of property to insert ! size - size of property in bytes ! value - initial value for the property -! OUTPUTS +! Outputs: ! hdferr: - error code ! Success: 0 ! Failure: -1 ! AUTHOR ! M. Scot Breitenfeld ! June 24, 2008 -! SOURCE +! Signature: SUBROUTINE h5pinsert_ptr(plist, name, size, value, hdferr) USE iso_c_binding IMPLICIT NONE @@ -1056,7 +1056,7 @@ CONTAINS ! PURPOSE ! Create a new property list class ! -! INPUTS +! Inputs: ! parent - Property list identifier of the parent class ! Possible values include: ! H5P_ROOT_F @@ -1066,13 +1066,13 @@ CONTAINS ! H5P_DATASET_XFER_F ! H5P_FILE_MOUNT_F ! name - name of the class we are creating -! OUTPUTS +! Outputs: ! class - porperty list class identifier ! hdferr: - error code ! ! Success: 0 ! Failure: -1 -! OPTIONAL PARAMETERS +! Optional parameters: ! H5P_cls_create_func_t (create) - Callback routine called when a property list is created ! create_data - User pointer to any class creation information needed ! H5P_cls_copy_func_t (copy) - Callback routine called when a property list is copied @@ -1088,7 +1088,7 @@ CONTAINS ! Added callback arguments ! M. Scot Breitenfeld, July 3, 2008 ! -! SOURCE +! Signature: SUBROUTINE h5pcreate_class_f(parent, name, class, hdferr, create, create_data, copy, copy_data, close, close_data) USE iso_c_binding IMPLICIT NONE diff --git a/fortran/src/H5Rff_F03.f90 b/fortran/src/H5Rff_F03.f90 index cc31ab4..7f66745 100644 --- a/fortran/src/H5Rff_F03.f90 +++ b/fortran/src/H5Rff_F03.f90 @@ -133,10 +133,10 @@ CONTAINS ! PURPOSE ! Creates reference to the object ! -! INPUTS +! Inputs: ! loc_id - location identifier ! name - name of the object at the specified location -! OUTPUTS +! Outputs: ! ref - reference to the specified object ! hdferr: - error code ! Success: 0 @@ -153,7 +153,7 @@ CONTAINS ! NOTES ! This is a module procedure for the h5rcreate_f subroutine. ! -! SOURCE +! Signature: SUBROUTINE h5rcreate_object_f(loc_id, name, ref, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -183,11 +183,11 @@ CONTAINS ! PURPOSE ! Creates reference to the dataset region ! -! INPUTS +! Inputs: ! loc_id - location identifier ! name - name of the dataset at the specified location ! space_id - dataspace identifier that describes selected region -! OUTPUTS +! Outputs: ! ref - reference to the dataset region ! hdferr: - error code ! Success: 0 @@ -205,7 +205,7 @@ CONTAINS ! NOTES ! This is a module procedure for the h5rcreate_f subroutine. ! -! SOURCE +! Signature: SUBROUTINE h5rcreate_region_f(loc_id, name, space_id, ref, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -256,13 +256,13 @@ CONTAINS ! PURPOSE ! Creates a reference. ! -! INPUTS +! Inputs: ! loc_id - location identifier ! name - name of the dataset at the specified location ! ref_type - type of reference: ! H5R_OBJECT ! H5T_STD_REF_DSETREG -! OUTPUTS +! Outputs: ! ref - reference created by the function call. ! hdferr - error code ! Success: 0 @@ -278,7 +278,7 @@ CONTAINS ! This is a module procedure for the h5rcreate_f ! subroutine where the output is a pointer. ! -! SOURCE +! Signature: SUBROUTINE h5rcreate_ptr_f(loc_id, name, ref_type, ref, hdferr, space_id) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -307,11 +307,11 @@ CONTAINS ! PURPOSE ! Opens the HDF5 object referenced ! -! INPUTS +! Inputs: ! dset_id - identifier of the dataset containing ! reference ! ref - reference to open -! OUTPUTS +! Outputs: ! obj_id - object_identifier ! hdferr: - error code ! Success: 0 @@ -328,7 +328,7 @@ CONTAINS ! NOTES ! This is a module procedure for the h5rdereference_f subroutine. ! -! SOURCE +! Signature: SUBROUTINE h5rdereference_object_f(obj_id, ref, ref_obj_id, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -352,11 +352,11 @@ CONTAINS ! PURPOSE ! Opens the dataset region ! -! INPUTS +! Inputs: ! dset_id - identifier of the dataset containing ! reference to teh regions ! ref - reference to open -! OUTPUTS +! Outputs: ! obj_id - dataspace identifier ! hdferr: - error code ! Success: 0 @@ -374,7 +374,7 @@ CONTAINS ! NOTES ! This is a module procedure for the h5rdereference_f subroutine. ! -! SOURCE +! Signature: SUBROUTINE h5rdereference_region_f(obj_id, ref, ref_obj_id, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -398,12 +398,12 @@ CONTAINS ! PURPOSE ! Opens the HDF5 object referenced. ! -! INPUTS +! Inputs: ! obj_id - valid identifier for the file containing the ! referenced object or any object in that file. ! ref_type - the reference type of ref. ! ref - Reference to open. -! OUTPUTS +! Outputs: ! ref_obj_id - identifier of referenced object ! hdferr - error code ! Success: 0 @@ -416,7 +416,7 @@ CONTAINS ! This is a module procedure for the h5rdereference_f ! subroutine using pointers. ! -! SOURCE +! Signature: SUBROUTINE h5rdereference_ptr_f(obj_id, ref_type, ref, ref_obj_id, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -440,25 +440,25 @@ CONTAINS ! PURPOSE ! Retrieves a name of a referenced object. ! -! INPUTS +! Inputs: ! loc_id - Identifier for the dataset containing the reference or for the group that dataset is in. ! ref - An object or dataset region reference. ! -! OUTPUTS +! Outputs: ! name - A name associated with the referenced object or dataset region. ! ! hdferr: - error code ! Success: 0 ! Failure: -1 ! -! OPTIONAL PARAMETERS +! Optional parameters: ! size - The size of the name buffer. ! ! AUTHOR ! M. Scot Breitenfeld ! March 28, 2008 ! -! SOURCES +! Signature:S SUBROUTINE h5rget_name_object_f(loc_id, ref, name, hdferr, size) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -495,25 +495,25 @@ CONTAINS ! PURPOSE ! Retrieves a name of a dataset region. ! -! INPUTS +! Inputs: ! loc_id - Identifier for the dataset containing the reference or ! for the group that dataset is in. ! ref - An object or dataset region reference. ! -! OUTPUTS +! Outputs: ! name - A name associated with the referenced object or dataset region. ! hdferr - error code ! Success: 0 ! Failure: -1 ! -! OPTIONAL PARAMETERS +! Optional parameters: ! size - The size of the name buffer. ! ! AUTHOR ! M. Scot Breitenfeld ! March 28, 2008 ! -! SOURCE +! Signature: SUBROUTINE h5rget_name_region_f(loc_id, ref, name, hdferr, size) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -548,27 +548,27 @@ CONTAINS ! PURPOSE ! Retrieves a name of a referenced object. ! - ! INPUTS + ! Inputs: ! loc_id - Identifier for the dataset containing the reference or ! for the group that dataset is in. ! ref_type - Type of reference. ! ref - An object or dataset region reference. ! - ! OUTPUTS + ! Outputs: ! name - A name associated with the referenced object or dataset ptr. ! ! hdferr - error code ! Success: 0 ! Failure: -1 ! - ! OPTIONAL PARAMETERS + ! Optional parameters: ! size - The size of the name buffer. ! ! AUTHOR ! M. Scot Breitenfeld ! March 28, 2008 ! - ! SOURCE + ! Signature: SUBROUTINE h5rget_name_ptr_f(loc_id, ref_type, ref, name, hdferr, size) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE @@ -601,13 +601,13 @@ CONTAINS ! PURPOSE ! Retrieves the type of object that an object reference points to. ! - ! INPUTS + ! Inputs: ! loc_id - Identifier for the dataset containing the reference or ! for the group that dataset is in. ! ref_type - Type of reference to query. ! ref - Reference to query. ! - ! OUTPUTS + ! Outputs: ! obj_type - Type of referenced object. ! H5G_UNKNOWN_F (-1) ! H5G_LINK_F 0 @@ -623,7 +623,7 @@ CONTAINS ! M. Scot Breitenfeld ! Decemeber 17, 2008 ! - ! SOURCE + ! Signature: SUBROUTINE h5rget_obj_type_f(loc_id, ref_type, ref, obj_type, hdferr) USE, INTRINSIC :: ISO_C_BINDING IMPLICIT NONE diff --git a/fortran/src/H5Tff_F03.f90 b/fortran/src/H5Tff_F03.f90 index 925a5a8..01600a0 100644 --- a/fortran/src/H5Tff_F03.f90 +++ b/fortran/src/H5Tff_F03.f90 @@ -53,7 +53,7 @@ CONTAINS ! PURPOSE ! Converts data from between specified datatypes. ! -! INPUTS +! Inputs: ! src_id - Identifier for the source datatype. ! dst_id - Identifier for the destination datatype. ! nelmts - Size of array buf. @@ -61,7 +61,7 @@ CONTAINS ! background - Optional background buffer. ! plist_id - Dataset transfer property list identifier. ! -! OUTPUTS +! Outputs: ! buf - Array containing post-conversion values. ! hdferr - error code: ! 0 on success and -1 on failure @@ -69,7 +69,7 @@ CONTAINS ! M. Scot Breitenfeld ! Decemember 8, 2008 ! -! SOURCE +! Signature: SUBROUTINE h5tconvert_f(src_id, dst_id, nelmts, buf, hdferr, background, plist_id) USE ISO_C_BINDING IMPLICIT NONE diff --git a/fortran/src/H5_ff_F03.f90 b/fortran/src/H5_ff_F03.f90 index 57b186d..3a1bc59 100644 --- a/fortran/src/H5_ff_F03.f90 +++ b/fortran/src/H5_ff_F03.f90 @@ -42,18 +42,18 @@ CONTAINS ! PURPOSE ! Computes the offset in memory ! -! INPUTS +! Inputs: ! start - starting pointer address ! end - ending pointer address ! -! OUTPUTS +! Outputs: ! offset - offset ! ! AUTHOR ! M. Scot Breitenfeld ! Augest 25, 2008 ! -! SOURCE +! Signature: FUNCTION h5offsetof(start,end) RESULT(offset) USE, INTRINSIC :: ISO_C_BINDING USE H5GLOBAL -- cgit v0.12