-
-/* Public headers needed by this file */
-#include "H5public.h" /* Generic Functions */
-#include "H5Lpublic.h" /* Links */
-#include "H5Opublic.h" /* Object headers */
-#include "H5Tpublic.h" /* Datatypes */
+#include "H5public.h" /* Generic Functions */
+#include "H5Ipublic.h" /* Identifiers */
+#include "H5Lpublic.h" /* Links */
+#include "H5Opublic.h" /* Object Headers */
/*****************/
/* Public Macros */
@@ -154,7 +148,7 @@ H5_DLL hid_t H5Gcreate_async(hid_t loc_id, const char *name, hid_t lcpl_id, hid
* provides similar functionality to that provided by
* H5Gcreate1(), with the differences described in the list below.
*
- * The new group’s creation and access properties are specified
+ * The new group's creation and access properties are specified
* in \p gcpl_id and \p gapl_id, respectively.
*
* H5Gcreate_anon() returns a new group identifier. This identifier
@@ -166,12 +160,12 @@ H5_DLL hid_t H5Gcreate_async(hid_t loc_id, const char *name, hid_t lcpl_id, hid
*
* \li H5Gcreate1() does not provide for the use of custom property
* lists; H5Gcreate1() always uses default properties.
- * \li H5Gcreate_anon() neither provides the new group’s name
+ * \li H5Gcreate_anon() neither provides the new group's name
* nor links it into the HDF5 file structure; those actions
* must be performed separately through a call to H5Olink(),
* which offers greater control over linking.
* \li H5Gcreate_anon() does not directly provide a hint mechanism
- * for the group’s heap size. Comparable information can be
+ * for the group's heap size. Comparable information can be
* included in the group creation property list \p gcpl_id through
* a H5Pset_local_heap_size_hint() call.
*
@@ -337,7 +331,7 @@ H5_DLL herr_t H5Gget_info_by_name_async(hid_t loc_id, const char *name, H5G_info
*-------------------------------------------------------------------------
* \ingroup H5G
*
- * \brief Retrieves information about a group, according to the group’s
+ * \brief Retrieves information about a group, according to the group's
* position within an index
*
* \fgdta_loc_id
@@ -890,7 +884,7 @@ H5_DLL herr_t H5Gget_linkval(hid_t loc_id, const char *name, size_t size, char *
* \p loc_id can specify any object in the file. name can be one of the
* following:
* \li The name of the object relative to \p loc_id
- * \li An absolute name of the object, starting from \c /, the file’s
+ * \li An absolute name of the object, starting from \c /, the file's
* root group
* \li A dot (\c .), if \p loc_id fully specifies the object
*
@@ -933,7 +927,7 @@ H5_DLL herr_t H5Gset_comment(hid_t loc_id, const char *name, const char *comment
* \p loc_id can specify any object in the file. name can be one of the
* following:
* \li The name of the object relative to \p loc_id
- * \li An absolute name of the object, starting from \c /, the file’s
+ * \li An absolute name of the object, starting from \c /, the file's
* root group
* \li A dot (\c .), if \p loc_id fully specifies the object
*
diff --git a/src/H5Ipublic.h b/src/H5Ipublic.h
index c7ca78b29a1..ce78ae3c0f3 100644
--- a/src/H5Ipublic.h
+++ b/src/H5Ipublic.h
@@ -17,8 +17,7 @@
#ifndef H5Ipublic_H
#define H5Ipublic_H
-/* Public headers needed by this file */
-#include "H5public.h"
+#include "H5public.h" /* Generic Functions */
/**
* Library type values.
@@ -145,7 +144,7 @@ H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object);
*
* \note H5Iobject_verify() does not change the ID it is called on in any way
* (as opposed to H5Iremove_verify(), which removes the ID from its
- * type’s hash table).
+ * type's hash table).
*
* \see H5Iregister()
*
@@ -336,14 +335,14 @@ H5_DLL int H5Iinc_ref(hid_t id);
*
* The reference count for a newly created object will be 1. Reference
* counts for objects may be explicitly modified with this function or
- * with H5Iinc_ref(). When an object identifier’s reference count
+ * 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
+ * identifier's \c close function decrements the reference count for
* 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
- * object identifier’s \c close function.
+ * object identifier's \c close function.
*
* If the object ID was created by a collective parallel call (such as
* H5Dcreate(), H5Gopen(), etc.), the reference count should be
@@ -455,9 +454,9 @@ H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force);
* identifiers of this type are destroyed and no new identifiers of
* this type can be registered.
*
- * The type’s free function is called on all of the identifiers which
+ * The type's free function is called on all of the identifiers which
* are deleted by this function, freeing their memory. In addition,
- * all memory used by this type’s hash table is freed.
+ * all memory used by this type's hash table is freed.
*
* Since the H5I_type_t values of destroyed identifier types are
* reused when new types are registered, it is a good idea to set the
diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h
index 0782090a1fc..bb5850c442f 100644
--- a/src/H5Lpublic.h
+++ b/src/H5Lpublic.h
@@ -13,8 +13,6 @@
/*-------------------------------------------------------------------------
*
* Created: H5Lpublic.h
- * Dec 1 2005
- * James Laird
*
* Purpose: Public declarations for the H5L package (links)
*
@@ -23,11 +21,10 @@
#ifndef H5Lpublic_H
#define H5Lpublic_H
-/* Public headers needed by this file */
-#include "H5public.h" /* Generic Functions */
-#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 */
/*****************/
/* Public Macros */
@@ -201,7 +198,7 @@ H5_DLL herr_t H5Lmove(hid_t src_loc, const char *src_name, hid_t dst_loc, const
* \p dst_name.
*
* If \p dst_loc_id is a file identifier, \p dst_name will be
- * interpreted relative to that file’s root group.
+ * interpreted relative to that file's root group.
*
* The new link is created with the creation and access property lists
* specified by \p lcpl_id and \p lapl_id. The interpretation of
@@ -345,7 +342,7 @@ H5_DLL herr_t H5Lcreate_hard_async(hid_t cur_loc_id, const char *cur_name, hid_t
* the new link, use H5Lcreate_external() to create an external link.
*
* \note Soft links and external links are also known as symbolic links as they
- * use a name to point to an object; hard links employ an object’s
+ * use a name to point to an object; hard links employ an object's
* address in the file.
*
* \note Unlike hard links, a soft link in an HDF5 file is allowed to dangle,
@@ -620,7 +617,7 @@ H5_DLL herr_t H5Lget_val_by_idx(hid_t loc_id, const char *group_name, H5_index_t
*
* If the link to be verified is specified with an absolute path, the
* same approach should be used, but starting with the first link in
- * the file’s root group. For instance, if \c datasetD were in
+ * the file's root group. For instance, if \c datasetD were in
* \c /group1/group2/softlink_to_group3, the first call to H5Lexists()
* would have name set to \c /group1.
*
@@ -713,7 +710,7 @@ H5_DLL herr_t H5Lexists_async(hid_t loc_id, const char *name, hbool_t *exists, h
* There will be additional valid values if user-defined links have
* been registered.
*
- * \p corder specifies the link’s creation order position, while
+ * \p corder specifies the link's creation order position, while
* \p corder_valid indicates whether the value in corder is valid.
*
* If \p corder_valid is \c TRUE, the value in \p corder is known to
@@ -985,7 +982,7 @@ H5_DLL herr_t H5Literate_async(hid_t group_id, H5_index_t idx_type, H5_iter_orde
*
* \warning H5Literate_by_name2() assumes that the membership of the group being
* iterated over remains unchanged through the iteration; if any of the
- * links in the group change during the iteration, the function’s
+ * links in the group change during the iteration, the function's
* behavior is undefined. Note, however, that objects pointed to by the
* links can be modified.
*
@@ -1115,7 +1112,7 @@ H5_DLL herr_t H5Lvisit2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order
* The group serving as the root of the iteration is specified by the
* \p loc_id / \p group_name parameter pair. \p loc_id specifies a
* file or group; group_name specifies either a group in the file
- * (with an absolute name based in the file’s root group) or a group
+ * (with an absolute name based in the file's root group) or a group
* relative to \p loc_id. If \p loc_id fully specifies the group that
* is to serve as the root of the iteration, group_name should be '.'
* (a dot). (Note that when \p loc_id fully specifies the group
@@ -1304,7 +1301,7 @@ H5_DLL herr_t H5Lunpack_elink_val(const void *ext_linkval /*in*/, size_t link_si
* \p file_name identifies the target file containing the target
* object; \p obj_name specifies the path of the target object within
* that file. \p obj_name must be an absolute pathname in
- * \p file_name, i.e., it must start at the target file’s root group,
+ * \p file_name, i.e., it must start at the target file's root group,
* but it is not interpreted until an application attempts to traverse
* it.
*
@@ -1510,7 +1507,7 @@ typedef herr_t (*H5L_iterate1_t)(hid_t group, const char *name, const H5L_info1_
* There will be additional valid values if user-defined links have
* been registered.
*
- * \c corder specifies the link’s creation order position while
+ * \c corder specifies the link's creation order position while
* \c corder_valid indicates whether the value in \c corder is valid.
*
* If \c corder_valid is \c TRUE, the value in \c corder is known to
@@ -1519,7 +1516,7 @@ typedef herr_t (*H5L_iterate1_t)(hid_t group, const char *name, const H5L_info1_
*
* \c corder starts at zero (0) and is incremented by one (1) as new
* links are created. But higher-numbered entries are not adjusted
- * when a lower-numbered link is deleted; the deleted link’s creation
+ * when a lower-numbered link is deleted; the deleted link's creation
* order position is simply left vacant. In such situations, the value
* of \c corder for the last link created will be larger than the
* number of links remaining in the group.
@@ -1731,7 +1728,7 @@ H5_DLL herr_t H5Literate1(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t ord
*
* \warning H5Literate_by_name1() assumes that the membership of the group being
* iterated over remains unchanged through the iteration; if any of the
- * links in the group change during the iteration, the function’s
+ * links in the group change during the iteration, the function's
* behavior is undefined. Note, however, that objects pointed to by the
* links can be modified.
*
@@ -1875,7 +1872,7 @@ H5_DLL herr_t H5Lvisit1(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t order
* The group serving as the root of the iteration is specified by the
* \p loc_id / \p group_name parameter pair. \p loc_id specifies a
* file or group; group_name specifies either a group in the file
- * (with an absolute name based in the file’s root group) or a group
+ * (with an absolute name based in the file's root group) or a group
* relative to \p loc_id. If \p loc_id fully specifies the group that
* is to serve as the root of the iteration, group_name should be '.'
* (a dot). (Note that when \p loc_id fully specifies the group
diff --git a/src/H5MMpublic.h b/src/H5MMpublic.h
index 778c6e389e3..62172c9ea09 100644
--- a/src/H5MMpublic.h
+++ b/src/H5MMpublic.h
@@ -22,8 +22,7 @@
#ifndef H5MMpublic_H
#define H5MMpublic_H
-/* Public headers needed by this file */
-#include "H5public.h"
+#include "H5public.h" /* Generic Functions */
/* These typedefs are currently used for VL datatype allocation/freeing */
//!
diff --git a/src/H5Mpublic.h b/src/H5Mpublic.h
index 213636d7556..48625a55382 100644
--- a/src/H5Mpublic.h
+++ b/src/H5Mpublic.h
@@ -19,11 +19,11 @@
#ifndef H5Mpublic_H
#define H5Mpublic_H
-/* System headers needed by this file */
+#include "H5public.h" /* Generic Functions */
+#include "H5Ipublic.h" /* Identifiers */
+#include "H5VLpublic.h" /* Virtual Object Layer */
-/* Public headers needed by this file */
-#include "H5public.h"
-#include "H5Ipublic.h"
+/* Exposes VOL connector types, so it needs the connector header */
#include "H5VLconnector.h"
/*****************/
diff --git a/src/H5Oprivate.h b/src/H5Oprivate.h
index fb8949fe0e6..07032e874cd 100644
--- a/src/H5Oprivate.h
+++ b/src/H5Oprivate.h
@@ -404,7 +404,7 @@ typedef struct H5O_efl_t {
#define H5O_LAYOUT_ALL_CHUNK_FLAGS \
(H5O_LAYOUT_CHUNK_DONT_FILTER_PARTIAL_BOUND_CHUNKS | H5O_LAYOUT_CHUNK_SINGLE_INDEX_WITH_FILTER)
-/* Version # of encoded virtual dataset global heap blocks */
+/* Version number of encoded virtual dataset global heap blocks */
#define H5O_LAYOUT_VDS_GH_ENC_VERS 0
/* Initial version of the layout information. Used when space is allocated */
diff --git a/src/H5Opublic.h b/src/H5Opublic.h
index 6fba5085948..4fdfcc60d0b 100644
--- a/src/H5Opublic.h
+++ b/src/H5Opublic.h
@@ -13,21 +13,17 @@
/*-------------------------------------------------------------------------
*
* Created: H5Opublic.h
- * Aug 5 1997
- * Robb Matzke
*
* Purpose: Public declarations for the H5O (object header)
- * package.
+ * package
*
*-------------------------------------------------------------------------
*/
#ifndef H5Opublic_H
#define H5Opublic_H
-/* Public headers needed by this file */
-#include "H5public.h" /* Generic Functions */
-#include "H5Ipublic.h" /* IDs */
-#include "H5Lpublic.h" /* Links */
+#include "H5public.h" /* Generic Functions */
+#include "H5Ipublic.h" /* Identifiers */
/*****************/
/* Public Macros */
@@ -98,7 +94,7 @@
//!
/* Convenience macro to check if the token is the 'undefined' token value */
-#define H5O_IS_TOKEN_UNDEF(token) (!HDmemcmp(&(token), &(H5O_TOKEN_UNDEF), sizeof(H5O_token_t)))
+#define H5O_IS_TOKEN_UNDEF(token) (!memcmp(&(token), &(H5O_TOKEN_UNDEF), sizeof(H5O_token_t)))
/*******************/
/* Public Typedefs */
@@ -432,7 +428,7 @@ H5_DLL hid_t H5Oopen_by_idx_async(hid_t loc_id, const char *group_name, H5_inde
* \par
* If the link to be verified is specified with an absolute path,
* the same approach should be used, but starting with the first
- * link in the file’s root group. For instance, if \c datasetD
+ * link in the file's root group. For instance, if \c datasetD
* were in \c /group1/group2/softlink_to_group3, the first call to
* H5Lexists() would have name set to \c /group1.
*
@@ -521,7 +517,7 @@ H5_DLL herr_t H5Oget_info3(hid_t loc_id, H5O_info2_t *oinfo, unsigned fields);
*
* \return \herr_t
*
- * \details H5Oget_info_by_name3() specifies an object’s location and name,
+ * \details H5Oget_info_by_name3() specifies an object's location and name,
* \p loc_id and \p name, respectively, and retrieves the metadata
* describing that object in \p oinfo, an H5O_info2_t struct.
*
@@ -579,7 +575,7 @@ H5_DLL herr_t H5Oget_info_by_name_async(hid_t loc_id, const char *name, H5O_info
* object in the \c struct \p oinfo, as specified by the location,
* \p loc_id, group name, \p group_name, the index by which objects
* in that group are tracked, \p idx_type, the order by which the
- * index is to be traversed, \p order, and an object’s position
+ * index is to be traversed, \p order, and an object's position
* \p n within that index.
*
* If \p loc_id fully specifies the group in which the object resides,
@@ -789,12 +785,12 @@ H5_DLL herr_t H5Olink(hid_t obj_id, hid_t new_loc_id, const char *new_name, hid_
* an object by address is added. When the link is deleted,
* H5Odecr_refcount() should be used.
*
- * An object’s reference count is the number of hard links in the
+ * An object's reference count is the number of hard links in the
* file that point to that object. See the “Programming Model”
* section of the HDF5 Groups chapter in the -- \ref UG
* for a complete discussion of reference counts.
*
- * If a user application needs to determine an object’s reference
+ * If a user application needs to determine an object's reference
* count, an H5Oget_info() call is required; the reference count
* is returned in the \c rc field of the #H5O_info_t \c struct.
*
@@ -824,12 +820,12 @@ H5_DLL herr_t H5Oincr_refcount(hid_t object_id);
* an object by address is deleted. In general, H5Oincr_refcount() will have
* been used previously, when the link was created.
*
- * An object’s reference count is the number of hard links in the
+ * An object's reference count is the number of hard links in the
* file that point to that object. See the “Programming Model”
* section of the HDF5 Groups chapter in the \ref UG
* for a more complete discussion of reference counts.
*
- * If a user application needs to determine an object’s reference
+ * If a user application needs to determine an object's reference
* count, an H5Oget_info() call is required; the reference count
* is returned in the \c rc field of the #H5O_info_t \c struct.
*
@@ -867,13 +863,13 @@ H5_DLL herr_t H5Odecr_refcount(hid_t object_id);
* The destination location, as specified in dst_loc_id, may
* be a group in the current file or a location in a different
* file. If dst_loc_id is a file identifier, the copy will be
- * placed in that file’s root group.
+ * placed in that file's root group.
*
* The copy will be created with the path specified in \p dst_name,
* which must not pre-exist in the destination location. If
* \p dst_name already exists at the location \p dst_loc_id,
* H5Ocopy() will fail. If \p dst_name is an absolute path,
- * the copy will be created relative to the file’s root group.
+ * the copy will be created relative to the file's root group.
*
* The copy of the object is created with the property lists
* specified by \p ocpypl_id and \p lcpl_id. #H5P_DEFAULT can be passed
@@ -1007,7 +1003,7 @@ H5_DLL herr_t H5Oset_comment(hid_t obj_id, const char *comment);
* \p name can be one of the following:
*
* - The name of the object specified as a path relative to \p loc_id
- * - An absolute name of the object, starting from \c /, the file’s root group
+ * - An absolute name of the object, starting from \c /, the file's root group
* - A dot (\c .), if \p loc_id fully specifies the object
*
* If \p comment is an empty string or a null pointer, any existing
@@ -1099,7 +1095,7 @@ H5_DLL ssize_t H5Oget_comment(hid_t obj_id, char *comment, size_t bufsize);
* \p name can be one of the following:
*
* - The name of the object relative to \p loc_id
- * - An absolute name of the object, starting from \c /, the file’s root group
+ * - An absolute name of the object, starting from \c /, the file's root group
* - A dot (\c .), if \p loc_id fully specifies the object
*
* The size in bytes of the comment, including the \c NULL terminator,
@@ -1161,7 +1157,7 @@ H5_DLL ssize_t H5Oget_comment_by_name(hid_t loc_id, const char *name, char *comm
*
* If \p obj_id is a group identifier, that group serves as the
* root of a recursive iteration. If \p obj_id is a file identifier,
- * that file’s root group serves as the root of the recursive
+ * that file's root group serves as the root of the recursive
* iteration. If \p obj_id is an attribute identifier,
* then the object where the attribute is attached will be iterated.
* If \p obj_id is any other type of object, such as a dataset or
@@ -1190,7 +1186,7 @@ H5_DLL ssize_t H5Oget_comment_by_name(hid_t loc_id, const char *name, char *comm
* The H5Ovisit3() \p op_data parameter is a user-defined pointer to the data
* required to process objects in the course of the iteration. This pointer
* is passed back to each step of the iteration in the callback
- * function’s \p op_data parameter.
+ * function's \p op_data parameter.
*
* The \p fields parameter contains flags to determine which fields will
* be retrieved by the \p op callback function. These flags are defined
@@ -1259,7 +1255,7 @@ H5_DLL herr_t H5Ovisit3(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* a file or an object in a file; if \p loc_id is an attribute identifier,
* the object where the attribute is attached will be used.
* \p obj_name specifies either an object in the file (with an absolute
- * name based on the file’s root group) or an object name relative
+ * name based on the file's root group) or an object name relative
* to \p loc_id. If \p loc_id fully specifies the object that is to serve
* as the root of the iteration, \p obj_name should be '\c .' (a dot).
* (Note that when \p loc_id fully specifies the object that is to serve
@@ -1289,7 +1285,7 @@ H5_DLL herr_t H5Ovisit3(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* The H5Ovisit_by_name3() \p op_data parameter is a user-defined
* pointer to the data required to process objects in the course
* of the iteration. This pointer is passed back to each step of
- * the iteration in the callback function’s \p op_data parameter.
+ * the iteration in the callback function's \p op_data parameter.
*
* \p lapl_id is a link access property list. In the general case,
* when default link access properties are acceptable, this can
@@ -1457,9 +1453,9 @@ H5_DLL herr_t H5Orefresh_async(hid_t oid, hid_t es_id);
*
* \details H5Odisable_mdc_flushes(), H5Oenable_mdc_flushes() and associated flush
* functions can be used to control the flushing of entries from
- * a file’s metadata cache.
+ * a file's metadata cache.
*
- * This function prevents an object’s or cache’s dirty metadata
+ * This function prevents an object's or cache's dirty metadata
* entries from being flushed from the cache by the usual cache
* eviction/flush policy. Instead, users must manually flush the
* cache or entries for individual objects via the appropriate
@@ -1490,7 +1486,7 @@ H5_DLL herr_t H5Odisable_mdc_flushes(hid_t object_id);
*-------------------------------------------------------------------------
* \ingroup H5O
*
- * \brief Enables flushing of dirty metadata entries from a file’s metadata cache
+ * \brief Enables flushing of dirty metadata entries from a file's metadata cache
*
* \param[in] object_id Identifier of the object that will have flushes re-enabled;
* may be a group, named datatype, or dataset identifier
@@ -1499,9 +1495,9 @@ H5_DLL herr_t H5Odisable_mdc_flushes(hid_t object_id);
*
* \details H5Oenable_mdc_flushes(), H5Odisable_mdc_flushes()
* and associated flush functions can be used to control the flushing
- * of entries from a file’s metadata cache.
+ * of entries from a file's metadata cache.
*
- * This function allows an object or cache’s dirty metadata entries to be
+ * This function allows an object or cache's dirty metadata entries to be
* flushed from the cache by the usual cache eviction/flush policy.
*
* Metadata cache entries can be controlled at both the individual HDF5
@@ -1519,7 +1515,7 @@ H5_DLL herr_t H5Odisable_mdc_flushes(hid_t object_id);
* determined with H5Oare_mdc_flushes_disabled(). An object will be
* returned to the default flush algorithm when it is closed. All objects
* will be returned to the default flush algorithm when the file is
- * closed. An object’s entries will not necessarily be flushed as a
+ * closed. An object's entries will not necessarily be flushed as a
* result of calling this function.
*
* \since 1.10.0
@@ -1546,7 +1542,7 @@ H5_DLL herr_t H5Oenable_mdc_flushes(hid_t object_id);
*
* The H5Oenable_mdc_flushes(), H5Odisable_mdc_flushes() and
* associated flush functions can be used to control the flushing of
- * entries from a file’s metadata cache. Metadata cache entries can be controlled
+ * entries from a file's metadata cache. Metadata cache entries can be controlled
* at both the individual HDF5 object level (datasets, groups,
* committed datatypes) and the entire metadata cache level.
*
@@ -1779,18 +1775,18 @@ typedef herr_t (*H5O_iterate1_t)(hid_t obj, const char *name, const H5O_info1_t
*
* \p loc_id is a location identifier in the file.
*
- * The object’s address within the file, \p addr, is the byte offset of the first byte
+ * The object's address within the file, \p addr, is the byte offset of the first byte
* of the object header from the beginning of the HDF5 file space, i.e., from the
* beginning of the superblock (see the “HDF5 Storage Model” section of the The
* HDF5 Data Model and File Structure chapter of the HDF5 User's Guide.)
*
* \p addr can be obtained via either of two function calls. H5Gget_objinfo() returns
- * the object’s address in the \c objno field of the H5G_stat_t \c struct;
+ * the object's address in the \c objno field of the H5G_stat_t \c struct;
* H5Lget_info() returns the address in the \c address field of the #H5L_info_t \c struct.
*
* The address of the HDF5 file on a physical device has no effect on H5Oopen_by_addr(),
* nor does the use of any file driver. As stated above, the object address is its
- * offset within the HDF5 file; HDF5’s file drivers will transparently map this to an
+ * offset within the HDF5 file; HDF5's file drivers will transparently map this to an
* address on a storage device.
*
* \warning This function must be used with care!
@@ -1872,7 +1868,7 @@ H5_DLL herr_t H5Oget_info1(hid_t loc_id, H5O_info1_t *oinfo);
* \deprecated As of HDF5-1.12 this function has been deprecated in favor of
* the function H5Oget_info_by_name2() or the macro #H5Oget_info_by_name.
*
- * \details H5Oget_info_by_name1() specifies an object’s location and name, \p loc_id
+ * \details H5Oget_info_by_name1() specifies an object's location and name, \p loc_id
* and \p name, respectively, and retrieves the metadata describing that object
* in \p oinfo, an H5O_info1_t \c struct.
*
@@ -1918,7 +1914,7 @@ H5_DLL herr_t H5Oget_info_by_name1(hid_t loc_id, const char *name, H5O_info1_t *
* object in the \c struct \p oinfo, as specified by the location,
* \p loc_id, group name, \p group_name, the index by which objects
* in that group are tracked, \p idx_type, the order by which the
- * index is to be traversed, \p order, and an object’s position
+ * index is to be traversed, \p order, and an object's position
* \p n within that index.
*
* If \p loc_id fully specifies the group in which the object resides,
@@ -1999,7 +1995,7 @@ H5_DLL herr_t H5Oget_info2(hid_t loc_id, H5O_info1_t *oinfo, unsigned fields);
* \deprecated As of HDF5-1.12 this function has been deprecated in favor of
* the function H5Oget_info_by_name3() or the macro H5Oget_info_by_name().
*
- * \details H5Oget_info_by_name2() specifies an object’s location and name, \p loc_id and
+ * \details H5Oget_info_by_name2() specifies an object's location and name, \p loc_id and
* \p name, respectively, and retrieves the metadata describing
* that object in \p oinfo, an H5O_info1_t \c struct.
*
@@ -2046,7 +2042,7 @@ H5_DLL herr_t H5Oget_info_by_name2(hid_t loc_id, const char *name, H5O_info1_t *
* object in the \c struct \p oinfo, as specified by the location,
* \p loc_id, group name, \p group_name, the index by which objects
* in that group are tracked, \p idx_type, the order by which the
- * index is to be traversed, \p order, and an object’s position
+ * index is to be traversed, \p order, and an object's position
* \p n within that index.
*
* \p oinfo, in which the object information is returned, is a \c struct of
@@ -2106,7 +2102,7 @@ H5_DLL herr_t H5Oget_info_by_idx2(hid_t loc_id, const char *group_name, H5_index
*
* If \p obj_id is a group identifier, that group serves as the
* root of a recursive iteration. If \p obj_id is a file identifier,
- * that file’s root group serves as the root of the recursive
+ * that file's root group serves as the root of the recursive
* iteration. If \p obj_id is an attribute identifier,
* then the object where the attribute is attached will be iterated.
* If \p obj_id is any other type of object, such as a dataset or
@@ -2197,7 +2193,7 @@ H5_DLL herr_t H5Ovisit1(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* a file or an object in a file; if \p loc_id is an attribute identifier,
* the object where the attribute is attached will be used.
* \p obj_name specifies either an object in the file (with an absolute
- * name based on the file’s root group) or an object name relative
+ * name based on the file's root group) or an object name relative
* to \p loc_id. If \p loc_id fully specifies the object that is to serve
* as the root of the iteration, \p obj_name should be '\c .' (a dot).
* (Note that when \p loc_id fully specifies the object that is to serve
@@ -2225,7 +2221,7 @@ H5_DLL herr_t H5Ovisit1(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* along the index specified in \p idx_type.
*
* The \p op callback function and the effect of the callback
- * function’s return value on the application are described
+ * function's return value on the application are described
* in H5Ovisit1().
*
* The H5O_info1_t \c struct is defined in H5Opublic.h
@@ -2234,7 +2230,7 @@ H5_DLL herr_t H5Ovisit1(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* The H5Ovisit_by_name1() \p op_data parameter is a user-defined
* pointer to the data required to process objects in the course
* of the iteration. This pointer is passed back to each step of
- * the iteration in the callback function’s \p op_data parameter.
+ * the iteration in the callback function's \p op_data parameter.
*
* \p lapl_id is a link access property list. In the general case,
* when default link access properties are acceptable, this can
@@ -2301,7 +2297,7 @@ H5_DLL herr_t H5Ovisit_by_name1(hid_t loc_id, const char *obj_name, H5_index_t i
*
* If \p obj_id is a group identifier, that group serves as the
* root of a recursive iteration. If \p obj_id is a file identifier,
- * that file’s root group serves as the root of the recursive
+ * that file's root group serves as the root of the recursive
* iteration. If \p obj_id is an attribute identifier,
* then the object where the attribute is attached will be iterated.
* If \p obj_id is any other type of object, such as a dataset or
@@ -2394,7 +2390,7 @@ H5_DLL herr_t H5Ovisit2(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* a file or an object in a file; if \p loc_id is an attribute identifier,
* the object where the attribute is attached will be used.
* \p obj_name specifies either an object in the file (with an absolute
- * name based in the file’s root group) or an object name relative
+ * name based in the file's root group) or an object name relative
* to \p loc_id. If \p loc_id fully specifies the object that is to serve
* as the root of the iteration, \p obj_name should be '\c .' (a dot).
* (Note that when \p loc_id fully specifies the object that is to serve
@@ -2422,7 +2418,7 @@ H5_DLL herr_t H5Ovisit2(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* along the index specified in \p idx_type.
*
* The \p op callback function and the effect of the callback
- * function’s return value on the application are described
+ * function's return value on the application are described
* in H5Ovisit2().
*
* The H5O_info1_t \c struct is defined in H5Opublic.h
@@ -2431,7 +2427,7 @@ H5_DLL herr_t H5Ovisit2(hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order
* The H5Ovisit_by_name2() \p op_data parameter is a user-defined
* pointer to the data required to process objects in the course
* of the iteration. This pointer is passed back to each step of
- * the iteration in the callback function’s \p op_data parameter.
+ * the iteration in the callback function's \p op_data parameter.
*
* \p lapl_id is a link access property list. In the general case,
* when default link access properties are acceptable, this can
diff --git a/src/H5PLpublic.h b/src/H5PLpublic.h
index c53053b1538..ca996977485 100644
--- a/src/H5PLpublic.h
+++ b/src/H5PLpublic.h
@@ -17,8 +17,7 @@
#ifndef H5PLpublic_H
#define H5PLpublic_H
-/* Public headers needed by this file */
-#include "H5public.h" /* Generic Functions */
+#include "H5public.h" /* Generic Functions */
/*******************/
/* Public Typedefs */
diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h
index ea6a5e49c0e..ea0b2de5842 100644
--- a/src/H5Pmodule.h
+++ b/src/H5Pmodule.h
@@ -299,7 +299,7 @@
* creation property list. These abbreviations may appear in either uppercase or lowercase.
*
* The “HDF5 property list class inheritance hierarchy” figure, immediately following, illustrates
- * the inheritance hierarchy of HDF5’s property list classes. Properties are defined at the root of the
+ * the inheritance hierarchy of HDF5's property list classes. Properties are defined at the root of the
* HDF5 property environment (\ref PLCR in the figure below). Property list
* classes then inherit properties from that root, either directly or indirectly through a parent class.
* In every case, a property list class inherits only the properties relevant to its role. For example,
@@ -325,14 +325,14 @@
*
* A property list is a collection of related properties that are used together in specific
* circumstances. A new property list created from a property list class inherits the properties of the
- * property list class and each property’s default value. A fresh dataset creation property list, for
+ * property list class and each property's default value. A fresh dataset creation property list, for
* example, includes all of the HDF5 properties relevant to the creation of a new dataset.
*
* Property lists are implemented as containers holding a collection of name/value pairs. Each pair
* specifies a property name and a value for the property. A property list usually contains
* information for one to many properties.
*
- * HDF5’s default property values are designed to be reasonable for general use cases. Therefore,
+ * HDF5's default property values are designed to be reasonable for general use cases. Therefore,
* an application can often use a property list without modification. On the other hand, adjusting
* property list settings is a routine action and there are many reasons for an application to do so.
*
@@ -346,7 +346,7 @@
* Property lists can be freely reused to create consistency. For example, a single set of file, group,
* and dataset creation property lists might be created at the beginning of a project and used to
* create hundreds, thousands, even millions, of consistent files, file structures, and datasets over
- * the project’s life. When such consistency is important to a project, this is an economical means
+ * the project's life. When such consistency is important to a project, this is an economical means
* of providing it.
*
* \subsubsection subsubsec_plist_props Properties
@@ -427,7 +427,7 @@
* will fit easily in system memory.
*
* A chunked layout is important if a dataset is to be compressed, to enable extending
- * the dataset’s size, or to enable caching during I/O.
+ * the dataset's size, or to enable caching during I/O.
*
* A compact layout is suitable only for very small datasets because the raw data is
* stored in the object header.
@@ -530,7 +530,7 @@
* \ref H5Pset_dxpl_mpio_chunk_opt_ratio, and \ref H5Pget_mpio_actual_chunk_opt_mode).
*
* Optimal settings differ due to the characteristics of a computing environment and due
- * to an application’s data access patterns; even when working with the same file, these
+ * to an application's data access patterns; even when working with the same file, these
* settings might change for every application and every platform.
*
*
@@ -558,7 +558,7 @@
* Default property lists can simplify many routine HDF5 tasks because you do not always have to
* create every property list you use.
*
- * An application that would be well-served by HDF5’s default property settings can use the default
+ * An application that would be well-served by HDF5's default property settings can use the default
* property lists simply by substituting the value \ref H5P_DEFAULT for a property list identifier.
* HDF5 will then apply the default property list for the appropriate property list class.
*
@@ -594,7 +594,7 @@
* The new dataset creation property list is created as an instance of the property list class
* \ref H5P_DATASET_CREATE.
*
- * The new dataset creation property list’s identifier is returned in dcplA_id and the property list is
+ * The new dataset creation property list's identifier is returned in dcplA_id and the property list is
* initialized with default dataset creation property values.
*
* A list of valid classes appears in the table \ref table_plist "Property list classes in HDF5".
@@ -610,7 +610,7 @@
* values that were changed in dcplA_id before dcplB_id was created. They may, however, diverge
* as additional property values are reset in each.
*
- * While we are creating property lists, let’s create a link creation property list; we will need this
+ * While we are creating property lists, let's create a link creation property list; we will need this
* property list when the new dataset is linked into the file below:
* \code
* lcplAB_id = H5Pcreate (H5P_LINK_CREATE);
@@ -695,7 +695,7 @@
* PList_Class = H5Pget_class (dcplA_id);
* \endcode
*
- * Upon this function’s return, PList_Class will contain the value \ref H5P_DATASET_CREATE indicating that
+ * Upon this function's return, PList_Class will contain the value \ref H5P_DATASET_CREATE indicating that
* dcplA_id is a dataset creation property list.
* Determine Current Creation Property List Settings in an Existing Object
@@ -706,7 +706,7 @@
*
* But sometimes an application must do something that requires knowing the creation property
* settings. HDF5 makes the acquisition of this information fairly straight-forward; for each
- * property setting call, H5Pset_*, there is a corresponding H5Pget_*call to retrieve the property’s
+ * property setting call, H5Pset_*, there is a corresponding H5Pget_*call to retrieve the property's
* current setting.
*
* Consider the following examples which illustrate the determination of dataset layout and chunking settings:
@@ -717,9 +717,9 @@
* \ref H5Dget_create_plist will return a property list identifier for the creation property list that was
* used to create the dataset. Call it DCPL1_id.
*
- * \ref H5Pset_layout sets a dataset’s layout to be compact, contiguous, or chunked.
+ * \ref H5Pset_layout sets a dataset's layout to be compact, contiguous, or chunked.
*
- * \ref H5Pget_layout called with DCPL1_id will return the dataset’s layout,
+ * \ref H5Pget_layout called with DCPL1_id will return the dataset's layout,
* either \ref H5D_COMPACT, \ref H5D_CONTIGUOUS, or \ref H5D_CHUNKED.
*
* \ref H5Pset_chunk sets the rank of a dataset, that is the number of dimensions it will have, and the
@@ -729,7 +729,7 @@
* size of each dimension.
*
* If a creation property value has not been explicitly set, these H5Pget_calls will return the
- * property’s default value.
+ * property's default value.
*
* Determine Access Property Settings
*
@@ -753,14 +753,14 @@
*
* \subsection subsec_plist_generic Generic Properties Interface and User-defined Properties
*
- * HDF5’s generic property interface provides tools for managing the entire property hierarchy and
+ * HDF5's generic property interface provides tools for managing the entire property hierarchy and
* for the creation and management of user-defined property lists and properties. This interface also
* makes it possible for an application or a driver to create, modify, and manage custom properties,
* property lists, and property list classes. A comprehensive list of functions for this interface
* appears under "Generic Property Operations (Advanced)" in the "H5P: Property List Interface"
* section of the \ref RM.
*
- * Further discussion of HDF5’s generic property interface and user-defined properties and
+ * Further discussion of HDF5's generic property interface and user-defined properties and
* property lists is beyond the scope of this document.
*
* \subsection subsec_plist_H5P Property List Function Summaries
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h
index 2a19b728c98..bebb0ecdb97 100644
--- a/src/H5Ppublic.h
+++ b/src/H5Ppublic.h
@@ -17,21 +17,18 @@
#ifndef H5Ppublic_H
#define H5Ppublic_H
-/* System headers needed by this file */
-
-/* Public headers needed by this file */
-#include "H5public.h"
-#include "H5ACpublic.h" /* Metadata cache */
+#include "H5public.h" /* Generic Functions */
+#include "H5ACpublic.h" /* Metadata Cache */
#include "H5Dpublic.h" /* Datasets */
#include "H5Fpublic.h" /* Files */
-#include "H5FDpublic.h" /* File drivers */
-#include "H5Ipublic.h" /* ID management */
+#include "H5FDpublic.h" /* (Virtual) File Drivers */
+#include "H5Ipublic.h" /* Identifiers */
#include "H5Lpublic.h" /* Links */
-#include "H5MMpublic.h" /* Memory management */
-#include "H5Opublic.h" /* Object headers */
+#include "H5MMpublic.h" /* Memory Management */
+#include "H5Opublic.h" /* Object Headers */
#include "H5Spublic.h" /* Dataspaces */
#include "H5Tpublic.h" /* Datatypes */
-#include "H5Zpublic.h" /* Data filters */
+#include "H5Zpublic.h" /* Data Filters */
/*****************/
/* Public Macros */
@@ -2412,7 +2409,7 @@ H5_DLL herr_t H5Pset_deflate(hid_t plist_id, unsigned level);
*
* | #H5Z_FLAG_MANDATORY |
* If the filter is required, that is, set to mandatory,
- * and the filter fails, the library’s behavior depends
+ * and the filter fails, the library's behavior depends
* on whether the chunk cache is in use:
* \li If the chunk cache is enabled, data chunks will
* be flushed to the file during H5Dclose() and the
@@ -2479,11 +2476,11 @@ H5_DLL herr_t H5Pset_deflate(hid_t plist_id, unsigned level);
* property list, the group will be created with the new group file
* format. The filters will come into play only when dense storage
* is used (see H5Pset_link_phase_change()) and will be applied to
- * the group’s fractal heap. The fractal heap will contain most of
- * the group’s link metadata, including link names.
+ * the group's fractal heap. The fractal heap will contain most of
+ * the group's link metadata, including link names.
*
* \note When working with group creation property lists, if you are
- * adding a filter that is not in HDF5’s set of predefined filters,
+ * adding a filter that is not in HDF5's set of predefined filters,
* i.e., a user-defined or third-party filter, you must first
* determine that the filter will work for a group. See the
* discussion of the set local and can apply callback functions
@@ -3416,9 +3413,9 @@ H5_DLL herr_t H5Pget_core_write_tracking(hid_t fapl_id, hbool_t *is_enabled, siz
* |
* | Family |
* #H5FD_FAMILY |
- * With this driver, the HDF5 file’s address space is partitioned
+ * | With this driver, the HDF5 file's address space is partitioned
* into pieces and sent to separate storage files using an
- * underlying driver of the user’s choice. This driver is for
+ * underlying driver of the user's choice. This driver is for
* systems that do not support files larger than 2 gigabytes.
* |
* H5Pset_fapl_family() |
@@ -3648,7 +3645,7 @@ H5_DLL herr_t H5Pget_fclose_degree(hid_t fapl_id, H5F_close_degree_t *degree);
* them when allocating and loading the buffer to return to the
* application (see H5Pset_file_image_callbacks()). If file image
* callbacks are not defined, the function will use \c malloc and \c
- * memcpy. When \c malloc and \c memcpy are used, it is the caller’s
+ * memcpy. When \c malloc and \c memcpy are used, it is the caller's
* responsibility to discard the returned buffer with a call to \c
* free.
*
@@ -4231,11 +4228,11 @@ H5_DLL herr_t H5Pset_alignment(hid_t fapl_id, hsize_t threshold, hsize_t alignme
*
* \details H5Pset_cache() sets the number of elements, the total number of
* bytes, and the preemption policy value for all datasets in a file
- * on the file’s file access property list.
+ * on the file's file access property list.
*
* The raw data chunk cache inserts chunks into the cache by first
* computing a hash value using the address of a chunk and then by
- * using that hash value as the chunk’s index into the table of
+ * using that hash value as the chunk's index into the table of
* cached chunks. In other words, the size of this hash table and the
* number of possible hash values are determined by the \p rdcc_nslots
* parameter. If a different chunk in the cache has the same hash value,
@@ -4469,8 +4466,8 @@ H5_DLL herr_t H5Pset_driver_by_value(hid_t plist_id, H5FD_class_value_t driver_v
* file open.
*
* Files opened through external links inherit the parent
- * file’s file access property list by default, and therefore
- * inherit the parent file’s external link open file cache
+ * file's file access property list by default, and therefore
+ * inherit the parent file's external link open file cache
* setting.
*
* When child files contain external links of their own, the
@@ -4712,7 +4709,7 @@ H5_DLL herr_t H5Pset_file_image(hid_t fapl_id, void *buf_ptr, size_t buf_len);
* is released from use.
*
* Some file drivers allow the use of user-defined callback functions
- * for allocating, freeing, and copying the driver’s internal buffer,
+ * for allocating, freeing, and copying the driver's internal buffer,
* potentially allowing optimizations such as avoiding large \c malloc
* and \c memcpy operations, or to perform detailed logging.
*
@@ -5433,7 +5430,7 @@ H5_DLL herr_t H5Pget_vol_cap_flags(hid_t plist_id, uint64_t *cap_flags);
* identifier will be issued collectively from all ranks irrespective
* of the individual setting of a particular operation. If this
* assumption is not adhered to, corruption will be introduced in the
- * metadata cache and HDF5’s behavior will be undefined.
+ * metadata cache and HDF5's behavior will be undefined.
*
* Alternatively, a user may wish to avoid setting this property
* globally on the file access property list, and individually set it
@@ -6270,12 +6267,12 @@ H5_DLL herr_t H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[/*ndims*
* dataset creation property list \p dcpl_id.
*
* The available option is detailed in the parameters section.
- * Only chunks that are not completely filled by the dataset’s
+ * Only chunks that are not completely filled by the dataset's
* dataspace are affected by this option. Such chunks are
* referred to as partial edge chunks.
*
* \b Motivation: H5Pset_chunk_opts() is used to specify storage
- * options for chunks on the edge of a dataset’s dataspace. This
+ * options for chunks on the edge of a dataset's dataspace. This
* capability allows the user to tune performance in cases where
* the dataset size may not be a multiple of the chunk size and
* the handling of partial edge chunks can impact performance.
@@ -6822,7 +6819,7 @@ H5_DLL herr_t H5Pset_scaleoffset(hid_t plist_id, H5Z_SO_scale_type_t scale_type,
* property list used to create a dataset containing a
* non-allowed datatype, the call to H5Dcreate() will fail; the
* conflict can be detected only when the property list is used.
- * - Users should be aware that there are factors that affect one’s
+ * - Users should be aware that there are factors that affect one's
* rights and ability to use SZIP compression by reviewing the
* SZIP copyright notice.
*
@@ -6896,7 +6893,7 @@ H5_DLL herr_t H5Pset_szip(hid_t plist_id, unsigned options_mask, unsigned pixels
* \param[in] src_dset_name The path to the HDF5 dataset in the file specified by
* \p src_file_name. The dataset might not exist yet. The dataset name
* can be specified using a C-style \c printf statement as described below.
- * \param[in] src_space_id The source dataset’s dataspace identifier with a
+ * \param[in] src_space_id The source dataset's dataspace identifier with a
* selection applied, possibly an unlimited selection
* \return \herr_t
*
@@ -6931,7 +6928,7 @@ H5_DLL herr_t H5Pset_szip(hid_t plist_id, unsigned options_mask, unsigned pixels
*
*
* If the printf form is used for the source file or dataset names, the
- * selection in the source dataset’s dataspace must be fixed-size.
+ * selection in the source dataset's dataspace must be fixed-size.
*
* \par Source File Resolutions:
* When a source dataset residing in a different file is accessed, the
@@ -7035,7 +7032,7 @@ H5_DLL herr_t H5Pset_virtual(hid_t dcpl_id, hid_t vspace_id, const char *src_fil
* the corresponding value that is set in the property list.
*
* \p func is the user-defined callback function to invoke when
- * a dataset’s appended dimension size reaches a boundary and
+ * a dataset's appended dimension size reaches a boundary and
* \p udata is the user-defined input data for the callback
* function.
*
@@ -7096,7 +7093,7 @@ H5_DLL herr_t H5Pget_chunk_cache(hid_t dapl_id, size_t *rdcc_nslots /*out*/, siz
* \details H5Pget_efile_prefix() retrieves the file system path prefix
* for locating external files associated with a dataset that
* uses external storage. This will be the value set with
- * H5Pset_efile_prefix() or the HDF5 library’s default.
+ * H5Pset_efile_prefix() or the HDF5 library's default.
*
* The value of \p size is the size in bytes of the prefix,
* including the NULL terminator. If the size is unknown, a
@@ -7200,7 +7197,7 @@ H5_DLL herr_t H5Pget_virtual_view(hid_t dapl_id, H5D_vds_view_t *view);
/**
* \ingroup DAPL
*
- * \brief Sets two actions to perform when the size of a dataset’s
+ * \brief Sets two actions to perform when the size of a dataset's
* dimension being appended reaches a specified boundary
*
* \dapl_id
@@ -7221,7 +7218,7 @@ H5_DLL herr_t H5Pget_virtual_view(hid_t dapl_id, H5D_vds_view_t *view);
* property list
*
* When a user is appending data to a dataset via H5DOappend()
- * and the dataset’s newly extended dimension size hits a
+ * and the dataset's newly extended dimension size hits a
* specified boundary, the library will perform the first action
* listed above. Upon return from the callback function, the
* library will then perform the second action listed above and
@@ -7231,7 +7228,7 @@ H5_DLL herr_t H5Pget_virtual_view(hid_t dapl_id, H5D_vds_view_t *view);
* The specified boundary is indicated by the parameter
* \p boundary. It is a 1-dimensional array with \p ndims
* elements, which should be the same as the rank of the
- * dataset’s dataspace. While appending to a dataset along a
+ * dataset's dataspace. While appending to a dataset along a
* particular dimension index via H5Dappend(), the library
* determines a boundary is reached when the resulting dimension
* size is divisible by \p boundary[index]. A zero value for
@@ -7252,7 +7249,7 @@ H5_DLL herr_t H5Pget_virtual_view(hid_t dapl_id, H5D_vds_view_t *view);
* create or open if the following conditions are true:
*
* \li \p ndims, the number of elements for boundary, is not the
- * same as the rank of the dataset’s dataspace.
+ * same as the rank of the dataset's dataspace.
* \li A non-zero boundary value is specified for a non-extendible
* dimension.
*
@@ -7264,7 +7261,7 @@ H5_DLL herr_t H5Pget_virtual_view(hid_t dapl_id, H5D_vds_view_t *view);
* prototype, are defined as follows:
*
* \li \p dataset_id is the dataset identifier.
- * \li \p cur_dims is the dataset’s current dimension sizes when
+ * \li \p cur_dims is the dataset's current dimension sizes when
* a boundary is hit.
* \li \p user_data is the user-defined input data.
*
@@ -7416,19 +7413,19 @@ H5_DLL herr_t H5Pset_chunk_cache(hid_t dapl_id, size_t rdcc_nslots, size_t rdcc_
* that uses external storage:
*
* \li The default behavior of the library is to search for the
- * dataset’s external storage raw data files in the same
+ * dataset's external storage raw data files in the same
* directory as the HDF5 file which contains the dataset.
* \li If the prefix is set to an absolute path, the target
- * directory will be searched for the dataset’s external
+ * directory will be searched for the dataset's external
* storage raw data files.
* \li If the prefix is set to a relative path, the target
* directory, relative to the current working directory, will
- * be searched for the dataset’s external storage raw data
+ * be searched for the dataset's external storage raw data
* files.
* \li If the prefix is set to a relative path that begins with
* the special token ${ORIGIN}, that directory, relative to
* the HDF5 file containing the dataset, will be searched for
- * the dataset’s external storage raw data files.
+ * the dataset's external storage raw data files.
*
* The HDF5_EXTFILE_PREFIX environment variable can be used to
* override the above behavior (the environment variable
@@ -7455,7 +7452,7 @@ H5_DLL herr_t H5Pset_chunk_cache(hid_t dapl_id, size_t rdcc_nslots, size_t rdcc_
* are unaware of the environment variable.
*
* \note On Windows, the prefix must be an ASCII string since the Windows
- * standard C library’s I/O functions cannot handle UTF-8 file names.
+ * standard C library's I/O functions cannot handle UTF-8 file names.
*
* \since 1.10.0, 1.8.17
*
@@ -7521,7 +7518,7 @@ H5_DLL herr_t H5Pset_virtual_prefix(hid_t dapl_id, const char *prefix);
* then the virtual dataset will contain the data from
* d-1, d-3, ..., d-N, ... . The blocks that are mapped to
* d-2 and d-3 will be filled according to the virtual
- * dataset’s fill value setting.
+ * dataset's fill value setting.
*
* \see_virtual
*
@@ -7548,7 +7545,7 @@ H5_DLL herr_t H5Pset_virtual_printf_gap(hid_t dapl_id, hsize_t gap_size);
* If \p view is set to #H5D_VDS_FIRST_MISSING, the view includes
* all data before the first missing mapped data. This setting
* provides a view containing only the continuous data starting
- * with the dataset’s first data element. Any break in
+ * with the dataset's first data element. Any break in
* continuity terminates the view.
*
* If \p view is set to #H5D_VDS_LAST_AVAILABLE, the view
@@ -7749,11 +7746,11 @@ H5_DLL herr_t H5Pget_type_conv_cb(hid_t dxpl_id, H5T_conv_except_func_t *op, voi
*
* \param[in] plist_id Identifier for the dataset transfer property list
* \param[out] alloc_func User's allocate routine, or NULL for system malloc
- * \param[out] alloc_info Extra parameter for user’s allocation routine.
+ * \param[out] alloc_info Extra parameter for user's allocation routine.
* Contents are ignored if preceding
* parameter is NULL \param[out] free_func User's free routine, or NULL for
* system free \param[out] free_info
- * Extra parameter for user’s free routine. Contents are ignored if preceding
+ * Extra parameter for user's free routine. Contents are ignored if preceding
* parameter is NULL
*
* \return \herr_t
@@ -8574,7 +8571,7 @@ H5_DLL herr_t H5Pget_link_creation_order(hid_t plist_id, unsigned *crt_order_fla
* to require before converting a group to a dense form.
*
* In the compact format, links are stored as messages in the
- * group’s header. In the dense format, links are stored in a
+ * group's header. In the dense format, links are stored in a
* fractal heap and indexed with a version 2 B-tree.
*
* \p max_compact is the maximum number of links to store as
@@ -8589,7 +8586,7 @@ H5_DLL herr_t H5Pget_link_creation_order(hid_t plist_id, unsigned *crt_order_fla
* converted back to the compact format.
*
* In the compact format, links are stored as messages in the
- * group’s header. In the dense format, links are stored in a
+ * group's header. In the dense format, links are stored in a
* fractal heap and indexed with a version 2 B-tree.
*
* See H5Pset_link_phase_change() for a discussion of
@@ -8785,7 +8782,7 @@ H5_DLL herr_t H5Pset_link_phase_change(hid_t plist_id, unsigned max_compact, uns
* \par Motivation:
* In situations where backward-compatibility is required, specifically, when
* libraries prior to HDF5 Release 1.8.0 may be used to read the file, groups
- * must be created and maintained in the original style. This is HDF5’s default
+ * must be created and maintained in the original style. This is HDF5's default
* behavior. If backward compatibility with pre-1.8.0 libraries is not a concern,
* greater efficiencies can be obtained with the new-format compact and indexed
* groups. See Group
@@ -8807,7 +8804,7 @@ H5_DLL herr_t H5Pset_link_phase_change(hid_t plist_id, unsigned max_compact, uns
* of that metadata (and hence, the size of the local heap) can vary wildly from group
* to group. To intelligently allocate space and to avoid unnecessary fragmentation of
* the local heap, it can be valuable to provide the library with a hint as to the local
- * heap’s likely eventual size. This can be particularly valuable when it is known that
+ * heap's likely eventual size. This can be particularly valuable when it is known that
* a group will eventually have a great many members. It can also be useful in conserving
* space in a file when it is known that certain groups will never have any members.
*
@@ -9331,7 +9328,7 @@ H5_DLL herr_t H5Pset_nlinks(hid_t plist_id, size_t nlinks);
* must be identical. Two attributes are considered identical if
* their datatype description, dataspace, and raw data values are
* the same. However, if an attribute uses a committed datatype,
- * that committed datatype’s attributes will not be compared.
+ * that committed datatype's attributes will not be compared.
*
* If a match is found, H5Ocopy() will perform the following in
* the destination file:
@@ -9341,7 +9338,7 @@ H5_DLL herr_t H5Pset_nlinks(hid_t plist_id, size_t nlinks);
* will modify the copied dataset to use the found committed
* datatype as its datatype.
* \li For an object with an attribute of a committed datatype,
- * the library will modify the copied object’s attribute to
+ * the library will modify the copied object's attribute to
* use the found committed datatype as its datatype.
*
* If no match is found, H5Ocopy() will perform the following in
@@ -9353,11 +9350,11 @@ H5_DLL herr_t H5Pset_nlinks(hid_t plist_id, size_t nlinks);
* file by a unique path.
* \li For a dataset that uses a committed datatype, the
* library will copy the datatype as an anonymous
- * committed datatype and use that as the dataset’s
+ * committed datatype and use that as the dataset's
* datatype.
* \li For an object with an attribute of a committed datatype,
* the library will copy the datatype as an anonymous
- * committed datatype and use that as the attribute’s
+ * committed datatype and use that as the attribute's
* datatype.
*
* \b Motivation: H5Padd_merge_committed_dtype_path() provides a
diff --git a/src/H5Rpublic.h b/src/H5Rpublic.h
index dfeffda1600..3f63d597426 100644
--- a/src/H5Rpublic.h
+++ b/src/H5Rpublic.h
@@ -16,10 +16,10 @@
#ifndef H5Rpublic_H
#define H5Rpublic_H
-/* Public headers needed by this file */
-#include "H5public.h"
-#include "H5Gpublic.h"
-#include "H5Ipublic.h"
+#include "H5public.h" /* Generic Functions */
+#include "H5Gpublic.h" /* Groups */
+#include "H5Ipublic.h" /* Identifiers */
+#include "H5Opublic.h" /* Object Headers */
/*****************/
/* Public Macros */
@@ -647,10 +647,10 @@ H5_DLL ssize_t H5Rget_attr_name(const H5R_ref_t *ref_ptr, char *name, size_t siz
* that can be determined with three preliminary calls:
*
* \li Call H5Dget_type() on the dataset containing the reference to
- * get a datatype identifier for the dataset’s datatype.
+ * get a datatype identifier for the dataset's datatype.
* \li Using that datatype identifier, H5Tget_class() returns a datatype
* class.\n If the datatype class is #H5T_REFERENCE, H5Tequal() can
- * then be used to determine whether the reference’s datatype is
+ * then be used to determine whether the reference's datatype is
* #H5T_STD_REF_OBJ or #H5T_STD_REF_DSETREG:
* - If the datatype is #H5T_STD_REF_OBJ, the reference object type
* is #H5R_OBJECT.
@@ -784,10 +784,10 @@ H5_DLL herr_t H5Rcreate(void *ref, hid_t loc_id, const char *name, H5R_type_t re
* that can be determined with three preliminary calls:
*
* \li Call H5Dget_type() on the dataset containing the reference to
- * get a datatype identifier for the dataset’s datatype.
+ * get a datatype identifier for the dataset's datatype.
* \li Using that datatype identifier, H5Tget_class() returns a datatype
* class.\n If the datatype class is #H5T_REFERENCE, H5Tequal() can
- * then be used to determine whether the reference’s datatype is
+ * then be used to determine whether the reference's datatype is
* #H5T_STD_REF_OBJ or #H5T_STD_REF_DSETREG:
* - If the datatype is #H5T_STD_REF_OBJ, the reference object type
* is #H5R_OBJECT.
@@ -905,7 +905,7 @@ H5_DLL hid_t H5Rget_region(hid_t dataset, H5R_type_t ref_type, const void *ref);
* include the following:
* \snippet this H5R_type_t_snip
*
- * \p ref is the reference for which the target object’s name is
+ * \p ref is the reference for which the target object's name is
* sought.
*
* If \p ref is an object reference, \p name will be returned with a
diff --git a/src/H5Smodule.h b/src/H5Smodule.h
index c5081c781d2..d212d5dbf2c 100644
--- a/src/H5Smodule.h
+++ b/src/H5Smodule.h
@@ -63,7 +63,7 @@
* \subsubsection subsubsec_dataspace_program_object Dataspace Objects
*
* An HDF5 dataspace is a required component of an HDF5 dataset or attribute. A dataspace defines the size
- * and the shape of a dataset’s or an attribute’s raw data. Currently, HDF5 supports the following types of
+ * and the shape of a dataset's or an attribute's raw data. Currently, HDF5 supports the following types of
* the dataspaces:
* \li Scalar dataspaces
* \li Simple dataspaces
@@ -165,7 +165,7 @@
*
* Creating a Simple Dataspace
*
- * Let’s assume that an application wants to store a two‐dimensional array of data, A(20,100). During the
+ * Let's assume that an application wants to store a two‐dimensional array of data, A(20,100). During the
* life of the application, the first dimension of the array can grow up to 30; there is no restriction on
* the size of the second dimension. The following steps are used to declare a dataspace for the dataset
* in which the array data will be stored.
@@ -1221,7 +1221,7 @@
* \subsection subsec_dataspace_sample Sample Programs
*
* This section contains the full programs from which several of the code examples in this chapter were
- * derived. The h5dump output from the program’s output file immediately follows each program.
+ * derived. The h5dump output from the program's output file immediately follows each program.
*
* h5_write.c
* \code
diff --git a/src/H5Spublic.h b/src/H5Spublic.h
index bd5a82cc627..737e88ba13c 100644
--- a/src/H5Spublic.h
+++ b/src/H5Spublic.h
@@ -16,14 +16,34 @@
#ifndef H5Spublic_H
#define H5Spublic_H
-/* Public headers needed by this file */
-#include "H5public.h"
-#include "H5Ipublic.h"
+#include "H5public.h" /* Generic Functions */
+#include "H5Ipublic.h" /* Identifiers */
/* Define special dataspaces for dataset I/O operations */
-#define H5S_ALL 0 /* (hid_t) */
-#define H5S_BLOCK 1 /* (hid_t) */
-#define H5S_PLIST 2 /* (hid_t) */
+
+/**
+ * Used with @ref H5Dread and @ref H5Dwrite to indicate that the entire
+ * dataspace will be selected. In the case of a file dataspace, this means
+ * that the entire file dataspace, as defined by the dataset's dimensions,
+ * will be selected. In the case of a memory dataspace, this means that
+ * the specified file dataspace will also be used for the memory dataspace.
+ * Used in place of a file or memory dataspace @ref hid_t value.
+ */
+#define H5S_ALL 0
+
+/**
+ * Indicates that the buffer provided in a call to @ref H5Dread or @ref H5Dwrite
+ * is a single contiguous block of memory, with the same number of elements
+ * as the file dataspace. Used in place of a memory dataspace @ref hid_t value.
+ */
+#define H5S_BLOCK 1
+
+/**
+ * Used with @ref H5Dread and @ref H5Dwrite to indicate that the file dataspace
+ * selection was set via @ref H5Pset_dataset_io_hyperslab_selection calls.
+ * Used in place of a file dataspace @ref hid_t value.
+ */
+#define H5S_PLIST 2
#define H5S_UNLIMITED HSIZE_UNDEF /**< Value for 'unlimited' dimensions */
@@ -1006,7 +1026,7 @@ H5_DLL herr_t H5Sselect_copy(hid_t dst_id, hid_t src_id);
* The \p coord parameter is a pointer to a buffer containing a
* serialized 2-dimensional array of size \p num_elements by the
* rank of the dataspace. The array lists dataset elements in the
- * point selection; that is, it’s a list of zero-based values
+ * point selection; that is, it's a list of zero-based values
* specifying the coordinates in the dataset of the selected
* elements. The order of the element coordinates in the \p coord
* array specifies the order in which the array elements are
diff --git a/src/H5Tdevelop.h b/src/H5Tdevelop.h
index 6ed542f6f56..e571741ec2e 100644
--- a/src/H5Tdevelop.h
+++ b/src/H5Tdevelop.h
@@ -154,9 +154,9 @@ H5_DLL herr_t H5Tregister(H5T_pers_t pers, const char *name, hid_t src_id, hid_t
* the conversion function.
*
* If a user is trying to remove a conversion function he registered,
- * all parameters can be used. If he is trying to remove a library’s
+ * all parameters can be used. If he is trying to remove a library's
* default conversion function, there is no guarantee the \p name and
- * \p func parameters will match the user’s chosen values. Passing in
+ * \p func parameters will match the user's chosen values. Passing in
* some values may cause this function to fail. A good practice is to
* pass in NULL as their values.
*
@@ -194,17 +194,17 @@ H5_DLL H5T_conv_t H5Tfind(hid_t src_id, hid_t dst_id, H5T_cdata_t **pcdata);
/**
* \ingroup CONV
*
- * \brief Check whether the library’s default conversion is hard conversion
+ * \brief Check whether the library's default conversion is hard conversion
*
* \type_id{src_id} of source datatype
* \type_id{dst_id} of destination datatype
*
* \return \htri_t
*
- * \details H5Tcompiler_conv() determines whether the library’s conversion
+ * \details H5Tcompiler_conv() determines whether the library's conversion
* function from type \p src_id to type \p dst_id is a compiler (hard)
- * conversion or not. A compiler conversion uses compiler’s casting; a
- * library (soft) conversion uses the library’s own conversion
+ * conversion or not. A compiler conversion uses compiler's casting; a
+ * library (soft) conversion uses the library's own conversion
* function.
*
* \since 1.8.0
diff --git a/src/H5Tmodule.h b/src/H5Tmodule.h
index c059d6e5c4c..801d474cd24 100644
--- a/src/H5Tmodule.h
+++ b/src/H5Tmodule.h
@@ -388,7 +388,7 @@
*
*
* This is an architecture that contains semi-standard datatypes like signed
- * two’s complement integers, unsigned integers, and bitfields in various
+ * two's complement integers, unsigned integers, and bitfields in various
* byte orders.
* |
*
@@ -408,11 +408,9 @@
* NATIVE
*
*
- * This architecture contains C-like datatypes for the machine on which
- * the library was compiled. The types were actually defined by running
- * the H5detect program when the library was compiled. In order to be
- * portable, applications should almost always use this architecture
- * to describe things in memory.
+ * This architecture contains C-like datatypes for the machine for which
+ * the library was compiled. In order to be portable, applications should
+ * almost always use this architecture to describe things in memory.
* |
*
*
@@ -429,7 +427,7 @@
* INTEL
*
* |
- * All Intel and compatible CPU’s.
+ * All Intel and compatible CPUs.
* These are little-endian systems with IEEE floating-point.
* |
*
@@ -438,7 +436,7 @@
* MIPS
*
*
- * All MIPS CPU’s commonly used in SGI systems. These are big-endian
+ * All MIPS CPUs commonly used in SGI systems. These are big-endian
* systems with IEEE floating-point.
* |
*
@@ -447,7 +445,7 @@
* ALPHA
*
*
- * All DEC Alpha CPU’s, little-endian systems with IEEE floating-point.
+ * All DEC Alpha CPUs, little-endian systems with IEEE floating-point.
* |
*
*
@@ -571,7 +569,7 @@
* #H5T_STD_I32LE
*
*
- * Four-byte, little-endian, signed two’s complement integer
+ * Four-byte, little-endian, signed two's complement integer
* |
*
*
@@ -1176,7 +1174,7 @@
* \ref H5T_sign_t \ref H5Tget_sign (\ref hid_t type)
*
* |
- * (INTEGER)Integer data can be signed two’s complement (#H5T_SGN_2) or unsigned (#H5T_SGN_NONE).
+ * (INTEGER)Integer data can be signed two's complement (#H5T_SGN_2) or unsigned (#H5T_SGN_NONE).
* |
*
*
@@ -1214,7 +1212,7 @@
* mantissa after the radix point are stored.
* #H5T_NORM_IMPLIED: the mantissa is shifted left \(if non-zero) until the first
* bit after the radix point is set and the exponent is adjusted accordingly. The first
- * bit after the radix point is not stored since it’s always set.
+ * bit after the radix point is not stored since it's always set.
* #H5T_NORM_NONE: the fractional part of the mantissa is stored without normalizing it.
*
*
@@ -1567,7 +1565,7 @@
* \ref herr_t \ref H5Tset_sign (\ref hid_t type, \ref H5T_sign_t sign)
*
*
- * (INTEGER)Integer data can be signed two’s complement (#H5T_SGN_2) or unsigned (#H5T_SGN_NONE).
+ * (INTEGER)Integer data can be signed two's complement (#H5T_SGN_2) or unsigned (#H5T_SGN_NONE).
* |
*
*
@@ -1911,7 +1909,7 @@ filled according to the value of this property. The padding can be:
* Usually a C struct or Fortran derived type will be defined to hold a data point in memory, and the
* offsets of the members in memory will be the offsets of the struct members from the beginning
* of an instance of the struct. The HDF5 C library provides a macro #HOFFSET (s,m)to calculate
- * the member’s offset. The HDF5 Fortran applications have to calculate offsets by using sizes of
+ * the member's offset. The HDF5 Fortran applications have to calculate offsets by using sizes of
* members datatypes and by taking in consideration the order of members in the Fortran derived type.
* \code
* HOFFSET(s,m)
@@ -2380,7 +2378,7 @@ filled according to the value of this property. The padding can be:
*
* Reading datasets with compound datatypes may be a challenge. For general applications there is
* no way to know a priori the corresponding C structure. Also, C structures cannot be allocated on
- * the fly during discovery of the dataset’s datatype. For general C, C++, Fortran and Java
+ * the fly during discovery of the dataset's datatype. For general C, C++, Fortran and Java
* application the following steps will be required to read and to interpret data from the dataset with
* compound datatype:
* \li 1. Get the identifier of the compound datatype in the file with the #H5Dget_type call
@@ -2494,7 +2492,7 @@ filled according to the value of this property. The padding can be:
*
* The example below shows how to read float and double members of a compound datatype into a
* structure that has those fields in a different order. Please notice that #H5Tinsert calls can be used
- * in an order different from the order of the structure’s members.
+ * in an order different from the order of the structure's members.
*
* Read float and double members of a compound datatype
* \code
@@ -3921,9 +3919,8 @@ filled according to the value of this property. The padding can be:
*
* \defgroup PDTNAT Native Datatypes
* \ingroup PDT
- * \details These are the datatypes detected during library \Emph{compilation}
- * by \c H5detect(). Their names differ from other HDF5 datatype names
- * as follows:
+ * \details These are the C-like datatypes for the platform. Their names differ
+ * from other HDF5 datatype names as follows:
* \li Instead of a class name, precision and byte order as the last
* component, they have a C-like type name.
* \li If the type begins with \c U then it is the unsigned version of
diff --git a/src/H5Tpublic.h b/src/H5Tpublic.h
index 92ec134efa6..1a16301b9cb 100644
--- a/src/H5Tpublic.h
+++ b/src/H5Tpublic.h
@@ -16,9 +16,8 @@
#ifndef H5Tpublic_H
#define H5Tpublic_H
-/* Public headers needed by this file */
-#include "H5public.h"
-#include "H5Ipublic.h"
+#include "H5public.h" /* Generic Functions */
+#include "H5Ipublic.h" /* Identifiers */
#define HOFFSET(S, M) (offsetof(S, M))
@@ -729,8 +728,7 @@ H5_DLLVAR hid_t H5T_VAX_F32_g;
H5_DLLVAR hid_t H5T_VAX_F64_g;
/*
- * The predefined native types. These are the types detected by H5detect and
- * they violate the naming scheme a little. Instead of a class name,
+ * The predefined native types for this platform. Instead of a class name,
* precision and byte order as the last component, they have a C-like type
* name. If the type begins with `U' then it is the unsigned version of the
* integer type; other integer types are signed. The type LLONG corresponds
@@ -1142,7 +1140,7 @@ H5_DLL herr_t H5Tlock(hid_t type_id);
*
* \fg_loc_id
* \param[in] name Name given to committed datatype
- * \type_id Identifier of datatype to be committed and, upon function’s
+ * \type_id Identifier of datatype to be committed and, upon function's
* return, identifier for the committed datatype
* \lcpl_id
* \tcpl_id
@@ -1268,7 +1266,7 @@ H5_DLL hid_t H5Topen_async(hid_t loc_id, const char *name, hid_t tapl_id, hid_t
* which provides for greater control of the creation process
* and of the properties of the new named datatype. H5Tcommit()
* always uses default properties.
- * \li H5Tcommit_anon() neither provides the new named datatype’s
+ * \li H5Tcommit_anon() neither provides the new named datatype's
* name nor links it into the HDF5 file structure; those actions
* must be performed separately through a call to H5Olink(),
* which offers greater control over linking.
@@ -1587,7 +1585,7 @@ H5_DLL herr_t H5Tenum_nameof(hid_t type, const void *value, char *name /*out*/,
* \details H5Tenum_valueof() finds the value that corresponds to the
* specified name of the enumeration datatype \p dtype_id.
*
- * Values returned in \p value will be of the enumerated type’s
+ * Values returned in \p value will be of the enumerated type's
* base type, that is, the datatype used by H5Tenum_create() when
* the enumerated type was created.
*
@@ -2198,7 +2196,7 @@ H5_DLL hid_t H5Tget_member_type(hid_t type_id, unsigned membno);
*
* The member value is returned in a user-supplied buffer pointed to
* by \p value. Values returned in \p value will be of the enumerated
- * type’s base type, that is, the datatype used by H5Tenum_create()
+ * type's base type, that is, the datatype used by H5Tenum_create()
* when the enumerated type was created.
*
* The value buffer must be at least large enough to hold a value
diff --git a/src/H5VLconnector.h b/src/H5VLconnector.h
index ad28136f552..02d22314ebc 100644
--- a/src/H5VLconnector.h
+++ b/src/H5VLconnector.h
@@ -1010,13 +1010,13 @@ typedef struct H5VL_token_class_t {
//!
typedef struct H5VL_class_t {
/* Overall connector fields & callbacks */
- unsigned version; /**< VOL connector class struct version # */
- H5VL_class_value_t value; /**< Value to identify connector */
- const char *name; /**< Connector name (MUST be unique!) */
- unsigned conn_version; /**< Version # of connector */
- uint64_t cap_flags; /**< Capability flags for connector */
- herr_t (*initialize)(hid_t vipl_id); /**< Connector initialization callback */
- herr_t (*terminate)(void); /**< Connector termination callback */
+ unsigned version; /**< VOL connector class struct version number */
+ H5VL_class_value_t value; /**< Value to identify connector */
+ const char *name; /**< Connector name (MUST be unique!) */
+ unsigned conn_version; /**< Version number of connector */
+ uint64_t cap_flags; /**< Capability flags for connector */
+ herr_t (*initialize)(hid_t vipl_id); /**< Connector initialization callback */
+ herr_t (*terminate)(void); /**< Connector termination callback */
/* VOL framework */
H5VL_info_class_t info_cls; /**< VOL info fields & callbacks */
diff --git a/src/H5VLmodule.h b/src/H5VLmodule.h
index 169134a296b..44b9af0454c 100644
--- a/src/H5VLmodule.h
+++ b/src/H5VLmodule.h
@@ -35,7 +35,7 @@
* that could potentially access objects in an HDF5 container and forwards those calls to a VOL
* connector, which implements the storage. The user or application gets the benefit of using the
* familiar and widely-used HDF5 data model and API, but can map the physical storage of the HDF5 file
- * and objects to storage that better meets the application’s data needs.
+ * and objects to storage that better meets the application's data needs.
*
* \subsection subsec_vol_abstract_layer The VOL Abstraction Layer
* The VOL lies just under the public API. When a storage-oriented public APIcall is made, the library
@@ -126,7 +126,7 @@
* due to inadequate support for pass-through connectors. These deficiencies have been addressed
* in HDF5 1.14.0, so VOL users and connector authors should target the 1.14.0 VOL API.
*
- * On Windows, it’s probably best to use the same debug vs release configuration for the application and
+ * On Windows, it's probably best to use the same debug vs release configuration for the application and
* all libraries in order to avoid C runtime (CRT) issues. Pre-2015 versions of Visual Studio are not
* supported.
*
@@ -141,7 +141,7 @@
*
* Exactly how you go about setting a VOL connector in a fapl, will depend on
* the complexity of the VOL connector and how much control you have over the
- * application’s source code. Note that the environment variable method, though
+ * application's source code. Note that the environment variable method, though
* convenient, has some limitations in its implementation, which are discussed
* below.
*
@@ -170,7 +170,7 @@
*
* \subsection subsec_vol_use Connector Use
* Before a VOL connector can be set in a fapl, it must be registered with the
- * library (\ref H5Pset_vol requires the connector’s #hid_t ID) and, if a plugin, it
+ * library (\ref H5Pset_vol requires the connector's #hid_t ID) and, if a plugin, it
* must be discoverable by the library at run time.
*
* \subsubsection subsubsec_vol_connect_register Registration
@@ -190,7 +190,7 @@
*
* Note the two ways that a VOL connector can be identified: by a name or by
* a connector-specific numerical value (#H5VL_class_value_t is typedef’d to an
- * integer). The name and value for a connector can be found in the connector’s
+ * integer). The name and value for a connector can be found in the connector's
* documentation or public header file.
*
* Each call also takes a VOL initialization property list (vipl). The library adds
@@ -203,11 +203,11 @@
* closed. If you want to close a VOL connector ID, either \ref H5VLunregister_connector()
* or \ref H5VLclose() can be used (they have the same internal code path). The library maintains a
* reference count on all open IDs and will not do the actual
- * work of closing an ID until its reference count drops to zero, so it’s safe to close
+ * work of closing an ID until its reference count drops to zero, so it's safe to close
* IDs anytime after they are used, even while an HDF5 file that was opened with
* that connector is still open.
*
- * Note that it’s considered an error to unload the native VOL connector. The
+ * Note that it's considered an error to unload the native VOL connector. The
* library will prevent this. This means that, for the time being, the native VOL
* connector will always be available. This may change in the future so that
* the memory footprint of the native VOL connector goes away when not in
@@ -222,7 +222,7 @@
* in the fapl. These will often be in the form of \b H5Pset_fapl_(). For
* example, the DAOS VOL connector
* provides a \b H5Pset_fapl_daos() API call which will take MPI parameters and
- * make this call. See the connector’s documentation or public header file(s) for
+ * make this call. See the connector's documentation or public header file(s) for
* more information.
*
* \subsubsection subsubsec_vol_connect_set_vol H5Pset_vol()
@@ -234,12 +234,12 @@
*
* It takes the ID of the file access property list, the ID of the registered VOL
* connector, and a pointer to whatever connector-specific data the connector is
- * expecting. This will usually be a data struct specified in the connector’s header
+ * expecting. This will usually be a data struct specified in the connector's header
* or a NULL pointer if the connecter requires no special information (as in the
* native VOL connector).
*
* As mentioned above, many connectors will provide their own replacement for
- * this call. See the connector’s documentation for more information.
+ * this call. See the connector's documentation for more information.
*
* \subsubsection subsubsec_vol_connect_search VOL Connector Search Path
* Dynamically loaded VOL connector plugins are discovered and loaded by the
@@ -297,7 +297,7 @@
*
* NOTE: Implementing the environment variable in this way means that setting
* the native VOL connector becomes somewhat awkward as there is no explicit
- * HDF5 API call to do this. Instead you will need to get the native VOL connector’s ID via
+ * HDF5 API call to do this. Instead you will need to get the native VOL connector's ID via
* \ref H5VLget_connector_id_by_value(#H5_VOL_NATIVE) and set it manually in the fapl
* using \ref H5Pset_vol().
*
@@ -595,7 +595,7 @@
* \code
* --vol-(name|value|info)
* \endcode
- * See the individual tool’s help for the options specific to that tool.
+ * See the individual tool's help for the options specific to that tool.
*
* \subsection subsec_vol_compat Compatibility
*
diff --git a/src/H5VLpublic.h b/src/H5VLpublic.h
index 09b31afc101..30a2b5dd62a 100644
--- a/src/H5VLpublic.h
+++ b/src/H5VLpublic.h
@@ -17,9 +17,8 @@
#ifndef H5VLpublic_H
#define H5VLpublic_H
-/* Public headers needed by this file */
-#include "H5public.h" /* Generic Functions */
-#include "H5Ipublic.h" /* IDs */
+#include "H5public.h" /* Generic Functions */
+#include "H5Ipublic.h" /* Identifiers */
/*****************/
/* Public Macros */
@@ -27,7 +26,7 @@
/**
* \ingroup H5VLDEF
- * \brief Version # of VOL class struct & callbacks
+ * \brief Version number of VOL class struct & callbacks
*
* \details Each VOL connector must set the 'version' field in the H5VL_class_t
* struct to the version of the H5VL_class_t struct that the connector
diff --git a/src/H5Zdevelop.h b/src/H5Zdevelop.h
index cc53824a714..736c2830ef1 100644
--- a/src/H5Zdevelop.h
+++ b/src/H5Zdevelop.h
@@ -218,10 +218,10 @@ extern "C" {
* used instead of the literal values.
*
* \c encoder_present is a library-defined value indicating whether
- * the filter’s encoding capability is available to the application.
+ * the filter's encoding capability is available to the application.
*
* \c decoder_present is a library-defined value indicating whether
- * the filter’s encoding capability is available to the application.
+ * the filter's encoding capability is available to the application.
*
* \c name is a descriptive comment used for debugging, may contain a
* descriptive name for the filter, and may be the null pointer.
diff --git a/src/H5Zpublic.h b/src/H5Zpublic.h
index 8a059870c99..6d9b9914228 100644
--- a/src/H5Zpublic.h
+++ b/src/H5Zpublic.h
@@ -13,8 +13,7 @@
#ifndef H5Zpublic_H
#define H5Zpublic_H
-/* Public headers needed by this file */
-#include "H5public.h"
+#include "H5public.h" /* Generic Functions */
/**
* \brief Filter identifiers
diff --git a/src/H5module.h b/src/H5module.h
index 35de9662364..0d2a0ba6ad1 100644
--- a/src/H5module.h
+++ b/src/H5module.h
@@ -352,7 +352,7 @@
* pass parameters from the calling program to a VFL driver or a module of the pipeline.
*
* Property lists are conceptually similar to attributes. Property lists are information relevant to the
- * behavior of the library while attributes are relevant to the user’s data and application.
+ * behavior of the library while attributes are relevant to the user's data and application.
*
*
*
@@ -761,7 +761,7 @@
* \subsubsection subsubsec_program_model_close Closing an Object
* An application should close an object such as a datatype, dataspace, or dataset once the object is
* no longer needed. Since each is an independent object, each must be released (or closed)
- * separately. This action is frequently referred to as releasing the object’s identifier. The code in
+ * separately. This action is frequently referred to as releasing the object's identifier. The code in
* the example below closes the datatype, dataspace, and dataset that were created in the preceding
* section.
*
@@ -779,7 +779,7 @@
*
* For more information,
* @see Using Identifiers
- * in the HDF5 Application Developer’s Guide under General Topics in HDF5.
+ * in the HDF5 Application Developer's Guide under General Topics in HDF5.
*
* How Closing a File Effects Other Open Structural Elements
* Every structural element in an HDF5 file can be opened, and these elements can be opened more
@@ -828,7 +828,7 @@
* portions of a dataset. These parts of datasets are known as selections.
*
* The simplest type of selection is a simple hyperslab. This is an n-dimensional rectangular sub-set
- * of a dataset where n is equal to the dataset’s rank. Other available selections include a more
+ * of a dataset where n is equal to the dataset's rank. Other available selections include a more
* complex hyperslab with user-defined stride and block size, a list of independent points, or the
* union of any of these.
*
@@ -863,7 +863,7 @@
* user-defined stride and block, a selection of points, or a union of any of these forms.
*
* Selections and hyperslabs are portions of a dataset. As described above, a simple hyperslab is a
- * rectangular array of data elements with the same rank as the dataset’s dataspace. Thus, a simple
+ * rectangular array of data elements with the same rank as the dataset's dataspace. Thus, a simple
* hyperslab is a logically contiguous collection of points within the dataset.
*
* The more general case of a hyperslab can also be a regular pattern of points or blocks within the
@@ -880,7 +880,7 @@
*
*
* | start |
- * The coordinates of the starting location of the hyperslab in the dataset’s dataspace. |
+ * The coordinates of the starting location of the hyperslab in the dataset's dataspace. |
*
*
* | block |
@@ -964,7 +964,7 @@
* count=(3,4,1), stride and block size are NULL.
*
* Writing Data into a Differently Shaped Disk Storage Block
- * Now let’s consider the opposite process of writing a selection from memory to a selection in a
+ * Now let's consider the opposite process of writing a selection from memory to a selection in a
* dataset in a file. Suppose that the source dataspace in memory is a 50-element, one-dimensional
* array called vector and that the source selection is a 48-element simple hyperslab that starts at the
* second element of vector. See the figure below.
@@ -1372,7 +1372,7 @@
* and a data I/O pipeline. The data I/O pipeline applies compression to data blocks, transforms
* data elements, and implements selections.
*
- * A substantial portion of the HDF5 library’s work is in transferring data from one environment or
+ * A substantial portion of the HDF5 library's work is in transferring data from one environment or
* media to another. This most often involves a transfer between system memory and a storage
* medium. Data transfers are affected by compression, encryption, machine-dependent differences
* in numerical representation, and other features. So, the bit-by-bit arrangement of a given dataset
@@ -1399,7 +1399,7 @@
* For a given I/O request, different combinations of actions may be performed by the pipeline. The
* library automatically sets up the pipeline and passes data through the processing steps. For
* example, for a read request (from disk to memory), the library must determine which logical
- * blocks contain the requested data elements and fetch each block into the library’s cache. If the
+ * blocks contain the requested data elements and fetch each block into the library's cache. If the
* data needs to be decompressed, then the compression algorithm is applied to the block after it is
* read from disk. If the data is a selection, the selected elements are extracted from the data block
* after it is decompressed. If the data needs to be transformed (for example, byte swapped), then
@@ -1420,7 +1420,7 @@
* Library by linking an appropriate module into the pipeline through the VFL. This requires
* creating an appropriate wrapper for the compression module and registering it with the library
* with #H5Zregister. The algorithm can then be applied to a dataset with an #H5Pset_filter call which
- * will add the algorithm to the selected dataset’s transfer property list.
+ * will add the algorithm to the selected dataset's transfer property list.
*
* Previous Chapter \ref sec_data_model - Next Chapter \ref sec_file
*
diff --git a/src/H5public.h b/src/H5public.h
index 193c8b95a23..cc8fc16634a 100644
--- a/src/H5public.h
+++ b/src/H5public.h
@@ -684,7 +684,7 @@ H5_DLL herr_t H5is_library_threadsafe(hbool_t *is_ts);
*
* H5Tget_member_name() provides an example of memory allocation on
* behalf of the caller: The function returns a buffer containing the
- * name of a compound datatype member. It is the caller’s
+ * name of a compound datatype member. It is the caller's
* responsibility to eventually free that buffer with H5free_memory().
*
* \attention It is especially important to use this function to free memory
@@ -710,7 +710,7 @@ H5_DLL herr_t H5is_library_threadsafe(hbool_t *is_ts);
H5_DLL herr_t H5free_memory(void *mem);
/**
* \ingroup H5
- * \brief Frees memory allocated by the HDF5 library
+ * \brief Allocates memory that will be freed later internally.
*
* \param[in] size The size in bytes of the buffer to be allocated
* \param[in] clear Flag whether the new buffer is to be initialized with 0
diff --git a/tools/src/misc/h5clear.c b/tools/src/misc/h5clear.c
index faf7d947618..4a2b07dbcc9 100644
--- a/tools/src/misc/h5clear.c
+++ b/tools/src/misc/h5clear.c
@@ -61,39 +61,36 @@ static struct h5_long_options l_opts[] = {
static void
usage(const char *prog)
{
- HDfprintf(stdout, "usage: %s [OPTIONS] file_name\n", prog);
- HDfprintf(stdout, " OPTIONS\n");
- HDfprintf(stdout, " -h, --help Print a usage message and exit\n");
- HDfprintf(stdout, " -V, --version Print version number and exit\n");
- HDfprintf(stdout, " -s, --status Clear the status_flags field in the file's superblock\n");
- HDfprintf(stdout, " -m, --image Remove the metadata cache image from the file\n");
- HDfprintf(stdout, " --filesize Print the file's EOA and EOF\n");
- HDfprintf(stdout,
- " --increment=C Set the file's EOA to the maximum of (EOA, EOF) + C for\n");
- HDfprintf(stdout, " the file .\n");
- HDfprintf(stdout,
- " C is >= 0; C is optional and will default to 1M when not set.\n");
- HDfprintf(
- stdout,
- " This option helps to repair a crashed file where the stored EOA\n");
- HDfprintf(stdout, " in the superblock is different from the actual EOF.\n");
- HDfprintf(stdout,
- " The file’s EOA and EOF will be the same after applying\n");
- HDfprintf(stdout, " this option to the file.\n");
- HDfprintf(stdout, "\n");
- HDfprintf(stdout, "Examples of use:\n");
- HDfprintf(stdout, "\n");
- HDfprintf(stdout, "h5clear -s file_name\n");
- HDfprintf(stdout, " Clear the status_flags field in the superblock of the HDF5 file .\n");
- HDfprintf(stdout, "\n");
- HDfprintf(stdout, "h5clear -m file_name\n");
- HDfprintf(stdout, " Remove the metadata cache image from the HDF5 file .\n");
- HDfprintf(stdout, "\n");
- HDfprintf(stdout, "h5clear --increment file_name\n");
- HDfprintf(stdout, " Set the EOA to the maximum of (EOA, EOF) + 1M for the file .\n");
- HDfprintf(stdout, "\n");
- HDfprintf(stdout, "h5clear --increment=512 file_name\n");
- HDfprintf(stdout, " Set the EOA to the maximum of (EOA, EOF) + 512 for the file .\n");
+ fprintf(stdout, "usage: %s [OPTIONS] file_name\n", prog);
+ fprintf(stdout, " OPTIONS\n");
+ fprintf(stdout, " -h, --help Print a usage message and exit\n");
+ fprintf(stdout, " -V, --version Print version number and exit\n");
+ fprintf(stdout, " -s, --status Clear the status_flags field in the file's superblock\n");
+ fprintf(stdout, " -m, --image Remove the metadata cache image from the file\n");
+ fprintf(stdout, " --filesize Print the file's EOA and EOF\n");
+ fprintf(stdout, " --increment=C Set the file's EOA to the maximum of (EOA, EOF) + C for\n");
+ fprintf(stdout, " the file .\n");
+ fprintf(stdout,
+ " C is >= 0; C is optional and will default to 1M when not set.\n");
+ fprintf(stdout,
+ " This option helps to repair a crashed file where the stored EOA\n");
+ fprintf(stdout, " in the superblock is different from the actual EOF.\n");
+ fprintf(stdout, " The file's EOA and EOF will be the same after applying\n");
+ fprintf(stdout, " this option to the file.\n");
+ fprintf(stdout, "\n");
+ fprintf(stdout, "Examples of use:\n");
+ fprintf(stdout, "\n");
+ fprintf(stdout, "h5clear -s file_name\n");
+ fprintf(stdout, " Clear the status_flags field in the superblock of the HDF5 file .\n");
+ fprintf(stdout, "\n");
+ fprintf(stdout, "h5clear -m file_name\n");
+ fprintf(stdout, " Remove the metadata cache image from the HDF5 file .\n");
+ fprintf(stdout, "\n");
+ fprintf(stdout, "h5clear --increment file_name\n");
+ fprintf(stdout, " Set the EOA to the maximum of (EOA, EOF) + 1M for the file .\n");
+ fprintf(stdout, "\n");
+ fprintf(stdout, "h5clear --increment=512 file_name\n");
+ fprintf(stdout, " Set the EOA to the maximum of (EOA, EOF) + 512 for the file .\n");
} /* usage() */
/*-------------------------------------------------------------------------
diff --git a/tools/test/misc/testfiles/h5clear_missing_file.ddl b/tools/test/misc/testfiles/h5clear_missing_file.ddl
index c4d21c9b115..c7a21189ea7 100644
--- a/tools/test/misc/testfiles/h5clear_missing_file.ddl
+++ b/tools/test/misc/testfiles/h5clear_missing_file.ddl
@@ -10,7 +10,7 @@ usage: h5clear [OPTIONS] file_name
C is >= 0; C is optional and will default to 1M when not set.
This option helps to repair a crashed file where the stored EOA
in the superblock is different from the actual EOF.
- The file’s EOA and EOF will be the same after applying
+ The file's EOA and EOF will be the same after applying
this option to the file.
Examples of use:
diff --git a/tools/test/misc/testfiles/h5clear_usage.ddl b/tools/test/misc/testfiles/h5clear_usage.ddl
index c4d21c9b115..c7a21189ea7 100644
--- a/tools/test/misc/testfiles/h5clear_usage.ddl
+++ b/tools/test/misc/testfiles/h5clear_usage.ddl
@@ -10,7 +10,7 @@ usage: h5clear [OPTIONS] file_name
C is >= 0; C is optional and will default to 1M when not set.
This option helps to repair a crashed file where the stored EOA
in the superblock is different from the actual EOF.
- The file’s EOA and EOF will be the same after applying
+ The file's EOA and EOF will be the same after applying
this option to the file.
Examples of use: