summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5_ff.F90
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2022-09-27 03:50:09 (GMT)
committerGitHub <noreply@github.com>2022-09-27 03:50:09 (GMT)
commit1c26386c38115d605a79d8c57a5df0dd181b93f3 (patch)
tree686fc53a8f361a082d792c05a607e181a91d99ab /fortran/src/H5_ff.F90
parentdcd332d2310d3f402a01ebfc187dc36101662d71 (diff)
downloadhdf5-1c26386c38115d605a79d8c57a5df0dd181b93f3.zip
hdf5-1c26386c38115d605a79d8c57a5df0dd181b93f3.tar.gz
hdf5-1c26386c38115d605a79d8c57a5df0dd181b93f3.tar.bz2
Added C references to Fortran constants. (#2126)
* added C references for Fortran APIs
Diffstat (limited to 'fortran/src/H5_ff.F90')
-rw-r--r--fortran/src/H5_ff.F9012
1 files changed, 12 insertions, 0 deletions
diff --git a/fortran/src/H5_ff.F90 b/fortran/src/H5_ff.F90
index 07705cf..1dc90c2 100644
--- a/fortran/src/H5_ff.F90
+++ b/fortran/src/H5_ff.F90
@@ -9,6 +9,18 @@
!!
!! @brief This module provides fortran specific helper functions for the HDF library.
!
+! PURPOSE
+! This module is used to pass C stubs for H5 Fortran APIs. The C stubs are
+! packed into arrays in H5_f.c and these arrays are then passed to Fortran.
+! This module then uses EQUIVALENCE to assign elements of the arrays to
+! Fortran equivalent C stubs.
+!
+! NOTES
+! The size of the C arrays in H5_f.c has to match the values of the variables
+! declared as PARAMETER, hence if the size of an array in H5_f.c is changed
+! then the PARAMETER of that corresponding array in Fortran must also be changed.
+!
+!
! COPYRIGHT
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
! Copyright by The HDF Group. *