summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/H5ACpublic.h2
-rw-r--r--src/H5Apublic.h30
-rw-r--r--src/H5C.c6
-rw-r--r--src/H5Cpkg.h4
-rw-r--r--src/H5Cprivate.h2
-rw-r--r--src/H5Dint.c4
-rw-r--r--src/H5Doh.c2
-rw-r--r--src/H5Dpublic.h36
-rw-r--r--src/H5ESmodule.h2
-rw-r--r--src/H5Epublic.h10
-rw-r--r--src/H5FDhdfs.c8
-rw-r--r--src/H5FDmulti.h8
-rw-r--r--src/H5FDros3.c8
-rw-r--r--src/H5Fpublic.h14
-rw-r--r--src/H5Gmodule.h12
-rw-r--r--src/H5Goh.c2
-rw-r--r--src/H5Gpublic.h16
-rw-r--r--src/H5HFcache.c2
-rw-r--r--src/H5Ipublic.h16
-rw-r--r--src/H5Lpublic.h28
-rw-r--r--src/H5MF.c2
-rw-r--r--src/H5Mpublic.h2
-rw-r--r--src/H5Oalloc.c2
-rw-r--r--src/H5Omodule.h2
-rw-r--r--src/H5Opublic.h44
-rw-r--r--src/H5Oshared.h2
-rw-r--r--src/H5PLpublic.h6
-rw-r--r--src/H5Pfapl.c4
-rw-r--r--src/H5Ppublic.h24
-rw-r--r--src/H5Rpublic.h12
-rw-r--r--src/H5Sall.c4
-rw-r--r--src/H5Shyper.c2
-rw-r--r--src/H5Spublic.h8
-rw-r--r--src/H5Tenum.c4
-rw-r--r--src/H5Tpublic.h22
-rw-r--r--src/H5Zdevelop.h28
-rw-r--r--src/H5Zmodule.h2
-rw-r--r--src/H5Zpublic.h6
-rw-r--r--src/H5public.h18
39 files changed, 203 insertions, 203 deletions
diff --git a/src/H5ACpublic.h b/src/H5ACpublic.h
index 0967f77..5dc65c7 100644
--- a/src/H5ACpublic.h
+++ b/src/H5ACpublic.h
@@ -466,7 +466,7 @@ typedef struct H5AC_cache_config_t {
/* general configuration fields: */
//! <!-- [H5AC_cache_config_t_general_snip] -->
int version;
- /**< Integer field indicating the the version of the H5AC_cache_config_t
+ /**< Integer field indicating the version of the H5AC_cache_config_t
* in use. This field should be set to #H5AC__CURR_CACHE_CONFIG_VERSION
* (defined in H5ACpublic.h). */
diff --git a/src/H5Apublic.h b/src/H5Apublic.h
index e21e808..92df94a 100644
--- a/src/H5Apublic.h
+++ b/src/H5Apublic.h
@@ -127,7 +127,7 @@ H5_DLL herr_t H5Aclose_async(hid_t attr_id, hid_t es_id);
* The attribute identifier returned by this function must be released
* with H5Aclose() resource leaks will develop.
*
- * \note If \p loc_id is a file identifier, the attribute will be attached
+ * \note If \p loc_id is a file identifier, the attribute will be attached to
* that file’s root group.
*
* \par Example
@@ -246,8 +246,8 @@ H5_DLL herr_t H5Adelete(hid_t loc_id, const char *attr_name);
* \param[in] obj_name Name of object, relative to location, from which
* attribute is to be removed
* \param[in] idx_type Type of index
- * \param[in] order Order in which to iterate over index
- * \param[in] n Offset within index
+ * \param[in] order Order in which to iterate over the index
+ * \param[in] n Offset within the index
* \lapl_id
*
* \return \herr_t
@@ -264,7 +264,7 @@ H5_DLL herr_t H5Adelete(hid_t loc_id, const char *attr_name);
* The order in which the index is to be traversed is specified by
* \p order. For example, if \p idx_type, \p order,
* and \p n are set to #H5_INDEX_NAME, #H5_ITER_INC, and 5,
- * respectively, the fifth attribute in lexicographic order of
+ * respectively, the fifth attribute in the lexicographic order of
* attribute names will be removed.
*
* The link access property list, \p lapl_id, may provide
@@ -354,7 +354,7 @@ H5_DLL herr_t H5Aexists_async(hid_t obj_id, const char *attr_name, hbool_t *exis
* \p loc_id specifies a location in the file containing the object.
* \p obj_name is the name of the object to which the attribute is
* attached and can be a relative name, relative to \p loc_id,
- * or an absolute name, based in the root group of the file.
+ * or an absolute name, based on the root group of the file.
*
* The link access property list, \p lapl_id, may provide
* information regarding the properties of links required to access
@@ -403,7 +403,7 @@ H5_DLL hid_t H5Aget_create_plist(hid_t attr_id);
/**
* \ingroup H5A
*
- * \brief Retrieves attribute information, by attribute identifier
+ * \brief Retrieves attribute information by attribute identifier
*
* \attr_id
* \param[out] ainfo Attribute information struct
@@ -438,7 +438,7 @@ H5_DLL herr_t H5Aget_info(hid_t attr_id, H5A_info_t *ainfo /*out*/);
* \details H5Aget_info_by_idx() retrieves information for an attribute
* that is attached to an object, which is specified by its
* location and name, \p loc_id and \p obj_name, respectively.
- * The attribute is located by its index position and the attribute
+ * The attribute is located by its index position, and the attribute
* information is returned in the \p ainfo struct.
*
* The attribute is located by means of an index type, an index
@@ -458,7 +458,7 @@ H5_DLL herr_t H5Aget_info_by_idx(hid_t loc_id, const char *obj_name, H5_index_t
/**
* \ingroup H5A
*
- * \brief Retrieves attribute information, by attribute name
+ * \brief Retrieves attribute information by attribute name
*
* \fgdt_loc_id
* \param[in] obj_name Name of the object to which an attribute is attached,
@@ -494,7 +494,7 @@ H5_DLL herr_t H5Aget_info_by_name(hid_t loc_id, const char *obj_name, const char
* \param[out] buf Buffer to store name in
*
* \return Returns the length of the attribute's name, which may be longer
- * than \p buf_size, if successful. Otherwise returns a negative
+ * than \p buf_size, if successful. Otherwise, returns a negative
* value.
*
* \details H5Aget_name() retrieves the name of an attribute specified by
@@ -529,7 +529,7 @@ H5_DLL ssize_t H5Aget_name(hid_t attr_id, size_t buf_size, char *buf);
* \lapl_id
*
* \return Returns attribute name size, in bytes, if successful;
- * otherwise returns a negative value.
+ * otherwise, returns a negative value.
*
* \details H5Aget_name_by_idx() retrieves the name of an attribute that is
* attached to an object, which is specified by its location and
@@ -584,7 +584,7 @@ H5_DLL hid_t H5Aget_space(hid_t attr_id);
* \attr_id
*
* \return Returns the amount of storage size allocated for the attribute;
- * otherwise returns 0 (zero).
+ * otherwise, returns 0 (zero).
*
* \details H5Aget_storage_size() returns the amount of storage that is
* required for the specified attribute, \p attr_id.
@@ -687,7 +687,7 @@ H5_DLL herr_t H5Aiterate2(hid_t loc_id, H5_index_t idx_type, H5_iter_order_t ord
*
* \return \herr_t
* Further note that this function returns the return value of
- * the last operator if it was non-zero, which can be a negative
+ * the last operator if it is non-zero, which can be a negative
* value, zero if all attributes were processed, or a positive value
* indicating short-circuit success.
*
@@ -1150,7 +1150,7 @@ H5_DLL hid_t H5Acreate1(hid_t loc_id, const char *name, hid_t type_id, hid_t spa
*
* \fgdt_loc_id
*
- * \return Returns the number of attributes if successful; otherwise returns
+ * \return Returns the number of attributes if successful; otherwise, returns
* a negative value.
*
* \deprecation_note{H5Oget_info(), H5Oget_info_by_name(), and H5Oget_info_by_idx()}
@@ -1207,8 +1207,8 @@ H5_DLL herr_t H5Aiterate1(hid_t loc_id, unsigned *idx, H5A_operator1_t op, void
*
* \deprecation_note{H5Aopen_by_idx()}
*
- * \details H5Aopen_idx() opens an attribute which is attached to the
- * object specified with \p loc_id . The location object may be
+ * \details H5Aopen_idx() opens an attribute that is attached to the
+ * object specified with \p loc_id. The location object may be
* either a group, dataset, or named datatype, all of which may
* have any sort of attribute. The attribute specified by the index,
* \p idx , indicates the attribute to access. The value of \p idx
diff --git a/src/H5C.c b/src/H5C.c
index 4262f00..ae03d69 100644
--- a/src/H5C.c
+++ b/src/H5C.c
@@ -4331,7 +4331,7 @@ H5C__auto_adjust_cache_size(H5F_t *f, hbool_t write_permitted)
* must run the marker maintenance code, whether we run the size
* reduction code or not. We do this in two places -- here we
* insert a new marker if the number of active epoch markers is
- * is less than the the current epochs before eviction, and after
+ * is less than the current epochs before eviction, and after
* the ageout call, we cycle the markers.
*
* However, we can't call the ageout code or cycle the markers
@@ -5027,7 +5027,7 @@ done:
*
* Purpose: Remove epoch markers from the end of the LRU list and
* mark them as inactive until the number of active markers
- * equals the the current value of
+ * equals the current value of
* (cache_ptr->resize_ctl).epochs_before_eviction.
*
* Return: SUCCEED on success/FAIL on failure.
@@ -8861,7 +8861,7 @@ H5C__serialize_single_entry(H5F_t *f, H5C_t *cache_ptr, H5C_cache_entry_t *entry
HDassert(!entry_ptr->flush_in_progress);
HDassert(entry_ptr->type);
- /* Set entry_ptr->flush_in_progress to TRUE so the the target entry
+ /* Set entry_ptr->flush_in_progress to TRUE so the target entry
* will not be evicted out from under us. Must set it back to FALSE
* when we are done.
*/
diff --git a/src/H5Cpkg.h b/src/H5Cpkg.h
index 4f826d1..23c2b78 100644
--- a/src/H5Cpkg.h
+++ b/src/H5Cpkg.h
@@ -4034,7 +4034,7 @@ typedef struct H5C_tag_info_t {
*
* 2) A pinned entry can be accessed or modified at any time.
* This places an additional burden on the associated pre-serialize
- * and serialize callbacks, which must ensure the the entry is in
+ * and serialize callbacks, which must ensure the entry is in
* a consistent state before creating an image of it.
*
* 3) A pinned entry can be marked as dirty (and possibly
@@ -4398,7 +4398,7 @@ typedef struct H5C_tag_info_t {
* order, we scan the index repeatedly, once for each flush dependency
* height in increasing order.
*
- * This operation is complicated by the fact that entries other the the
+ * This operation is complicated by the fact that entries other than the
* target may be inserted, loaded, relocated, or removed from the cache
* (either by eviction or the take ownership flag) as the result of a
* pre_serialize or serialize callback. While entry removals are not
diff --git a/src/H5Cprivate.h b/src/H5Cprivate.h
index 109f5f6..6a661d2 100644
--- a/src/H5Cprivate.h
+++ b/src/H5Cprivate.h
@@ -1125,7 +1125,7 @@ typedef int H5C_ring_t;
* flag will only be applied to one entry, the superblock,
* and the code utilizing these flags is protected with HDasserts
* to enforce this. This restraint can certainly be relaxed in
- * the future if the the need for multiple entries getting flushed
+ * the future if the need for multiple entries getting flushed
* last or collectively arises, though the code allowing for that
* will need to be expanded and tested appropriately if that
* functionality is desired.
diff --git a/src/H5Dint.c b/src/H5Dint.c
index f55b829..34a9d75 100644
--- a/src/H5Dint.c
+++ b/src/H5Dint.c
@@ -1016,7 +1016,7 @@ H5D__update_oh_info(H5F_t *file, H5D_t *dset, hid_t dapl_id)
#endif /* H5O_ENABLE_BOGUS */
/* Add a modification time message, if using older format. */
- /* (If using v18 format versions and above, the the modification time is part of the object
+ /* (If using v18 format versions and above, the modification time is part of the object
* header and doesn't use a separate message -QAK)
*/
if (!use_at_least_v18)
@@ -1506,7 +1506,7 @@ H5D_open(const H5G_loc_t *loc, hid_t dapl_id)
if (H5FO_top_incr(dataset->oloc.file, dataset->oloc.addr) < 0)
HGOTO_ERROR(H5E_DATASET, H5E_CANTINC, NULL, "can't increment object count")
- /* We're the first dataset to use the the shared info */
+ /* We're the first dataset to use the shared info */
dataset->shared->fo_count = 1;
/* Set the external file prefix */
diff --git a/src/H5Doh.c b/src/H5Doh.c
index 1e498bc..42cb543 100644
--- a/src/H5Doh.c
+++ b/src/H5Doh.c
@@ -282,7 +282,7 @@ H5O__dset_create(H5F_t *f, void *_crt_info, H5G_loc_t *obj_loc)
HDassert(crt_info);
HDassert(obj_loc);
- /* Create the the dataset */
+ /* Create the dataset */
if (NULL ==
(dset = H5D__create(f, crt_info->type_id, crt_info->space, crt_info->dcpl_id, crt_info->dapl_id)))
HGOTO_ERROR(H5E_DATASET, H5E_CANTINIT, NULL, "unable to create dataset")
diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h
index 45b941a..9ec6f70 100644
--- a/src/H5Dpublic.h
+++ b/src/H5Dpublic.h
@@ -279,7 +279,7 @@ extern "C" {
*
* \p loc_id may specify a file, group, dataset, named datatype,
* or attribute. If an attribute, dataset, or named datatype is
- * specified then the dataset will be created at the location
+ * specified, then the dataset will be created at the location
* where the attribute, dataset, or named datatype is attached.
*
* \p name may be either an absolute path in the file or a relative
@@ -290,7 +290,7 @@ extern "C" {
* file location where the dataset will be created, the datatype
* is copied and converted to a transient type.
*
- * The link creation property list, \p lcpl_id, governs creation
+ * The link creation property list, \p lcpl_id, governs the creation
* of the link(s) by which the new dataset is accessed and the
* creation of any intermediate groups that may be missing.
*
@@ -348,12 +348,12 @@ H5_DLL hid_t H5Dcreate_async(hid_t loc_id, const char *name, hid_t type_id, hid
*
* \p loc_id may specify a file, group, dataset, named datatype,
* or attribute. If an attribute, dataset, or named datatype is
- * specified then the dataset will be created at the location
+ * specified, then the dataset will be created at the location
* where the attribute, dataset, or named datatype is attached.
*
* The dataset’s datatype and dataspace are specified by
* \p type_id and \p space_id, respectively. These are the
- * datatype and dataspace of the dataset as it will exist in
+ * datatype and dataspace of the dataset as they will exist in
* the file, which may differ from the datatype and dataspace
* in application memory.
*
@@ -692,7 +692,7 @@ H5_DLL herr_t H5Dget_chunk_info_by_coord(hid_t dset_id, const hsize_t *offset, u
* context \p op_data.
*
* \par Example
- * For each chunk, print the allocated chunk size (0 for un-allocated chunks).
+ * For each chunk, print the allocated chunk size (0 for unallocated chunks).
* \snippet H5D_examples.c H5Dchunk_iter_cb
* Iterate over all chunked datasets and chunks in a file.
* \snippet H5D_examples.c H5Ovisit_cb
@@ -729,17 +729,17 @@ H5_DLL herr_t H5Dchunk_iter(hid_t dset_id, hid_t dxpl_id, H5D_chunk_iter_op_t cb
*
* \p chk_idx is the chunk index in the selection. The index value
* may have a value of 0 up to the number of chunks stored in
- * the file that have a nonempty intersection with the file
- * dataspace selection
+ * the file that has a nonempty intersection with the file
+ * dataspace selection.
*
* \note As of 1.10.5, the dataspace intersection is not yet
- * supported, hence, the index is of all the written chunks.
+ * supported. Hence, the index is of all the written chunks.
*
* \p fspace_id specifies the file dataspace selection. It is
- * intended to take #H5S_ALL for specifying the current selection.
+ * intended to take #H5S_ALL to specify the current selection.
*
* \note Please be aware that this function currently does not
- * support non-trivial selections, thus \p fspace_id has no
+ * support non-trivial selections; thus \p fspace_id has no
* effect. Also, the implementation does not handle the #H5S_ALL
* macro correctly. As a workaround, an application can get
* the dataspace for the dataset using H5Dget_space() and pass that
@@ -893,7 +893,7 @@ H5_DLL herr_t H5Dread(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_
*
* This function will produce the same results as \p count calls to
* H5Dread(). Information listed in that function about the specifics
- * of its behaviour also apply to H5Dread_multi(). By calling
+ * of its behavior also applies to H5Dread_multi(). By calling
* H5Dread_multi() instead of multiple calls to H5Dread(), however, the
* library can in some cases pass information about the entire I/O
* operation to the file driver, which can improve performance.
@@ -1156,7 +1156,7 @@ H5_DLL herr_t H5Dwrite_multi_async(size_t count, hid_t dset_id[], hid_t mem_type
* the file. Only one chunk can be written with this function.
*
* \p filters is a mask providing a record of which filters are
- * used with the the chunk. The default value of the mask is
+ * used with the chunk. The default value of the mask is
* zero (0), indicating that all enabled filters are applied. A
* filter is skipped if the bit corresponding to the filter’s
* position in the pipeline (0 ≤ position < 32) is turned on.
@@ -1489,7 +1489,7 @@ H5_DLL herr_t H5Drefresh(hid_t dset_id);
* \p op and scatters it to the supplied buffer \p dst_buf in a
* manner similar to data being written to a dataset.
*
- * \p dst_space_id is a dataspace which defines the extent of \p
+ * \p dst_space_id is a dataspace that defines the extent of \p
* dst_buf and the selection within it to scatter the data to.
*
* \p type_id is the datatype of the data to be scattered in both
@@ -1546,7 +1546,7 @@ H5_DLL herr_t H5Dscatter(H5D_scatter_func_t op, void *op_data, hid_t type_id, hi
* enough to hold all the data if the callback function \p op is
* not provided.
*
- * \p op is a callback function which handles the gathered data.
+ * \p op is a callback function that handles the gathered data.
* It is optional if \p dst_buf is large enough to hold all of the
* gathered data; required otherwise.
*
@@ -1715,10 +1715,10 @@ H5_DLL herr_t H5Dget_chunk_index_type(hid_t did, H5D_chunk_index_t *idx_type);
*
* H5Dcreate() and H5Dcreate_anon() return a dataset identifier for
* success or a negative value for failure. The dataset identifier
- * should eventually be closed by calling H5Dclose() to release
+ * should eventually be closed by calling H5Dclose() to release the
* resources it uses.
*
- * See H5Dcreate_anon() for discussion of the differences between
+ * See H5Dcreate_anon() for a discussion of the differences between
* H5Dcreate() and H5Dcreate_anon().
*
* The HDF5 library provides flexible means of specifying a fill value,
@@ -1794,7 +1794,7 @@ H5_DLL hid_t H5Dopen1(hid_t loc_id, const char *name);
*
* This function ensures that the dataset dimensions are of at least
* the sizes specified in size. The function H5Dset_extent() must be
- * used if the dataset dimension sizes are are to be reduced.
+ * used if the dataset dimension sizes are to be reduced.
*
* \version 1.8.0 Function deprecated in this release. Parameter size
* syntax changed to \Code{const hsize_t size[]} in this release.
@@ -1822,7 +1822,7 @@ H5_DLL herr_t H5Dextend(hid_t dset_id, const hsize_t size[]);
* The \p type_id must be the datatype stored in the buffer. The \p
* space_id describes the selection for the memory buffer to free the
* VL datatypes within. The \p dxpl_id is the dataset transfer property
- * list which was used for the I/O transfer to create the buffer. And
+ * list that was used for the I/O transfer to create the buffer. And
* \p buf is the pointer to the buffer to be reclaimed.
*
* The VL structures (\ref hvl_t) in the user's buffer are modified to
diff --git a/src/H5ESmodule.h b/src/H5ESmodule.h
index 1e333f7..d945b70 100644
--- a/src/H5ESmodule.h
+++ b/src/H5ESmodule.h
@@ -120,7 +120,7 @@
*
* \brief Event Set Interface
*
- * \details \Bold{This interface can be only used with the HDF5 VOL connectors that
+ * \details \Bold{This interface can only be used with the HDF5 VOL connectors that
* enable the asynchronous feature in HDF5.} The native HDF5 library has
* only synchronous operations.
*
diff --git a/src/H5Epublic.h b/src/H5Epublic.h
index dbc3457..c02049a 100644
--- a/src/H5Epublic.h
+++ b/src/H5Epublic.h
@@ -203,7 +203,7 @@ typedef herr_t (*H5E_auto2_t)(hid_t estack, void *client_data);
* \param[in] cls_name Name of the error class
* \param[in] lib_name Name of the client library or application to which the error class belongs
* \param[in] version Version of the client library or application to which the
- error class belongs. Can be \c NULL.
+ error class belongs. It can be \c NULL.
* \return Returns a class identifier on success; otherwise returns H5I_INVALID_ID.
*
* \details H5Eregister_class() registers a client library or application
@@ -341,12 +341,12 @@ H5_DLL herr_t H5Eclose_stack(hid_t stack_id);
*
* \param[in] class_id Error class identifier
* \param[out] name Buffer for the error class name
- * \param[in] size The maximum number of characters the class name to be returned
- * by this function in\p name.
+ * \param[in] size The maximum number of characters of the class name to be returned
+ * by this function in \p name.
* \return Returns non-negative value as on success; otherwise returns negative value.
*
* \details H5Eget_class_name() retrieves the name of the error class specified
- * by the class identifier. If non-NULL pointer is passed in for \p
+ * by the class identifier. If a non-NULL pointer is passed in for \p
* name and \p size is greater than zero, the class name of \p size
* long is returned. The length of the error class name is also
* returned. If NULL is passed in as \p name, only the length of class
@@ -817,7 +817,7 @@ H5_DLL herr_t H5Epush1(const char *file, const char *func, unsigned line, H5E_ma
* \deprecated 1.8.0 Function H5Eprint() renamed to H5Eprint1() and
* deprecated in this release.
*
- * \details H5Eprint1() prints prints the error stack for the current thread
+ * \details H5Eprint1() prints the error stack for the current thread
* on the specified stream, \p stream. Even if the error stack is empty, a
* one-line message of the following form will be printed:
* \code{.unparsed}
diff --git a/src/H5FDhdfs.c b/src/H5FDhdfs.c
index d81e8a5..2c64237 100644
--- a/src/H5FDhdfs.c
+++ b/src/H5FDhdfs.c
@@ -924,7 +924,7 @@ done:
* or "meta" (any other flag)
*
* Prints filename and listing of total number of reads and bytes read,
- * both as a grand total and separate meta- and rawdata reads.
+ * both as a grand total and separate meta- and raw data reads.
*
* If any reads were done, prints out two tables:
*
@@ -1153,11 +1153,11 @@ hdfs__fprint_stats(FILE *stream, const H5FD_hdfs_t *file)
HDfprintf(stream, " %8.3f%c %7d %7d %8.3f%c %8.3f%c %8.3f%c %8.3f%c\n", re_dub,
suffixes[suffix_i], /* bin ceiling */
m->count, /* metadata reads */
- r->count, /* rawdata reads */
+ r->count, /* raw data reads */
bm_val, bm_suffix, /* metadata bytes */
- br_val, br_suffix, /* rawdata bytes */
+ br_val, br_suffix, /* raw data bytes */
am_val, am_suffix, /* metadata average */
- ar_val, ar_suffix); /* rawdata average */
+ ar_val, ar_suffix); /* raw data average */
HDfflush(stream);
}
diff --git a/src/H5FDmulti.h b/src/H5FDmulti.h
index e5975d3..1765c6a 100644
--- a/src/H5FDmulti.h
+++ b/src/H5FDmulti.h
@@ -226,17 +226,17 @@ H5_DLL herr_t H5Pget_fapl_multi(hid_t fapl_id, H5FD_mem_t *memb_map /*out*/, hid
*
* \par Example:
* \code
- * // Example 1: Both metadata and rawdata files are in the same
+ * // Example 1: Both metadata and raw data files are in the same
* // directory. Use Station1-m.h5 and Station1-r.h5 as
- * // the metadata and rawdata files.
+ * // the metadata and raw data files.
* hid_t fapl, fid;
* fapl = H5Pcreate(H5P_FILE_ACCESS);
* H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "-r.h5", H5P_DEFAULT);
* fid=H5Fcreate("Station1",H5F_ACC_TRUNC,H5P_DEFAULT,fapl);
*
- * // Example 2: metadata and rawdata files are in different
+ * // Example 2: metadata and raw data files are in different
* // directories. Use PointA-m.h5 and /pfs/PointA-r.h5 as
- * // the metadata and rawdata files.
+ * // the metadata and raw data files.
* hid_t fapl, fid;
* fapl = H5Pcreate(H5P_FILE_ACCESS);
* H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "/pfs/%s-r.h5", H5P_DEFAULT);
diff --git a/src/H5FDros3.c b/src/H5FDros3.c
index 156da68..9a529d6 100644
--- a/src/H5FDros3.c
+++ b/src/H5FDros3.c
@@ -793,7 +793,7 @@ done:
* or "meta" (any other flag)
*
* Prints filename and listing of total number of reads and bytes read,
- * both as a grand total and separate meta- and rawdata reads.
+ * both as a grand total and separate meta- and raw data reads.
*
* If any reads were done, prints out two tables:
*
@@ -1042,11 +1042,11 @@ ros3_fprint_stats(FILE *stream, const H5FD_ros3_t *file)
HDfprintf(stream, " %8.3f%c %7d %7d %8.3f%c %8.3f%c %8.3f%c %8.3f%c\n", re_dub,
suffixes[suffix_i], /* bin ceiling */
m->count, /* metadata reads */
- r->count, /* rawdata reads */
+ r->count, /* raw data reads */
bm_val, bm_suffix, /* metadata bytes */
- br_val, br_suffix, /* rawdata bytes */
+ br_val, br_suffix, /* raw data bytes */
am_val, am_suffix, /* metadata average */
- ar_val, ar_suffix); /* rawdata average */
+ ar_val, ar_suffix); /* raw data average */
HDfflush(stream);
}
diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h
index 9bee5c4..59f8dec 100644
--- a/src/H5Fpublic.h
+++ b/src/H5Fpublic.h
@@ -398,7 +398,7 @@ H5_DLL hid_t H5Fcreate_async(const char *filename, unsigned flags, hid_t fcpl_id
* opened.
*
* The \p fapl_id parameter specifies the file access property list.
- * Use of #H5P_DEFAULT specifies that default I/O access properties
+ * The use of #H5P_DEFAULT specifies that default I/O access properties
* are to be used.
*
* The \p flags parameter specifies whether the file will be opened in
@@ -530,7 +530,7 @@ H5_DLL hid_t H5Freopen_async(hid_t file_id, hid_t es_id);
* \snippet H5F_examples.c flush
*
* \attention HDF5 does not possess full control over buffering. H5Fflush()
- * flushes the internal HDF5 buffers then asks the operating system
+ * flushes the internal HDF5 buffers and then asks the operating system
* (the OS) to flush the system buffers for the open files. After
* that, the OS is responsible for ensuring that the data is
* actually flushed to disk.
@@ -568,7 +568,7 @@ H5_DLL herr_t H5Fflush_async(hid_t object_id, H5F_scope_t scope, hid_t es_id);
* \snippet H5F_examples.c minimal
*
* \note \Bold{Delayed close:} Note the following deviation from the
- * above-described behavior. If H5Fclose() is called for a file but one
+ * above-described behavior. If H5Fclose() is called for a file, but one
* or more objects within the file remain open, those objects will remain
* accessible until they are individually closed. Thus, if the dataset
* \c data_sample is open when H5Fclose() is called for the file
@@ -577,7 +577,7 @@ H5_DLL herr_t H5Fflush_async(hid_t object_id, H5F_scope_t scope, hid_t es_id);
* automatically closed once all objects in the file have been closed.\n
* Be warned, however, that there are circumstances where it is not
* possible to delay closing a file. For example, an MPI-IO file close is
- * a collective call; all of the processes that opened the file must
+ * a collective call; all of the processes that open the file must
* close it collectively. The file cannot be closed at some time in the
* future by each process in an independent fashion. Another example is
* that an application using an AFS token-based file access privilege may
@@ -1360,7 +1360,7 @@ H5_DLL herr_t H5Fstart_swmr_write(hid_t file_id);
* \snippet this H5F_sect_info_t_snip
*
* This routine retrieves free-space section information for \p nsects
- * sections or at most the maximum number of sections in the specified
+ * sections or, at most, the maximum number of sections in the specified
* free-space manager. If the number of sections is not known, a
* preliminary H5Fget_free_sections() call can be made by setting \p
* sect_info to NULL and the total number of free-space sections for
@@ -1662,7 +1662,7 @@ H5_DLL herr_t H5Fget_mdc_image_info(hid_t file_id, haddr_t *image_addr, hsize_t
* file_id. This setting is used to inform the library to create
* minimized dataset object headers when \c TRUE.
*
- * The setting's value is returned in the boolean pointer minimize.
+ * The setting's value is returned in the boolean pointer minimized.
*
* \since 1.10.5
*
@@ -1888,7 +1888,7 @@ H5_DLL herr_t H5Fget_info1(hid_t obj_id, H5F_info1_t *file_info);
/**
* \ingroup H5F
*
- * \brief Sets thelatest version of the library to be used for writing objects
+ * \brief Sets the latest version of the library to be used for writing objects
*
* \file_id
* \param[in] latest_format Latest format flag
diff --git a/src/H5Gmodule.h b/src/H5Gmodule.h
index d4738f6..f09486d 100644
--- a/src/H5Gmodule.h
+++ b/src/H5Gmodule.h
@@ -886,24 +886,24 @@
* objects appear in at least one group (with the possible exception of
* the root object) and since objects can have names in more than one
* group, the set of all objects in an HDF5 file is a directed
- * graph. The internal nodes (nodes with out-degree greater than zero)
- * must be groups while the leaf nodes (nodes with out-degree zero) are
+ * graph. The internal nodes (nodes with an out-degree greater than zero)
+ * must be groups, while the leaf nodes (nodes with an out-degree zero) are
* either empty groups or objects of some other type. Exactly one
* object in every non-empty file is the root object. The root object
* always has a positive in-degree because it is pointed to by the file
- * super block.
+ * superblock.
*
* \Bold{Locating objects in the HDF5 file hierarchy:} An object name
* consists of one or more components separated from one another by
- * slashes. An absolute name begins with a slash and the object is
+ * slashes. An absolute name begins with a slash, and the object is
* located by looking for the first component in the root object, then
* looking for the second component in the first object, etc., until
* the entire name is traversed. A relative name does not begin with a
- * slash and the traversal begins at the location specified by the
+ * slash, and the traversal begins at the location specified by the
* create or access function.
*
* \Bold{Group implementations in HDF5:} The original HDF5 group
- * implementation provided a single indexed structure for link
+ * implementation provided a single-indexed structure for link
* storage. A new group implementation, in HDF5 Release 1.8.0, enables
* more efficient compact storage for very small groups, improved link
* indexing for large groups, and other advanced features.
diff --git a/src/H5Goh.c b/src/H5Goh.c
index 5e8ab02..94d51f0 100644
--- a/src/H5Goh.c
+++ b/src/H5Goh.c
@@ -246,7 +246,7 @@ H5O__group_create(H5F_t *f, void *_crt_info, H5G_loc_t *obj_loc)
HDassert(crt_info);
HDassert(obj_loc);
- /* Create the the group */
+ /* Create the group */
if (NULL == (grp = H5G__create(f, crt_info)))
HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, NULL, "unable to create group")
diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h
index ace2071..0e0a58b 100644
--- a/src/H5Gpublic.h
+++ b/src/H5Gpublic.h
@@ -406,7 +406,7 @@ H5_DLL herr_t H5Gget_info_by_idx_async(hid_t loc_id, const char *group_name, H5_
* \return \herr_t
*
* \details H5Gflush() causes all buffers associated with a group to be
- * immediately flushed to disk without removing the data from
+ * immediately flushed to the disk without removing the data from
* the cache.
*
* \attention
@@ -414,7 +414,7 @@ H5_DLL herr_t H5Gget_info_by_idx_async(hid_t loc_id, const char *group_name, H5_
* flushes the internal HDF5 buffers and then asks the operating
* system (the OS) to flush the system buffers for the open
* files. After that, the OS is responsible for ensuring that
- * the data is actually flushed to disk.
+ * the data is actually flushed to the disk.
*
* \since 1.8.0
*
@@ -435,7 +435,7 @@ H5_DLL herr_t H5Gflush(hid_t group_id);
* cleared and immediately re-loaded with updated contents from disk.
*
* This function essentially closes the group, evicts all
- * metadata associated with it from the cache, and then re-opens
+ * metadata associated with it from the cache, and then reopens
* the group. The reopened group is automatically re-registered
* with the same identifier.
*
@@ -454,7 +454,7 @@ H5_DLL herr_t H5Grefresh(hid_t group_id);
*
* \return \herr_t
*
- * \details H5Gclose() releases resources used by a group which was
+ * \details H5Gclose() releases resources used by a group that was
* opened by H5Gcreate() or H5Gopen(). After closing a group,
* \p group_id cannot be used again until another H5Gcreate()
* or H5Gopen() is called on it.
@@ -926,7 +926,7 @@ H5_DLL herr_t H5Gset_comment(hid_t loc_id, const char *name, const char *comment
* \deprecated This function is deprecated in favor of the function
* H5Oget_comment().
*
- * \details H5Gget_comment() retrieves the comment for the the object specified
+ * \details H5Gget_comment() retrieves the comment for the object specified
* by \p loc_id and \p name. The comment is returned in the buffer \p
* buf.
*
@@ -987,7 +987,7 @@ H5_DLL int H5Gget_comment(hid_t loc_id, const char *name, size_t bufsize, char *
* The operation receives the group identifier for the group being
* iterated over, \p group, the name of the current object within
* the group, \p name, and the pointer to the operator data
- * passed in to H5Giterate(), \p op_data.
+ * passed into H5Giterate(), \p op_data.
*
* The return values from an operator are:
* \li Zero causes the iterator to continue, returning zero when all
@@ -1096,7 +1096,7 @@ H5_DLL herr_t H5Gget_objinfo(hid_t loc_id, const char *name, hbool_t follow_link
*-------------------------------------------------------------------------
* \ingroup H5G
*
- * \brief Returns a name of an object specified by an index
+ * \brief Returns the name of an object specified by an index
*
* \fg_loc_id
* \param[in] idx Transient index identifying object
@@ -1109,7 +1109,7 @@ H5_DLL herr_t H5Gget_objinfo(hid_t loc_id, const char *name, hbool_t follow_link
*
* \deprecated This function is deprecated in favor of the function H5Lget_name_by_idx().
*
- * \details H5Gget_objname_by_idx() returns a name of the object specified by
+ * \details H5Gget_objname_by_idx() returns the name of the object specified by
* the index \p idx in the group \p loc_id.
*
* The group is specified by a group identifier \p loc_id. If
diff --git a/src/H5HFcache.c b/src/H5HFcache.c
index 3cb067c..ab01c1e 100644
--- a/src/H5HFcache.c
+++ b/src/H5HFcache.c
@@ -3385,7 +3385,7 @@ H5HF__cache_verify_descendant_iblocks_clean(H5F_t *f, haddr_t fd_parent_addr, H5
* If the entry is unprotected and unpinned, we simply
* protect it.
*
- * If, however, the the child iblock is already protected,
+ * If, however, the child iblock is already protected,
* but not pinned, we have a bit of a problem, as we have
* no legitimate way of looking up its pointer in memory.
*
diff --git a/src/H5Ipublic.h b/src/H5Ipublic.h
index d699c92..69b2450 100644
--- a/src/H5Ipublic.h
+++ b/src/H5Ipublic.h
@@ -235,7 +235,7 @@ H5_DLL hid_t H5Iget_file_id(hid_t id);
* \brief Retrieves a name of an object based on the object identifier
*
* \obj_id{id}
- * \param[out] name A buffer for thename associated with the identifier
+ * \param[out] name A buffer for the name associated with the identifier
* \param[in] size The size of the \p name buffer; usually the size of
* the name in bytes plus 1 for a NULL terminator
*
@@ -339,7 +339,7 @@ H5_DLL int H5Iinc_ref(hid_t id);
* with H5Iinc_ref(). When an object identifier’s reference count
* reaches zero, the object will be closed. Calling an object
* identifier’s \c close function decrements the reference count for
- * the identifier which normally closes the object, but if the
+ * the identifier, which normally closes the object, but if the
* reference count for the identifier has been incremented with
* H5Iinc_ref(), the object will only be closed when the reference
* count reaches zero with further calls to this function or the
@@ -348,15 +348,15 @@ H5_DLL int H5Iinc_ref(hid_t id);
* If the object ID was created by a collective parallel call (such as
* H5Dcreate(), H5Gopen(), etc.), the reference count should be
* modified by all the processes which have copies of the ID.
- * Generally this means that group, dataset, attribute, file and named
+ * Generally, this means that group, dataset, attribute, file and named
* datatype IDs should be modified by all the processes and that all
* other types of IDs are safe to modify by individual processes.
*
- * This function is of particular value when an application is
- * maintaining multiple copies of an object ID. The object ID can be
+ * This function is of particular value when an application
+ * maintains multiple copies of an object ID. The object ID can be
* incremented when a copy is made. Each copy of the ID can then be
* safely closed or decremented and the HDF5 object will be closed
- * when the reference count for that that object drops to zero.
+ * when the reference count for that object drops to zero.
*
* \since 1.6.2
*
@@ -643,7 +643,7 @@ H5_DLL htri_t H5Itype_exists(H5I_type_t type);
* \details Valid identifiers are those that have been obtained by an
* application and can still be used to access the original target.
* Examples of invalid identifiers include:
- * \li Out of range values: negative, for example
+ * \li Out-of-range values: negative, for example
* \li Previously-valid identifiers that have been released:
* for example, a dataset identifier for which the dataset has
* been closed
@@ -651,7 +651,7 @@ H5_DLL htri_t H5Itype_exists(H5I_type_t type);
* H5Iis_valid() can be used with any type of identifier: object
* identifier, property list identifier, attribute identifier, error
* message identifier, etc. When necessary, a call to H5Iget_type()
- * can determine the type of the object that \p id identifies.
+ * can determine the type of object that the \p id identifies.
*
* \since 1.8.3
*
diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h
index 6feefcd..653bf27 100644
--- a/src/H5Lpublic.h
+++ b/src/H5Lpublic.h
@@ -209,7 +209,7 @@ H5_DLL herr_t H5Lmove(hid_t src_loc, const char *src_name, hid_t dst_loc, const
*
* H5Lcopy() retains the creation time and the target of the original
* link. However, since the link may be renamed, the character
- * encoding is that specified in \p lcpl_id rather than that of the
+ * encoding is specified in \p lcpl_id rather than in that of the
* original link. Other link creation properties are ignored.
*
* If the link is a soft link, also known as a symbolic link, its
@@ -337,7 +337,7 @@ H5_DLL herr_t H5Lcreate_hard_async(hid_t cur_loc_id, const char *cur_name, hid_t
*
* For instance, if target_path is \c ./foo, \p link_loc_id specifies
* \c ./x/y/bar, and the name of the new link is \c new_link, then a
- * subsequent request for \c ./x/y/bar/new_link will return same the
+ * subsequent request for \c ./x/y/bar/new_link will return the same
* object as would be found at \c ./foo.
*
* \note H5Lcreate_soft() is for use only if the target object is in the
@@ -480,7 +480,7 @@ H5_DLL herr_t H5Ldelete_by_idx_async(hid_t loc_id, const char *group_name, H5_in
*
* \return \herr_t
*
- * \details H5Lget_val() returns the value of link \p name. For smbolic links,
+ * \details H5Lget_val() returns the value of link \p name. For symbolic links,
* this is the path to which the link points, including the null
* terminator. For external and user-defined links, it is the link
* buffer.
@@ -607,7 +607,7 @@ H5_DLL herr_t H5Lget_val_by_idx(hid_t loc_id, const char *group_name, H5_index_t
* the link \c datasetD in the \c group group1/group2/softlink_to_group3/,
* where \c group1 is a member of the group specified by \c loc_id:
*
- * 1. First use H5Lexists() to verify that \c group1 exists.
+ * 1. First, use H5Lexists() to verify that the \c group1 exists.
* 2. If \c group1 exists, use H5Lexists() again, this time with name
* set to \c group1/group2, to verify that \c group2 exists.
* 3. If \c group2 exists, use H5Lexists() with name set to
@@ -624,7 +624,7 @@ H5_DLL herr_t H5Lget_val_by_idx(hid_t loc_id, const char *group_name, H5_index_t
* \c /group1/group2/softlink_to_group3, the first call to H5Lexists()
* would have name set to \c /group1.
*
- * Note that this is an outline and does not include all necessary
+ * Note that this is an outline and does not include all the necessary
* details. Depending on circumstances, for example, you may need to
* verify that an intermediate link points to a group and that a soft
* link points to an existing target.
@@ -713,7 +713,7 @@ H5_DLL herr_t H5Lexists_async(hid_t loc_id, const char *name, hbool_t *exists, h
* There will be additional valid values if user-defined links have
* been registered.
*
- * \p corder specifies the link’s creation order position while
+ * \p corder specifies the link’s creation order position, while
* \p corder_valid indicates whether the value in corder is valid.
*
* If \p corder_valid is \c TRUE, the value in \p corder is known to
@@ -732,7 +732,7 @@ H5_DLL herr_t H5Lexists_async(hid_t loc_id, const char *name, hbool_t *exists, h
* This value is set with #H5Pset_char_encoding.
*
* \c token is the location that a hard link points to, and
- * \c val_size is the size of a soft link or user defined link value.
+ * \c val_size is the size of a soft link or user-defined link value.
* H5O_token_t is used in the VOL layer. It is defined in H5public.h
* as:
* \snippet H5public.h H5O_token_t_snip
@@ -1118,7 +1118,7 @@ H5_DLL herr_t H5Lvisit2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order
* (with an absolute name based in the file’s root group) or a group
* relative to \p loc_id. If \p loc_id fully specifies the group that
* is to serve as the root of the iteration, group_name should be '.'
- * (a dot). (Note that when \p loc_id fully specifies the the group
+ * (a dot). (Note that when \p loc_id fully specifies the group
* that is to serve as the root of the iteration, the user may wish to
* consider using H5Lvisit2() instead of H5Lvisit_by_name2().)
*
@@ -1363,7 +1363,7 @@ H5_DLL herr_t H5Lunpack_elink_val(const void *ext_linkval /*in*/, size_t link_si
* If that target file does not exist, the new \p file_name after
* stripping will be \c A.h5.
* - For Windows, there are 6 cases:
- * -# \p file_name is an absolute drive with absolute pathname.
+ * -# \p file_name is an absolute drive with an absolute pathname.
* For example, consider a \p file_name of \c /tmp/A.h5. If that
* target file does not exist, the new \p file_name after
* stripping will be \c A.h5.
@@ -1371,16 +1371,16 @@ H5_DLL herr_t H5Lunpack_elink_val(const void *ext_linkval /*in*/, size_t link_si
* name. For example, consider a \p file_name of \c /tmp/A.h5.
* If that target file does not exist, the new \p file_name after
* stripping will be \c A.h5.
- * -# \p file_name is an absolute drive with relative pathname.
+ * -# \p file_name is an absolute drive with a relative pathname.
* For example, consider a \p file_name of \c /tmp/A.h5. If that
* target file does not exist, the new \p file_name after
* stripping will be \c tmp\A.h5.
* -# \p file_name is in UNC (Uniform Naming Convention) format with
- * server name, share name, and pathname. For example, consider
+ * a server name, share name, and pathname. For example, consider
* a \p file_name of \c /tmp/A.h5. If that target file does not
* exist, the new \p file_name after stripping will be \c A.h5.
* -# \p file_name is in Long UNC (Uniform Naming Convention) format
- * with server name, share name, and pathname. For example,
+ * with a server name, share name, and pathname. For example,
* consider a \p file_name of \c /tmp/A.h5. If that target file
* does not exist, the new \p file_name after stripping will be
* \c A.h5.
@@ -1390,7 +1390,7 @@ H5_DLL herr_t H5Lunpack_elink_val(const void *ext_linkval /*in*/, size_t link_si
* does not exist, the new \p file_name after stripping will be
* \c A.h5.
*
- * The library opens target file \p file_name with the file access
+ * The library opens the target file \p file_name with the file access
* property list that is set via H5Pset_elink_fapl() when the external
* link link_name is accessed. If no such property list is set, the
* library uses the file access property list associated with the file
@@ -1879,7 +1879,7 @@ H5_DLL herr_t H5Lvisit1(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order
* (with an absolute name based in the file’s root group) or a group
* relative to \p loc_id. If \p loc_id fully specifies the group that
* is to serve as the root of the iteration, group_name should be '.'
- * (a dot). (Note that when \p loc_id fully specifies the the group
+ * (a dot). (Note that when \p loc_id fully specifies the group
* that is to serve as the root of the iteration, the user may wish to
* consider using H5Lvisit1() instead of H5Lvisit_by_name1().)
*
diff --git a/src/H5MF.c b/src/H5MF.c
index be71b2f..9f430c9 100644
--- a/src/H5MF.c
+++ b/src/H5MF.c
@@ -3236,7 +3236,7 @@ H5MF_settle_meta_data_fsm(H5F_t *f, hbool_t *fsm_settled)
* multi file drivers, as the self referential free space
* manager header and section info can be stored in up to
* two different files -- requiring that up to two EOA's
- * be stored in the the free space managers super block
+ * be stored in the free space manager's superblock
* extension message.
*
* As of this writing, we are solving this problem by
diff --git a/src/H5Mpublic.h b/src/H5Mpublic.h
index 86fe433..f5874e8 100644
--- a/src/H5Mpublic.h
+++ b/src/H5Mpublic.h
@@ -211,7 +211,7 @@ extern "C" {
* \details H5Mcreate() creates a new map object for storing key-value
* pairs. The in-file datatype for keys is defined by \p key_type_id
* and the in-file datatype for values is defined by \p val_type_id. \p
- * loc_id specifies the location to create the the map object and \p
+ * loc_id specifies the location to create the map object and \p
* name specifies the name of the link to the map object relative to
* \p loc_id.
*
diff --git a/src/H5Oalloc.c b/src/H5Oalloc.c
index 17c1535..8484678 100644
--- a/src/H5Oalloc.c
+++ b/src/H5Oalloc.c
@@ -517,7 +517,7 @@ H5O__alloc_extend_chunk(H5F_t *f, H5O_t *oh, unsigned chunkno, size_t size, size
HDassert(H5F_addr_defined(oh->chunk[chunkno].addr));
/* Test to see if the specified chunk ends with a null messages.
- * If successful, set the index of the the null message in extend_msg.
+ * If successful, set the index of the null message in extend_msg.
*/
for (u = 0; u < oh->nmesgs; u++) {
/* Check for null message at end of proper chunk */
diff --git a/src/H5Omodule.h b/src/H5Omodule.h
index afb005b..deb00bd 100644
--- a/src/H5Omodule.h
+++ b/src/H5Omodule.h
@@ -52,7 +52,7 @@
*
* HDF5 objects are deleted as a side effect of rendering them unreachable
* from the root group. The net effect is the diminution of the object's
- * reference count to zero, which can (but should not usually) be effected
+ * reference count to zero, which can (but should not usually) be affected
* by a function in this module.
*
* <table>
diff --git a/src/H5Opublic.h b/src/H5Opublic.h
index 65e140f..6fba508 100644
--- a/src/H5Opublic.h
+++ b/src/H5Opublic.h
@@ -246,7 +246,7 @@ extern "C" {
*
* H5Oopen() cannot be used to open a dataspace, attribute, property list, or file.
*
- * Once an object of unknown type has been opened with H5Oopen(),
+ * Once an object of an unknown type has been opened with H5Oopen(),
* the type of that object can be determined by means of an H5Iget_type() call.
*
* \p loc_id may be a file, group, dataset, named datatype, or attribute.
@@ -384,7 +384,7 @@ H5_DLL hid_t H5Oopen_by_idx_async(hid_t loc_id, const char *group_name, H5_inde
* the \p loc_id and \p name combination exists.
* \return Returns 0 if the object pointed to by
* the \p loc_id and \p name combination does not exist.
- * \return Returns a negatvie value when the function fails.
+ * \return Returns a negative value when the function fails.
*
* \details H5Oexists_by_name() allows an application to determine whether
* the link \p name in the group or file specified with \p loc_id
@@ -408,22 +408,22 @@ H5_DLL hid_t H5Oopen_by_idx_async(hid_t loc_id, const char *group_name, H5_inde
* where \c group1 is a member of the group specified by \c loc_id:
*
* \par
- * - First use H5Lexists() to verify that a link named \c group1 exists.
+ * - First, use H5Lexists() to verify that a link named \c group1 exists.
* - If \c group1 exists, use H5Oexists_by_name() to verify that the
* link \c group1 resolves to an object.
- * - If \c group1 exists, use H5Lexists() again, this time with name
+ * - If \c group1 exists, use H5Lexists() again, this time with the name
* set to \c group1/group2, to verify that the link \c group2 exists
* in \c group1.
* - If the \c group2 link exists, use H5Oexists_by_name() to verify
* that \c group1/group2 resolves to an object.
- * - If \c group2 exists, use H5Lexists() again, this time with name
+ * - If \c group2 exists, use H5Lexists() again, this time with the name
* set to \c group1/group2/softlink_to_group3, to verify that the
* link \c softlink_to_group3 exists in \c group2.
* - If the \c softlink_to_group3 link exists, use H5Oexists_by_name()
* to verify that \c group1/group2/softlink_to_group3 resolves to
* an object.
* - If \c softlink_to_group3 exists, you can now safely use H5Lexists
- * with name set to \c group1/group2/softlink_to_group3/datasetD to
+ * with the name set to \c group1/group2/softlink_to_group3/datasetD to
* verify that the target link, \c datasetD, exists.
* - And finally, if the link \c datasetD exists, use H5Oexists_by_name
* to verify that \c group1/group2/softlink_to_group3/datasetD
@@ -437,12 +437,12 @@ H5_DLL hid_t H5Oopen_by_idx_async(hid_t loc_id, const char *group_name, H5_inde
* H5Lexists() would have name set to \c /group1.
*
* \par
- * Note that this is an outline and does not include all necessary
+ * Note that this is an outline and does not include all the necessary
* details. Depending on circumstances, for example, an application
* may need to verify the type of an object also.
*
* \warning \Bold{Failure Modes:}
- * \warning If \p loc_id and \p name both exist but the combination does not
+ * \warning If \p loc_id and \p name both exist, but the combination does not
* resolve to an object, the function will return 0 (zero);
* the function does not fail in this case.
* \warning If either the location or the link specified by the \p loc_id
@@ -492,7 +492,7 @@ H5_DLL htri_t H5Oexists_by_name(hid_t loc_id, const char *name, hid_t lapl_id);
* \note If you are iterating through a lot of different objects to
* retrieve information via the H5Oget_info() family of routines,
* you may see memory building up. This can be due to memory
- * allocation for metadata such as object headers and messages
+ * allocation for metadata, such as object headers and messages,
* when the iterated objects are put into the metadata cache.
* \note
* If the memory buildup is not desirable, you can configure a
@@ -722,7 +722,7 @@ H5_DLL herr_t H5Oget_native_info_by_idx(hid_t loc_id, const char *group_name, H5
*
* \details H5Olink() creates a new hard link to an object in an HDF5 file.
* \p new_loc_id and \p \p new_link_name specify the location and name of the
- * new link while \p object_id identifies the object that the link
+ * new link, while \p object_id identifies the object that the link
* points to.
*
* H5Olink() is designed for two purposes:
@@ -792,7 +792,7 @@ H5_DLL herr_t H5Olink(hid_t obj_id, hid_t new_loc_id, const char *new_name, hid_
* An object’s reference count is the number of hard links in the
* file that point to that object. See the “Programming Model”
* section of the HDF5 Groups chapter in the -- <em>\ref UG</em>
- * for a more complete discussion of reference counts.
+ * for a complete discussion of reference counts.
*
* If a user application needs to determine an object’s reference
* count, an H5Oget_info() call is required; the reference count
@@ -965,7 +965,7 @@ H5_DLL herr_t H5Ocopy_async(hid_t src_loc_id, const char *src_name, hid_t dst_lo
* is overwritten.
*
* The target object is specified by an identifier, \p obj_id.
- * If \p comment is the empty string or a null pointer, any existing
+ * If \p comment is an empty string or a null pointer, any existing
* comment message is removed from the object.
*
* Comments should be relatively short, null-terminated, ASCII strings.
@@ -1010,7 +1010,7 @@ H5_DLL herr_t H5Oset_comment(hid_t obj_id, const char *comment);
* - An absolute name of the object, starting from \c /, the file’s root group
* - A dot (\c .), if \p loc_id fully specifies the object
*
- * If \p comment is the empty string or a null pointer, any existing
+ * If \p comment is an empty string or a null pointer, any existing
* comment message is removed from the object.
*
* Comments should be relatively short, null-terminated, ASCII strings.
@@ -1064,7 +1064,7 @@ H5_DLL herr_t H5Oset_comment_by_name(hid_t loc_id, const char *name, const char
* only \p bufsize bytes of the comment, without a \c NULL terminator,
* are returned in \p comment.
*
- * If an object does not have a comment, the empty string is
+ * If an object does not have a comment, an empty string is
* returned in \p comment.
*
* \version 1.8.11 Fortran subroutine introduced in this release.
@@ -1112,7 +1112,7 @@ H5_DLL ssize_t H5Oget_comment(hid_t obj_id, char *comment, size_t bufsize);
* only \p bufsize bytes of the comment, without a \c NULL terminator,
* are returned in \p comment.
*
- * If an object does not have a comment, the empty string is
+ * If an object does not have a comment, an empty string is
* returned in \p comment.
*
* \p lapl_id contains a link access property list identifier. A
@@ -1259,7 +1259,7 @@ H5_DLL herr_t H5Ovisit3(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* a file or an object in a file; if \p loc_id is an attribute identifier,
* the object where the attribute is attached will be used.
* \p obj_name specifies either an object in the file (with an absolute
- * name based in the file’s root group) or an object name relative
+ * name based on the file’s root group) or an object name relative
* to \p loc_id. If \p loc_id fully specifies the object that is to serve
* as the root of the iteration, \p obj_name should be '\c .' (a dot).
* (Note that when \p loc_id fully specifies the object that is to serve
@@ -1374,7 +1374,7 @@ H5_DLL herr_t H5Oclose_async(hid_t object_id, hid_t es_id);
* flushed to disk without removing the data from the cache.
*
* The object associated with \p object_id can be any named object in an
- * HDF5 file including a dataset, a group, or a committed datatype.
+ * HDF5 file, including a dataset, a group, or a committed datatype.
*
* \warning H5Oflush doesn't work correctly with parallel. It causes an assertion
* failure in metadata cache during H5Fclose().
@@ -1781,7 +1781,7 @@ typedef herr_t (*H5O_iterate1_t)(hid_t obj, const char *name, const H5O_info1_t
*
* The object’s address within the file, \p addr, is the byte offset of the first byte
* of the object header from the beginning of the HDF5 file space, i.e., from the
- * beginning of the super block (see the “HDF5 Storage Model” section of the The
+ * beginning of the superblock (see the “HDF5 Storage Model” section of the The
* HDF5 Data Model and File Structure chapter of the <em>HDF5 User's Guide</em>.)
*
* \p addr can be obtained via either of two function calls. H5Gget_objinfo() returns
@@ -1800,7 +1800,7 @@ typedef herr_t (*H5O_iterate1_t)(hid_t obj, const char *name, const H5O_info1_t
* overcome by retrieving the object address with H5Gget_objinfo() or H5Lget_info()
* immediately before calling H5Oopen_by_addr(). The immediacy of the operation can be
* important; if time has elapsed and the object has been deleted from the file,
- * the address will be invalid and file corruption can result.
+ * the address will be invalid, and file corruption can result.
*
* \version 1.8.4 Fortran subroutine added in this release.
*
@@ -1829,7 +1829,7 @@ H5_DLL hid_t H5Oopen_by_addr(hid_t loc_id, haddr_t addr);
* \note If you are iterating through a lot of different objects to
* retrieve information via the H5Oget_info() family of routines,
* you may see memory building up. This can be due to memory
- * allocation for metadata such as object headers and messages
+ * allocation for metadata, such as object headers and messages,
* when the iterated objects are put into the metadata cache.
* \note
* If the memory buildup is not desirable, you can configure a
@@ -1967,7 +1967,7 @@ H5_DLL herr_t H5Oget_info_by_idx1(hid_t loc_id, const char *group_name, H5_index
* \note If you are iterating through a lot of different objects to
* retrieve information via the H5Oget_info() family of routines,
* you may see memory building up. This can be due to memory
- * allocation for metadata such as object headers and messages
+ * allocation for metadata, such as object headers and messages,
* when the iterated objects are put into the metadata cache.
* \note
* If the memory buildup is not desirable, you can configure a
@@ -2197,7 +2197,7 @@ H5_DLL herr_t H5Ovisit1(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* a file or an object in a file; if \p loc_id is an attribute identifier,
* the object where the attribute is attached will be used.
* \p obj_name specifies either an object in the file (with an absolute
- * name based in the file’s root group) or an object name relative
+ * name based on the file’s root group) or an object name relative
* to \p loc_id. If \p loc_id fully specifies the object that is to serve
* as the root of the iteration, \p obj_name should be '\c .' (a dot).
* (Note that when \p loc_id fully specifies the object that is to serve
diff --git a/src/H5Oshared.h b/src/H5Oshared.h
index 07bc4a1..3280c4b 100644
--- a/src/H5Oshared.h
+++ b/src/H5Oshared.h
@@ -418,7 +418,7 @@ H5O_SHARED_POST_COPY_FILE(const H5O_loc_t H5_ATTR_NDEBUG_UNUSED *oloc_src, const
HGOTO_ERROR(H5E_OHDR, H5E_CANTCOPY, FAIL, "unable to update native message")
#endif /* H5O_SHARED_POST_COPY_FILE_UPD */
- /* Make sure that if the the source or destination is committed, both are
+ /* Make sure that if the source or destination is committed, both are
* committed */
HDassert((shared_src->type == H5O_SHARE_TYPE_COMMITTED) ==
(shared_dst->type == H5O_SHARE_TYPE_COMMITTED));
diff --git a/src/H5PLpublic.h b/src/H5PLpublic.h
index 4595d22..c53053b 100644
--- a/src/H5PLpublic.h
+++ b/src/H5PLpublic.h
@@ -95,9 +95,9 @@ H5_DLL herr_t H5PLset_loading_state(unsigned int plugin_control_mask);
* \brief Queries the loadability of dynamic plugin types
*
* \param[out] plugin_control_mask List of dynamic plugin types that are enabled or disabled.\n
- * A plugin bit set to 0 (zero) indicates that that the dynamic plugin type is
+ * A plugin bit set to 0 (zero) indicates that the dynamic plugin type is
* disabled.\n
- * A plugin bit set to 1 (one) indicates that that the dynamic plugin type is
+ * A plugin bit set to 1 (one) indicates that the dynamic plugin type is
* enabled.\n
* If the value of \p plugin_control_mask is negative, all dynamic plugin
* types are enabled.\n
@@ -105,7 +105,7 @@ H5_DLL herr_t H5PLset_loading_state(unsigned int plugin_control_mask);
* are disabled.
* \return \herr_t
*
- * \details H5PLget_loading_state() retrieves the bitmask that controls whether a certain type of plugins
+ * \details H5PLget_loading_state() retrieves the bitmask that controls whether a certain type of plugin
* (e.g.: filters, VOL drivers) will be loaded by the HDF5 library.
*
* Bit positions allocated to date are specified in \ref H5PL_type_t as follows:
diff --git a/src/H5Pfapl.c b/src/H5Pfapl.c
index 07d64bc..8e9b680 100644
--- a/src/H5Pfapl.c
+++ b/src/H5Pfapl.c
@@ -5957,7 +5957,7 @@ H5Pset_page_buffer_size(hid_t plist_id, size_t buf_size, unsigned min_meta_perc,
"Minimum metadata fractions must be between 0 and 100 inclusive")
if (min_raw_perc > 100)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
- "Minimum rawdata fractions must be between 0 and 100 inclusive")
+ "Minimum raw data fractions must be between 0 and 100 inclusive")
if (min_meta_perc + min_raw_perc > 100)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
@@ -5969,7 +5969,7 @@ H5Pset_page_buffer_size(hid_t plist_id, size_t buf_size, unsigned min_meta_perc,
if (H5P_set(plist, H5F_ACS_PAGE_BUFFER_MIN_META_PERC_NAME, &min_meta_perc) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set percentage of min metadata entries")
if (H5P_set(plist, H5F_ACS_PAGE_BUFFER_MIN_RAW_PERC_NAME, &min_raw_perc) < 0)
- HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set percentage of min rawdata entries")
+ HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set percentage of min raw data entries")
done:
FUNC_LEAVE_API(ret_value)
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h
index 24dc754..bb5d421 100644
--- a/src/H5Ppublic.h
+++ b/src/H5Ppublic.h
@@ -2419,7 +2419,7 @@ H5_DLL herr_t H5Pset_deflate(hid_t plist_id, unsigned level);
* format. The filters will come into play only when dense storage
* is used (see H5Pset_link_phase_change()) and will be applied to
* the group’s fractal heap. The fractal heap will contain most of
- * the the group’s link metadata, including link names.
+ * the group’s link metadata, including link names.
*
* \note When working with group creation property lists, if you are
* adding a filter that is not in HDF5’s set of predefined filters,
@@ -3268,7 +3268,7 @@ H5_DLL herr_t H5Pget_cache(hid_t plist_id, int *mdc_nelmts, /* out */
* after the call to H5Pset_fapl_core(). It is an error to use this
* function with any other VFD.
*
- * \note This function only applies to the backing store write operation
+ * \note This function only applies to the backing store write operation,
* which typically occurs when the file is flushed or closed. This
* function has no relationship to the increment parameter passed
* to H5Pset_fapl_core().
@@ -3315,7 +3315,7 @@ H5_DLL herr_t H5Pget_core_write_tracking(hid_t fapl_id, hbool_t *is_enabled, siz
* <tr>
* <td>Direct</td>
* <td>#H5FD_DIRECT</td>
- * <td>This is the #H5FD_SEC2 driver except data is written to or
+ * <td>This is the #H5FD_SEC2 driver, except data is written to or
* read from the file synchronously without being cached by the
* system.</td>
* <td>H5Pset_fapl_direct()</td>
@@ -3366,7 +3366,7 @@ H5_DLL herr_t H5Pget_core_write_tracking(hid_t fapl_id, hbool_t *is_enabled, siz
* <td>Multi</td>
* <td>#H5FD_MULTI</td>
* <td>With this driver, data can be stored in multiple files
- * according to the type of the data. I/O might work better if
+ * according to the type of data. I/O might work better if
* data is stored in separate files based on the type of data.
* The Split driver is a special case of this driver.</td>
* <td>H5Pset_fapl_multi()</td>
@@ -3947,7 +3947,7 @@ H5_DLL herr_t H5Pget_metadata_read_attempts(hid_t plist_id, unsigned *attempts);
* for more information.
*
* The type of data returned in \p type will be one of those
- * listed in the discussion of the \p type parameter in the the
+ * listed in the discussion of the \p type parameter in the
* description of the function H5Pset_multi_type().
*
* Use of this function is only appropriate for an HDF5 file
@@ -4106,7 +4106,7 @@ H5_DLL herr_t H5Pget_vol_info(hid_t plist_id, void **vol_info);
* \details H5Pset_alignment() sets the alignment properties of a
* file access property list so that any file object greater
* than or equal in size to \p threshold bytes will be aligned
- * on an address which is a multiple of \p alignment. The
+ * on an address that is a multiple of \p alignment. The
* addresses are relative to the end of the user block; the
* alignment is calculated by subtracting the user block size
* from the absolute file address and then adjusting the address
@@ -4116,7 +4116,7 @@ H5_DLL herr_t H5Pget_vol_info(hid_t plist_id, void **vol_info);
* implying no alignment. Generally the default values will
* result in the best performance for single-process access to
* the file. For MPI IO and other parallel systems, choose an
- * alignment which is a multiple of the disk block size.
+ * alignment that is a multiple of the disk block size.
*
* If the file space handling strategy is set to
* #H5F_FSPACE_STRATEGY_PAGE, then the alignment set via this
@@ -4154,7 +4154,7 @@ H5_DLL herr_t H5Pset_alignment(hid_t fapl_id, hsize_t threshold, hsize_t alignme
* penalized when determining which chunks to flush
* from cache. A value of 0 means fully read or
* written chunks are treated no differently than
- * other chunks (the preemption is strictly LRU)
+ * other chunks (the preemption is strictly LRU),
* while a value of 1 means fully read or written
* chunks are always preempted before other chunks.
* If your application only reads or writes data once,
@@ -4176,7 +4176,7 @@ H5_DLL herr_t H5Pset_alignment(hid_t fapl_id, hsize_t threshold, hsize_t alignme
* computing a hash value using the address of a chunk and then by
* using that hash value as the chunk’s index into the table of
* cached chunks. In other words, the size of this hash table and the
- * number of possible hash values is determined by the \p rdcc_nslots
+ * number of possible hash values are determined by the \p rdcc_nslots
* parameter. If a different chunk in the cache has the same hash value,
* a collision will occur, which will reduce efficiency. If inserting
* the chunk into the cache would cause the cache to be too big, then
@@ -5341,7 +5341,7 @@ H5_DLL herr_t H5Pget_vol_cap_flags(hid_t plist_id, uint64_t *cap_flags);
/**
* \ingroup GAPL
*
- * \brief Sets metadata I/O mode for read operations to collective or independent (default)
+ * \brief Sets metadata I/O mode for read operations to be collective or independent (default)
*
* \gacpl_id
* \param[in] is_collective Boolean value indicating whether metadata reads are collective
@@ -5430,7 +5430,7 @@ H5_DLL herr_t H5Pget_all_coll_metadata_ops(hid_t plist_id, hbool_t *is_collectiv
/**
* \ingroup FAPL
*
- * \brief Sets metadata write mode to collective or independent (default)
+ * \brief Sets metadata write mode to be collective or independent (default)
*
* \fapl_id{plist_id}
* \param[out] is_collective Boolean value indicating whether metadata
@@ -6699,7 +6699,7 @@ H5_DLL herr_t H5Pset_scaleoffset(hid_t plist_id, H5Z_SO_scale_type_t scale_type,
* Specifically, a dataset with a datatype that is 8-, 16-, 32-, or
* 64-bit signed or unsigned integer; char; or 32- or 64-bit float
* can be compressed with SZIP. See Note, below, for further
- * discussion of the the SZIP \p bits_per_pixel setting.
+ * discussion of the SZIP \p bits_per_pixel setting.
*
* SZIP options are passed in an options mask, \p options_mask,
* as follows.
diff --git a/src/H5Rpublic.h b/src/H5Rpublic.h
index 856a445..dfeffda 100644
--- a/src/H5Rpublic.h
+++ b/src/H5Rpublic.h
@@ -259,7 +259,7 @@ H5_DLL herr_t H5Rdestroy(H5R_ref_t *ref_ptr);
* \snippet this H5R_type_t_snip
*
* Note that #H5R_OBJECT1 and #H5R_DATASET_REGION1 can never be
- * associated to an \ref H5R_ref_t reference and can therefore never be
+ * associated with an \ref H5R_ref_t reference and can, therefore, never be
* returned through that function.
*
* \ref H5R_ref_t is defined in H5Rpublic.h as:
@@ -302,7 +302,7 @@ H5_DLL htri_t H5Requal(const H5R_ref_t *ref1_ptr, const H5R_ref_t *ref2_ptr);
* \return \herr_t
*
* \details H5Rcopy() creates a copy of an existing reference.
- * \p src_ref_ptr points to the reference to copy and \p dst_ref_ptr is the
+ * \p src_ref_ptr points to the reference to copy, and \p dst_ref_ptr is the
* pointer to the destination reference.
*
*/
@@ -336,7 +336,7 @@ H5_DLL herr_t H5Rcopy(const H5R_ref_t *src_ref_ptr, H5R_ref_t *dst_ref_ptr);
*
* The object opened with this function should be closed when it
* is no longer needed so that resource leaks will not develop. Use
- * the appropriate close function such as H5Oclose() or H5Dclose()
+ * the appropriate close function, such as H5Oclose() or H5Dclose()
* for datasets.
*
*/
@@ -628,7 +628,7 @@ H5_DLL ssize_t H5Rget_attr_name(const H5R_ref_t *ref_ptr, char *name, size_t siz
*
* A \Emph{reference type} is the type of reference, either an object
* reference or a dataset region reference. An \Emph{object reference}
- * points to an HDF5 object while a \Emph{dataset region reference}
+ * points to an HDF5 object, while a \Emph{dataset region reference}
* points to a defined region within a dataset.
*
* The \Emph{referenced object} is the object the reference points
@@ -700,7 +700,7 @@ H5_DLL H5G_obj_t H5Rget_obj_type1(hid_t id, H5R_type_t ref_type, const void *ref
*
* The object opened with this function should be closed when it is no
* longer needed so that resource leaks will not develop. Use the
- * appropriate close function such as H5Oclose() or H5Dclose() for
+ * appropriate close function, such as H5Oclose() or H5Dclose() for
* datasets.
*
* \version 1.10.0 Function H5Rdereference() renamed to H5Rdereference1() and
@@ -837,7 +837,7 @@ H5_DLL herr_t H5Rget_obj_type2(hid_t id, H5R_type_t ref_type, const void *ref, H
*
* The object opened with this function should be closed when it is no
* longer needed so that resource leaks will not develop. Use the
- * appropriate close function such as H5Oclose() or H5Dclose() for
+ * appropriate close function, such as H5Oclose() or H5Dclose() for
* datasets.
*
* \since 1.10.0
diff --git a/src/H5Sall.c b/src/H5Sall.c
index eb9a4d7..20c9a20 100644
--- a/src/H5Sall.c
+++ b/src/H5Sall.c
@@ -1109,7 +1109,7 @@ done:
NAME
H5S_select_all
PURPOSE
- Specify the the entire extent is selected
+ Specify the entire extent is selected
USAGE
herr_t H5S_select_all(dsid)
hid_t dsid; IN: Dataspace ID of selection to modify
@@ -1152,7 +1152,7 @@ done:
NAME
H5Sselect_all
PURPOSE
- Specify the the entire extent is selected
+ Specify the entire extent is selected
USAGE
herr_t H5Sselect_all(dsid)
hid_t dsid; IN: Dataspace ID of selection to modify
diff --git a/src/H5Shyper.c b/src/H5Shyper.c
index 2399937..e749ee9 100644
--- a/src/H5Shyper.c
+++ b/src/H5Shyper.c
@@ -9230,7 +9230,7 @@ done:
owned by the result. If not, the 2nd span list
has to be copied.
hbool_t *span2_owned; OUT: Indicates if the 2nd span list is actually owned
- H5S_t **result; OUT: The dataspace containing the the new selection. It
+ H5S_t **result; OUT: The dataspace containing the new selection. It
could be same with the 1st dataspace.
RETURNS
Non-negative on success, negative on failure
diff --git a/src/H5Spublic.h b/src/H5Spublic.h
index f8fed47..871a8e7 100644
--- a/src/H5Spublic.h
+++ b/src/H5Spublic.h
@@ -1006,7 +1006,7 @@ H5_DLL herr_t H5Sselect_copy(hid_t dst_id, hid_t src_id);
* The \p coord parameter is a pointer to a buffer containing a
* serialized 2-dimensional array of size \p num_elements by the
* rank of the dataspace. The array lists dataset elements in the
- * point selection; that is, it’s a list of of zero-based values
+ * point selection; that is, it’s a list of zero-based values
* specifying the coordinates in the dataset of the selected
* elements. The order of the element coordinates in the \p coord
* array specifies the order in which the array elements are
@@ -1048,7 +1048,7 @@ H5_DLL herr_t H5Sselect_copy(hid_t dst_id, hid_t src_id);
*
* In the 1D case, we will be selecting five points and a 1D
* dataspace has rank 1, so the selection will be described in a
- * 5-by-1 array. To select the 1st, 14th, 17th, 23rd, 8th elements
+ * 5-by-1 array. To select the 1st, 14th, 17th, 23rd and 8th elements
* of the dataset, the selection array would be as follows
* (remembering that point coordinates are zero-based):
* \n 0
@@ -1320,9 +1320,9 @@ H5_DLL herr_t H5Sset_extent_none(hid_t space_id);
* \details H5Sset_extent_simple() sets or resets the size of an existing
* dataspace.
*
- * \p dims is an array of size \p rank which contains the new size
+ * \p dims is an array of size \p rank that contains the new size
* of each dimension in the dataspace. \p max is an array of size
- * \p rank which contains the maximum size of each dimension in
+ * \p rank that contains the maximum size of each dimension in
* the dataspace.
*
* Any previous extent is removed from the dataspace, the dataspace
diff --git a/src/H5Tenum.c b/src/H5Tenum.c
index af5812d..bf9b671 100644
--- a/src/H5Tenum.c
+++ b/src/H5Tenum.c
@@ -333,7 +333,7 @@ done:
/*-------------------------------------------------------------------------
* Function: H5T__enum_nameof
*
- * Purpose: Finds the symbol name that corresponds the the specified
+ * Purpose: Finds the symbol name that corresponds to the specified
* VALUE of an enumeration data type DT. At most SIZE characters
* of the symbol name are copied into the NAME buffer. If the
* entire symbol name and null terminator do not fit in the NAME
@@ -470,7 +470,7 @@ done:
/*-------------------------------------------------------------------------
* Function: H5T__enum_valueof
*
- * Purpose: Finds the value that corresponds the the specified symbol
+ * Purpose: Finds the value that corresponds to the specified symbol
* NAME of an enumeration data type DT and copy it to the VALUE
* result buffer. The VALUE should be allocated by the caller to
* be large enough for the result.
diff --git a/src/H5Tpublic.h b/src/H5Tpublic.h
index 16172a8..92ec134 100644
--- a/src/H5Tpublic.h
+++ b/src/H5Tpublic.h
@@ -1069,7 +1069,7 @@ H5_DLL hid_t H5Tcreate(H5T_class_t type, size_t size);
* dataset's datatype.
*
* The returned datatype identifier should be released with H5Tclose()
- * to prevent resource leak.
+ * to prevent resource leaks.
*
*/
H5_DLL hid_t H5Tcopy(hid_t type_id);
@@ -1158,7 +1158,7 @@ H5_DLL herr_t H5Tlock(hid_t type_id);
*
* \p loc_id may be a file identifier, or a group identifier within
* that file. \p name may be either an absolute path in the file or
- * a relative path from \p loc_id naming the newly-commited datatype.
+ * a relative path from \p loc_id naming the newly-committed datatype.
*
* The link creation property list, \p lcpl_id, governs creation of
* the link(s) by which the new committed datatype is accessed and
@@ -1235,7 +1235,7 @@ H5_DLL hid_t H5Topen_async(hid_t loc_id, const char *name, hid_t tapl_id, hid_t
/**
* \ingroup H5T
*
- * \brief Commits a transient datatype to a file, creating a new named
+ * \brief Commits a transient datatype to a file, creating a newly named
* datatype, but does not link it into the file structure
*
* \fg_loc_id
@@ -1365,7 +1365,7 @@ H5_DLL herr_t H5Tencode(hid_t obj_id, void *buf, size_t *nalloc);
/**
* \ingroup H5T
*
- * \brief Decodes a binary object description of datatype and return a new
+ * \brief Decodes a binary object description of datatype and returns a new
* object handle
*
* \param[in] buf Buffer for the datatype object to be decoded
@@ -1437,7 +1437,7 @@ H5_DLL herr_t H5Tflush(hid_t type_id);
* contents from disk.
*
* This function essentially closes the datatype, evicts all
- * metadata associated with it from the cache, and then re-opens the
+ * metadata associated with it from the cache, and then reopens the
* datatype. The reopened datatype is automatically re-registered
* with the same identifier.
*
@@ -2263,7 +2263,7 @@ H5_DLL htri_t H5Tis_variable_str(hid_t type_id);
* \details H5Tget_native_type() returns the equivalent native datatype
* identifier for the datatype specified by \p type_id.
*
- * H5Tget_native_type() is designed primarily to facilitate use of
+ * H5Tget_native_type() is designed primarily to facilitate the use of
* the H5Dread() function, for which users otherwise must undertake a
* multi-step process to determine the native datatype of a dataset
* prior to reading it into memory. This function can be used for
@@ -2321,7 +2321,7 @@ H5_DLL htri_t H5Tis_variable_str(hid_t type_id);
*
* \note Please note that a datatype is actually an object
* identifier or handle returned from opening the datatype. It
- * is not persistent and its value can be different from one HDF5
+ * is not persistent, and its value can be different from one HDF5
* session to the next.
*
* \note H5Tequal() can be used to compare datatypes.
@@ -2342,14 +2342,14 @@ H5_DLL hid_t H5Tget_native_type(hid_t type_id, H5T_direction_t direction);
* \brief Sets size for a datatype.
*
* \type_id
- * \param[in] size New datatype size is bytes or #H5T_VARIABLE
+ * \param[in] size New datatype size in bytes or #H5T_VARIABLE
*
* \return \herr_t
*
* \details H5Tset_size() sets the total size, \p size, in bytes, for a
* datatype.
*
- * \p size must have a positive value, unless it is passed in as
+ * \p size must have a positive value unless it is passed in as
* #H5T_VARIABLE and the datatype is a string datatype.
*
* \li Numeric datatypes: If the datatype is atomic and the size
@@ -2361,7 +2361,7 @@ H5_DLL hid_t H5Tget_native_type(hid_t type_id, H5T_direction_t direction);
*
* \li String or character datatypes: The size set for a string
* datatype should include space for the null-terminator character,
- * otherwise it will not be stored on (or retrieved from)
+ * otherwise it will not be stored on (or retrieved from) the
* disk. Adjusting the size of a string automatically sets the
* precision to \p 8*size.
*
@@ -2767,7 +2767,7 @@ H5_DLL herr_t H5Treclaim(hid_t type_id, hid_t space_id, hid_t plist_id, void *bu
/**
* \ingroup H5T
*
- * \brief Commits a transient datatype to a file, creating a new named datatype
+ * \brief Commits a transient datatype to a file, creating a newly named datatype
*
* \fg_loc_id
* \param[in] name Name given to committed datatype
diff --git a/src/H5Zdevelop.h b/src/H5Zdevelop.h
index 346eb0e..cc53824 100644
--- a/src/H5Zdevelop.h
+++ b/src/H5Zdevelop.h
@@ -227,12 +227,12 @@ extern "C" {
* descriptive name for the filter, and may be the null pointer.
*
* \c can_apply, described in detail below, is a user-defined callback
- * function which determines whether the combination of the dataset
+ * function that determines whether the combination of the dataset
* creation property list values, the datatype, and the dataspace
* represent a valid combination to apply this filter to.
*
* \c set_local, described in detail below, is a user-defined callback
- * function which sets any parameters that are specific to this
+ * function that sets any parameters that are specific to this
* dataset, based on the combination of the dataset creation property
* list values, the datatype, and the dataspace.
*
@@ -242,9 +242,9 @@ extern "C" {
* The statistics associated with a filter are not reset by this
* function; they accumulate over the life of the library.
*
- * #H5Z_class_t is a macro which maps to either H5Z_class1_t or
+ * #H5Z_class_t is a macro that maps to either H5Z_class1_t or
* H5Z_class2_t, depending on the needs of the application. To affect
- * only this macro, H5Z_class_t_vers may be defined to either 1 or 2.
+ * only this macro, H5Z_class_t_vers may be defined as either 1 or 2.
* Otherwise, it will behave in the same manner as other API
* compatibility macros. See API Compatibility Macros in HDF5 for more
* information. H5Z_class1_t matches the #H5Z_class_t structure that is
@@ -261,15 +261,15 @@ extern "C" {
* defined as described in the HDF5 library header file H5Zpublic.h.
*
* When a filter is applied to the fractal heap for a group (e.g.,
- * when compressing group metadata) and if the can apply and set local
- * callback functions have been defined for that filter, HDF5 passes
+ * when compressing group metadata) and if they can apply and set local
+ * callback functions that have been defined for that filter, HDF5 passes
* the value -1 for all parameters for those callback functions. This
* is done to ensure that the filter will not be applied to groups if
* it relies on these parameters, as they are not applicable to group
* fractal heaps; to operate on group fractal heaps, a filter must be
* capable of operating on an opaque block of binary data.
*
- * The \Emph{can apply} callback function must return a positive value
+ * The \Emph{can-apply} callback function must return a positive value
* for a valid combination, zero for an invalid combination, and a
* negative value for an error.
* \snippet this H5Z_can_apply_func_t_snip
@@ -302,9 +302,9 @@ extern "C" {
* \Emph{set local} callback functions for any filters used in the
* dataset creation property list are called. These callbacks receive
* \c dcpl_id, the dataset's private copy of the dataset creation
- * property list passed in to H5Dcreate() (i.e. not the actual
- * property list passed in to H5Dcreate()); \c type_id, the datatype
- * identifier passed in to H5Dcreate(), which is not copied and should
+ * property list passed into H5Dcreate() (i.e. not the actual
+ * property list passed into H5Dcreate()); \c type_id, the datatype
+ * identifier passed into H5Dcreate(), which is not copied and should
* not be modified; and \c space_id, a dataspace describing the chunk
* (for chunked dataset storage), which should also not be modified.
*
@@ -345,13 +345,13 @@ extern "C" {
* will work in many cases, but if there is a mismatch between the
* memory allocators used in the library and any filter that
* reallocates a buffer, there could be problems. This is most often
- * the case with Windows and/or when debug memory allocators are being
+ * the case with Windows and/or when debugging memory allocators are being
* used. In both cases, the "state" of the memory allocator lies in
* different libraries and will get corrupted if you allocate in one
* library and free in another. Windows adds the C standard library
- * via dlls that can vary with Visual Studio version and debug vs
+ * via dlls that can vary with Visual Studio version and debug vs.
* release builds. Static links to the MSVC CRT can also introduce
- * new memory allocator state.
+ * a new memory allocator state.
*
* The library does provide H5allocate_memory() and H5free_memory()
* functions that will use the library's allocation and free functions,
@@ -398,7 +398,7 @@ H5_DLL herr_t H5Zregister(const void *cls);
* sure that all cached data that may use this filter are written out.
*
* If the application is a parallel program, all processes that
- * participate in collective data write should call this function to
+ * participate in collective data writing should call this function to
* ensure that all data is flushed.
*
* After a call to H5Zunregister(), the filter specified in filter
diff --git a/src/H5Zmodule.h b/src/H5Zmodule.h
index ec21e50..57e08c1 100644
--- a/src/H5Zmodule.h
+++ b/src/H5Zmodule.h
@@ -84,7 +84,7 @@
*
* The HDF5 library does not support filters for contiguous datasets because of
* the difficulty of implementing random access for partial I/O. Compact dataset
- * filters are not supported because it would not produce significant results.
+ * filters are not supported because they would not produce significant results.
*
* Filter identifiers for the filters distributed with the HDF5
* Library are as follows:
diff --git a/src/H5Zpublic.h b/src/H5Zpublic.h
index ce67cd7..a63729e 100644
--- a/src/H5Zpublic.h
+++ b/src/H5Zpublic.h
@@ -268,7 +268,7 @@ H5_DLL htri_t H5Zfilter_avail(H5Z_filter_t id);
* \details H5Zget_filter_info() retrieves information about a filter. At
* present, this means that the function retrieves a filter's
* configuration flags, indicating whether the filter is configured to
- * decode data, to encode data, neither, or both.
+ * decode data, encode data, neither, or both.
*
* If \p filter_config_flags is not set to NULL prior to the function
* call, the returned parameter contains a bit field specifying the
@@ -305,8 +305,8 @@ H5_DLL htri_t H5Zfilter_avail(H5Z_filter_t id);
* to read an existing file encoded with that filter.
*
* This function should be called, and the returned \p
- * filter_config_flags analyzed, before calling any other function,
- * such as H5Pset_szip() , that might require a particular filter
+ * filter_config_flags should be analyzed, before calling any other function,
+ * such as H5Pset_szip(), that might require a particular filter
* configuration.
*
* \since 1.6.3
diff --git a/src/H5public.h b/src/H5public.h
index 5b6bce8..895c070 100644
--- a/src/H5public.h
+++ b/src/H5public.h
@@ -421,7 +421,7 @@ extern "C" {
* issued. If one finds that an HDF5 library function is failing
* inexplicably, H5open() can be called first. It is safe to call
* H5open() before an application issues any other function calls to
- * the HDF5 library as there are no damaging side effects in calling
+ * the HDF5 library, as there are no damaging side effects in calling
* it more than once.
*/
H5_DLL herr_t H5open(void);
@@ -434,13 +434,13 @@ H5_DLL herr_t H5open(void);
*
* \details H5atclose() registers a callback that the HDF5 library will invoke
* when closing. The full capabilities of the HDF5 library are
- * available to callbacks invoked through this mechanism, library
+ * available to callbacks invoked through this mechanism, and library
* shutdown will only begin in earnest when all callbacks have been
* invoked and have returned.
*
* Registered callbacks are invoked in LIFO order, similar to the
* Standard C 'atexit' routine. For example, if 'func1' is registered,
- * then 'func2', when the library is closing 'func2' will
+ * then 'func2', when the library is closing 'func2', will
* be invoked first, then 'func1'.
*
* The \p ctx pointer will be passed to \p func when it's invoked.
@@ -474,13 +474,13 @@ H5_DLL herr_t H5close(void);
* function is in situations where the library is dynamically linked
* into an application and is un-linked from the application before
* exit() gets called. In those situations, a routine installed with
- * atexit() would jump to a routine which was no longer in memory,
+ * atexit() would jump to a routine that was no longer in memory,
* causing errors.
*
* \attention In order to be effective, this routine \Emph{must} be called
* before any other HDF5 function calls, and must be called each
* time the library is loaded/linked into the application (the first
- * time and after it's been un-loaded).
+ * time and after it's been unloaded).
*/
H5_DLL herr_t H5dont_atexit(void);
/**
@@ -492,7 +492,7 @@ H5_DLL herr_t H5dont_atexit(void);
* of the library, freeing any unused memory.
*
* It is not required that H5garbage_collect() be called at any
- * particular time; it is only necessary in certain situations where
+ * particular time; it is only necessary for certain situations where
* the application has performed actions that cause the library to
* allocate many objects. The application should call
* H5garbage_collect() if it eventually releases those objects and
@@ -678,7 +678,7 @@ H5_DLL herr_t H5is_library_threadsafe(hbool_t *is_ts);
* \param[in] mem Buffer to be freed. Can be NULL
* \return \herr_t
*
- * \details H5free_memory() frees memory that has been allocated by the caller
+ * \details H5free_memory() frees the memory that has been allocated by the caller
* with H5allocate_memory() or by the HDF5 library on behalf of the
* caller.
*
@@ -728,7 +728,7 @@ H5_DLL herr_t H5free_memory(void *mem);
* initialized.
*
* This function is intended to have the semantics of malloc() and
- * calloc(). However, unlike malloc() and calloc() which allow for a
+ * calloc(). However, unlike malloc() and calloc(), which allow for a
* "special" pointer to be returned instead of NULL, this function
* always returns NULL on failure or when size is set to 0 (zero).
*
@@ -740,7 +740,7 @@ H5_DLL herr_t H5free_memory(void *mem);
* the same library that initially allocated it. In most cases, the
* HDF5 API uses resources that are allocated and freed either
* entirely by the user or entirely by the library, so this is not a
- * problem. In rare cases, however, HDF5 API calls will free memory
+ * problem. In rare cases, however, HDF5 API calls will free the memory
* that the user allocated. This function allows the user to safely
* allocate this memory.\n
* It is particularly important to use this function to allocate