summaryrefslogtreecommitdiffstats
path: root/src/H5Tpublic.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/H5Tpublic.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/H5Tpublic.h')
-rw-r--r--src/H5Tpublic.h16
1 files changed, 7 insertions, 9 deletions
diff --git a/src/H5Tpublic.h b/src/H5Tpublic.h
index 92ec134..1a16301 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