[svn-r22243] Updated the comments for robodoc inclusion and changed spacing formatting in the source

headers, cosmetic changes only.

1 files changed, 68 insertions, 69 deletions

diff --git a/fortran/src/H5Off.f90 b/fortran/src/H5Off.f90
index 04c96e2..4f1ea18 100644
--- a/fortran/src/H5Off.f90
+++ b/fortran/src/H5Off.f90
@@ -49,33 +49,32 @@ CONTAINS
 !
 ! PURPOSE
 !  Creates a hard link to an object in an HDF5 file.
-! INPUTS
+!
+! Inputs:
 !  object_id 	 - Object to be linked.
 !  new_loc_id 	 - File or group identifier specifying location at which object is to be linked.
 !  new_link_name - Name of link to be created, relative to new_loc_id.
-! OUTPUTS
-!  hdferr:       - error code
-!                   Success:  0
-!                   Failure: -1
-! OPTIONAL PARAMETERS
+!
+! Outputs:
+!  hdferr        - Returns 0 if successful and -1 if fails.
+!
+! Optional parameters:
 !  lcpl_id 	 - Link creation property list identifier.
 !  lapl_id 	 - Link access property list identifier.
+!
 ! AUTHOR
 !  M. Scot Breitenfeld
 !  April 21, 2008
 !
-! SOURCE
+! Fortran90 Interface:
   SUBROUTINE h5olink_f(object_id, new_loc_id, new_link_name, hdferr, lcpl_id, lapl_id)
     IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: object_id  ! Object to be linked
-    INTEGER(HID_T), INTENT(IN) :: new_loc_id ! File or group identifier specifying
-                                             ! location at which object is to be linked.
-    CHARACTER(LEN=*), INTENT(IN) :: new_link_name ! Name of link to be created, relative to new_loc_id.
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          !   Success:  0
-                                          !   Failure: -1
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list identifier.
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link creation property list identifier.
+    INTEGER(HID_T)  , INTENT(IN)  :: object_id
+    INTEGER(HID_T)  , INTENT(IN)  :: new_loc_id
+    CHARACTER(LEN=*), INTENT(IN)  :: new_link_name
+    INTEGER         , INTENT(OUT) :: hdferr
+    INTEGER(HID_T)  , INTENT(IN), OPTIONAL :: lcpl_id
+    INTEGER(HID_T)  , INTENT(IN), OPTIONAL :: lapl_id
 !*****
     INTEGER(HID_T) :: lapl_id_default
     INTEGER(HID_T) :: lcpl_id_default
@@ -115,33 +114,33 @@ CONTAINS
 !
 ! NAME
 !  h5oopen_f
+!
 ! PURPOSE
 !  Opens an object in an HDF5 file by location identifier and path name.
 !
-! INPUTS
-!  loc_id 	 - File or group identifier
+! Inputs:
+!  loc_id 	 - File or group identifier.
 !  name 	 - Path to the object, relative to loc_id.
-! OUTPUTS
-!  obj_id 	 - Object identifier for the opened object
-!  hdferr:       - error code
-!                   Success:  0
-!                   Failure: -1
-! OPTIONAL PARAMETERS
-!  lapl_id 	 - Access property list identifier for the link pointing to the object
+!
+! Outputs:
+!  obj_id 	 - Object identifier for the opened object.
+!  hdferr        - Returns 0 if successful and -1 if fails.
+!
+! Optional parameters:
+!  lapl_id 	 - Access property list identifier for the link pointing to the object.
 !
 ! AUTHOR
 !  M. Scot Breitenfeld
 !  April 18, 2008
-! SOURCE
+!
+! Fortran90 Interface:
   SUBROUTINE h5oopen_f(loc_id, name, obj_id, hdferr, lapl_id)
     IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Path to the object, relative to loc_id
-    INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier for the opened object
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          !   Success:  0
-                                          !   Failure: -1
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  ! Attribute access property list
+    INTEGER(HID_T)  , INTENT(IN)  :: loc_id
+    CHARACTER(LEN=*), INTENT(IN)  :: name
+    INTEGER(HID_T)  , INTENT(OUT) :: obj_id
+    INTEGER         , INTENT(OUT) :: hdferr
+    INTEGER(HID_T)  , INTENT(IN), OPTIONAL :: lapl_id
 !*****
     INTEGER(HID_T) :: lapl_id_default
     INTEGER(SIZE_T) :: namelen
@@ -178,20 +177,21 @@ CONTAINS
 ! PURPOSE
 !  Closes an object in an HDF5 file.
 !
-! INPUTS
-!  object_id     - Object identifier
-! OUTPUTS
-!  hdferr 	 - Returns 0 if successful and -1 if fails
+! Inputs:
+!  object_id - Object identifier.
+!
+! Outputs:
+!  hdferr    - Returns 0 if successful and -1 if fails.
 !
 ! AUTHOR
 !  M. Scot Breitenfeld
 !  December 17, 2008
 !
