diff options
author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2023-07-20 14:01:58 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-20 14:01:58 (GMT) |
commit | 1706355ee10cdad20b79603b3f39935601c5fff0 (patch) | |
tree | 878434891f435edf79062cd7b291f72066a4a02c /src/H5Pmodule.h | |
parent | b68988d2d21c57ca02c054272aec01ad86b67ea7 (diff) | |
download | hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.zip hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.tar.gz hdf5-1706355ee10cdad20b79603b3f39935601c5fff0.tar.bz2 |
removed the use of encoded single apostrophe (#3261)
* removed the use of encoded single apostrophe, and fix H5Dread_chunk from write to read
* updated sanitizer paragraph
* fixed brief description for H5Fget_info
Diffstat (limited to 'src/H5Pmodule.h')
-rw-r--r-- | src/H5Pmodule.h | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h index ea6a5e4..ea0b2de 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. <br /> * <br /> * 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. <br /> + * the dataset's size, or to enable caching during I/O. <br /> * <br /> * 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).<br /> * <br /> * 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. * </p> * </td> @@ -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. * <h4>Determine Current Creation Property List Settings in an Existing Object</h4> @@ -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. * * <h4>Determine Access Property Settings</h4> * @@ -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 |