Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix github issue #2523: doxygen -- fix grammatically incorrect senten… #4474

Merged
merged 1 commit into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions src/H5Apublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ H5_DLL herr_t H5Aclose_async(hid_t attr_id, hid_t es_id);
* \acpl_id
* \aapl_id
*
* \return \hid_tv{attribute}
* \return \hid_ti{attribute}
*
* \details H5Acreate2() creates an attribute, \p attr_name, which is attached
* to the object specified by the identifier \p loc_id.
Expand Down Expand Up @@ -173,7 +173,7 @@ H5_DLL hid_t H5Acreate_async(hid_t loc_id, const char *attr_name, hid_t type_id
* \aapl_id
* \lapl_id
*
* \return \hid_tv{attribute}
* \return \hid_ti{attribute}
*
* \details H5Acreate_by_name() creates an attribute, \p attr_name, which is
* attached to the object specified by \p loc_id and \p obj_name.
Expand Down Expand Up @@ -389,7 +389,7 @@ H5_DLL herr_t H5Aexists_by_name_async(hid_t loc_id, const char *obj_name, const
*
* \attr_id
*
* \return \hid_tv{attribute's creation property list}
* \return \hid_ti{attribute's creation property list}
*
* \details H5Aget_create_plist() returns an identifier for the attribute
* creation property list associated with the attribute specified
Expand Down Expand Up @@ -567,7 +567,7 @@ H5_DLL ssize_t H5Aget_name_by_idx(hid_t loc_id, const char *obj_name, H5_index_t
*
* \attr_id
*
* \return \hid_tv{attribute dataspace}
* \return \hid_ti{attribute dataspace}
*
* \details H5Aget_space() retrieves a copy of the dataspace for an
* attribute. The dataspace identifier returned from this
Expand Down Expand Up @@ -747,7 +747,7 @@ H5_DLL herr_t H5Aiterate_by_name(hid_t loc_id, const char *obj_name, H5_index_t
* \param[in] attr_name Name of attribute to open
* \aapl_id
*
* \return \hid_tv{attribute}
* \return \hid_ti{attribute}
*
* \details H5Aopen() opens an existing attribute, \p attr_name, that is
* attached to the object specified by an object identifier, \p obj_id.
Expand Down Expand Up @@ -795,7 +795,7 @@ H5_DLL hid_t H5Aopen_async(hid_t obj_id, const char *attr_name, hid_t aapl_id,
* \aapl_id
* \lapl_id
*
* \return \hid_tv{attribute}
* \return \hid_ti{attribute}
*
* \details H5Aopen_by_idx() opens an existing attribute that is attached
* to an object specified by location and name, \p loc_id and
Expand Down Expand Up @@ -850,7 +850,7 @@ H5_DLL hid_t H5Aopen_by_idx_async(hid_t loc_id, const char *obj_name, H5_index_
* \aapl_id
* \lapl_id
*
* \return \hid_tv{attribute}
* \return \hid_ti{attribute}
*
* \details H5Aopen_by_name() opens an existing attribute, \p attr_name,
* that is attached to an object specified by location and name,
Expand Down Expand Up @@ -1128,7 +1128,7 @@ typedef herr_t (*H5A_operator1_t)(hid_t location_id /*in*/, const char *attr_nam
* \space_id
* \acpl_id
*
* \return \hid_tv{attribute}
* \return \hid_ti{attribute}
*
* \deprecation_note{H5Acreate2()}
*
Expand Down Expand Up @@ -1215,7 +1215,7 @@ H5_DLL herr_t H5Aiterate1(hid_t loc_id, unsigned *idx, H5A_operator1_t op, void
* \loc_id
* \param[in] idx Index of the attribute to open
*
* \return \hid_tv{attribute}
* \return \hid_ti{attribute}
*
* \deprecation_note{H5Aopen_by_idx()}
*
Expand All @@ -1241,7 +1241,7 @@ H5_DLL hid_t H5Aopen_idx(hid_t loc_id, unsigned idx);
* \loc_id
* \param[in] name Attribute name
*
* \return \hid_tv{attribute}
* \return \hid_ti{attribute}
*
* \deprecation_note{H5Aopen_by_name()}
*
Expand Down
6 changes: 3 additions & 3 deletions src/H5Opublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ extern "C" {
* \param[in] name Path to the object; relative to \p loc_id
* \lapl_id
*
* \return \hid_tv{object}
* \return \hid_ti{object}
*
* \details H5Oopen() opens a group, dataset, or committed (named) datatype
* specified by a location, \p loc_id, and a path name, \p name, in an HDF5 file.
Expand Down Expand Up @@ -311,7 +311,7 @@ H5_DLL hid_t H5Oopen_by_token(hid_t loc_id, H5O_token_t token);
* \param[in] n Object to open
* \lapl_id
*
* \return \hid_tv{object}
* \return \hid_ti{object}
*
* \details H5Oopen_by_idx() opens the nth object in the group specified by \p loc_id
* and \p group_name.
Expand Down Expand Up @@ -1769,7 +1769,7 @@ typedef herr_t (*H5O_iterate1_t)(hid_t obj, const char *name, const H5O_info1_t
* \fgdta_loc_obj_id{loc_id}
* \param[in] addr Object's address in the file
*
* \return \hid_tv{object}
* \return \hid_ti{object}
*
* \deprecated As of HDF5-1.12 this function has been deprecated in favor of
* the function H5Oopen_by_token().
Expand Down
2 changes: 1 addition & 1 deletion src/H5Ppublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -882,7 +882,7 @@ H5_DLL hid_t H5Pcreate_class(hid_t parent, const char *name, H5P_cls_create_func
*
* \param[in] buf Buffer holding the encoded property list
*
* \return \hid_tv{object}
* \return \hid_ti{object}
*
* \details Given a binary property list description in a buffer, H5Pdecode()
* reconstructs the HDF5 property list and returns an identifier
Expand Down
4 changes: 2 additions & 2 deletions src/H5Spublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ H5_DLL herr_t H5Sclose(hid_t space_id);
* \param[in] count Number of blocks included in the hyperslab
* \param[in] block Size of a block in the hyperslab
*
* \return \hid_tv{dataspace}
* \return \hid_t{dataspace}
*
* \details H5Scombine_hyperslab() combines a hyperslab selection specified
* by \p start, \p stride, \p count and \p block with the current
Expand Down Expand Up @@ -224,7 +224,7 @@ H5_DLL hid_t H5Scombine_select(hid_t space1_id, H5S_seloper_t op, hid_t space2_i
*
* \space_id
*
* \return \hid_tv{dataspace}
* \return \hid_t{dataspace}
*
* \details H5Scopy() creates a new dataspace which is an exact copy of the
* dataspace identified by \p space_id. The dataspace identifier
Expand Down
Loading