develop Merge doxygen from 1.12 branch (#2095)

4 files changed, 59 insertions, 62 deletions

diff --git a/hl/fortran/src/H5DSff.F90 b/hl/fortran/src/H5DSff.F90
index bb80eb7..dcc6ed0 100644
--- a/hl/fortran/src/H5DSff.F90
+++ b/hl/fortran/src/H5DSff.F90
@@ -1,6 +1,6 @@
-!> @defgroup FH5DS Fortran High-level H5DS Interface
+!> @defgroup FH5DS Fortran High Level Dimension Scales (H5DS) Interface
 !!
-!! @see H5DS, C-API
+!! @see H5DS, C-HL API
 !!
 !! @see @ref H5DS_UG, User Guide
 !!
@@ -40,6 +40,7 @@ MODULE H5DS
   USE hdf5
 
 CONTAINS
+
 !>
 !! \ingroup FH5DS
 !!
@@ -47,7 +48,7 @@ CONTAINS
 !!
 !! \param dsid    The dataset to be made a Dimemsion Scale.
 !! \param errcode \fortran_error
-!! \param dimname The dimension name.
+!! \param dimname The dimension name
 !!
   SUBROUTINE H5DSset_scale_f( dsid, errcode, dimname)
 
@@ -55,7 +56,7 @@ CONTAINS
 
     INTEGER(hid_t),   INTENT(in) :: dsid
     CHARACTER(LEN=*), INTENT(in), OPTIONAL :: dimname
-    INTEGER :: errcode 
+    INTEGER :: errcode
 
     INTEGER(SIZE_T) :: dimname_len ! length of dimname (if present)
 
@@ -88,7 +89,7 @@ CONTAINS
 !! \param did     The dataset.
 !! \param dsid    The scale to be attached.
 !! \param idx     The dimension of \p did that \p dsid is associated with.
-!! \param errcode \fortran_error 
+!! \param errcode \fortran_error
 !!
   SUBROUTINE H5DSattach_scale_f( did, dsid, idx, errcode)
 
@@ -125,7 +126,7 @@ CONTAINS
 !! \param did     The dataset.
 !! \param dsid    The scale to be detached.
 !! \param idx     The dimension of \p did to detach.
-!! \param errcode \fortran_error 
+!! \param errcode \fortran_error
 !!
 
   SUBROUTINE H5DSdetach_scale_f( did, dsid, idx, errcode)
@@ -164,7 +165,7 @@ CONTAINS
 !! \param dsid        The scale to be attached.
 !! \param idx         The dimension of \p did that \p dsid is associated with.
 !! \param is_attached If dimension scale \p dsid is currently attached to dimension \p idx of dataset \p did.
-!! \param errcode     \fortran_error 
+!! \param errcode     \fortran_error
 !!
   SUBROUTINE H5DSis_attached_f( did, dsid, idx, is_attached, errcode)
 
@@ -213,7 +214,7 @@ CONTAINS
 !!
 !! \param did         The data set to query.
 !! \param is_scale    If is a Dimension Scale.
-!! \param errcode     \fortran_error 
+!! \param errcode     \fortran_error
 !!
   SUBROUTINE H5DSis_scale_f( did, is_scale, errcode)
 
@@ -253,7 +254,7 @@ CONTAINS
 !! \param did     The data set.
 !! \param idx     The dimension.
 !! \param label   The label.
-!! \param errcode \fortran_error 
+!! \param errcode \fortran_error
 !!
   SUBROUTINE H5DSset_label_f( did, idx, label, errcode)
 
@@ -296,7 +297,7 @@ CONTAINS
 !! \param idx     The dimension.
 !! \param label   The label.
 !! \param size    The length of the \p label buffer.
-!! \param errcode \fortran_error 
+!! \param errcode \fortran_error
 !!
   SUBROUTINE H5DSget_label_f( did, idx, label, size, errcode)
 
@@ -336,7 +337,7 @@ CONTAINS
 !! \param did     Dimension scale identifier.
 !! \param name    Buffer to contain the returned name.
 !! \param size    Size in bytes, of the name buffer.
-!! \param errcode \fortran_error 
+!! \param errcode \fortran_error
 !!
   SUBROUTINE H5DSget_scale_name_f(did, name, size, errcode)
 
@@ -371,7 +372,7 @@ CONTAINS
 !! \param did        The dataset to query.
 !! \param idx        The dimension of \p did to query.
 !! \param num_scales Number of Dimension Scales associated with \p did.
-!! \param errcode    \fortran_error 
+!! \param errcode    \fortran_error
 !!
   SUBROUTINE H5DSget_num_scales_f( did, idx, num_scales, errcode)
 
diff --git a/hl/fortran/src/H5IMff.F90 b/hl/fortran/src/H5IMff.F90
index a2573d6..967c35d 100644
--- a/hl/fortran/src/H5IMff.F90
+++ b/hl/fortran/src/H5IMff.F90
@@ -1,6 +1,6 @@
-!> @defgroup FH5IM Fortran High-level H5IM Interface
+!> @defgroup FH5IM Fortran High Level Images (H5IM) Interface
 !!
-!! @see H5IM, C-API
+!! @see H5IM, C-HL API
 !!
 !! @see @ref H5IM_UG, User Guide
 !!
@@ -42,13 +42,13 @@ CONTAINS
 !>
 !! \ingroup FH5IM
 !!
-!! \brief Creates and writes an image an 8 bit image.
+!! \brief Creates and writes an image an 8 bit image
 !!
 !! \param loc_id    Location identifier. The identifier may be that of a file or group.
 !! \param dset_name The name of the dataset to create.
 !! \param width	    The width of the image.
-!! \param height    The height of the image.
-!! \param buf       Buffer with data to be written to the dataset.
+!! \param height    The height of the image
+!! \param buf       Buffer with data to be written to the dataset
 !! \param errcode   \fortran_error
 !!
   SUBROUTINE h5immake_image_8bit_f(loc_id,&
@@ -105,7 +105,7 @@ CONTAINS
 
     IMPLICIT NONE
 
-    INTEGER(hid_t),   INTENT(in) :: loc_id 
+    INTEGER(hid_t),   INTENT(in) :: loc_id
     CHARACTER(len=*), INTENT(in) :: dset_name
     INTEGER, INTENT(inout), DIMENSION(*) :: buf
     INTEGER :: errcode
@@ -133,7 +133,7 @@ CONTAINS
 !! \ingroup FH5IM
 !!
 !! \brief Creates and writes an image a 24 bit image.
-!! 
+!!
 !! \param loc_id    Location identifier. The identifier may be that of a file or group.
 !! \param dset_name The name of the dataset to create.
 !! \param width     The width of the image.
@@ -307,7 +307,7 @@ CONTAINS
          IMPORT :: C_CHAR
          IMPORT :: HID_T, SIZE_T, HSIZE_T
          IMPLICIT NONE
-         INTEGER(hid_t),   INTENT(in) :: loc_id 
+         INTEGER(hid_t),   INTENT(in) :: loc_id
          INTEGER(size_t) :: namelen
          CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: pal_name
          INTEGER(hsize_t), INTENT(in), DIMENSION(*) :: pal_dims
@@ -437,7 +437,7 @@ CONTAINS
          IMPORT :: C_CHAR
          IMPORT :: HID_T, SIZE_T, HSIZE_T
          IMPLICIT NONE
-         INTEGER(hid_t),   INTENT(in) :: loc_id 
+         INTEGER(hid_t),   INTENT(in) :: loc_id
          CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: image_name
          INTEGER(hsize_t), INTENT(inout) :: npals
          INTEGER(size_t) :: namelen
@@ -471,7 +471,7 @@ CONTAINS
     CHARACTER(len=*), INTENT(in) :: image_name
     INTEGER, INTENT(in) :: pal_number
     INTEGER(hsize_t), DIMENSION(*), INTENT(inout) :: pal_dims
-    INTEGER :: errcode 
+    INTEGER :: errcode
     INTEGER(size_t) :: namelen ! name length
 
     INTERFACE
@@ -512,7 +512,7 @@ CONTAINS
 
     IMPLICIT NONE
 
-    INTEGER(hid_t),   INTENT(in) :: loc_id 
+    INTEGER(hid_t),   INTENT(in) :: loc_id
     CHARACTER(len=*), INTENT(in) :: image_name
     INTEGER, INTENT(in) :: pal_number
     INTEGER, INTENT(inout), DIMENSION(*) :: pal_data
@@ -525,10 +525,10 @@ CONTAINS
          IMPORT :: C_CHAR
          IMPORT :: HID_T, SIZE_T
          IMPLICIT NONE
-         INTEGER(hid_t),   INTENT(in) :: loc_id 
+         INTEGER(hid_t),   INTENT(in) :: loc_id
          INTEGER(size_t) :: namelen
          CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: image_name
-         INTEGER, INTENT(in) :: pal_number 
+         INTEGER, INTENT(in) :: pal_number
          INTEGER, INTENT(inout), DIMENSION(*) :: pal_data
        END FUNCTION h5imget_palette_c
     END INTERFACE
@@ -575,7 +575,3 @@ CONTAINS
 
 END MODULE H5IM
 
-
-
-
-
diff --git a/hl/fortran/src/H5LTff.F90 b/hl/fortran/src/H5LTff.F90
index d2e9daf..3b50ad8 100644
--- a/hl/fortran/src/H5LTff.F90
+++ b/hl/fortran/src/H5LTff.F90
@@ -1,6 +1,6 @@
-!> @defgroup FH5LT Fortran High-level H5LT Interface
+!> @defgroup FH5LT Fortran High Level Lite (H5LT) Interface
 !!
-!! @see H5LT, C-API
+!! @see H5LT, C-HL API
 !!
 !! @see @ref H5LT_UG, User Guide
 !!
@@ -98,7 +98,7 @@ MODULE H5LT_CONST
        CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: attr_name ! name of the attribute
        INTEGER(size_t),  INTENT(in) :: size                          ! size of attribute array
        TYPE(C_PTR), VALUE :: buf                                     ! data buffer
-       CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: dtype     ! flag indicating the datatype of the the buffer:
+       CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: dtype     ! flag indicating the datatype of the buffer:
                                                                      ! R=Real, D=DOUBLE, I=Integer, C=Character
        INTEGER(size_t) :: SizeOf_buf                                 ! Sizeof the buf datatype
      END FUNCTION h5ltset_attribute_c
@@ -116,7 +116,7 @@ MODULE H5LT_CONST
        CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: dset_name ! name of the dataset
        CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: attr_name ! name of the attribute
        TYPE(C_PTR), VALUE :: buf                                     ! data buffer
-       CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: dtype     ! flag indicating the datatype of the the buffer:
+       CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: dtype     ! flag indicating the datatype of the buffer:
                                                                      ! R=Real, D=DOUBLE, I=Integer
        INTEGER(size_t), INTENT(in) :: SizeOf_buf                     ! Sizeof the buf data type
      END FUNCTION h5ltget_attribute_c
@@ -291,7 +291,7 @@ CONTAINS
     INTEGER,          INTENT(in) :: rank
     INTEGER(hsize_t), DIMENSION(*), INTENT(in) :: dims
     INTEGER(hid_t),   INTENT(in) :: type_id
-    INTEGER :: errcode 
+    INTEGER :: errcode
     INTEGER(size_t) :: namelen ! name length
     INTEGER, INTENT(in), &
          DIMENSION(dims(1),dims(2),dims(3),dims(4)), TARGET :: buf ! data buffer
@@ -335,7 +335,7 @@ CONTAINS
     INTEGER,          INTENT(in) :: rank
     INTEGER(hsize_t), DIMENSION(*), INTENT(in) :: dims
     INTEGER(hid_t),   INTENT(in) :: type_id
-    INTEGER :: errcode 
+    INTEGER :: errcode
     INTEGER(size_t) :: namelen ! name length
     INTEGER, INTENT(in), &
          DIMENSION(dims(1),dims(2),dims(3),dims(4),dims(5),dims(6)), TARGET :: buf ! data buffer
@@ -377,7 +377,7 @@ CONTAINS
   !!
   !! \brief Reads a dataset of a type \p type_id.
   !!
-  !! \note \fortran_approved 
+  !! \note \fortran_approved
   !!
   !! \param loc_id    Location identifier. The identifier may be that of a file or group.
   !! \param dset_name The name of the dataset to create.
@@ -881,7 +881,7 @@ CONTAINS
     INTEGER(hid_t),   INTENT(in) :: loc_id
     CHARACTER(LEN=*), INTENT(in) :: dset_name
     INTEGER(hsize_t), DIMENSION(*), INTENT(in) :: dims
-    INTEGER :: errcode 
+    INTEGER :: errcode
     INTEGER(size_t) :: namelen ! name length
     INTEGER, INTENT(inout), &
          DIMENSION(dims(1),dims(2),dims(3),dims(4),dims(5)), TARGET :: buf
@@ -1039,7 +1039,7 @@ CONTAINS
   !>
   !! \ingroup FH5LT
   !!
-  !! \brief Creates and writes an attribute and is a generic replacement for data type specific 
+  !! \brief Creates and writes an attribute and is a generic replacement for data type specific
   !!        Fortran h5ltset_attribute_*_f APIs. There is no C equivalent API.
   !!
   !! \note  \fortran_approved
@@ -1105,7 +1105,7 @@ CONTAINS
   !! \param obj_name  The name of the object to attach the attribute.
   !! \param attr_name The attribute name.
   !! \param buf       Buffer with data to be written to the attribute.
-  !! \param size      The size of the 1D array (one in the case of a scalar attribute). 
+  !! \param size      The size of the 1D array (one in the case of a scalar attribute).
   !!                  This value is used by H5Screate_simple() to create the dataspace.
   !! \param errcode   \fortran_error
   !!
@@ -1154,7 +1154,7 @@ CONTAINS
   !! \param obj_name  The name of the object to attach the attribute.
   !! \param attr_name The attribute name.
   !! \param buf       Buffer with data to be written to the attribute.
-  !! \param size      The size of the 1D array (one in the case of a scalar attribute). 
+  !! \param size      The size of the 1D array (one in the case of a scalar attribute).
   !!                  This value is used by H5Screate_simple() to create the dataspace.
   !! \param errcode   \fortran_error
   !!
@@ -1202,7 +1202,7 @@ CONTAINS
   !! \param obj_name  The name of the object to attach the attribute.
   !! \param attr_name The attribute name.
   !! \param buf       Buffer with data to be written to the attribute.
-  !! \param size      The size of the 1D array (one in the case of a scalar attribute). 
+  !! \param size      The size of the 1D array (one in the case of a scalar attribute).
   !!                  This value is used by H5Screate_simple() to create the dataspace.
   !! \param errcode   \fortran_error
   !!
@@ -1601,7 +1601,7 @@ CONTAINS
   !>
   !! \ingroup FH5LT
   !!
-  !! \brief Retrieves information about a dataset. 
+  !! \brief Retrieves information about a dataset.
   !!
   !! \param loc_id     Identifier of the object to locate the dataset within.
   !! \param dset_name  The dataset name.
@@ -1633,7 +1633,7 @@ CONTAINS
          IMPORT :: HID_T, SIZE_T, HSIZE_T
          IMPLICIT NONE
          INTEGER(hid_t),   INTENT(in) :: loc_id
-         INTEGER(size_t) :: namelen 
+         INTEGER(size_t) :: namelen
          CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: dset_name
          INTEGER(hsize_t),DIMENSION(*),INTENT(inout):: dims
          INTEGER, INTENT(inout)         :: type_class
@@ -1759,7 +1759,7 @@ CONTAINS
   !! \brief Determines whether an HDF5 path is valid and, optionally, whether the path resolves to an HDF5 object.
   !!
   !! \param loc_id              Identifier of an object in the file.
-  !! \param path                The path to the object to check; links in path may be of any type. 
+  !! \param path                The path to the object to check; links in path may be of any type.
   !! \param check_object_valid	Indicates whether to check if the final component of the path resolves to a valid object.
   !! \param path_valid          Object status.
   !! \param errcode             \fortran_error
diff --git a/hl/fortran/src/H5TBff.F90 b/hl/fortran/src/H5TBff.F90
index 611d5ec..52af33f 100644
--- a/hl/fortran/src/H5TBff.F90
+++ b/hl/fortran/src/H5TBff.F90
@@ -1,6 +1,6 @@
-!> @defgroup FH5TB Fortran High-level H5TB Interface
+!> @defgroup FH5TB Fortran High Level Table (H5TB) Interface
 !!
-!! @see H5TB, C-API
+!! @see H5TB, C-HL API
 !!
 !! @see @ref H5TB_UG, User Guide
 !!
@@ -45,7 +45,7 @@
 
   INTERFACE h5tbwrite_field_name_f
 #ifdef H5_DOXYGEN_FORTRAN
-     MODULE PROCEDURE h5tbwrite_field_name_f 
+     MODULE PROCEDURE h5tbwrite_field_name_f
 #else
      MODULE PROCEDURE h5tbwrite_field_name_f_int
      MODULE PROCEDURE h5tbwrite_field_name_f_string
@@ -214,12 +214,12 @@ CONTAINS
 !! \param field_types   An array containing the type of the fields.
 !! \param chunk_size    The chunk size.
 !! \param compress      Flag that turns compression on or off.
-!! \param errcode       \fortran_error     
+!! \param errcode       \fortran_error
 !!
 #ifdef H5_DOXYGEN_FORTRAN
   SUBROUTINE h5tbmake_table_f(&
 #else
-  SUBROUTINE h5tbmake_table_f90(&    
+  SUBROUTINE h5tbmake_table_f90(&
 #endif
        table_title,&
        loc_id,&
@@ -308,7 +308,7 @@ CONTAINS
 #ifdef H5_DOXYGEN_FORTRAN
   END SUBROUTINE h5tbmake_table_f
 #else
-  END SUBROUTINE h5tbmake_table_f90 
+  END SUBROUTINE h5tbmake_table_f90
 #endif
 
 !>
@@ -331,7 +331,7 @@ CONTAINS
 !! \param fill_data     Fill values data
 !! \param compress      Flag that turns compression on or off
 !! \param data	        Buffer with data to be written to the table
-!! \param errcode       \fortran_error     
+!! \param errcode       \fortran_error
 !!
 #ifdef H5_DOXYGEN_FORTRAN
   SUBROUTINE h5tbmake_table_f(&
@@ -446,9 +446,9 @@ CONTAINS
 !! \param nfields    Number of fields, i.e., size of dst_offset and dst_sizes arrays.
 !! \param dst_size   The size of the structure type, as calculated by sizeof or storage_size
 !! \param dst_offset An array containing the offsets of the fields. These offsets can be calculated with H5OFFSETOF.
-!! \param dst_sizes  An array containing the sizes of the fields. These sizes can be calculated with sizeof or storage_size. 
+!! \param dst_sizes  An array containing the sizes of the fields. These sizes can be calculated with sizeof or storage_size.
 !! \param dst_buf    Pointer to buffer with data.
-!! \param errcode    \fortran_error  
+!! \param errcode    \fortran_error
 !!
   SUBROUTINE h5tbread_table_f(loc_id, dset_name, nfields, dst_size, dst_offset, &
        dst_sizes, dst_buf, errcode)
@@ -509,7 +509,7 @@ CONTAINS
 !! \ingroup FH5TB
 !!
 !! \brief Overwrites field.
-!! 
+!!
 !! \param loc_id      Location identifier. The identifier may be that of a file or group.
 !! \param dset_name   The name of the dataset to overwrite
 !! \param field_name  The names of the fields to write
@@ -556,7 +556,7 @@ CONTAINS
     errcode = h5tbwrite_field_name_c(loc_id,namelen,dset_name,namelen1,field_name,&
          start,nrecords,type_size,f_ptr)
 #ifdef H5_DOXYGEN_FORTRAN
-  END SUBROUTINE h5tbwrite_field_name_f  
+  END SUBROUTINE h5tbwrite_field_name_f
 #else
   END SUBROUTINE h5tbwrite_field_name_f_int
 
@@ -607,7 +607,7 @@ CONTAINS
 !! \param nrecords    The number of records to read.
 !! \param type_size   The size in bytes of the structure associated with the table.  Obtained with sizeof or storage_size.
 !! \param buf         Buffer with data
-!! \param errcode     \fortran_error     
+!! \param errcode     \fortran_error
 !!
   SUBROUTINE h5tbread_field_name_f(&
 #else
@@ -700,7 +700,7 @@ CONTAINS
 !! \param type_size    The size of the structure type, as calculated by sizeof or storage_size.
 !! \param buf	       Buffer with data.
 !! \param errcode      \fortran_error
-!!   
+!!
   SUBROUTINE h5tbwrite_field_index_f(&
 #else
   SUBROUTINE h5tbwrite_field_index_f_int(&
@@ -776,7 +776,7 @@ CONTAINS
 !>
 !! \ingroup FH5TB
 !!
-!! \brief Reads field. The fields are identified by index. 
+!! \brief Reads field. The fields are identified by index.
 !!
 !! \param loc_id       Location identifier. The identifier may be that of a file or group.
 !! \param dset_name    The name of the dataset to read.
@@ -957,7 +957,7 @@ CONTAINS
        field_name,&
        errcode )
     IMPLICIT NONE
-    INTEGER(hid_t),   INTENT(in) :: loc_id 
+    INTEGER(hid_t),   INTENT(in) :: loc_id
     CHARACTER(LEN=*), INTENT(in) :: dset_name
     CHARACTER(LEN=*), INTENT(in) :: field_name
     INTEGER :: errcode
@@ -995,7 +995,7 @@ CONTAINS
 !! \param dset_name The name of the dataset to read.
 !! \param nfields   The number of fields.
 !! \param nrecords  The number of records.
-!! \param errcode   \fortran_error     
+!! \param errcode   \fortran_error
 !!
   SUBROUTINE h5tbget_table_info_f(loc_id,&
        dset_name,&
@@ -1017,7 +1017,7 @@ CONTAINS
          IMPORT :: C_CHAR
          IMPORT :: HID_T, SIZE_T, HSIZE_T
          IMPLICIT NONE
-         INTEGER(hid_t),   INTENT(in) :: loc_id 
+         INTEGER(hid_t),   INTENT(in) :: loc_id
          CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(in) :: dset_name
          INTEGER(hsize_t), INTENT(inout):: nfields
          INTEGER(hsize_t), INTENT(inout):: nrecords
@@ -1043,7 +1043,7 @@ CONTAINS
 !! \param field_offsets	An array containing the offsets of the fields.
 !! \param type_size	The size of the HDF5 datatype associated with the table
 !!                      (i.e., the size in bytes of the HDF5 compound datatype used to define a row, or record, in the table).
-!! \param errcode       \fortran_error   
+!! \param errcode       \fortran_error
 !! \param maxlen_out    Maximum character length of the field names.
 !!
   SUBROUTINE h5tbget_field_info_f(loc_id,&