From 1706355ee10cdad20b79603b3f39935601c5fff0 Mon Sep 17 00:00:00 2001 From: Scot Breitenfeld Date: Thu, 20 Jul 2023 09:01:58 -0500 Subject: 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 --- config/sanitizer/README.md | 2 +- doxygen/aliases | 2 +- doxygen/dox/IntroHDF5.dox | 4 +- doxygen/dox/high_level/extension.dox | 2 +- doxygen/examples/tables/fileDriverLists.dox | 4 +- fortran/src/H5Af.c | 10 +-- fortran/src/H5Aff.F90 | 24 +++---- fortran/src/H5Gff.F90 | 6 +- fortran/src/H5Lf.c | 6 +- fortran/src/H5Lff.F90 | 6 +- fortran/src/H5Of.c | 2 +- fortran/src/H5Off.F90 | 2 +- fortran/src/H5Pff.F90 | 2 +- fortran/src/H5Tff.F90 | 2 +- fortran/test/tH5A_1_8.F90 | 12 ++-- fortran/test/tH5G_1_8.F90 | 16 ++--- hl/src/H5DOpublic.h | 18 ++--- hl/src/H5LDpublic.h | 6 +- hl/src/H5LTpublic.h | 18 ++--- src/H5Amodule.h | 28 ++++---- src/H5Apublic.h | 20 +++--- src/H5D.c | 8 +-- src/H5Dmodule.h | 30 ++++---- src/H5Dpublic.h | 56 +++++++-------- src/H5Emodule.h | 14 ++-- src/H5Epublic.h | 6 +- src/H5FDdevelop.h | 2 +- src/H5FDdirect.h | 4 +- src/H5FDwindows.h | 2 +- src/H5Fmodule.h | 12 ++-- src/H5Fprivate.h | 2 +- src/H5Fpublic.h | 18 ++--- src/H5Gmodule.h | 22 +++--- src/H5Gpublic.h | 12 ++-- src/H5Ipublic.h | 12 ++-- src/H5Lpublic.h | 22 +++--- src/H5Oprivate.h | 2 +- src/H5Opublic.h | 74 +++++++++---------- src/H5Pmodule.h | 32 ++++----- src/H5Ppublic.h | 84 +++++++++++----------- src/H5Rpublic.h | 10 +-- src/H5Smodule.h | 6 +- src/H5Spublic.h | 2 +- src/H5Tdevelop.h | 12 ++-- src/H5Tmodule.h | 22 +++--- src/H5Tpublic.h | 8 +-- src/H5VLconnector.h | 14 ++-- src/H5VLmodule.h | 24 +++---- src/H5VLpublic.h | 2 +- src/H5Zdevelop.h | 4 +- src/H5module.h | 20 +++--- src/H5public.h | 2 +- tools/src/misc/h5clear.c | 2 +- tools/test/misc/testfiles/h5clear_missing_file.ddl | 2 +- tools/test/misc/testfiles/h5clear_usage.ddl | 2 +- 55 files changed, 369 insertions(+), 369 deletions(-) diff --git a/config/sanitizer/README.md b/config/sanitizer/README.md index 0d5fb6c..308f9c3 100644 --- a/config/sanitizer/README.md +++ b/config/sanitizer/README.md @@ -53,7 +53,7 @@ These obviously force the standard to be required, and also disables compiler-sp ## Sanitizer Builds [`sanitizers.cmake`](sanitizers.cmake) -Sanitizers are tools that perform checks during a program’s runtime and returns issues, and as such, along with unit testing, code coverage and static analysis, is another tool to add to the programmers toolbox. And of course, like the previous tools, are tragically simple to add into any project using CMake, allowing any project and developer to quickly and easily use. +Sanitizers are tools that perform checks during a program's runtime and return issues, and as such, along with unit testing, code coverage and static analysis, are another tool to add to the programmer's toolbox. And, of course, like the previous tools, they are simple to add to any project using CMake, allowing any project and developer to quickly and easily use them. A quick rundown of the tools available, and what they do: - [LeakSanitizer](https://clang.llvm.org/docs/LeakSanitizer.html) detects memory leaks, or issues where memory is allocated and never deallocated, causing programs to slowly consume more and more memory, eventually leading to a crash. diff --git a/doxygen/aliases b/doxygen/aliases index 367881c..c83302a 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -306,7 +306,7 @@ ALIASES += ref_rfc20120523="HDF5 File Image Operations" ALIASES += ref_rfc20120305="Enabling a Strict Consistency Semantics Model in Parallel HDF5" ALIASES += ref_rfc20120220="h5repack: Improved Hyperslab selections for Large Chunked Datasets" -ALIASES += ref_rfc20120120="A Maintainer’s Guide for the Datatype Module in HDF5 Library" +ALIASES += ref_rfc20120120="A Maintainer's Guide for the Datatype Module in HDF5 Library" ALIASES += ref_rfc20120104="Actual I/O Mode" ALIASES += ref_rfc20111119="New public functions to handle comparison" ALIASES += ref_rfc20110825="Merging Named Datatypes in H5Ocopy()" diff --git a/doxygen/dox/IntroHDF5.dox b/doxygen/dox/IntroHDF5.dox index 951e60b..3ca7d00 100644 --- a/doxygen/dox/IntroHDF5.dox +++ b/doxygen/dox/IntroHDF5.dox @@ -124,7 +124,7 @@ It is a 2-dimensional 5 x 3 array (the dataspace). The datatype should not be co \subsubsection subsec_intro_desc_prop_dspace Dataspaces -A dataspace describes the layout of a dataset’s data elements. It can consist of no elements (NULL), +A dataspace describes the layout of a dataset's data elements. It can consist of no elements (NULL), a single element (scalar), or a simple array. @@ -141,7 +141,7 @@ in size (i.e. they are extendible). There are two roles of a dataspace: \li It contains the spatial information (logical layout) of a dataset stored in a file. This includes the rank and dimensions of a dataset, which are a permanent part of the dataset definition. -\li It describes an application’s data buffers and data elements participating in I/O. In other words, it can be used to select a portion or subset of a dataset. +\li It describes an application's data buffers and data elements participating in I/O. In other words, it can be used to select a portion or subset of a dataset.
diff --git a/doxygen/dox/high_level/extension.dox b/doxygen/dox/high_level/extension.dox index d754b96..20a099a 100644 --- a/doxygen/dox/high_level/extension.dox +++ b/doxygen/dox/high_level/extension.dox @@ -392,7 +392,7 @@ H5_HLRDLL herr_t H5LRread_region(hid_t obj_id, * * \details H5LRget_region_info() queries information about the data * pointed by a region reference \p ref. It returns one of the - * absolute paths to a dataset, length of the path, dataset’s rank + * absolute paths to a dataset, length of the path, dataset's rank * and datatype, description of the referenced region and type of * the referenced region. Any output argument can be NULL if that * argument does not need to be returned. diff --git a/doxygen/examples/tables/fileDriverLists.dox b/doxygen/examples/tables/fileDriverLists.dox index 1aae3ce..125df63 100644 --- a/doxygen/examples/tables/fileDriverLists.dox +++ b/doxygen/examples/tables/fileDriverLists.dox @@ -94,8 +94,8 @@ version of the file can be written back to disk or abandoned. - diff --git a/fortran/src/H5Af.c b/fortran/src/H5Af.c index 9e27f87..364d2c5 100644 --- a/fortran/src/H5Af.c +++ b/fortran/src/H5Af.c @@ -259,7 +259,7 @@ done: * H5_ITER_NATIVE - No particular order, whatever is fastest * H5_ITER_N - Number of iteration orders * - * n - Attribute’s position in index + * n - Attribute's position in index * attr_id - Attribute identifier * size - Buffer size ! *TEST* check for 0 value *CHECK* should this return the correct value * @@ -331,7 +331,7 @@ done: * * corder_valid - Indicates whether the creation order data is valid for this attribute * corder - Is a positive integer containing the creation order of the attribute - * cset - Indicates the character set used for the attribute’s name + * cset - Indicates the character set used for the attribute's name * data_size - indicates the size, in the number of characters, of the attribute * * RETURNS @@ -388,13 +388,13 @@ done: * H5_ITER_NATIVE - No particular order, whatever is fastest * H5_ITER_N - Number of iteration orders * - * n - Attribute’s position in index + * n - Attribute's position in index * lapl_id - Link access property list * OUTPUTS * * corder_valid - Indicates whether the creation order data is valid for this attribute * corder - Is a positive integer containing the creation order of the attribute - * cset - Indicates the character set used for the attribute’s name + * cset - Indicates the character set used for the attribute's name * data_size - indicates the size, in the number of characters, of the attribute * * RETURNS @@ -455,7 +455,7 @@ done: * * corder_valid - Indicates whether the creation order data is valid for this attribute * corder - Is a positive integer containing the creation order of the attribute - * cset - Indicates the character set used for the attribute’s name + * cset - Indicates the character set used for the attribute's name * data_size - indicates the size, in the number of characters, of the attribute * * RETURNS diff --git a/fortran/src/H5Aff.F90 b/fortran/src/H5Aff.F90 index 9216060..3cb1191 100644 --- a/fortran/src/H5Aff.F90 +++ b/fortran/src/H5Aff.F90 @@ -456,7 +456,7 @@ CONTAINS !! \li H5_ITER_DEC_F - Decreasing order !! \li H5_ITER_NATIVE_F - No particular order, whatever is fastest !! \li H5_ITER_N_F - Number of iteration orders -!! \param n Attribute’s position in index +!! \param n Attribute's position in index !! \param name Attribute name !! \param hdferr \fortran_error !! @@ -687,7 +687,7 @@ CONTAINS !! \brief Gets an attribute creation property list identifier !! !! \param attr_id Identifier of the attribute -!! \param creation_prop_id Identifier for the attribute’s creation property +!! \param creation_prop_id Identifier for the attribute's creation property !! \param hdferr \fortran_error !! !! See C API: @ref H5Aget_create_plist() @@ -1080,7 +1080,7 @@ CONTAINS !! \li H5_ITER_DEC_F - Decreasing order !! \li H5_ITER_NATIVE_F - No particular order, whatever is fastest !! \li H5_ITER_N_F - Number of iteration orders -!! \param n Attribute’s position in index. +!! \param n Attribute's position in index. !! \param attr_id Attribute identifier. !! \param hdferr \fortran_error !! \param aapl_id Attribute access property list. @@ -1152,7 +1152,7 @@ CONTAINS !! \li H5_ITER_DEC_F - Decreasing order !! \li H5_ITER_NATIVE_F - No particular order, whatever is fastest !! \li H5_ITER_N_F - Number of iteration orders -!! \param n Attribute’s position in index. +!! \param n Attribute's position in index. !! \param attr_id Attribute identifier. !! \param es_id \fortran_es_id !! \param hdferr \fortran_error @@ -1237,7 +1237,7 @@ CONTAINS !! NOTE: In C it is defined as a structure: H5A_info_t. !! \param f_corder_valid Indicates whether the creation order data is valid for this attribute. !! \param corder Is a positive integer containing the creation order of the attribute. -!! \param cset Indicates the character set used for the attribute’s name. +!! \param cset Indicates the character set used for the attribute's name. !! \param data_size Indicates the size, in the number of characters, of the attribute. !! \param hdferr \fortran_error !! @@ -1283,10 +1283,10 @@ CONTAINS !! \param obj_name Name of object to which attribute is attached, relative to location !! \param idx_type Type of index !! \param order Index traversal order -!! \param n Attribute’s position in index +!! \param n Attribute's position in index !! \param f_corder_valid Indicates whether the creation order data is valid for this attribute !! \param corder Is a positive integer containing the creation order of the attribute -!! \param cset Indicates the character set used for the attribute’s name +!! \param cset Indicates the character set used for the attribute's name !! \param data_size Indicates the size, in the number of characters, of the attribute !! \param hdferr \fortran_error !! \param lapl_id Link access property list @@ -1359,7 +1359,7 @@ CONTAINS !! \param attr_name Attribute name !! \param f_corder_valid Indicates whether the creation order data is valid for this attribute !! \param corder Is a positive integer containing the creation order of the attribute -!! \param cset Indicates the character set used for the attribute’s name +!! \param cset Indicates the character set used for the attribute's name !! \param data_size Indicates the size, in the number of characters, of the attribute !! \param hdferr \fortran_error !! \param lapl_id Link access property list @@ -1701,7 +1701,7 @@ CONTAINS !! \brief Determines whether an attribute with a given name exists on an object !! !! \param loc_id Location identifier -!! \param obj_name Object name either relative to loc_id, absolute from the file’s root group, or '. '(a dot) +!! \param obj_name Object name either relative to loc_id, absolute from the file's root group, or '. '(a dot) !! \param attr_name Attribute name !! \param attr_exists Attribute exists status !! \param hdferr \fortran_error @@ -1758,7 +1758,7 @@ CONTAINS !! \brief Asynchronously determines whether an attribute with a given name exists on an object !! !! \param loc_id Location identifier -!! \param obj_name Object name either relative to loc_id, absolute from the file’s root group, or '. '(a dot) +!! \param obj_name Object name either relative to loc_id, absolute from the file's root group, or '. '(a dot) !! \param attr_name Attribute name !! \param attr_exists Pointer to attribute exists status, must be of type LOGICAL(C_BOOL) and initialize to .FALSE. !! \param es_id \fortran_es_id @@ -1829,7 +1829,7 @@ CONTAINS !! \brief Opens an attribute for an object by object name and attribute name. !! !! \param loc_id Location from which to find object to which attribute is attached -!! \param obj_name Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot) +!! \param obj_name Object name either relative to loc_id, absolute from the file's root group, or '.' (a dot) !! \param attr_name Attribute name !! \param attr_id Attribute identifier !! \param hdferr \fortran_error @@ -1888,7 +1888,7 @@ CONTAINS !! \brief Asynchronously opens an attribute for an object by object name and attribute name. !! !! \param loc_id Location from which to find object to which attribute is attached -!! \param obj_name Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot) +!! \param obj_name Object name either relative to loc_id, absolute from the file's root group, or '.' (a dot) !! \param attr_name Attribute name !! \param attr_id Attribute identifier !! \param es_id \fortran_es_id diff --git a/fortran/src/H5Gff.F90 b/fortran/src/H5Gff.F90 index a9c7208..8f805ab 100644 --- a/fortran/src/H5Gff.F90 +++ b/fortran/src/H5Gff.F90 @@ -1171,7 +1171,7 @@ CONTAINS !> !! \ingroup FH5G !! -!! \brief Retrieves information about a group, according to the group’s position within an index. +!! \brief Retrieves information about a group, according to the group's position within an index. !! !! \attention \fortran_approved !! @@ -1226,7 +1226,7 @@ CONTAINS !> !! \ingroup FH5G !! -!! \brief Asynchronously retrieves information about a group, according to the group’s position within an index. +!! \brief Asynchronously retrieves information about a group, according to the group's position within an index. !! !! \param loc_id Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. !! \param group_name Name of group containing group for which information is to be retrieved. @@ -1285,7 +1285,7 @@ CONTAINS !> !! \ingroup FH5G !! -!! \brief Retrieves information about a group, according to the group’s position within an index. +!! \brief Retrieves information about a group, according to the group's position within an index. !! !! \attention \fortran_obsolete. Both nlinks and max_corder can overflow. !! diff --git a/fortran/src/H5Lf.c b/fortran/src/H5Lf.c index 009f7e3..5fb5a34 100644 --- a/fortran/src/H5Lf.c +++ b/fortran/src/H5Lf.c @@ -150,8 +150,8 @@ done: * OUTPUTS * * - * cset - indicates the character set used for link’s name. - * corder - specifies the link’s creation order position. + * cset - indicates the character set used for link's name. + * corder - specifies the link's creation order position. * corder_valid - indicates whether the value in corder is valid. * link_type - specifies the link class: * H5L_LINK_HARD_F - Hard link @@ -221,7 +221,7 @@ done: * * corder_valid - Indicates whether the creation order data is valid for this attribute * corder - Is a positive integer containing the creation order of the attribute - * cset - Indicates the character set used for the attribute’s name + * cset - Indicates the character set used for the attribute's name * data_size - indicates the size, in the number of characters, of the attribute * * RETURNS diff --git a/fortran/src/H5Lff.F90 b/fortran/src/H5Lff.F90 index 86bee88..c474754 100644 --- a/fortran/src/H5Lff.F90 +++ b/fortran/src/H5Lff.F90 @@ -830,8 +830,8 @@ CONTAINS !! \param link_loc_id File or group identifier. !! \param link_name Name of the link for which information is being sought. !! NOTE: In C these are contained in the structure H5L_info_t -!! \param cset Indicates the character set used for link’s name. -!! \param corder Specifies the link’s creation order position. +!! \param cset Indicates the character set used for link's name. +!! \param corder Specifies the link's creation order position. !! \param f_corder_valid Indicates whether the value in corder is valid. !! \param link_type Specifies the link class: !! \li H5L_TYPE_HARD_F - Hard link @@ -926,7 +926,7 @@ CONTAINS !! \li H5L_TYPE_ERROR _F - Error !! \param f_corder_valid Indicates whether the creation order data is valid for this attribute. !! \param corder Is a positive integer containing the creation order of the attribute. -!! \param cset Indicates the character set used for the attribute’s name. +!! \param cset Indicates the character set used for the attribute's name. !! \param token If the link is a hard link, token specifies the object token that the link points to. !! \param val_size If the link is a symbolic link, val_size will be the length of the link value, e.g., !! the length of the name of the pointed-to object with a null terminator. diff --git a/fortran/src/H5Of.c b/fortran/src/H5Of.c index aeb0b70..393f505 100644 --- a/fortran/src/H5Of.c +++ b/fortran/src/H5Of.c @@ -136,7 +136,7 @@ done: * Calls H5open_by_token * INPUTS * loc_id - File or group identifier - * token - Object’s token in the file + * token - Object's token in the file * * OUTPUTS * obj_id - Object identifier diff --git a/fortran/src/H5Off.F90 b/fortran/src/H5Off.F90 index e7862cf..75e0717 100644 --- a/fortran/src/H5Off.F90 +++ b/fortran/src/H5Off.F90 @@ -404,7 +404,7 @@ CONTAINS !! \brief Opens an object using its token within an HDF5 file. !! !! \param loc_id File or group identifier. -!! \param token Object’s token in the file. +!! \param token Object's token in the file. !! \param obj_id Object identifier for the opened object. !! \param hdferr \fortran_error !! diff --git a/fortran/src/H5Pff.F90 b/fortran/src/H5Pff.F90 index 16ad2ac..5f76b6c 100644 --- a/fortran/src/H5Pff.F90 +++ b/fortran/src/H5Pff.F90 @@ -5775,7 +5775,7 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! unlimited selection. !! \param src_file_name The name of the HDF5 file where the source dataset is located. !! \param src_dset_name The path to the HDF5 dataset in the file specified by src_file_name. -!! \param src_space_id The source dataset’s dataspace identifier with a selection applied, possibly an unlimited selection. +!! \param src_space_id The source dataset's dataspace identifier with a selection applied, possibly an unlimited selection. !! \param hdferr \fortran_error !! !! See C API: @ref H5Pset_virtual() diff --git a/fortran/src/H5Tff.F90 b/fortran/src/H5Tff.F90 index 4e05bbc..b93e3c3 100644 --- a/fortran/src/H5Tff.F90 +++ b/fortran/src/H5Tff.F90 @@ -1945,7 +1945,7 @@ CONTAINS !> !! \ingroup FH5T !! -!! \brief Check whether the library’s default conversion is hard conversion. +!! \brief Check whether the library's default conversion is hard conversion. !! !! \param src_id Identifier for the source datatype. !! \param dst_id Identifier for the destination datatype. diff --git a/fortran/test/tH5A_1_8.F90 b/fortran/test/tH5A_1_8.F90 index c19d177..2a479e4 100644 --- a/fortran/test/tH5A_1_8.F90 +++ b/fortran/test/tH5A_1_8.F90 @@ -236,7 +236,7 @@ SUBROUTINE test_attr_corder_create_compact(fcpl,fapl, total_error) LOGICAL :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute INTEGER :: corder ! Is a positive integer containing the creation order of the attribute - INTEGER :: cset ! Indicates the character set used for the attribute’s name + INTEGER :: cset ! Indicates the character set used for the attribute's name INTEGER(HSIZE_T) :: data_size ! indicates the size, in the number of characters data_dims = 0 @@ -413,7 +413,7 @@ SUBROUTINE test_attr_null_space(fcpl, fapl, total_error) LOGICAL :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute INTEGER :: corder ! Is a positive integer containing the creation order of the attribute - INTEGER :: cset ! Indicates the character set used for the attribute’s name + INTEGER :: cset ! Indicates the character set used for the attribute's name INTEGER(HSIZE_T) :: data_size ! indicates the size, in the number of characters LOGICAL :: equal @@ -755,7 +755,7 @@ SUBROUTINE test_attr_info_by_idx(new_format, fcpl, fapl, total_error) LOGICAL :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute INTEGER :: corder ! Is a positive integer containing the creation order of the attribute - INTEGER :: cset ! Indicates the character set used for the attribute’s name + INTEGER :: cset ! Indicates the character set used for the attribute's name INTEGER(HSIZE_T) :: data_size ! indicates the size, in the number of characters INTEGER(HSIZE_T) :: n LOGICAL, DIMENSION(1:2) :: use_index = (/.FALSE.,.TRUE./) @@ -936,7 +936,7 @@ SUBROUTINE attr_info_by_idx_check(obj_id, attrname, n, use_index, total_error ) LOGICAL :: use_index LOGICAL :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute INTEGER :: corder ! Is a positive integer containing the creation order of the attribute - INTEGER :: cset ! Indicates the character set used for the attribute’s name + INTEGER :: cset ! Indicates the character set used for the attribute's name INTEGER(HSIZE_T) :: data_size ! indicates the size, in the number of characters INTEGER(SIZE_T) :: NAME_BUF_SIZE = 7 @@ -1399,7 +1399,7 @@ SUBROUTINE test_attr_delete_by_idx(new_format, fcpl, fapl, total_error) LOGICAL :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute INTEGER :: corder ! Is a positive integer containing the creation order of the attribute - INTEGER :: cset ! Indicates the character set used for the attribute’s name + INTEGER :: cset ! Indicates the character set used for the attribute's name INTEGER(HSIZE_T) :: data_size ! indicates the size, in the number of characters LOGICAL, DIMENSION(1:2) :: use_index = (/.FALSE.,.TRUE./) @@ -2688,7 +2688,7 @@ SUBROUTINE attr_open_check(fid, dsetname, obj_id, max_attrs, total_error ) INTEGER :: error LOGICAL :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute INTEGER :: corder ! Is a positive integer containing the creation order of the attribute - INTEGER :: cset ! Indicates the character set used for the attribute’s name + INTEGER :: cset ! Indicates the character set used for the attribute's name INTEGER(HSIZE_T) :: data_size ! indicates the size, in the number of characters INTEGER(HSIZE_T) :: storage_size ! attributes storage requirements diff --git a/fortran/test/tH5G_1_8.F90 b/fortran/test/tH5G_1_8.F90 index 358c508..dca4cf2 100644 --- a/fortran/test/tH5G_1_8.F90 +++ b/fortran/test/tH5G_1_8.F90 @@ -751,8 +751,8 @@ END SUBROUTINE group_info INTEGER :: arank = 1 ! Attribute rank INTEGER :: error - INTEGER :: cset ! Indicates the character set used for the link’s name. - INTEGER :: corder ! Specifies the link’s creation order position. + INTEGER :: cset ! Indicates the character set used for the link's name. + INTEGER :: corder ! Specifies the link's creation order position. LOGICAL :: f_corder_valid ! Indicates whether the value in corder is valid. INTEGER :: link_type ! Specifies the link class: ! H5L_TYPE_HARD_F - Hard link @@ -850,8 +850,8 @@ END SUBROUTINE group_info INTEGER :: crt_order_flags ! Status of creation order info for GCPL CHARACTER(LEN=12), PARAMETER :: filename = 'TestLinks.h5' - INTEGER :: cset ! Indicates the character set used for the link’s name. - INTEGER :: corder ! Specifies the link’s creation order position. + INTEGER :: cset ! Indicates the character set used for the link's name. + INTEGER :: corder ! Specifies the link's creation order position. LOGICAL :: f_corder_valid ! Indicates whether the value in corder is valid. INTEGER :: link_type ! Specifies the link class: ! H5L_TYPE_HARD_F - Hard link @@ -1250,7 +1250,7 @@ SUBROUTINE delete_by_idx(cleanup, fapl, total_error) LOGICAL :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute INTEGER :: corder ! Is a positive integer containing the creation order of the attribute - INTEGER :: cset ! Indicates the character set used for the attribute’s name + INTEGER :: cset ! Indicates the character set used for the attribute's name INTEGER(SIZE_T) :: val_size INTEGER :: link_type TYPE(H5O_TOKEN_T_F) :: token @@ -1475,7 +1475,7 @@ SUBROUTINE link_info_by_idx_check(group_id, linkname, n, & LOGICAL :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute INTEGER :: corder ! Is a positive integer containing the creation order of the attribute - INTEGER :: cset ! Indicates the character set used for the attribute’s name + INTEGER :: cset ! Indicates the character set used for the attribute's name INTEGER :: link_type TYPE(H5O_TOKEN_T_F) :: token INTEGER(SIZE_T) :: val_size ! Indicates the size, in the number of characters, of the attribute @@ -1572,8 +1572,8 @@ SUBROUTINE link_info_by_idx_check(group_id, linkname, n, & INTEGER(HID_T) :: type_id INTEGER(HID_T) :: lcpl_id - INTEGER :: cset ! Indicates the character set used for the link’s name. - INTEGER :: corder ! Specifies the link’s creation order position. + INTEGER :: cset ! Indicates the character set used for the link's name. + INTEGER :: corder ! Specifies the link's creation order position. LOGICAL :: f_corder_valid ! Indicates whether the value in corder is valid. INTEGER :: link_type ! Specifies the link class: ! H5L_TYPE_HARD_F - Hard link diff --git a/hl/src/H5DOpublic.h b/hl/src/H5DOpublic.h index 106eb28..887e659 100644 --- a/hl/src/H5DOpublic.h +++ b/hl/src/H5DOpublic.h @@ -29,7 +29,7 @@ extern "C" { * HDF5 functions described is this section are implemented in the HDF5 High-level * library as optimized functions. These functions generally require careful setup * and testing as they enable an application to bypass portions of the HDF5 - * library’s I/O pipeline for performance purposes. + * library's I/O pipeline for performance purposes. * * These functions are distributed in the standard HDF5 distribution and are * available any time the HDF5 High-level library is available. @@ -113,7 +113,7 @@ H5_HLDLL herr_t H5DOappend(hid_t dset_id, hid_t dxpl_id, unsigned axis, size_t e * \param[in] dxpl_id Transfer property list identifier for * this I/O operation * \param[in] filters Mask for identifying the filters in use - * \param[in] offset Logical position of the chunk’s first element + * \param[in] offset Logical position of the chunk's first element * in the dataspace * \param[in] data_size Size of the actual data to be written in bytes * \param[in] buf Buffer containing data to be written to the chunk @@ -131,7 +131,7 @@ H5_HLDLL herr_t H5DOappend(hid_t dset_id, hid_t dxpl_id, unsigned axis, size_t e * logical \p offset in a chunked dataset \p dset_id from the application * memory buffer \p buf to the dataset in the file. Typically, the data * in \p buf is preprocessed in memory by a custom transformation, such as - * compression. The chunk will bypass the library’s internal data + * compression. The chunk will bypass the library's internal data * transfer pipeline, including filters, and will be written directly to the file. * * \p dxpl_id is a data transfer property list identifier. @@ -139,12 +139,12 @@ H5_HLDLL herr_t H5DOappend(hid_t dset_id, hid_t dxpl_id, unsigned axis, size_t e * \p filters is a mask providing a record of which filters are used * with the chunk. The default value of the mask is zero (\c 0), * indicating that all enabled filters are applied. A filter is skipped - * if the bit corresponding to the filter’s position in the pipeline + * if the bit corresponding to the filter's position in the pipeline * (0 ≤ position < 32) is turned on. This mask is saved * with the chunk in the file. * * \p offset is an array specifying the logical position of the first - * element of the chunk in the dataset’s dataspace. The length of the + * element of the chunk in the dataset's dataspace. The length of the * offset array must equal the number of dimensions, or rank, of the * dataspace. The values in \p offset must not exceed the dimension limits * and must specify a point that falls on a dataset chunk boundary. @@ -189,7 +189,7 @@ H5_HLDLL herr_t H5DOwrite_chunk(hid_t dset_id, hid_t dxpl_id, uint32_t filters, * \param[in] dset_id Identifier for the dataset to be read * \param[in] dxpl_id Transfer property list identifier for * this I/O operation - * \param[in] offset Logical position of the chunk’s first + * \param[in] offset Logical position of the chunk's first element in the dataspace * \param[in,out] filters Mask for identifying the filters used * with the chunk @@ -209,7 +209,7 @@ H5_HLDLL herr_t H5DOwrite_chunk(hid_t dset_id, hid_t dxpl_id, uint32_t filters, * by its logical \p offset in a chunked dataset \p dset_id * from the dataset in the file into the application memory * buffer \p buf. The data in \p buf is read directly from the file - * bypassing the library’s internal data transfer pipeline, + * bypassing the library's internal data transfer pipeline, * including filters. * * \p dxpl_id is a data transfer property list identifier. @@ -217,11 +217,11 @@ H5_HLDLL herr_t H5DOwrite_chunk(hid_t dset_id, hid_t dxpl_id, uint32_t filters, * The mask \p filters indicates which filters are used with the * chunk when written. A zero value indicates that all enabled filters * are applied on the chunk. A filter is skipped if the bit corresponding - * to the filter’s position in the pipeline + * to the filter's position in the pipeline * (0 ≤ position < 32) is turned on. * * \p offset is an array specifying the logical position of the first - * element of the chunk in the dataset’s dataspace. The length of the + * element of the chunk in the dataset's dataspace. The length of the * offset array must equal the number of dimensions, or rank, of the * dataspace. The values in \p offset must not exceed the dimension * limits and must specify a point that falls on a dataset chunk boundary. diff --git a/hl/src/H5LDpublic.h b/hl/src/H5LDpublic.h index 830b488..1eee8b4 100644 --- a/hl/src/H5LDpublic.h +++ b/hl/src/H5LDpublic.h @@ -50,18 +50,18 @@ H5_HLDLL herr_t H5LDget_dset_dims(hid_t did, hsize_t *cur_dims); *------------------------------------------------------------------------- * \ingroup H5LT * - * \brief Returns the size in bytes of the dataset’s datatype + * \brief Returns the size in bytes of the dataset's datatype * * \param[in] did The dataset identifier * \param[in] fields The pointer to a comma-separated list of fields for a compound datatype * * \return If successful, returns the size in bytes of the - * dataset’s datatype. Otherwise, returns 0. + * dataset's datatype. Otherwise, returns 0. * * \details H5LDget_dset_type_size() allows the user to find out the datatype * size for the dataset associated with \p did. If the * parameter \p fields is NULL, this routine just returns the size - * of the dataset’s datatype. If the dataset has a compound datatype + * of the dataset's datatype. If the dataset has a compound datatype * and \p fields is non-NULL, this routine returns the size of the * datatype(s) for the selected fields specified in \p fields. * Note that ’,’ is the separator for the fields of a compound diff --git a/hl/src/H5LTpublic.h b/hl/src/H5LTpublic.h index 7ef51d4..1ce5c81 100644 --- a/hl/src/H5LTpublic.h +++ b/hl/src/H5LTpublic.h @@ -208,7 +208,7 @@ H5_HLDLL herr_t H5LTmake_dataset(hid_t loc_id, const char *dset_name, int rank, * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be \e character, #H5T_NATIVE_CHAR. + * The dataset's datatype will be \e character, #H5T_NATIVE_CHAR. * */ H5_HLDLL herr_t H5LTmake_dataset_char(hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, @@ -232,7 +232,7 @@ H5_HLDLL herr_t H5LTmake_dataset_char(hid_t loc_id, const char *dset_name, int r * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be short signed integer, + * The dataset's datatype will be short signed integer, * #H5T_NATIVE_SHORT. * */ @@ -257,7 +257,7 @@ H5_HLDLL herr_t H5LTmake_dataset_short(hid_t loc_id, const char *dset_name, int * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be native signed integer, + * The dataset's datatype will be native signed integer, * #H5T_NATIVE_INT. * * \version Fortran subroutine modified in this release to accommodate @@ -285,7 +285,7 @@ H5_HLDLL herr_t H5LTmake_dataset_int(hid_t loc_id, const char *dset_name, int ra * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be long signed integer, + * The dataset's datatype will be long signed integer, * #H5T_NATIVE_LONG. * */ @@ -310,7 +310,7 @@ H5_HLDLL herr_t H5LTmake_dataset_long(hid_t loc_id, const char *dset_name, int r * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be native floating point, + * The dataset's datatype will be native floating point, * #H5T_NATIVE_FLOAT. * * \version 1.8.7 Fortran subroutine modified in this release to accommodate @@ -338,7 +338,7 @@ H5_HLDLL herr_t H5LTmake_dataset_float(hid_t loc_id, const char *dset_name, int * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be + * The dataset's datatype will be * native floating-point double, #H5T_NATIVE_DOUBLE. * * \version 1.8.7 Fortran subroutine modified in this release to accommodate @@ -364,7 +364,7 @@ H5_HLDLL herr_t H5LTmake_dataset_double(hid_t loc_id, const char *dset_name, int * named \p dset_name attached to the object specified by * the identifier \p loc_id. * - * The dataset’s datatype will be C string, #H5T_C_S1. + * The dataset's datatype will be C string, #H5T_C_S1. * */ H5_HLDLL herr_t H5LTmake_dataset_string(hid_t loc_id, const char *dset_name, const char *buf); @@ -1496,7 +1496,7 @@ H5_HLDLL herr_t H5LTfind_attribute(hid_t loc_id, const char *name); * final component of \p path resolves to an HDF5 object; * if not, the final component is a dangling link. * - * The meaning of the function’s return value depends on the + * The meaning of the function's return value depends on the * value of \p check_object_valid: * * If \p check_object_valid is set to \c FALSE, H5LTpath_valid() @@ -1516,7 +1516,7 @@ H5_HLDLL herr_t H5LTfind_attribute(hid_t loc_id, const char *name); * \p path can be any one of the following: * * - An absolute path, which starts with a slash (\c /) - * indicating the file’s root group, followed by the members + * indicating the file's root group, followed by the members * - A relative path with respect to \p loc_id * - A dot (\c .), if \p loc_id is the object identifier for * the object itself. diff --git a/src/H5Amodule.h b/src/H5Amodule.h index 75a4c8c..18fabe5 100644 --- a/src/H5Amodule.h +++ b/src/H5Amodule.h @@ -77,7 +77,7 @@ * data, and the attribute creation property list. * * The following steps are required to create and write an HDF5 attribute: - * \li Obtain the object identifier for the attribute’s primary data object + * \li Obtain the object identifier for the attribute's primary data object * \li Define the characteristics of the attribute and specify the attribute creation property list * * - * + * * *
The dataspace is used to describe both the logical layout of a dataset and a subset of a dataset.
Family #H5FD_FAMILYWith 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 +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 systems that do not support files larger than 2 gigabytes. #H5Pset_fapl_family
#H5Dset_extentChanges the sizes of a dataset’s dimensions.Changes the sizes of a dataset's dimensions.
* @@ -268,7 +268,7 @@ * of each dimension. The maximum dimension size can be a fixed value or the constant * #H5S_UNLIMITED, in which case the actual dimension size can be changed with calls to * #H5Dset_extent, up to the maximum set with the maxdims parameter in the #H5Screate_simple - * call that established the dataset’s original dimensions. The maximum dimension size is set when + * call that established the dataset's original dimensions. The maximum dimension size is set when * the dataset is created and cannot be changed. * *

Datatype

@@ -738,11 +738,11 @@ * * * I/O initiation - * Initiation of HDF5 I/O activities (#H5Dwrite and #H5Dread) in a user’s application program. + * Initiation of HDF5 I/O activities (#H5Dwrite and #H5Dread) in a user's application program. * * * Memory hyperslab operation - * Data is scattered to (for read), or gathered from (for write) the application’s memory buffer + * Data is scattered to (for read), or gathered from (for write) the application's memory buffer * (bypassed if no datatype conversion is needed). * * @@ -849,7 +849,7 @@ * Filters are selected by dataset creation properties, and some behavior may be controlled by data * transfer properties. The library determines what filters must be applied and applies them in the * order in which they were set by the application. That is, if an application calls - * #H5Pset_shuffle and then #H5Pset_deflate when creating a dataset’s creation property list, the + * #H5Pset_shuffle and then #H5Pset_deflate when creating a dataset's creation property list, the * library will apply the shuffle filter first and then the deflate filter. * * For more information, @@ -1147,8 +1147,8 @@ allocated if necessary. * are defined. See the example code below. * * The dimensions of the dataset can also be reduced. If the sizes specified are smaller than the - * dataset’s current dimension sizes, #H5Dset_extent will reduce the dataset’s dimension sizes to the - * specified values. It is the user’s responsibility to ensure that valuable data is not lost; + * dataset's current dimension sizes, #H5Dset_extent will reduce the dataset's dimension sizes to the + * specified values. It is the user's responsibility to ensure that valuable data is not lost; * #H5Dset_extent does not check. * * Using #H5Dset_extent to increase the size of a dataset @@ -1298,7 +1298,7 @@ allocated if necessary. * * * - * Together these three properties control the library’s behavior. The table below summarizes the + * Together these three properties control the library's behavior. The table below summarizes the * possibilities during the dataset create-write-close cycle. * * @@ -1812,7 +1812,7 @@ allocated if necessary. * The first and second parameters can be obtained using the HDF5 dataspace and datatype * interface calls. * - * A compound datatype can have members of array or compound datatype. An array datatype’s + * A compound datatype can have members of array or compound datatype. An array datatype's * base datatype can be a complex compound datatype. Recursive calls are required to set * parameters for these complex situations. * @@ -1821,16 +1821,16 @@ allocated if necessary. * recursive calls. * * For an atomic datatype (integer or floating-point), parameters that will be stored include the - * datatype’s size, endianness, precision, and offset. + * datatype's size, endianness, precision, and offset. * * For a no-op datatype, only the size is required. * - * For a compound datatype, parameters that will be stored include the datatype’s total size and + * For a compound datatype, parameters that will be stored include the datatype's total size and * number of members. For each member, its member offset needs to be stored. Other parameters * for members will depend on the respective datatype class. * - * For an array datatype, the total size parameter should be stored. Other parameters for the array’s - * base type depend on the base type’s datatype class. + * For an array datatype, the total size parameter should be stored. Other parameters for the array's + * base type depend on the base type's datatype class. * * Further, to correctly retrieve the parameter for use of n-bit compression or decompression later, * parameters for distinguishing between datatype classes should be stored. @@ -1897,7 +1897,7 @@ allocated if necessary. * In the function H5Z__set_parms_array: *
@@ -164,7 +164,7 @@ * H5Eget_auto2(error_stack, &old_func, &old_client_data); * *** Turn off error handling *** * H5Eset_auto2(error_stack, NULL, NULL); - * *** Probe. Likely to fail, but that’s okay *** + * *** Probe. Likely to fail, but that's okay *** * status = H5Fopen (......); * *** Restore previous error handler *** * H5Eset_auto2(error_stack, old_func, old_client_data); @@ -300,7 +300,7 @@ * * * *
Example: An Error Report
- *

An error report shows both the library’s error record and the application’s error records. + *

An error report shows both the library's error record and the application's error records. * See the example below. *

  * Error Test-DIAG: Error detected in Error Program (1.0)
@@ -323,9 +323,9 @@
  *   
* In the line above error record #002 in the example above, the starting phrase is HDF5. This is the error - * class name of the HDF5 Library. All of the library’s error messages (major and minor) are in this default + * class name of the HDF5 Library. All of the library's error messages (major and minor) are in this default * error class. The Error Test in the beginning of the line above error record #000 is the name of the - * application’s error class. The first two error records, #000 and #001, are from application’s error class. + * application's error class. The first two error records, #000 and #001, are from application's error class. * By definition, an error class is a group of major and minor error messages for a library (the HDF5 Library * or an application library built on top of the HDF5 Library) or an application program. The error class can * be registered for a library or program through the HDF5 Error API. Major and minor messages can be defined diff --git a/src/H5Epublic.h b/src/H5Epublic.h index 1d7d7b5..a62c462 100644 --- a/src/H5Epublic.h +++ b/src/H5Epublic.h @@ -276,7 +276,7 @@ H5_DLL hid_t H5Ecreate_msg(hid_t cls, H5E_type_t msg_type, const char *msg); * \return \hid_ti{error stack} * * \details H5Ecreate_stack() creates a new empty error stack and returns the - * new stack’s identifier. Use H5Eclose_stack() to close the error stack + * new stack's identifier. Use H5Eclose_stack() to close the error stack * identifier returned by this function. * * \since 1.8.0 @@ -530,7 +530,7 @@ H5_DLL herr_t H5Ewalk2(hid_t err_stack, H5E_direction_t direction, H5E_walk2_t f * H5Eget_auto2() will fail and will indicate that the application has * mixed H5Eset_auto1() and H5Eget_auto2(). On the other hand, mixing * H5Eset_auto2() and H5Eget_auto1() will also cause a failure. But if - * the traversal functions are the library’s default H5Eprint1() or + * the traversal functions are the library's default H5Eprint1() or * H5Eprint2(), mixing H5Eset_auto1() and H5Eget_auto2() or mixing * H5Eset_auto2() and H5Eget_auto1() does not fail. * @@ -768,7 +768,7 @@ H5_DLL herr_t H5Eclear1(void); * H5Eget_auto2() will fail and will indicate that the application has * mixed H5Eset_auto1() and H5Eget_auto2(). On the other hand, mixing * H5Eset_auto2() and H5Eget_auto1() will also cause a failure. But if - * the traversal functions are the library’s default H5Eprint1() or + * the traversal functions are the library's default H5Eprint1() or * H5Eprint2(), mixing H5Eset_auto1() and H5Eget_auto2() or mixing * H5Eset_auto2() and H5Eget_auto1() does not fail. * diff --git a/src/H5FDdevelop.h b/src/H5FDdevelop.h index ab1579c..cba2703 100644 --- a/src/H5FDdevelop.h +++ b/src/H5FDdevelop.h @@ -163,7 +163,7 @@ typedef struct H5FD_t H5FD_t; /* Class information for each file driver */ typedef struct H5FD_class_t { - unsigned version; /**< File driver class struct version # */ + unsigned version; /**< File driver class struct version number */ H5FD_class_value_t value; const char *name; haddr_t maxaddr; diff --git a/src/H5FDdirect.h b/src/H5FDdirect.h index 7858dfd..e47ac37 100644 --- a/src/H5FDdirect.h +++ b/src/H5FDdirect.h @@ -54,7 +54,7 @@ H5_DLL hid_t H5FD_direct_init(void); * cached by the system. * * File systems usually require the data address in memory, the file - * address, and the size of the data to be aligned. The HDF5 library’s + * address, and the size of the data to be aligned. The HDF5 library's * direct I/O driver is able to handle unaligned data, though that will * consume some additional memory resources and may slow * performance. To get better performance, use the system function \p @@ -67,7 +67,7 @@ H5_DLL hid_t H5FD_direct_init(void); * \p alignment specifies the required alignment boundary in memory. * * \p block_size specifies the file system block size. A value of 0 - * (zero) means to use HDF5 library’s default value of 4KB. + * (zero) means to use HDF5 library's default value of 4KB. * * \p cbuf_size specifies the copy buffer size. * diff --git a/src/H5FDwindows.h b/src/H5FDwindows.h index a491e54..14f6985 100644 --- a/src/H5FDwindows.h +++ b/src/H5FDwindows.h @@ -44,7 +44,7 @@ extern "C" { * comes. * * Only the Windows driver is tested on Windows systems; other drivers - * are used at the application’s and the user’s risk. + * are used at the application's and the user's risk. * * Furthermore, the Windows driver is tested and available only on * Windows systems; it is not available on non-Windows systems. diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h index 75f2b47..0fcf4b8 100644 --- a/src/H5Fmodule.h +++ b/src/H5Fmodule.h @@ -133,7 +133,7 @@ * \li Single file on a standard file system * \li Multiple files on a standard file system * \li Multiple files on a parallel file system - * \li Block of memory within an application’s memory space + * \li Block of memory within an application's memory space * \li More abstract situations such as virtual files * * This HDF5 address space is generally referred to as an HDF5 file regardless of its organization at @@ -347,7 +347,7 @@ * * * #H5Fget_mdc_hit_rate - * Obtains target file’s metadata cache hit rate. + * Obtains target file's metadata cache hit rate. * * * #H5Fget_mdc_size @@ -436,7 +436,7 @@ * * The new file is created with the properties specified in the property lists fcpl_id and fapl_id. * fcpl is short for file creation property list. fapl is short for file access property list. Specifying - * #H5P_DEFAULT for either the creation or access property list will use the library’s default + * #H5P_DEFAULT for either the creation or access property list will use the library's default * creation or access properties. * * If #H5Fcreate successfully creates the file, it returns a file identifier for the new file. This @@ -629,7 +629,7 @@ * #H5Pget_sieve_buf_size retrieves the current maximum size of the data sieve buffer. * *

Garbage Collection References

- * Dataset region references and other reference types use space in an HDF5 file’s global heap. If + * Dataset region references and other reference types use space in an HDF5 file's global heap. If * garbage collection is on (1) and the user passes in an uninitialized value in a reference structure, * the heap might become corrupted. When garbage collection is off (0), however, and the user reuses * a reference, the previous heap block will be orphaned and not returned to the free heap @@ -644,7 +644,7 @@ * \li Single file on standard file system * \li Multiple files on standard file system * \li Multiple files on parallel file system - * \li Block of memory within application’s memory space + * \li Block of memory within application's memory space * \li More abstract situations such as virtual files * * This HDF5 address space is generally referred to as an HDF5 file regardless of its organization at @@ -1029,7 +1029,7 @@ * function. * * \subsubsection subsubsec_file_alternate_drivers_par The Parallel Driver - * Parallel environments require a parallel low-level driver. HDF5’s default driver for parallel + * Parallel environments require a parallel low-level driver. HDF5's default driver for parallel * systems is called the Parallel driver, #H5FD_MPIO. This driver uses the MPI standard for both * communication and file I/O. * diff --git a/src/H5Fprivate.h b/src/H5Fprivate.h index 319ba3a..aa62800 100644 --- a/src/H5Fprivate.h +++ b/src/H5Fprivate.h @@ -293,7 +293,7 @@ typedef struct H5F_t H5F_t; #define H5F_SIGNATURE "\211HDF\r\n\032\n" #define H5F_SIGNATURE_LEN 8 -/* Version #'s of the major components of the file format */ +/* Version number's of the major components of the file format */ #define HDF5_SUPERBLOCK_VERSION_DEF 0 /* The default super block format */ #define HDF5_SUPERBLOCK_VERSION_1 1 /* Version with non-default B-tree 'K' value */ #define HDF5_SUPERBLOCK_VERSION_2 2 /* Revised version with superblock extension and checksum */ diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h index ffcde3c..585f9a0 100644 --- a/src/H5Fpublic.h +++ b/src/H5Fpublic.h @@ -124,17 +124,17 @@ typedef enum H5F_close_degree_t { //! typedef struct H5F_info2_t { struct { - unsigned version; /**< Superblock version # */ + unsigned version; /**< Superblock version number */ hsize_t super_size; /**< Superblock size */ hsize_t super_ext_size; /**< Superblock extension size */ } super; struct { - unsigned version; /**< Version # of file free space management */ + unsigned version; /**< Version number of file free space management */ hsize_t meta_size; /**< Free space manager metadata size */ hsize_t tot_space; /**< Amount of free space in the file */ } free; struct { - unsigned version; /**< Version # of shared object header info */ + unsigned version; /**< Version number of shared object header info */ hsize_t hdr_size; /**< Shared object header message header size */ H5_ih_info_t msgs_info; /**< Shared object header message index & heap size */ } sohm; @@ -957,7 +957,7 @@ H5_DLL herr_t H5Fincrement_filesize(hid_t file_id, hsize_t increment); * \file_id * \param[out] buf_ptr Pointer to the buffer into which the image of the * HDF5 file is to be copied. If \p buf_ptr is NULL, - * no data will be copied but the function’s return value + * no data will be copied but the function's return value * will still indicate the buffer size required (or a * negative value on error). * \param[out] buf_len Size of the supplied buffer @@ -974,7 +974,7 @@ H5_DLL herr_t H5Fincrement_filesize(hid_t file_id, hsize_t increment); * file image. So if the file size is unknown, it can be safely * determined with an initial H5Fget_file_image() call with buf_ptr * set to NULL. The file image can then be retrieved with a second - * H5Fget_file_image() call with \p buf_len set to the initial call’s + * H5Fget_file_image() call with \p buf_len set to the initial call's * return value. * * While the current file size can also be retrieved with @@ -1172,7 +1172,7 @@ H5_DLL ssize_t H5Fget_name(hid_t obj_id, char *name, size_t size); /** * \ingroup H5F * - * \brief Retrieves name of file to which object belongs + * \brief Retrieves global file information * * \fgdta_obj_id * \param[out] file_info Buffer for global file information @@ -1320,7 +1320,7 @@ H5_DLL herr_t H5Fget_metadata_read_retry_info(hid_t file_id, H5F_retry_info_t *i * on a system that is not atomic. * \li Turn off usage of the library's accumulator to avoid possible * ordering problem on a system that is not atomic. - * \li Perform a flush of the file’s data buffers and metadata to set + * \li Perform a flush of the file's data buffers and metadata to set * a consistent state for starting SWMR write operations. * * Library objects are groups, datasets, and committed datatypes. For @@ -1390,7 +1390,7 @@ H5_DLL ssize_t H5Fget_free_sections(hid_t file_id, H5F_mem_t type, size_t nsects * \return \herr_t * * \details H5Fclear_elink_file_cache() evicts all the cached child files in - * the specified file’s external file cache, causing them to be closed + * the specified file's external file cache, causing them to be closed * if there is nothing else holding them open. * * H5Fclear_elink_file_cache() does not close the cache itself; @@ -1845,7 +1845,7 @@ typedef struct H5F_info1_t { /** * \ingroup H5F * - * \brief Retrieves name of file to which object belongs + * \brief Retrieves global file information * * \fgdta_obj_id * \param[out] file_info Buffer for global file information diff --git a/src/H5Gmodule.h b/src/H5Gmodule.h index bebca87..4c435eb 100644 --- a/src/H5Gmodule.h +++ b/src/H5Gmodule.h @@ -46,7 +46,7 @@ * In the first figure below, the group structure is strictly hierarchical, identical to the file system * analogs. * - * In the next two figures below, the structure takes advantage of the directed graph’s allowance of + * In the next two figures below, the structure takes advantage of the directed graph's allowance of * circular references. In the second figure, GroupA is not only a member of the root group, /, but a * member of GroupC. Since Group C is a member of Group B and Group B is a member of Group * A, Dataset1 can be accessed by means of the circular reference /Group A/Group B/Group @@ -189,7 +189,7 @@ * like a regular or hard link. The differences are that the hard link cannot be created if the target * object does not exist and it always points to the same object. A soft link can be created with any * path name, whether or not the object exists; it may or may not, therefore, be possible to follow a - * soft link. Furthermore, a soft link’s target object may be changed. + * soft link. Furthermore, a soft link's target object may be changed. * * \subsubsection subsubsec_group_descr_path HDF5 Path Names * The structure of the HDF5 file constitutes the name space for the objects in the file. A path name @@ -257,14 +257,14 @@ * for very small groups, improved link indexing for large groups, and other advanced features. *