diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2022-09-14 20:44:24 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-14 20:44:24 (GMT) |
commit | 45178c87a3099a9fef8bae6f7249ca306cf89629 (patch) | |
tree | cb404581365434d641e4d6303921613ef3432bd0 /hl | |
parent | dcf3b54b6ef3ffe2093cfae81fe80cdb2bb53047 (diff) | |
download | hdf5-45178c87a3099a9fef8bae6f7249ca306cf89629.zip hdf5-45178c87a3099a9fef8bae6f7249ca306cf89629.tar.gz hdf5-45178c87a3099a9fef8bae6f7249ca306cf89629.tar.bz2 |
develop Merge doxygen from 1.12 branch (#2095)
Diffstat (limited to 'hl')
-rw-r--r-- | hl/fortran/src/H5DSff.F90 | 25 | ||||
-rw-r--r-- | hl/fortran/src/H5IMff.F90 | 30 | ||||
-rw-r--r-- | hl/fortran/src/H5LTff.F90 | 30 | ||||
-rw-r--r-- | hl/fortran/src/H5TBff.F90 | 36 | ||||
-rw-r--r-- | hl/src/H5DOpublic.h | 6 | ||||
-rw-r--r-- | hl/src/H5DSpublic.h | 28 | ||||
-rw-r--r-- | hl/src/H5IMpublic.h | 8 | ||||
-rw-r--r-- | hl/src/H5LDpublic.h | 6 | ||||
-rw-r--r-- | hl/src/H5LTpublic.h | 128 | ||||
-rw-r--r-- | hl/src/H5PTpublic.h | 8 | ||||
-rw-r--r-- | hl/src/H5TBpublic.h | 8 |
11 files changed, 169 insertions, 144 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,& diff --git a/hl/src/H5DOpublic.h b/hl/src/H5DOpublic.h index 13b2422..20f4c98 100644 --- a/hl/src/H5DOpublic.h +++ b/hl/src/H5DOpublic.h @@ -18,7 +18,11 @@ extern "C" { #endif -/**\defgroup H5DO Optimizations +/** \page H5DO_UG The HDF5 High Level Optimizations + * @todo Under Construction + */ + +/**\defgroup H5DO HDF5 Optimizations APIs (H5DO) * * <em>Bypassing default HDF5 behavior in order to optimize for specific * use cases (H5DO)</em> diff --git a/hl/src/H5DSpublic.h b/hl/src/H5DSpublic.h index 77dd64b..4fcf681 100644 --- a/hl/src/H5DSpublic.h +++ b/hl/src/H5DSpublic.h @@ -31,7 +31,11 @@ typedef herr_t (*H5DS_iterate_t)(hid_t dset, unsigned dim, hid_t scale, void *vi extern "C" { #endif -/**\defgroup H5DS Dimension Scales +/** \page H5DS_UG The HDF5 High Level Dimension Scales + * @todo Under Construction + */ + +/**\defgroup H5DS HDF5 Dimension Scales APIs (H5DS) * * <em>Creating and manipulating HDF5 datasets that are associated with * the dimension of another HDF5 dataset (H5DS)</em> @@ -77,21 +81,21 @@ extern "C" { /* THIS IS A NEW ROUTINE NOT ON OLD PORTAL */ /** - * -------------------------------------------------------------------------- - * \ingroup H5DS + * -------------------------------------------------------------------------- + * \ingroup H5DS * - * \brief Determines if new references are used with dimension scales. + * \brief Determines if new references are used with dimension scales. * - * \param[in] obj_id Object identifier - * \param[out] with_new_ref New references are used or not + * \param[in] obj_id Object identifier + * \param[out] with_new_ref New references are used or not * - * \return \herr_t + * \return \herr_t * - * \details H5DSwith_new_ref() takes any object identifier and checks - * if new references are used for dimension scales. Currently, - * new references are used when non-native VOL connector is - * used or when H5_DIMENSION_SCALES_WITH_NEW_REF is set up - * via configure option. + * \details H5DSwith_new_ref() takes any object identifier and checks + * if new references are used for dimension scales. Currently, + * new references are used when non-native VOL connector is + * used or when H5_DIMENSION_SCALES_WITH_NEW_REF is set up + * via configure option. * */ H5_HLDLL herr_t H5DSwith_new_ref(hid_t obj_id, hbool_t *with_new_ref); diff --git a/hl/src/H5IMpublic.h b/hl/src/H5IMpublic.h index b5426d6..bccf3c4 100644 --- a/hl/src/H5IMpublic.h +++ b/hl/src/H5IMpublic.h @@ -18,7 +18,11 @@ extern "C" { #endif -/**\defgroup H5IM Images +/** \page H5IM_UG The HDF5 High Level Images + * @todo Under Construction + */ + +/**\defgroup H5IM HDF5 Images API (H5IM) * * <em>Creating and manipulating HDF5 datasets intended to be * interpreted as images (H5IM)</em> @@ -27,7 +31,7 @@ extern "C" { * document: \ref IMG * This version of the API is primarily concerned with two dimensional raster * data similar to HDF4 Raster Images. - * The HDF5 Images API uses the \ref H5LT HDF5 API. + * The HDF5 Images API uses the \ref H5LT. * * \note \Bold{Programming hints:} * \note To use any of these functions or subroutines, diff --git a/hl/src/H5LDpublic.h b/hl/src/H5LDpublic.h index fed0c1c..363b59c 100644 --- a/hl/src/H5LDpublic.h +++ b/hl/src/H5LDpublic.h @@ -34,7 +34,7 @@ extern "C" { * It will return failure if \p cur_dims is NULL. * * \note See Also: - * \note Dataset Watch functions (used with \ref h5watch): + * \note Dataset Watch functions (used with h5watch): * - H5LDget_dset_dims() * - H5LDget_dset_elmts() * - H5LDget_dset_type_size() @@ -71,7 +71,7 @@ H5_HLDLL herr_t H5LDget_dset_dims(hid_t did, hsize_t *cur_dims); * conflict with these two separators. * * \note See Also: - * \note Dataset Watch functions (used with \ref h5watch): + * \note Dataset Watch functions (used with h5watch): * - H5LDget_dset_dims() * - H5LDget_dset_elmts() * - H5LDget_dset_type_size() @@ -123,7 +123,7 @@ H5_HLDLL size_t H5LDget_dset_type_size(hid_t did, const char *fields); * two separators. * * \note See Also: - * \note Dataset Watch functions (used with \ref h5watch): + * \note Dataset Watch functions (used with h5watch): * - H5LDget_dset_dims() * - H5LDget_dset_elmts() * - H5LDget_dset_type_size() diff --git a/hl/src/H5LTpublic.h b/hl/src/H5LTpublic.h index d1684fd..15cd845 100644 --- a/hl/src/H5LTpublic.h +++ b/hl/src/H5LTpublic.h @@ -35,7 +35,11 @@ typedef enum H5LT_lang_t { extern "C" { #endif -/**\defgroup H5LT Lite +/** \page H5LT_UG The HDF5 High Level Lite + * @todo Under Construction + */ + +/**\defgroup H5LT HDF5 Lite APIs (H5LT,H5LD) * <em>Functions used to simplify creating and manipulating datasets, * attributes and other features (H5LT, H5LD)</em> * @@ -57,87 +61,93 @@ extern "C" { * * <table> * <tr valign="top"><td style="border: none;"> + * * - Dataset Functions * - Make dataset functions - * - \ref H5LTmake_dataset - * - \ref H5LTmake_dataset_char - * - \ref H5LTmake_dataset_short - * - \ref H5LTmake_dataset_int - * - \ref H5LTmake_dataset_long - * - \ref H5LTmake_dataset_float - * - \ref H5LTmake_dataset_double - * - \ref H5LTmake_dataset_string + * - \ref H5LTmake_dataset + * - \ref H5LTmake_dataset_char + * - \ref H5LTmake_dataset_short + * - \ref H5LTmake_dataset_int + * - \ref H5LTmake_dataset_long + * - \ref H5LTmake_dataset_float + * - \ref H5LTmake_dataset_double + * - \ref H5LTmake_dataset_string * * - Read dataset functions - * - \ref H5LTread_dataset - * - \ref H5LTread_dataset_char - * - \ref H5LTread_dataset_short - * - \ref H5LTread_dataset_int - * - \ref H5LTread_dataset_long - * - \ref H5LTread_dataset_float - * - \ref H5LTread_dataset_double - * - \ref H5LTread_dataset_string + * - \ref H5LTread_dataset + * - \ref H5LTread_dataset_char + * - \ref H5LTread_dataset_short + * - \ref H5LTread_dataset_int + * - \ref H5LTread_dataset_long + * - \ref H5LTread_dataset_float + * - \ref H5LTread_dataset_double + * - \ref H5LTread_dataset_string * * - Query dataset functions - * - \ref H5LTfind_dataset - * - \ref H5LTget_dataset_ndims - * - \ref H5LTget_dataset_info + * - \ref H5LTfind_dataset + * - \ref H5LTget_dataset_ndims + * - \ref H5LTget_dataset_info * * - Dataset watch functions - * - \ref H5LDget_dset_dims - * - \ref H5LDget_dset_elmts - * - \ref H5LDget_dset_type_size + * - \ref H5LDget_dset_dims + * - \ref H5LDget_dset_elmts + * - \ref H5LDget_dset_type_size + * * </td><td style="border: none;"> + * * - Attribute Functions * - Set attribute functions - * - \ref H5LTset_attribute_string - * - \ref H5LTset_attribute_char - * - \ref H5LTset_attribute_uchar - * - \ref H5LTset_attribute_short - * - \ref H5LTset_attribute_ushort - * - \ref H5LTset_attribute_int - * - \ref H5LTset_attribute_uint - * - \ref H5LTset_attribute_long - * - \ref H5LTset_attribute_long_long - * - \ref H5LTset_attribute_ulong - * - \ref H5LTset_attribute_ullong - * - \ref H5LTset_attribute_float - * - \ref H5LTset_attribute_double - * - <code>H5LTset_attribute_f</code> (fortran ONLY) + * - \ref H5LTset_attribute_string + * - \ref H5LTset_attribute_char + * - \ref H5LTset_attribute_uchar + * - \ref H5LTset_attribute_short + * - \ref H5LTset_attribute_ushort + * - \ref H5LTset_attribute_int + * - \ref H5LTset_attribute_uint + * - \ref H5LTset_attribute_long + * - \ref H5LTset_attribute_long_long + * - \ref H5LTset_attribute_ulong + * - \ref H5LTset_attribute_ullong + * - \ref H5LTset_attribute_float + * - \ref H5LTset_attribute_double + * - <code>H5LTset_attribute_f</code> (fortran ONLY) * * - Get attribute functions - * - \ref H5LTget_attribute - * - \ref H5LTget_attribute_string - * - \ref H5LTget_attribute_char - * - \ref H5LTget_attribute_uchar - * - \ref H5LTget_attribute_short - * - \ref H5LTget_attribute_ushort - * - \ref H5LTget_attribute_int - * - \ref H5LTget_attribute_uint - * - \ref H5LTget_attribute_long - * - \ref H5LTget_attribute_long_long - * - \ref H5LTget_attribute_ulong - * - \ref H5LTget_attribute_ullong - * - \ref H5LTget_attribute_float - * - \ref H5LTget_attribute_double + * - \ref H5LTget_attribute + * - \ref H5LTget_attribute_string + * - \ref H5LTget_attribute_char + * - \ref H5LTget_attribute_uchar + * - \ref H5LTget_attribute_short + * - \ref H5LTget_attribute_ushort + * - \ref H5LTget_attribute_int + * - \ref H5LTget_attribute_uint + * - \ref H5LTget_attribute_long + * - \ref H5LTget_attribute_long_long + * - \ref H5LTget_attribute_ulong + * - \ref H5LTget_attribute_ullong + * - \ref H5LTget_attribute_float + * - \ref H5LTget_attribute_double * * - Query attribute functions - * - \ref H5LTfind_attribute - * - \ref H5LTget_attribute_info - * - \ref H5LTget_attribute_ndims + * - \ref H5LTfind_attribute + * - \ref H5LTget_attribute_info + * - \ref H5LTget_attribute_ndims + * * </td><td style="border: none;"> + * * - Datatype Functions * - Datatype translation functions - * - \ref H5LTtext_to_dtype - * - \ref H5LTdtype_to_text + * - \ref H5LTtext_to_dtype + * - \ref H5LTdtype_to_text * * - File image function * - Open file image function - * - \ref H5LTopen_file_image + * - \ref H5LTopen_file_image * * - Path and object function * - Query path and object function - * - \ref H5LTpath_valid + * - \ref H5LTpath_valid + * * </td></tr> * </table> * @@ -1510,7 +1520,7 @@ H5_HLDLL herr_t H5LTfind_attribute(hid_t loc_id, const char *name); * indicating the file’s root group, followed by the members * - A relative path with respect to \p loc_id * - A dot (\c .), if \p loc_id is the object identifier for - * the object itself + * the object itself. * * If \p path is an absolute path, then \p loc_id can be an * identifier for any object in the file as it is used only to diff --git a/hl/src/H5PTpublic.h b/hl/src/H5PTpublic.h index 04741ac..6552aa9 100644 --- a/hl/src/H5PTpublic.h +++ b/hl/src/H5PTpublic.h @@ -18,7 +18,11 @@ extern "C" { #endif -/**\defgroup H5PT Packet Table +/** \page H5PT_UG The HDF5 High Level Packet Table + * @todo Under Construction + */ + +/**\defgroup H5PT HDF5 Packet Table APIs (H5PT) * * <em>Creating and manipulating HDF5 datasets to support append- * and read-only operations on table data (H5PT)</em> @@ -210,7 +214,7 @@ H5_HLDLL herr_t H5PTclose(hid_t table_id); * Level 0 is faster but offers the least compression; * level 9 is slower but offers maximum compression. * A setting of -1 indicates that no compression is desired. - + * */ /* This function may be removed from the packet table in release 1.8.19. */ H5_HLDLL hid_t H5PTcreate_fl(hid_t loc_id, const char *dset_name, hid_t dtype_id, hsize_t chunk_size, diff --git a/hl/src/H5TBpublic.h b/hl/src/H5TBpublic.h index 9ad8e08..44b122c 100644 --- a/hl/src/H5TBpublic.h +++ b/hl/src/H5TBpublic.h @@ -18,7 +18,11 @@ extern "C" { #endif -/**\defgroup H5TB Table +/** \page H5TB_UG The HDF5 High Level Table + * @todo Under Construction + */ + +/**\defgroup H5TB HDF5 Table APIs (H5TB) * * <em>Creating and manipulating HDF5 datasets intended to be * interpreted as tables (H5TB)</em> @@ -656,12 +660,10 @@ H5_HLDLL herr_t H5TBAget_title(hid_t loc_id, char *table_title); * \return A return value of 0 indicates a fill value is not present. * \return A return value <0 indicates an error. * - * * \details H5TBget_fill() reads the table attribute fill values into * the buffer \p dst_buf for the table specified by \p dset_id * and \p dset_name located in \p loc_id. * - * * \par Example * \include H5TBAget_fill.c * |