Misc. Fortran Doxygen updates (#2129)

4 files changed, 106 insertions, 4 deletions

diff --git a/hl/fortran/src/H5DSff.F90 b/hl/fortran/src/H5DSff.F90
index dcc6ed0..73d62b1 100644
--- a/hl/fortran/src/H5DSff.F90
+++ b/hl/fortran/src/H5DSff.F90
@@ -50,6 +50,8 @@ CONTAINS
 !! \param errcode \fortran_error
 !! \param dimname The dimension name
 !!
+!! See C API: @ref herr_t H5DSset_scale(hid_t dsid, const char *dimname);
+!!
   SUBROUTINE H5DSset_scale_f( dsid, errcode, dimname)
 
     IMPLICIT NONE
@@ -91,6 +93,8 @@ CONTAINS
 !! \param idx     The dimension of \p did that \p dsid is associated with.
 !! \param errcode \fortran_error
 !!
+!! See C API: @ref herr_t H5DSattach_scale(hid_t did, hid_t dsid, unsigned int idx);
+!!
   SUBROUTINE H5DSattach_scale_f( did, dsid, idx, errcode)
 
     IMPLICIT NONE
@@ -129,6 +133,8 @@ CONTAINS
 !! \param errcode \fortran_error
 !!
 
+!! See C API: @ref herr_t H5DSdetach_scale(hid_t did, hid_t dsid, unsigned int idx);
+!!
   SUBROUTINE H5DSdetach_scale_f( did, dsid, idx, errcode)
 
     IMPLICIT NONE
@@ -167,6 +173,8 @@ CONTAINS
 !! \param is_attached If dimension scale \p dsid is currently attached to dimension \p idx of dataset \p did.
 !! \param errcode     \fortran_error
 !!
+!! See C API: @ref  htri_t H5DSis_attached(hid_t did, hid_t dsid, unsigned int idx);
+!!
   SUBROUTINE H5DSis_attached_f( did, dsid, idx, is_attached, errcode)
 
     IMPLICIT NONE
@@ -216,6 +224,8 @@ CONTAINS
 !! \param is_scale    If is a Dimension Scale.
 !! \param errcode     \fortran_error
 !!
+!! See C API: @ref  htri_t H5DSis_scale(hid_t did);
+!!
   SUBROUTINE H5DSis_scale_f( did, is_scale, errcode)
 
     IMPLICIT NONE
@@ -256,6 +266,8 @@ CONTAINS
 !! \param label   The label.
 !! \param errcode \fortran_error
 !!
+!! See C API: @ref herr_t H5DSset_label(hid_t did, unsigned int idx, const char *label);
+!!
   SUBROUTINE H5DSset_label_f( did, idx, label, errcode)
 
     IMPLICIT NONE
@@ -299,6 +311,8 @@ CONTAINS
 !! \param size    The length of the \p label buffer.
 !! \param errcode \fortran_error
 !!
+!! See C API: @ref ssize_t H5DSget_label(hid_t did, unsigned int idx, char *label, size_t size);
+!!
   SUBROUTINE H5DSget_label_f( did, idx, label, size, errcode)
 
     IMPLICIT NONE
@@ -339,6 +353,8 @@ CONTAINS
 !! \param size    Size in bytes, of the name buffer.
 !! \param errcode \fortran_error
 !!
+!! See C API: @ref ssize_t H5DSget_scale_name(hid_t did, char *name, size_t size);
+!!
   SUBROUTINE H5DSget_scale_name_f(did, name, size, errcode)
 
     IMPLICIT NONE
@@ -374,6 +390,8 @@ CONTAINS
 !! \param num_scales Number of Dimension Scales associated with \p did.
 !! \param errcode    \fortran_error
 !!
+!! See C API: @ref int H5DSget_num_scales(hid_t did, unsigned int idx);
+!!
   SUBROUTINE H5DSget_num_scales_f( did, idx, num_scales, errcode)
 
     IMPLICIT NONE
diff --git a/hl/fortran/src/H5IMff.F90 b/hl/fortran/src/H5IMff.F90
index 967c35d..d8d5366 100644
--- a/hl/fortran/src/H5IMff.F90
+++ b/hl/fortran/src/H5IMff.F90
@@ -51,6 +51,8 @@ CONTAINS
 !! \param buf       Buffer with data to be written to the dataset
 !! \param errcode   \fortran_error
 !!
+!! See C API: @ref herr_t H5IMmake_image_8bit(hid_t loc_id, const char *dset_name, hsize_t width, hsize_t height, const unsigned char *buffer);
+!!
   SUBROUTINE h5immake_image_8bit_f(loc_id,&
        dset_name,&
        width,&
@@ -98,6 +100,8 @@ CONTAINS
 !! \param buf       Buffer with data to store the image.
 !! \param errcode   \fortran_error
 !!
+!! See C API: @ref herr_t H5IMread_image(hid_t loc_id, const char *dset_name, unsigned char *buffer);
+!!
   SUBROUTINE h5imread_image_f(loc_id,&
        dset_name,&
        buf,&
@@ -142,7 +146,9 @@ CONTAINS
 !! \param buf       Buffer with data to be written to the dataset.
 !! \param errcode   \fortran_error
 !!
-  SUBROUTINE h5immake_image_24bit_f(loc_id, dset_name, width, height, il, buf, errcode )
+!! See C API: @ref herr_t H5IMmake_image_24bit(hid_t loc_id, const char *dset_name, hsize_t width, hsize_t height, const char *interlace, const unsigned char *buffer);
+!!
+  SUBROUTINE h5immake_image_24bit_f(loc_id, dset_name, width, height, il, buf, errcode)
 
     IMPLICIT NONE
 
@@ -194,6 +200,8 @@ CONTAINS
 !! \param npals     The number of palettes associated to the image.
 !! \param errcode   \fortran_error
 !!
+!! See C API: @ref herr_t H5IMget_image_info(hid_t loc_id, const char *dset_name, hsize_t *width, hsize_t *height, hsize_t *planes, char *interlace, hssize_t *npals);
+!!
   SUBROUTINE h5imget_image_info_f(loc_id,&
        dset_name,&
        width,&
@@ -248,6 +256,8 @@ CONTAINS
 !! \param loc_id    Location identifier. The identifier may be that of a file or group.
 !! \param dset_name The name of the dataset.
 !!
+!! See C API: @ref herr_t H5IMis_image(hid_t loc_id, const char *dset_name);
+!!
   INTEGER FUNCTION h5imis_image_f(loc_id, dset_name)
 
     IMPLICIT NONE
@@ -286,6 +296,8 @@ CONTAINS
 !! \param pal_data Buffer with data to be written to the dataset.
 !! \param errcode  \fortran_error
 !!
+!! See C API: @ref herr_t H5IMmake_palette(hid_t loc_id, const char *pal_name, const hsize_t *pal_dims, const unsigned char *pal_data);
+!!
   SUBROUTINE h5immake_palette_f(loc_id,&
        pal_name,&
        pal_dims,&
@@ -330,6 +342,8 @@ CONTAINS
 !! \param pal_name   The name of the palette.
 !! \param errcode    \fortran_error
 !!
+!! See C API: @ref herr_t H5IMlink_palette(hid_t loc_id, const char *image_name, const char *pal_name);
+!!
   SUBROUTINE h5imlink_palette_f(loc_id,&
        image_name,&
        pal_name,&
@@ -373,7 +387,9 @@ CONTAINS
 !! \param image_name The name of the image dataset.
 !! \param pal_name   The name of the palette.
 !! \param errcode    \fortran_error
-
+!!
+!! See C API: @ref herr_t H5IMunlink_palette(hid_t loc_id, const char *image_name, const char *pal_name);
+!!
   SUBROUTINE h5imunlink_palette_f(loc_id,&
        image_name,&
        pal_name,&
@@ -418,6 +434,8 @@ CONTAINS
 !! \param npals      The number of palettes.
 !! \param errcode    \fortran_error
 !!
+!! See C API: @ref herr_t H5IMget_npalettes(hid_t loc_id, const char *image_name, hssize_t *npals);
+!!
   SUBROUTINE h5imget_npalettes_f(loc_id,&
        image_name,&
        npals,&
@@ -448,6 +466,7 @@ CONTAINS
     errcode = h5imget_npalettes_c(loc_id,namelen,image_name,npals)
 
   END SUBROUTINE h5imget_npalettes_f
+
 !>
 !! \ingroup FH5IM
 !!
@@ -459,6 +478,8 @@ CONTAINS
 !! \param pal_dims   The dimensions of the palette dataset.
 !! \param  errcode   \fortran_error
 !!
+!! See C API: @ref herr_t H5IMget_palette_info(hid_t loc_id, const char *image_name, int pal_number, hsize_t *pal_dims);
+!!
   SUBROUTINE h5imget_palette_info_f(loc_id,&
        image_name,&
        pal_number,&
@@ -504,6 +525,8 @@ CONTAINS
 !! \param pal_data   The palette dataset.
 !! \param errcode    \fortran_error
 !!
+!! See C API: @ref herr_t H5IMget_palette_info(hid_t loc_id, const char *image_name, int pal_number, hsize_t *pal_dims);
+!!
   SUBROUTINE h5imget_palette_f(loc_id,&
        image_name,&
        pal_number,&
@@ -546,6 +569,8 @@ CONTAINS
 !! \param loc_id    Location identifier. The identifier may be that of a file or group.
 !! \param dset_name The name of the dataset.
 !!
+!! See C API: @ref herr_t H5IMis_palette(hid_t loc_id, const char *dset_name);
+!!
   INTEGER FUNCTION h5imis_palette_f(loc_id, dset_name)
 
     IMPLICIT NONE
diff --git a/hl/fortran/src/H5LTff.F90 b/hl/fortran/src/H5LTff.F90
index 3b50ad8..2469dbb 100644
--- a/hl/fortran/src/H5LTff.F90
+++ b/hl/fortran/src/H5LTff.F90
@@ -146,6 +146,8 @@ CONTAINS
   !! \param buf       Buffer with data to be written to the dataset.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTmake_dataset(hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, hid_t type_id, const void *buffer);
+  !!
   SUBROUTINE h5ltmake_dataset_f(&
 #else
   SUBROUTINE h5ltmake_dataset_f_ptr( &
@@ -193,6 +195,8 @@ CONTAINS
   !! \param buf       Buffer with data to be written to the dataset.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTmake_dataset(hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, hid_t type_id, const void *buffer);
+  !!
    SUBROUTINE h5ltmake_dataset_f(&
 #else
   SUBROUTINE h5ltmake_dataset_f_int1(&
@@ -385,6 +389,8 @@ CONTAINS
   !! \param buf       Buffer with data to be written to the dataset.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTread_dataset(hid_t loc_id, const char *dset_name, hid_t type_id, void *buffer);
+  !!
   SUBROUTINE h5ltread_dataset_f(&
 #else
   SUBROUTINE h5ltread_dataset_f_ptr(&
@@ -426,6 +432,8 @@ CONTAINS
   !! \param dims      An array of the size of each dimension. Limited to seven dimensions.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTread_dataset(hid_t loc_id, const char *dset_name, hid_t type_id, void *buffer);
+  !!
    SUBROUTINE h5ltread_dataset_f(&
 #else
   SUBROUTINE h5ltread_dataset_f_int1(&
@@ -1109,6 +1117,8 @@ CONTAINS
   !!                  This value is used by H5Screate_simple() to create the dataspace.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTset_attribute_int(hid_t loc_id, const char *obj_name, const char *attr_name, const int *buffer, size_t size);
+  !!
   SUBROUTINE h5ltset_attribute_int_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1158,6 +1168,8 @@ CONTAINS
   !!                  This value is used by H5Screate_simple() to create the dataspace.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTset_attribute_float(hid_t loc_id, const char *obj_name, const char *attr_name, const float *buffer, size_t size);
+  !!
   SUBROUTINE h5ltset_attribute_float_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1206,6 +1218,8 @@ CONTAINS
   !!                  This value is used by H5Screate_simple() to create the dataspace.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTset_attribute_double(hid_t loc_id, const char *obj_name, const char *attr_name, const double *buffer, size_t size);
+  !!
   SUBROUTINE h5ltset_attribute_double_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1253,6 +1267,8 @@ CONTAINS
   !! \param buf       Buffer with data to be written to the attribute.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTset_attribute_string(hid_t loc_id, const char *obj_name, const char *attr_name, const char *attr_data);
+  !!
   SUBROUTINE h5ltset_attribute_string_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1302,6 +1318,8 @@ CONTAINS
   !! \param SizeOf_buf_type Size of \p buf's data type, in bytes.
   !! \param errcode         \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_attribute(hid_t loc_id, const char *obj_name, const char *attr_name, hid_t mem_type_id, void *data);
+  !!
   SUBROUTINE h5ltget_attribute_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1349,6 +1367,8 @@ CONTAINS
   !! \param buf       Buffer with data to be written to the attribute.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_attribute_int(hid_t loc_id, const char *obj_name, const char *attr_name, int *data);
+  !!
   SUBROUTINE h5ltget_attribute_int_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1392,6 +1412,8 @@ CONTAINS
   !! \param buf       Buffer with data to be written to the attribute.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_attribute_float(hid_t loc_id, const char *obj_name, const char *attr_name, float *data);
+  !!
   SUBROUTINE h5ltget_attribute_float_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1434,6 +1456,8 @@ CONTAINS
   !! \param buf       Buffer with data to be written to the attribute.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_attribute_double(hid_t loc_id, const char *obj_name, const char *attr_name, double *data);
+  !!
   SUBROUTINE h5ltget_attribute_double_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1477,6 +1501,8 @@ CONTAINS
   !! \param buf       Buffer with data to be written to the attribute.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_attribute_string(hid_t loc_id, const char *obj_name, const char *attr_name, char *data);
+  !!
   SUBROUTINE h5ltget_attribute_string_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1531,6 +1557,8 @@ CONTAINS
   !! \param rank      The dimensionality of the dataset.
   !! \param errcode   \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_dataset_ndims(hid_t loc_id, const char *dset_name, int *rank);
+  !!
   SUBROUTINE h5ltget_dataset_ndims_f(loc_id,&
        dset_name,&
        rank,&
@@ -1571,8 +1599,9 @@ CONTAINS
   !!
   !! \result Returns zero (false), a positive (true) or a negative (failure) value.
   !!
-  INTEGER FUNCTION h5ltfind_dataset_f(loc_id,&
-       dset_name)
+  !! See C API: @ref herr_t H5LTfind_dataset(hid_t loc_id, const char *name);
+  !!
+  INTEGER FUNCTION h5ltfind_dataset_f(loc_id, dset_name)
 
     IMPLICIT NONE
     INTEGER(hid_t),   INTENT(in) :: loc_id
@@ -1610,6 +1639,8 @@ CONTAINS
   !! \param type_size  The size of the datatype in bytes.
   !! \param errcode    \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_dataset_info(hid_t loc_id, const char *dset_name, hsize_t *dims, H5T_class_t *type_class, size_t *type_size);
+  !!
   SUBROUTINE h5ltget_dataset_info_f(loc_id,&
        dset_name,&
        dims,&
@@ -1662,6 +1693,8 @@ CONTAINS
   !! \param rank       The dimensionality of the attribute.
   !! \param errcode    \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_attribute_ndims(hid_t loc_id, const char *obj_name, const char *attr_name, int *rank);
+  !!
   SUBROUTINE h5ltget_attribute_ndims_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1711,6 +1744,8 @@ CONTAINS
   !! \param type_size  The size of the datatype in bytes.
   !! \param errcode    \fortran_error
   !!
+  !! See C API: @ref herr_t H5LTget_attribute_info(hid_t loc_id, const char *obj_name, const char *attr_name, hsize_t *dims, H5T_class_t *type_class, size_t *type_size);
+  !!
   SUBROUTINE h5ltget_attribute_info_f(loc_id,&
        obj_name,&
        attr_name,&
@@ -1764,6 +1799,8 @@ CONTAINS
   !! \param path_valid          Object status.
   !! \param errcode             \fortran_error
   !!
+  !! See C API: @ref htri_t H5LTpath_valid(hid_t loc_id, const char *path, hbool_t check_object_valid);
+  !!
   SUBROUTINE h5ltpath_valid_f(loc_id, path, check_object_valid, path_valid, errcode)
 
     IMPLICIT NONE
diff --git a/hl/fortran/src/H5TBff.F90 b/hl/fortran/src/H5TBff.F90
index 52af33f..9985ab8 100644
--- a/hl/fortran/src/H5TBff.F90
+++ b/hl/fortran/src/H5TBff.F90
@@ -216,6 +216,8 @@ CONTAINS
 !! \param compress      Flag that turns compression on or off.
 !! \param errcode       \fortran_error
 !!
+!! See C API: @ref herr_t H5TBmake_table(const char *table_title, hid_t loc_id, const char *dset_name, hsize_t nfields, hsize_t nrecords, size_t type_size, const char *field_names[], const size_t *field_offset, const hid_t *field_types, hsize_t chunk_size, void *fill_data, int compress, const void *buf);
+!!
 #ifdef H5_DOXYGEN_FORTRAN
   SUBROUTINE h5tbmake_table_f(&
 #else
@@ -333,6 +335,8 @@ CONTAINS
 !! \param data	        Buffer with data to be written to the table
 !! \param errcode       \fortran_error
 !!
+!! See C API: @ref herr_t H5TBmake_table(const char *table_title, hid_t loc_id, const char *dset_name, hsize_t nfields, hsize_t nrecords, size_t type_size, const char *field_names[], const size_t *field_offset, const hid_t *field_types, hsize_t chunk_size, void *fill_data, int compress, const void *buf);
+!!
 #ifdef H5_DOXYGEN_FORTRAN
   SUBROUTINE h5tbmake_table_f(&
 #else
@@ -450,6 +454,8 @@ CONTAINS
 !! \param dst_buf    Pointer to buffer with data.
 !! \param errcode    \fortran_error
 !!
+!! See C API: @ref herr_t H5TBread_table(hid_t loc_id, const char *dset_name, size_t dst_size, const size_t *dst_offset, const size_t *dst_sizes, void *dst_buf);
+!!
   SUBROUTINE h5tbread_table_f(loc_id, dset_name, nfields, dst_size, dst_offset, &
        dst_sizes, dst_buf, errcode)
 
@@ -519,6 +525,8 @@ CONTAINS
 !! \param buf         Buffer with data.
 !! \param errcode     \fortran_error
 !!
+!! See similar C API: @ref herr_t H5TBwrite_fields_name(hid_t loc_id, const char *dset_name, const char *field_names, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, const void *buf);
+!!
   SUBROUTINE h5tbwrite_field_name_f(&
 #else
   SUBROUTINE h5tbwrite_field_name_f_int(&
@@ -609,6 +617,8 @@ CONTAINS
 !! \param buf         Buffer with data
 !! \param errcode     \fortran_error
 !!
+!! See similar C API: @ref herr_t H5TBread_fields_name(hid_t loc_id, const char *dset_name, const char *field_names, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, void *buf);
+!!
   SUBROUTINE h5tbread_field_name_f(&
 #else
   SUBROUTINE h5tbread_field_name_f_int(&
@@ -701,6 +711,8 @@ CONTAINS
 !! \param buf	       Buffer with data.
 !! \param errcode      \fortran_error
 !!
+!! See similar C API: herr_t H5TBwrite_fields_index(hid_t loc_id, const char *dset_name, hsize_t nfields, const int *field_index, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, const void *buf);
+!!
   SUBROUTINE h5tbwrite_field_index_f(&
 #else
   SUBROUTINE h5tbwrite_field_index_f_int(&
@@ -787,6 +799,8 @@ CONTAINS
 !! \param buf          Buffer with data.
 !! \param errcode      \fortran_error
 !!
+!! See similar C API: herr_t H5TBread_fields_index(hid_t loc_id, const char *dset_name, hsize_t nfields, const int *field_index, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes,void *buf);
+!!
   SUBROUTINE h5tbread_field_index_f(&
 #else
   SUBROUTINE h5tbread_field_index_f_int(&
@@ -870,6 +884,8 @@ CONTAINS
 !! \param buf	     Buffer with data.
 !! \param errcode    \fortran_error
 !!
+!! See C API: @ref herr_t H5TBinsert_field(hid_t loc_id, const char *dset_name, const char *field_name, hid_t field_type, hsize_t position, const void *fill_data, const void *buf);
+!!
   SUBROUTINE h5tbinsert_field_f(&
 #else
   SUBROUTINE h5tbinsert_field_f_int(&
@@ -952,6 +968,8 @@ CONTAINS
 !! \param field_name	The name of the field to delete.
 !! \param errcode       \fortran_error
 !!
+!! See C API: @ref herr_t H5TBdelete_field(hid_t loc_id, const char *dset_name, const char *field_name);
+!!
   SUBROUTINE h5tbdelete_field_f(loc_id,&
        dset_name,&
        field_name,&
@@ -997,6 +1015,8 @@ CONTAINS
 !! \param nrecords  The number of records.
 !! \param errcode   \fortran_error
 !!
+!! See C API: @ref herr_t H5TBget_table_info(hid_t loc_id, const char *dset_name, hsize_t *nfields, hsize_t *nrecords);
+!!
   SUBROUTINE h5tbget_table_info_f(loc_id,&
        dset_name,&
        nfields,&
@@ -1046,6 +1066,8 @@ CONTAINS
 !! \param errcode       \fortran_error
 !! \param maxlen_out    Maximum character length of the field names.
 !!
+!! See C API: @ref herr_t H5TBget_field_info(hid_t loc_id, const char *dset_name, char *field_names[], size_t *field_sizes, size_t *field_offsets, size_t *type_size);
+!!
   SUBROUTINE h5tbget_field_info_f(loc_id,&
        dset_name,&
        nfields,&