diff options
author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2011-10-13 04:10:34 (GMT) |
---|---|---|
committer | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2011-10-13 04:10:34 (GMT) |
commit | c09f1dbc244461e1063457cd31ca666c3496fb22 (patch) | |
tree | d0de8b949a84159517178a4de19f42af0b3e8c8c /fortran/src/H5_ff.f90 | |
parent | 5f8a03a2bf32889843ce71e930e68dfb0bf04f65 (diff) | |
download | hdf5-c09f1dbc244461e1063457cd31ca666c3496fb22.zip hdf5-c09f1dbc244461e1063457cd31ca666c3496fb22.tar.gz hdf5-c09f1dbc244461e1063457cd31ca666c3496fb22.tar.bz2 |
[svn-r21535] Description:
Updated to the robodoc headers comments, cleaned up the spacing of the
source code which is included in the documenaton.
Tested: jam (intel)
Diffstat (limited to 'fortran/src/H5_ff.f90')
-rw-r--r-- | fortran/src/H5_ff.f90 | 76 |
1 files changed, 33 insertions, 43 deletions
diff --git a/fortran/src/H5_ff.f90 b/fortran/src/H5_ff.f90 index fdb8748..99a82bd 100644 --- a/fortran/src/H5_ff.f90 +++ b/fortran/src/H5_ff.f90 @@ -41,6 +41,7 @@ MODULE H5LIB ! pre-Fortran 2003 - empty module ! Forttran 2003 - contains functions USE H5GLOBAL + CONTAINS !****s* H5LIB/h5open_f ! @@ -50,10 +51,9 @@ CONTAINS ! PURPOSE ! Initializes the HDF5 library and Fortran90 interface. ! -! OUTPUTS -! error - error code -! Success: 0 -! Failure: -1 +! Outputs: +! error - Returns 0 if successful and -1 if fails +! ! AUTHOR ! Elena Pourmal ! August 12, 1999 @@ -63,7 +63,7 @@ CONTAINS ! called C functions (it is needed for Windows ! port). February 28, 2001 ! -! SOURCE +! Fortran90 Interface: SUBROUTINE h5open_f(error) USE H5GLOBAL IMPLICIT NONE @@ -175,22 +175,19 @@ CONTAINS ! PURPOSE ! Closes the HDF5 library and Fortran90 interface. ! -! OUTPUTS -! error - error code -! Success: 0 -! Failure: -1 +! Outputs: +! error - 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). February 28, 2001 ! -! SOURCE +! Fortran90 Interface: SUBROUTINE h5close_f(error) USE H5GLOBAL IMPLICIT NONE @@ -237,19 +234,17 @@ CONTAINS ! PURPOSE ! Returns the HDF5 LIbrary release number ! -! OUTPUTS -! majnum - major version of the library -! minum - minor version of the library -! relnum - release version of the library -! error - error code -! Success: 0 -! Failure: -1 +! Outputs: +! majnum - major version of the library +! minum - minor version of the library +! relnum - release version of the library +! error - Returns 0 if successful and -1 if fails ! ! AUTHOR ! Elena Pourmal ! September 24, 2002 ! -! SOURCE +! Fortran90 Interface: SUBROUTINE h5get_libversion_f(majnum, minnum, relnum, error) USE H5GLOBAL IMPLICIT NONE @@ -276,24 +271,23 @@ CONTAINS ! PURPOSE ! Verifies that library versions are consistent. ! -! INPUTS -! majnum - major version of the library -! minum - minor version of the library -! relnum - release version of the library -! OUTPUTS -! error - error code -! Success: 0 -! Failure: application aborts +! Inputs: +! majnum - major version of the library +! minum - minor version of the library +! relnum - release version of the library +! +! Outputs: +! error - Returns 0 if successful and -1 if fails ! ! AUTHOR ! Elena Pourmal ! September 24, 2002 ! -! SOURCE +! Fortran90 Interface: SUBROUTINE h5check_version_f(majnum, minnum, relnum, error) USE H5GLOBAL IMPLICIT NONE - INTEGER, INTENT(IN) :: majnum, minnum, relnum + INTEGER, INTENT(IN) :: majnum, minnum, relnum INTEGER, INTENT(OUT) :: error !***** INTERFACE @@ -316,16 +310,14 @@ CONTAINS ! PURPOSE ! Garbage collects on all free-lists of all types. ! -! OUTPUTS -! error - error code -! Success: 0 -! Failure: -1 +! Outputs: +! error - Returns 0 if successful and -1 if fails ! ! AUTHOR ! Elena Pourmal ! September 24, 2002 ! -! SOURCE +! Fortran90 Interface: SUBROUTINE h5garbage_collect_f(error) USE H5GLOBAL IMPLICIT NONE @@ -350,16 +342,14 @@ CONTAINS ! PURPOSE ! Instructs library not to install atexit cleanup routine. ! -! OUTPUTS -! error - error code -! Success: 0 -! Failure: -1 +! Outputs: +! error - Returns 0 if successful and -1 if fails ! ! AUTHOR ! Elena Pourmal ! September 24, 2002 ! -! SOURCE +! Fortran90 Interface: SUBROUTINE h5dont_atexit_f(error) USE H5GLOBAL IMPLICIT NONE @@ -385,19 +375,19 @@ CONTAINS ! PURPOSE ! Converts the KIND to the correct HDF type ! -! INPUTS +! Inputs: ! kind - Fortran KIND parameter ! flag - whether KIND is of type INTEGER or REAL: ! H5_INTEGER_KIND - integer ! H5_REAL_KIND - real -! OUTPUTS +! Outputs: ! h5_type - returns the type ! ! AUTHOR ! M. Scot Breitenfeld -! Augest 25, 2008 +! August 25, 2008 ! -! SOURCE +! Fortran90 Interface: INTEGER(HID_T) FUNCTION h5kind_to_type(kind, flag) RESULT(h5_type) USE H5GLOBAL IMPLICIT NONE |