Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

removed the use of encoded single apostrophe #3261

Merged
merged 8 commits into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/sanitizer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 programs 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.
Expand Down
2 changes: 1 addition & 1 deletion doxygen/aliases
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ ALIASES += ref_rfc20120523="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/paged_a
ALIASES += ref_rfc20120501="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/HDF5FileImageOperations.pdf\">HDF5 File Image Operations</a>"
ALIASES += ref_rfc20120305="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/RFC%20PHDF5%20Consistency%20Semantics%20MC%20120328.docx.pdf\">Enabling a Strict Consistency Semantics Model in Parallel HDF5</a>"
ALIASES += ref_rfc20120220="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/h5repack_improve_hyperslab_over_chunked_dataset_v1.pdf\"><tt>h5repack</tt>: Improved Hyperslab selections for Large Chunked Datasets</a>"
ALIASES += ref_rfc20120120="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/2012-1-25-Maintainers-guide-for-datatype.docx.pdf\">A Maintainers Guide for the Datatype Module in HDF5 Library</a>"
ALIASES += ref_rfc20120120="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/2012-1-25-Maintainers-guide-for-datatype.docx.pdf\">A Maintainer's Guide for the Datatype Module in HDF5 Library</a>"
ALIASES += ref_rfc20120104="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/RFC_actual_io_v4-1_done.docx.pdf\">Actual I/O Mode</a>"
ALIASES += ref_rfc20111119="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/RFC-H5Ocompare-review_v6.pdf\">New public functions to handle comparison</a>"
ALIASES += ref_rfc20110825="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/2011-08-31-RFC_H5Ocopy_Named_DT_v2.docx.pdf\">Merging Named Datatypes in H5Ocopy()</a>"
Expand Down
4 changes: 2 additions & 2 deletions doxygen/dox/IntroHDF5.dox
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ It is a 2-dimensional 5 x 3 array (the dataspace). The datatype should not be co
</ul>

\subsubsection subsec_intro_desc_prop_dspace Dataspaces
A dataspace describes the layout of a datasets 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.

<table>
Expand All @@ -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 applications 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.

