summaryrefslogtreecommitdiffstats
path: root/src/H5Rpublic.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/H5Rpublic.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/H5Rpublic.h')
-rw-r--r--src/H5Rpublic.h12
1 files changed, 6 insertions, 6 deletions
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