summaryrefslogtreecommitdiffstats
path: root/src/H5Ipublic.h
diff options
context:
space:
mode:
authorDana Robinson <43805+derobins@users.noreply.github.com>2023-07-27 19:24:05 (GMT)
committerGitHub <noreply@github.com>2023-07-27 19:24:05 (GMT)
commitdf5dcb2a735dd5bb3ee2cc700119109605976e41 (patch)
tree4013a33b5e586013dce09c4831510cb59fdf400c /src/H5Ipublic.h
parentcb69bc279ce12d078d43f7aa70b2929d8df1c147 (diff)
downloadhdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.zip
hdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.tar.gz
hdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.tar.bz2
Normalizes the public headers (#3292)
* Also brings over the apostrophe fix
Diffstat (limited to 'src/H5Ipublic.h')
-rw-r--r--src/H5Ipublic.h15
1 files changed, 7 insertions, 8 deletions
diff --git a/src/H5Ipublic.h b/src/H5Ipublic.h
index c7ca78b..ce78ae3 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