diff options
author | jhendersonHDF <jhenderson@hdfgroup.org> | 2023-09-26 17:01:47 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-26 17:01:47 (GMT) |
commit | d26d674e676446dd2f785ba2895fa72b78025b6e (patch) | |
tree | 1f09de849a7c1ab806a3d1f49cd70355d0719dd8 /src/H5Apublic.h | |
parent | b772aeeff5d3a43c3af7a8984b68810bef989237 (diff) | |
download | hdf5-d26d674e676446dd2f785ba2895fa72b78025b6e.zip hdf5-d26d674e676446dd2f785ba2895fa72b78025b6e.tar.gz hdf5-d26d674e676446dd2f785ba2895fa72b78025b6e.tar.bz2 |
Fix docs for H5Acreate2 and H5Acreate_by_name (#3598)
Diffstat (limited to 'src/H5Apublic.h')
-rw-r--r-- | src/H5Apublic.h | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/src/H5Apublic.h b/src/H5Apublic.h index 3bef700..232ae0a 100644 --- a/src/H5Apublic.h +++ b/src/H5Apublic.h @@ -40,7 +40,7 @@ typedef struct { * or named datatype being iterated over * \param[in] attr_name The name of the current object attribute * \param[in] ainfo The attribute's info struct - * \param[in,out] op_data A pointer to the operator data passed in to + * \param[in,out] op_data A pointer to the operator data passed into * H5Aiterate2() or H5Aiterate_by_name() * \returns The return values from an operator are: * \li Zero causes the iterator to continue, returning zero when @@ -122,10 +122,10 @@ H5_DLL herr_t H5Aclose_async(hid_t attr_id, hid_t es_id); * The attribute is created with the specified datatype and dataspace, * \p type_id and \p space_id. * - * \plist_unused{acpl} + * \plist_unused{aapl_id} * * The attribute identifier returned by this function must be released - * with H5Aclose() resource leaks will develop. + * with H5Aclose() or resource leaks will develop. * * \note If \p loc_id is a file identifier, the attribute will be attached to * that file's root group. @@ -183,7 +183,7 @@ H5_DLL hid_t H5Acreate_async(hid_t loc_id, const char *attr_name, hid_t type_id * The attribute is created with the specified datatype and * dataspace, \p type_id and \p space_id. * - * \plist_unused{aapl} + * \plist_unused{aapl_id} * * The link access property list, \p lapl_id, may provide * information regarding the properties of links required to access @@ -252,7 +252,7 @@ H5_DLL herr_t H5Adelete(hid_t loc_id, const char *attr_name); * * \return \herr_t * - * \details H5Adelete_by_idx() removes an attribute, specified by its + * \details H5Adelete_by_idx() removes an attribute specified by its * location in an index, from an object. * * The object from which the attribute is to be removed is @@ -638,7 +638,7 @@ H5_DLL hid_t H5Aget_type(hid_t attr_id); * \details H5Aiterate2() iterates over the attributes attached to a * dataset, named datatype, or group, as specified by \p loc_id. * For each attribute, user-provided data, \p op_data, with - * additional information as defined below, is passed to a + * additional information, as defined below, is passed to a * user-defined function, \p op, which operates on that * attribute. * @@ -697,7 +697,7 @@ H5_DLL herr_t H5Aiterate2(hid_t loc_id, H5_index_t idx_type, H5_iter_order_t ord * \details H5Aiterate_by_name() iterates over the attributes attached * to the dataset or group specified with \p loc_id and \p obj_name. * For each attribute, user-provided data, \p op_data, with - * additional information as defined below, is passed to a + * additional information, as defined below, is passed to a * user-defined function, \p op, which operates on that attribute. * * The order of the iteration and the attributes iterated over @@ -747,7 +747,7 @@ H5_DLL herr_t H5Aiterate_by_name(hid_t loc_id, const char *obj_name, H5_index_t * \return \hid_tv{attribute} * * \details H5Aopen() opens an existing attribute, \p attr_name, that is - * attached to object specified by an object identifier, \p obj_id. + * attached to the object specified by an object identifier, \p obj_id. * * \plist_unused{aapl_id} * @@ -1096,7 +1096,7 @@ H5_DLL herr_t H5Arename_by_name(hid_t loc_id, const char *obj_name, const char * * \param[in] location_id The identifier for the group, dataset * or named datatype being iterated over * \param[in] attr_name The name of the current object attribute - * \param[in,out] operator_data A pointer to the operator data passed in to + * \param[in,out] operator_data A pointer to the operator data passed into * H5Aiterate1() * \returns The return values from an operator are: * \li Zero causes the iterator to continue, returning zero when @@ -1177,7 +1177,7 @@ H5_DLL int H5Aget_num_attrs(hid_t loc_id); * \loc_id * \param[in,out] idx Starting (in) and ending (out) attribute index * \param[in] op User's function to pass each attribute to - * \param[in,out] op_data User's data to pass through to iterator operator + * \param[in,out] op_data User's data to pass through to the iterator operator * function * * \return \herr_t @@ -1220,7 +1220,7 @@ H5_DLL herr_t H5Aiterate1(hid_t loc_id, unsigned *idx, H5A_operator1_t op, void * 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 + * \p idx, indicates the attribute to access. The value of \p idx * is a 0-based, non-negative integer. The attribute identifier * returned from this function must be released with H5Aclose() * or resource leaks will develop. |