-! SOURCE
+! Fortran90 Interface:
   SUBROUTINE h5oclose_f(object_id, hdferr)
     IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN)  :: object_id
-    INTEGER,        INTENT(OUT) :: hdferr
+    INTEGER(HID_T), INTENT(IN)   :: object_id
+    INTEGER       ,  INTENT(OUT) :: hdferr
 !*****
     INTERFACE
        INTEGER FUNCTION h5oclose_c(object_id)
@@ -214,25 +214,25 @@ CONTAINS
 ! PURPOSE
 !  Opens an object using its address within an HDF5 file. 
 !
-! INPUTS  
-!    loc_id - File or group identifier
-!    addr   - Object’s address in the file
-! OUTPUTS: 
-!    obj_id - Object identifier for the opened object
-!    hdferr - Returns 0 if successful and -1 if fails
+! Inputs:  
+!    loc_id - File or group identifier.
+!    addr   - Object’s address in the file.
+!
+! Outputs:
+!    obj_id - Object identifier for the opened object.
+!    hdferr - Returns 0 if successful and -1 if fails.
 !
 ! AUTHOR	
 !  M. Scot Breitenfeld
 !  September 14, 2009
 ! 
-! SOURCE
+! Fortran90 Interface:
   SUBROUTINE h5oopen_by_addr_f(loc_id, addr, obj_id, hdferr)
     IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! File or group identifier
-    INTEGER(HADDR_T), INTENT(IN) :: addr  ! Object’s address in the file
-    INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier for the opened object
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
+    INTEGER(HID_T)  , INTENT(IN)  :: loc_id
+    INTEGER(HADDR_T), INTENT(IN)  :: addr
+    INTEGER(HID_T)  , INTENT(OUT) :: obj_id
+    INTEGER         , INTENT(OUT) :: hdferr
 !*****
     INTERFACE
        INTEGER FUNCTION h5oopen_by_addr_c(loc_id, addr, obj_id)
@@ -249,7 +249,6 @@ CONTAINS
     hdferr = h5oopen_by_addr_c(loc_id, addr, obj_id)
 
   END SUBROUTINE h5oopen_by_addr_f
-
 !
 !****s* H5O/h5ocopy_f
 ! NAME		
@@ -258,31 +257,31 @@ CONTAINS
 ! PURPOSE
 !  Copies an object in an HDF5 file.
 !
-! INPUTS  
-!  src_loc_id - Object identifier indicating the location of the source object to be copied 
-!  src_name   - Name of the source object to be copied 
-!  dst_loc_id - Location identifier specifying the destination 
-!  dst_name   - Name to be assigned to the new copy
+! Inputs:  
+!  src_loc_id - Object identifier indicating the location of the source object to be copied.
+!  src_name   - Name of the source object to be copied.
+!  dst_loc_id - Location identifier specifying the destination.
+!  dst_name   - Name to be assigned to the new copy.
 !
-! OPTIONAL PARAMETERS
-!  ocpypl_id  - Object copy property list
-!  lcpl_id    - Link creation property list for the new hard link
+! Optional parameters:
+!  ocpypl_id  - Object copy property list.
+!  lcpl_id    - Link creation property list for the new hard link.
 !
-! OUTPUTS: 
-!  hdferr     - Returns 0 if successful and -1 if fails
+! Outputs: 
+!  hdferr     - Returns 0 if successful and -1 if fails.
 !
 ! AUTHOR	
 !  M. Scot Breitenfeld
 !  March 14, 2012
 ! 
-! SOURCE
+! Fortran90 Interface:
   SUBROUTINE h5ocopy_f(src_loc_id, src_name, dst_loc_id, dst_name, hdferr, ocpypl_id, lcpl_id)
     IMPLICIT NONE
-    INTEGER(HID_T)  , INTENT(IN) :: src_loc_id
-    CHARACTER(LEN=*), INTENT(IN) :: src_name
-    INTEGER(HID_T)  , INTENT(IN) :: dst_loc_id
-    CHARACTER(LEN=*), INTENT(IN) :: dst_name
-    INTEGER, INTENT(OUT) :: hdferr
+    INTEGER(HID_T)  , INTENT(IN)  :: src_loc_id
+    CHARACTER(LEN=*), INTENT(IN)  :: src_name
+    INTEGER(HID_T)  , INTENT(IN)  :: dst_loc_id
+    CHARACTER(LEN=*), INTENT(IN)  :: dst_name
+    INTEGER         , INTENT(OUT) :: hdferr
     INTEGER(HID_T)  , INTENT(IN), OPTIONAL :: ocpypl_id
     INTEGER(HID_T)  , INTENT(IN), OPTIONAL :: lcpl_id
 !*****