summaryrefslogtreecommitdiffstats
path: root/src/H5Fpublic.h
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2023-07-20 14:01:58 (GMT)
committerGitHub <noreply@github.com>2023-07-20 14:01:58 (GMT)
commit1706355ee10cdad20b79603b3f39935601c5fff0 (patch)
tree878434891f435edf79062cd7b291f72066a4a02c /src/H5Fpublic.h
parentb68988d2d21c57ca02c054272aec01ad86b67ea7 (diff)
downloadhdf5-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 'src/H5Fpublic.h')
-rw-r--r--src/H5Fpublic.h18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h
index ffcde3c..585f9a0 100644
--- a/src/H5Fpublic.h
+++ b/src/H5Fpublic.h
@@ -124,17 +124,17 @@ typedef enum H5F_close_degree_t {
//! <!-- [H5F_info2_t_snip] -->
typedef struct H5F_info2_t {
struct {
- unsigned version; /**< Superblock version # */
+ unsigned version; /**< Superblock version number */
hsize_t super_size; /**< Superblock size */
hsize_t super_ext_size; /**< Superblock extension size */
} super;
struct {
- unsigned version; /**< Version # of file free space management */
+ unsigned version; /**< Version number of file free space management */
hsize_t meta_size; /**< Free space manager metadata size */
hsize_t tot_space; /**< Amount of free space in the file */
} free;
struct {
- unsigned version; /**< Version # of shared object header info */
+ unsigned version; /**< Version number of shared object header info */
hsize_t hdr_size; /**< Shared object header message header size */
H5_ih_info_t msgs_info; /**< Shared object header message index & heap size */
} sohm;
@@ -957,7 +957,7 @@ H5_DLL herr_t H5Fincrement_filesize(hid_t file_id, hsize_t increment);
* \file_id
* \param[out] buf_ptr Pointer to the buffer into which the image of the
* HDF5 file is to be copied. If \p buf_ptr is NULL,
- * no data will be copied but the function’s return value
+ * no data will be copied but the function's return value
* will still indicate the buffer size required (or a
* negative value on error).
* \param[out] buf_len Size of the supplied buffer
@@ -974,7 +974,7 @@ H5_DLL herr_t H5Fincrement_filesize(hid_t file_id, hsize_t increment);
* file image. So if the file size is unknown, it can be safely
* determined with an initial H5Fget_file_image() call with buf_ptr
* set to NULL. The file image can then be retrieved with a second
- * H5Fget_file_image() call with \p buf_len set to the initial call’s
+ * H5Fget_file_image() call with \p buf_len set to the initial call's
* return value.
*
* While the current file size can also be retrieved with
@@ -1172,7 +1172,7 @@ H5_DLL ssize_t H5Fget_name(hid_t obj_id, char *name, size_t size);
/**
* \ingroup H5F
*
- * \brief Retrieves name of file to which object belongs
+ * \brief Retrieves global file information
*
* \fgdta_obj_id
* \param[out] file_info Buffer for global file information
@@ -1320,7 +1320,7 @@ H5_DLL herr_t H5Fget_metadata_read_retry_info(hid_t file_id, H5F_retry_info_t *i
* on a system that is not atomic.
* \li Turn off usage of the library's accumulator to avoid possible
* ordering problem on a system that is not atomic.
- * \li Perform a flush of the file’s data buffers and metadata to set
+ * \li Perform a flush of the file's data buffers and metadata to set
* a consistent state for starting SWMR write operations.
*
* Library objects are groups, datasets, and committed datatypes. For
@@ -1390,7 +1390,7 @@ H5_DLL ssize_t H5Fget_free_sections(hid_t file_id, H5F_mem_t type, size_t nsects
* \return \herr_t
*
* \details H5Fclear_elink_file_cache() evicts all the cached child files in
- * the specified file’s external file cache, causing them to be closed
+ * the specified file's external file cache, causing them to be closed
* if there is nothing else holding them open.
*
* H5Fclear_elink_file_cache() does not close the cache itself;
@@ -1845,7 +1845,7 @@ typedef struct H5F_info1_t {
/**
* \ingroup H5F
*
- * \brief Retrieves name of file to which object belongs
+ * \brief Retrieves global file information
*
* \fgdta_obj_id
* \param[out] file_info Buffer for global file information