diff options
author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2023-07-20 14:01:58 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-20 14:01:58 (GMT) |
commit | 1706355ee10cdad20b79603b3f39935601c5fff0 (patch) | |
tree | 878434891f435edf79062cd7b291f72066a4a02c /hl | |
parent | b68988d2d21c57ca02c054272aec01ad86b67ea7 (diff) | |
download | hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.zip hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.tar.gz hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.tar.bz2 |
removed the use of encoded single apostrophe (#3261)
* removed the use of encoded single apostrophe, and fix H5Dread_chunk from write to read
* updated sanitizer paragraph
* fixed brief description for H5Fget_info
Diffstat (limited to 'hl')
-rw-r--r-- | hl/src/H5DOpublic.h | 18 | ||||
-rw-r--r-- | hl/src/H5LDpublic.h | 6 | ||||
-rw-r--r-- | hl/src/H5LTpublic.h | 18 |
3 files changed, 21 insertions, 21 deletions
diff --git a/hl/src/H5DOpublic.h b/hl/src/H5DOpublic.h index 106eb28..887e659 100644 --- a/hl/src/H5DOpublic.h +++ b/hl/src/H5DOpublic.h @@ -29,7 +29,7 @@ extern "C" { * HDF5 functions described is this section are implemented in the HDF5 High-level * library as optimized functions. These functions generally require careful setup * and testing as they enable an application to bypass portions of the HDF5 - * library’s I/O pipeline for performance purposes. + * library's I/O pipeline for performance purposes. * * These functions are distributed in the standard HDF5 distribution and are * available any time the HDF5 High-level library is available. @@ -113,7 +113,7 @@ H5_HLDLL herr_t H5DOappend(hid_t dset_id, hid_t dxpl_id, unsigned axis, size_t e * \param[in] dxpl_id Transfer property list identifier for * this I/O operation * \param[in] filters Mask for identifying the filters in use - * \param[in] offset Logical position of the chunk’s first element + * \param[in] offset Logical position of the chunk's first element * in the dataspace * \param[in] data_size Size of the actual data to be written in bytes * \param[in] buf Buffer containing data to be written to the chunk @@ -131,7 +131,7 @@ H5_HLDLL herr_t H5DOappend(hid_t dset_id, hid_t dxpl_id, unsigned axis, size_t e * logical \p offset in a chunked dataset \p dset_id from the application * memory buffer \p buf to the dataset in the file. Typically, the data * in \p buf is preprocessed in memory by a custom transformation, such as - * compression. The chunk will bypass the library’s internal data + * compression. The chunk will bypass the library's internal data * transfer pipeline, including filters, and will be written directly to the file. * * \p dxpl_id is a data transfer property list identifier. @@ -139,12 +139,12 @@ H5_HLDLL herr_t H5DOappend(hid_t dset_id, hid_t dxpl_id, unsigned axis, size_t e * \p filters is a mask providing a record of which filters are used * with the chunk. The default value of the mask is zero (\c 0), * indicating that all enabled filters are applied. A filter is skipped - * if the bit corresponding to the filter’s position in the pipeline + * if the bit corresponding to the filter's position in the pipeline * (<tt>0 ≤ position < 32</tt>) is turned on. This mask is saved * with the chunk in the file. * * \p offset is an array specifying the logical position of the first - * element of the chunk in the dataset’s dataspace. The length of the + * element of the chunk in the dataset's dataspace. The length of the * offset array must equal the number of dimensions, or rank, of the * dataspace. The values in \p offset must not exceed the dimension limits * and must specify a point that falls on a dataset chunk boundary. @@ -189,7 +189,7 @@ H5_HLDLL herr_t H5DOwrite_chunk(hid_t dset_id, hid_t dxpl_id, uint32_t filters, * \param[in] dset_id Identifier for the dataset to be read * \param[in] dxpl_id Transfer property list identifier for * this I/O operation - * \param[in] offset Logical position of the chunk’s first + * \param[in] offset Logical position of the chunk's first element in the dataspace * \param[in,out] filters Mask for identifying the filters used * with the chunk @@ -209,7 +209,7 @@ H5_HLDLL herr_t H5DOwrite_chunk(hid_t dset_id, hid_t dxpl_id, uint32_t filters, * by its logical \p offset in a chunked dataset \p dset_id * from the dataset in the file into the application memory * buffer \p buf. The data in \p buf is read directly from the file - * bypassing the library’s internal data transfer pipeline, + * bypassing the library's internal data transfer pipeline, * including filters. * * \p dxpl_id is a data transfer property list identifier. @@ -217,11 +217,11 @@ H5_HLDLL herr_t H5DOwrite_chunk(hid_t dset_id, hid_t dxpl_id, uint32_t filters, * The mask \p filters indicates which filters are used with the * chunk when written. A zero value indicates that all enabled filters * are applied on the chunk. A filter is skipped if the bit corresponding - * to the filter’s position in the pipeline + * to the filter's position in the pipeline * (<tt>0 ≤ position < 32</tt>) is turned on. * * \p offset is an array specifying the logical position of the first - * element of the chunk in the dataset’s dataspace. The length of the + * element of the chunk in the dataset's dataspace. The length of the * offset array must equal the number of dimensions, or rank, of the * dataspace. The values in \p offset must not exceed the dimension * limits and must specify a point that falls on a dataset chunk boundary. diff --git a/hl/src/H5LDpublic.h b/hl/src/H5LDpublic.h index 830b488..1eee8b4 100644 --- a/hl/src/H5LDpublic.h +++ b/hl/src/H5LDpublic.h @@ -50,18 +50,18 @@ H5_HLDLL herr_t H5LDget_dset_dims(hid_t did, hsize_t *cur_dims); *------------------------------------------------------------------------- * \ingroup H5LT * - * \brief Returns the size in bytes of the dataset’s datatype + * \brief Returns the size in bytes of the dataset's datatype * * \param[in] did The dataset identifier * \param[in] fields The pointer to a comma-separated list of fields for a compound datatype * * \return If successful, returns the size in bytes of the - * dataset’s datatype. Otherwise, returns 0. + * dataset's datatype. Otherwise, returns 0. * * \details H5LDget_dset_type_size() allows the user to find out the datatype * size for the dataset associated with \p did. If the * parameter \p fields is NULL, this routine just returns the size - * of the dataset’s datatype. If the dataset has a compound datatype + * of the dataset's datatype. If the dataset has a compound datatype * and \p fields is non-NULL, this routine returns the size of the * datatype(s) for the selected fields specified in \p fields. * Note that ’,’ is the separator for the fields of a compound diff --git a/hl/src/H5LTpublic.h b/hl/src/H5LTpublic.h index 7ef51d4..1ce5c81 100644 --- a/hl/src/H5LTpublic.h +++ b/hl/src/H5LTpublic.h @@ -208,7 +208,7 @@ H5_HLDLL herr_t H5LTmake_dataset(hid_t loc_id, const char *dset_name, int rank, * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be \e character, #H5T_NATIVE_CHAR. + * The dataset's datatype will be \e character, #H5T_NATIVE_CHAR. * */ H5_HLDLL herr_t H5LTmake_dataset_char(hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, @@ -232,7 +232,7 @@ H5_HLDLL herr_t H5LTmake_dataset_char(hid_t loc_id, const char *dset_name, int r * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be <em>short signed integer</em>, + * The dataset's datatype will be <em>short signed integer</em>, * #H5T_NATIVE_SHORT. * */ @@ -257,7 +257,7 @@ H5_HLDLL herr_t H5LTmake_dataset_short(hid_t loc_id, const char *dset_name, int * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be <em>native signed integer</em>, + * The dataset's datatype will be <em>native signed integer</em>, * #H5T_NATIVE_INT. * * \version Fortran subroutine modified in this release to accommodate @@ -285,7 +285,7 @@ H5_HLDLL herr_t H5LTmake_dataset_int(hid_t loc_id, const char *dset_name, int ra * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be <em>long signed integer</em>, + * The dataset's datatype will be <em>long signed integer</em>, * #H5T_NATIVE_LONG. * */ @@ -310,7 +310,7 @@ H5_HLDLL herr_t H5LTmake_dataset_long(hid_t loc_id, const char *dset_name, int r * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be <em>native floating point</em>, + * The dataset's datatype will be <em>native floating point</em>, * #H5T_NATIVE_FLOAT. * * \version 1.8.7 Fortran subroutine modified in this release to accommodate @@ -338,7 +338,7 @@ H5_HLDLL herr_t H5LTmake_dataset_float(hid_t loc_id, const char *dset_name, int * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be + * The dataset's datatype will be * <em>native floating-point double</em>, #H5T_NATIVE_DOUBLE. * * \version 1.8.7 Fortran subroutine modified in this release to accommodate @@ -364,7 +364,7 @@ H5_HLDLL herr_t H5LTmake_dataset_double(hid_t loc_id, const char *dset_name, int * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be <em>C string</em>, #H5T_C_S1. + * The dataset's datatype will be <em>C string</em>, #H5T_C_S1. * */ H5_HLDLL herr_t H5LTmake_dataset_string(hid_t loc_id, const char *dset_name, const char *buf); @@ -1496,7 +1496,7 @@ H5_HLDLL herr_t H5LTfind_attribute(hid_t loc_id, const char *name); * final component of \p path resolves to an HDF5 object; * if not, the final component is a dangling link. * - * The meaning of the function’s return value depends on the + * The meaning of the function's return value depends on the * value of \p check_object_valid: * * If \p check_object_valid is set to \c FALSE, H5LTpath_valid() @@ -1516,7 +1516,7 @@ H5_HLDLL herr_t H5LTfind_attribute(hid_t loc_id, const char *name); * \p path can be any one of the following: * * - An absolute path, which starts with a slash (\c /) - * indicating the file’s root group, followed by the members + * 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. |