summaryrefslogtreecommitdiffstats
path: root/src/H5Ipublic.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/H5Ipublic.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/H5Ipublic.h')
-rw-r--r--src/H5Ipublic.h16
1 files changed, 8 insertions, 8 deletions
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
*