summaryrefslogtreecommitdiffstats
path: root/src/H5Ppublic.h
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2023-03-13 16:53:08 (GMT)
committerGitHub <noreply@github.com>2023-03-13 16:53:08 (GMT)
commitd2345e9f0cb2ca6a8b6268116eed35647cfebf61 (patch)
tree2e1ba965f1e461dd057f58f5a9f470553b816baf /src/H5Ppublic.h
parentbefbbd0b6d508f18af493b7138ca85b117976db6 (diff)
downloadhdf5-d2345e9f0cb2ca6a8b6268116eed35647cfebf61.zip
hdf5-d2345e9f0cb2ca6a8b6268116eed35647cfebf61.tar.gz
hdf5-d2345e9f0cb2ca6a8b6268116eed35647cfebf61.tar.bz2
Addressed various Doxygen grammar issues. (#2524)
* reviewed H5A * Addressed various grammar issues. * remove double words, spelling fixes * replace the use of rawdata with raw data
Diffstat (limited to 'src/H5Ppublic.h')
-rw-r--r--src/H5Ppublic.h24
1 files changed, 12 insertions, 12 deletions
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.