<table>
<caption>The dataspace is used to describe both the logical layout of a dataset and a subset of a dataset.</caption>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/high_level/extension.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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, datasets 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.
Expand Down
4 changes: 2 additions & 2 deletions doxygen/examples/tables/fileDriverLists.dox
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ version of the file can be written back to disk or abandoned.</td>
<tr>
<td>Family</td>
<td>#H5FD_FAMILY</td>
<td>With this driver, the HDF5 files address space is partitioned into pieces and sent to
separate storage files using an underlying driver of the users choice. This driver is for
<td>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.</td>
<td>#H5Pset_fapl_family</td>
</tr>
Expand Down
10 changes: 5 additions & 5 deletions fortran/src/H5Af.c
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ h5adelete_by_idx_c(hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen, int_f
* H5_ITER_NATIVE - No particular order, whatever is fastest
* H5_ITER_N - Number of iteration orders
*
* n - Attributes 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
*
Expand Down Expand Up @@ -331,7 +331,7 @@ h5aget_name_by_idx_c(hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen, int_
*
* 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 attributes 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
Expand Down Expand Up @@ -388,13 +388,13 @@ h5aget_info_c(hid_t_f *loc_id, int_f *corder_valid, int_f *corder, int_f *cset,
* H5_ITER_NATIVE - No particular order, whatever is fastest
* H5_ITER_N - Number of iteration orders
*
* n - Attributes 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 attributes 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
Expand Down Expand Up @@ -455,7 +455,7 @@ h5aget_info_by_idx_c(hid_t_f *loc_id, _fcd obj_name, size_t_f *obj_namelen, int_
*
* 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 attributes 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
Expand Down
24 changes: 12 additions & 12 deletions fortran/src/H5Aff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ END SUBROUTINE h5aget_name_f
!! \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 Attributes position in index
!! \param n Attribute&apos;s position in index
!! \param name Attribute name
!! \param hdferr \fortran_error
!!
Expand Down Expand Up @@ -687,7 +687,7 @@ END SUBROUTINE h5aget_storage_size_f
!! \brief Gets an attribute creation property list identifier
!!
!! \param attr_id Identifier of the attribute
!! \param creation_prop_id Identifier for the attributes creation property
!! \param creation_prop_id Identifier for the attribute&apos;s creation property
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Aget_create_plist()
Expand Down Expand Up @@ -1080,7 +1080,7 @@ END SUBROUTINE h5adelete_by_name_f
!! \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 Attributes position in index.
!! \param n Attribute&apos;s position in index.
!! \param attr_id Attribute identifier.
!! \param hdferr \fortran_error
!! \param aapl_id Attribute access property list.
Expand Down Expand Up @@ -1152,7 +1152,7 @@ END SUBROUTINE h5aopen_by_idx_f
!! \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 Attributes position in index.
!! \param n Attribute&apos;s position in index.
!! \param attr_id Attribute identifier.
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
Expand Down Expand Up @@ -1237,7 +1237,7 @@ END SUBROUTINE h5aopen_by_idx_async_f
!! 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 attributes name.
!! \param cset Indicates the character set used for the attribute&apos;s name.
!! \param data_size Indicates the size, in the number of characters, of the attribute.
!! \param hdferr \fortran_error
!!
Expand Down Expand Up @@ -1283,10 +1283,10 @@ END SUBROUTINE h5aget_info_f
!! \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 Attributes position in index
!! \param n Attribute&apos;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 attributes name
!! \param cset Indicates the character set used for the attribute&apos;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
Expand Down Expand Up @@ -1359,7 +1359,7 @@ END SUBROUTINE h5aget_info_by_idx_f
!! \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 attributes name
!! \param cset Indicates the character set used for the attribute&apos;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
Expand Down Expand Up @@ -1701,7 +1701,7 @@ END SUBROUTINE h5aexists_async_f
!! \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 files root group, or &apos;. &apos;(a dot)
!! \param obj_name Object name either relative to loc_id, absolute from the file&apos;s root group, or &apos;. &apos;(a dot)
!! \param attr_name Attribute name
!! \param attr_exists Attribute exists status
!! \param hdferr \fortran_error
Expand Down Expand Up @@ -1758,7 +1758,7 @@ END SUBROUTINE h5aexists_by_name_f
!! \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 files root group, or &apos;. &apos;(a dot)
!! \param obj_name Object name either relative to loc_id, absolute from the file&apos;s root group, or &apos;. &apos;(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
Expand Down Expand Up @@ -1829,7 +1829,7 @@ END SUBROUTINE h5aexists_by_name_async_f
!! \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 files root group, or &apos;.&apos; (a dot)
!! \param obj_name Object name either relative to loc_id, absolute from the file&apos;s root group, or &apos;.&apos; (a dot)
!! \param attr_name Attribute name
!! \param attr_id Attribute identifier
!! \param hdferr \fortran_error
Expand Down Expand Up @@ -1888,7 +1888,7 @@ END SUBROUTINE h5aopen_by_name_f
!! \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 files root group, or &apos;.&apos; (a dot)
!! \param obj_name Object name either relative to loc_id, absolute from the file&apos;s root group, or &apos;.&apos; (a dot)
!! \param attr_name Attribute name
!! \param attr_id Attribute identifier
!! \param es_id \fortran_es_id
Expand Down
6 changes: 3 additions & 3 deletions fortran/src/H5Gff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -1171,7 +1171,7 @@ END SUBROUTINE h5gget_info_f90
!>
!! \ingroup FH5G
!!
!! \brief Retrieves information about a group, according to the groups position within an index.
!! \brief Retrieves information about a group, according to the group&apos;s position within an index.
!!
!! \attention \fortran_approved
!!
Expand Down Expand Up @@ -1226,7 +1226,7 @@ END SUBROUTINE h5gget_info_by_idx_f03
!>
!! \ingroup FH5G
!!
!! \brief Asynchronously retrieves information about a group, according to the groups position within an index.
!! \brief Asynchronously retrieves information about a group, according to the group&apos;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.
Expand Down Expand Up @@ -1285,7 +1285,7 @@ END SUBROUTINE h5gget_info_by_idx_async_f
!>
!! \ingroup FH5G
!!
!! \brief Retrieves information about a group, according to the groups position within an index.
!! \brief Retrieves information about a group, according to the group&apos;s position within an index.
!!
!! \attention \fortran_obsolete. Both nlinks and max_corder can overflow.
!!
Expand Down
6 changes: 3 additions & 3 deletions fortran/src/H5Lf.c
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ h5lcreate_external_c(_fcd file_name, size_t_f *file_namelen, _fcd obj_name, size
* OUTPUTS
*
*
* cset - indicates the character set used for links name.
* corder - specifies the links 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
Expand Down Expand Up @@ -221,7 +221,7 @@ h5lget_info_c(hid_t_f *link_loc_id, _fcd link_name, size_t_f *link_namelen, int_
*
* 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 attributes 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
Expand Down
6 changes: 3 additions & 3 deletions fortran/src/H5Lff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -830,8 +830,8 @@ END SUBROUTINE h5lexists_async_f
!! \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 links name.
!! \param corder Specifies the links creation order position.
!! \param cset Indicates the character set used for link&apos;s name.
!! \param corder Specifies the link&apos;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
Expand Down Expand Up @@ -926,7 +926,7 @@ END SUBROUTINE h5lget_info_f
!! \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 attributes name.
!! \param cset Indicates the character set used for the attribute&apos;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.
Expand Down
2 changes: 1 addition & 1 deletion fortran/src/H5Of.c
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ h5olink_c(hid_t_f *object_id, hid_t_f *new_loc_id, _fcd name, size_t_f *namelen,
* Calls H5open_by_token
* INPUTS
* loc_id - File or group identifier
* token - Objects token in the file
* token - Object's token in the file
*
* OUTPUTS
* obj_id - Object identifier
Expand Down
2 changes: 1 addition & 1 deletion fortran/src/H5Off.F90
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ END SUBROUTINE h5oclose_async_f
!! \brief Opens an object using its token within an HDF5 file.
!!
!! \param loc_id File or group identifier.
!! \param token Objects token in the file.
!! \param token Object&apos;s token in the file.
!! \param obj_id Object identifier for the opened object.
!! \param hdferr \fortran_error
!!
Expand Down
2 changes: 1 addition & 1 deletion fortran/src/H5Pff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -5775,7 +5775,7 @@ END SUBROUTINE h5pget_virtual_printf_gap_f
!! 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 datasets dataspace identifier with a selection applied, possibly an unlimited selection.
!! \param src_space_id The source dataset&apos;s dataspace identifier with a selection applied, possibly an unlimited selection.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Pset_virtual()
Expand Down
2 changes: 1 addition & 1 deletion fortran/src/H5Tff.F90
Original file line number Diff line number Diff line change
Expand Up @@ -1945,7 +1945,7 @@ END SUBROUTINE h5tget_create_plist_f
!>
!! \ingroup FH5T
!!
!! \brief Check whether the librarys default conversion is hard conversion.
!! \brief Check whether the library&apos;s default conversion is hard conversion.
!!
!! \param src_id Identifier for the source datatype.
!! \param dst_id Identifier for the destination datatype.
Expand Down
Loading