diff options
author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2023-07-27 19:24:05 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-27 19:24:05 (GMT) |
commit | df5dcb2a735dd5bb3ee2cc700119109605976e41 (patch) | |
tree | 4013a33b5e586013dce09c4831510cb59fdf400c /src/H5Apublic.h | |
parent | cb69bc279ce12d078d43f7aa70b2929d8df1c147 (diff) | |
download | hdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.zip hdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.tar.gz hdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.tar.bz2 |
Normalizes the public headers (#3292)
* Also brings over the apostrophe fix
Diffstat (limited to 'src/H5Apublic.h')
-rw-r--r-- | src/H5Apublic.h | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/H5Apublic.h b/src/H5Apublic.h index 46a6cad..3bef700 100644 --- a/src/H5Apublic.h +++ b/src/H5Apublic.h @@ -16,10 +16,10 @@ #ifndef H5Apublic_H #define H5Apublic_H -/* Public headers needed by this file */ -#include "H5Ipublic.h" /* IDs */ -#include "H5Opublic.h" /* Object Headers */ -#include "H5Tpublic.h" /* Datatypes */ +#include "H5public.h" /* Generic Functions */ +#include "H5Ipublic.h" /* Identifiers */ +#include "H5Opublic.h" /* Object Headers */ +#include "H5Tpublic.h" /* Datatypes */ //! <!-- [H5A_info_t_snip] --> /** @@ -39,7 +39,7 @@ typedef struct { * \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] ainfo The attribute’s info struct + * \param[in] ainfo The attribute's info struct * \param[in,out] op_data A pointer to the operator data passed in to * H5Aiterate2() or H5Aiterate_by_name() * \returns The return values from an operator are: @@ -128,7 +128,7 @@ H5_DLL herr_t H5Aclose_async(hid_t attr_id, hid_t es_id); * with H5Aclose() resource leaks will develop. * * \note If \p loc_id is a file identifier, the attribute will be attached to - * that file’s root group. + * that file's root group. * * \par Example * \snippet H5A_examples.c create @@ -429,7 +429,7 @@ H5_DLL herr_t H5Aget_info(hid_t attr_id, H5A_info_t *ainfo /*out*/); * relative to location * \param[in] idx_type Type of index * \param[in] order Index traversal order - * \param[in] n Attribute’s position in index + * \param[in] n Attribute's position in index * \param[out] ainfo Struct containing returned attribute information * \lapl_id * @@ -523,7 +523,7 @@ H5_DLL ssize_t H5Aget_name(hid_t attr_id, size_t buf_size, char *buf); * relative to location * \param[in] idx_type Type of index * \param[in] order Index traversal order - * \param[in] n Attribute’s position in index + * \param[in] n Attribute's position in index * \param[out] name Attribute name * \param[in] size Size, in bytes, of attribute name * \lapl_id @@ -541,9 +541,9 @@ H5_DLL ssize_t H5Aget_name(hid_t attr_id, size_t buf_size, char *buf); * traversal order, and a position in the index, \p idx_type, * \p order and \p n, respectively. * - * If the attribute name’s size is unknown, the values 0 and NULL + * If the attribute name's size is unknown, the values 0 and NULL * can be passed in for the parameters \p size and \p name. The - * function’s return value will provide the correct value for + * function's return value will provide the correct value for * \p size. * * The link access property list, \p lapl_id, may provide @@ -645,7 +645,7 @@ H5_DLL hid_t H5Aget_type(hid_t attr_id); * The order of the iteration and the attributes iterated over * are specified by three parameters: the index type, * \p idx_type; the order in which the index is to be traversed, - * \p order; and the attribute’s position in the index, \p idx. + * \p order; and the attribute's position in the index, \p idx. * The next attribute to be operated on is specified by \p idx, * a position in the index. * @@ -703,7 +703,7 @@ H5_DLL herr_t H5Aiterate2(hid_t loc_id, H5_index_t idx_type, H5_iter_order_t ord * The order of the iteration and the attributes iterated over * are specified by three parameters: the index type, \p idx_type; * the order in which the index is to be traversed, \p order; - * and the attribute’s position in the index, \p idx. + * and the attribute's position in the index, \p idx. * The next attribute to be operated on is specified by \p idx, * a position in the index. * @@ -788,7 +788,7 @@ H5_DLL hid_t H5Aopen_async(hid_t obj_id, const char *attr_name, hid_t aapl_id, * relative to location * \param[in] idx_type Type of index * \param[in] order Index traversal order - * \param[in] n Attribute’s position in index + * \param[in] n Attribute's position in index * \aapl_id * \lapl_id * @@ -1172,7 +1172,7 @@ H5_DLL int H5Aget_num_attrs(hid_t loc_id); /** * \ingroup H5A * - * \brief Calls a user’s function for each attribute on an object + * \brief Calls a user's function for each attribute on an object * * \loc_id * \param[in,out] idx Starting (in) and ending (out) attribute index |