diff options
author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2023-07-20 14:01:58 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-20 14:01:58 (GMT) |
commit | 1706355ee10cdad20b79603b3f39935601c5fff0 (patch) | |
tree | 878434891f435edf79062cd7b291f72066a4a02c /src/H5Amodule.h | |
parent | b68988d2d21c57ca02c054272aec01ad86b67ea7 (diff) | |
download | hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.zip hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.tar.gz hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.tar.bz2 |
removed the use of encoded single apostrophe (#3261)
* removed the use of encoded single apostrophe, and fix H5Dread_chunk from write to read
* updated sanitizer paragraph
* fixed brief description for H5Fget_info
Diffstat (limited to 'src/H5Amodule.h')
-rw-r--r-- | src/H5Amodule.h | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/H5Amodule.h b/src/H5Amodule.h index 75a4c8c..18fabe5 100644 --- a/src/H5Amodule.h +++ b/src/H5Amodule.h @@ -77,7 +77,7 @@ * data, and the attribute creation property list. * * The following steps are required to create and write an HDF5 attribute: - * \li Obtain the object identifier for the attribute’s primary data object + * \li Obtain the object identifier for the attribute's primary data object * \li Define the characteristics of the attribute and specify the attribute creation property list * <ul> <li> Define the datatype</li> * <li> Define the dataspace</li> @@ -88,12 +88,12 @@ * \li Close the primary data object (if appropriate) * * The following steps are required to open and read/write an existing attribute. Since HDF5 attributes - * allow no partial I/O, you need specify only the attribute and the attribute’s memory datatype to read it: - * \li Obtain the object identifier for the attribute’s primary data object - * \li Obtain the attribute’s name or index + * allow no partial I/O, you need specify only the attribute and the attribute's memory datatype to read it: + * \li Obtain the object identifier for the attribute's primary data object + * \li Obtain the attribute's name or index * \li Open the attribute * \li Get attribute dataspace and datatype (optional) - * \li Specify the attribute’s memory type + * \li Specify the attribute's memory type * \li Read and/or write the attribute data * \li Close the attribute * \li Close the primary data object (if appropriate) @@ -126,7 +126,7 @@ * * HDF5 attributes are sometimes discussed as name/value pairs in the form name=value. * - * An attribute’s name is a null-terminated ASCII or UTF-8 character string. Each attribute attached to an + * An attribute's name is a null-terminated ASCII or UTF-8 character string. Each attribute attached to an * object has a unique name. * * The value portion of the attribute contains one or more data elements of the same datatype. @@ -148,8 +148,8 @@ * hid_t access_plist) * \endcode * loc_id identifies the object (dataset, group, or committed datatype) to which the attribute is to be - * attached. name, type_id, space_id, and create_plist convey, respectively, the attribute’s name, datatype, - * dataspace, and attribute creation property list. The attribute’s name must be locally unique: it must be + * attached. name, type_id, space_id, and create_plist convey, respectively, the attribute's name, datatype, + * dataspace, and attribute creation property list. The attribute's name must be locally unique: it must be * unique within the context of the object to which it is attached. * * \ref H5Acreate creates the attribute in memory. The attribute does not exist in the file until @@ -175,14 +175,14 @@ * * To access an attribute by its name, use the \ref H5Aopen_by_name function. \ref H5Aopen_by_name returns an * attribute identifier that can then be used by any function that must access an attribute such as \ref - * H5Aread. Use the function \ref H5Aget_name to determine an attribute’s name. + * H5Aread. Use the function \ref H5Aget_name to determine an attribute's name. * * To access an attribute by its index value, use the \ref H5Aopen_by_idx function. To determine an attribute * index value when it is not already known, use the H5Oget_info function. \ref H5Aopen_by_idx is generally * used in the course of opening several attributes for later access. Use \ref H5Aiterate if the intent is to * perform the same operation on every attribute attached to an object. * - * \subsubsection subsubsec_attribute_work_info Obtaining Information Regarding an Object’s Attributes + * \subsubsection subsubsec_attribute_work_info Obtaining Information Regarding an Object's Attributes * * In the course of working with HDF5 attributes, one may need to obtain any of several pieces of information: * \li An attribute name @@ -190,12 +190,12 @@ * \li The datatype of an attribute * \li The number of attributes attached to an object * - * To obtain an attribute’s name, call H5Aget_name with an attribute identifier, attr_id: + * To obtain an attribute's name, call H5Aget_name with an attribute identifier, attr_id: * \code * ssize_t H5Aget_name (hid_t attr_id, size_t buf_size, char *buf) * \endcode * As with other attribute functions, attr_id identifies the attribute; buf_size defines the size of the - * buffer; and buf is the buffer to which the attribute’s name will be read. + * buffer; and buf is the buffer to which the attribute's name will be read. * * If the length of the attribute name, and hence the value required for buf_size, is unknown, a first call * to \ref H5Aget_name will return that size. If the value of buf_size used in that first call is too small, @@ -213,7 +213,7 @@ * step in determining attribute index values. If the call returns N, the attributes attached to the object * object_id have index values of 0 through N-1. * - * \subsubsection subsubsec_attribute_work_iterate Iterating across an Object’s Attributes + * \subsubsection subsubsec_attribute_work_iterate Iterating across an Object's Attributes * * It is sometimes useful to be able to perform the identical operation across all of the attributes attached * to an object. At the simplest level, you might just want to open each attribute. At a higher level, you @@ -235,7 +235,7 @@ * null pointer, then all attributes have been processed, and the iterative process is complete. * * op_func is a user-defined operation that adheres to the \ref H5A_operator_t prototype. This prototype and - * certain requirements imposed on the operator’s behavior are described in the \ref H5Aiterate entry in the + * certain requirements imposed on the operator's behavior are described in the \ref H5Aiterate entry in the * \ref RM. * * op_data is also user-defined to meet the requirements of op_func. Beyond providing a parameter with which |