diff options
| author | Scot Breitenfeld <brtnfld@hdfgroup.org> | 2023-03-13 16:53:08 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-13 16:53:08 (GMT) |
| commit | d2345e9f0cb2ca6a8b6268116eed35647cfebf61 (patch) | |
| tree | 2e1ba965f1e461dd057f58f5a9f470553b816baf /doxygen | |
| parent | befbbd0b6d508f18af493b7138ca85b117976db6 (diff) | |
| download | hdf5-d2345e9f0cb2ca6a8b6268116eed35647cfebf61.zip hdf5-d2345e9f0cb2ca6a8b6268116eed35647cfebf61.tar.gz hdf5-d2345e9f0cb2ca6a8b6268116eed35647cfebf61.tar.bz2 | |
Addressed various Doxygen grammar issues. (#2524)
* reviewed H5A
* Addressed various grammar issues.
* remove double words, spelling fixes
* replace the use of rawdata with raw data
Diffstat (limited to 'doxygen')
| -rw-r--r-- | doxygen/aliases | 2 | ||||
| -rw-r--r-- | doxygen/examples/H5Pget_metadata_read_attempts.2.c | 4 | ||||
| -rw-r--r-- | doxygen/examples/H5Pget_metadata_read_attempts.3.c | 4 | ||||
| -rw-r--r-- | doxygen/examples/H5Pset_metadata_read_attempts.c | 4 |
4 files changed, 7 insertions, 7 deletions
diff --git a/doxygen/aliases b/doxygen/aliases index 3fc7e10..bb31325 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -15,7 +15,7 @@ ALIASES += Code{1}="<tt>\1</tt>" ALIASES += success{1}="\Bold{Success:} \1" ALIASES += failure{1}="\Bold{Failure:} \1" -ALIASES += herr_t="Returns a non-negative value if successful; otherwise returns a negative value." +ALIASES += herr_t="Returns a non-negative value if successful; otherwise, returns a negative value." ALIASES += herr_t_iter="\li Zero causes the iterator to continue, returning zero when the iteration is complete. \li A positive value causes the iterator to immediately return that positive value, indicating short-circuit success. \li A negative value causes the iterator to immediately return that value, indicating failure." ALIASES += hid_t{1}="Returns a \1 identifier if successful; otherwise returns #H5I_INVALID_HID. " ALIASES += hid_ti{1}="Returns an \1 identifier if successful; otherwise returns #H5I_INVALID_HID. " diff --git a/doxygen/examples/H5Pget_metadata_read_attempts.2.c b/doxygen/examples/H5Pget_metadata_read_attempts.2.c index 2cd12db..44b26e9 100644 --- a/doxygen/examples/H5Pget_metadata_read_attempts.2.c +++ b/doxygen/examples/H5Pget_metadata_read_attempts.2.c @@ -1,7 +1,7 @@ /* Open the file with SWMR access and default file access property list */ fid = H5Fopen(FILE, (H5F_ACC_RDONLY | H5F_ACC_SWMR_READ), H5P_DEFAULT); -/* Get the file's file access roperty list */ +/* Get the file's file access property list */ file_fapl = H5Fget_access_plist(fid); /* Retrieve the # of read attempts from the file's file access property list */ @@ -26,7 +26,7 @@ H5Pset_metadata_read_attempts(fapl, 20); /* Open the file with SWMR access and the non-default file access property list */ fid = H5Fopen(FILE, (H5F_ACC_RDONLY | H5F_ACC_SWMR_READ), fapl); -/* Get the file's file access roperty list */ +/* Get the file's file access property list */ file_fapl = H5Fget_access_plist(fid); /* Retrieve the # of read attempts from the file's file access property list */ diff --git a/doxygen/examples/H5Pget_metadata_read_attempts.3.c b/doxygen/examples/H5Pget_metadata_read_attempts.3.c index 4b5ea3a..8edda9f 100644 --- a/doxygen/examples/H5Pget_metadata_read_attempts.3.c +++ b/doxygen/examples/H5Pget_metadata_read_attempts.3.c @@ -1,7 +1,7 @@ /* Open the file with non-SWMR access and default file access property list */ fid = H5Fopen(FILE, H5F_ACC_RDONLY, H5P_DEFAULT); -/* Get the file's file access roperty list */ +/* Get the file's file access property list */ file_fapl = H5Fget_access_plist(fid); /* Retrieve the # of read attempts from the file's file access property list */ @@ -26,7 +26,7 @@ H5Pset_metadata_read_attempts(fapl, 20); /* Open the file with non-SWMR access and the non-default file access property list */ fid = H5Fopen(FILE, H5F_ACC_RDONLY, fapl); -/* Get the file's file access roperty list */ +/* Get the file's file access property list */ file_fapl = H5Fget_access_plist(fid); /* Retrieve the # of read attempts from the file's file access property list */ diff --git a/doxygen/examples/H5Pset_metadata_read_attempts.c b/doxygen/examples/H5Pset_metadata_read_attempts.c index 7c2f65d..db3573b 100644 --- a/doxygen/examples/H5Pset_metadata_read_attempts.c +++ b/doxygen/examples/H5Pset_metadata_read_attempts.c @@ -8,7 +8,7 @@ H5Pset_metadata_read_attempts(fapl, 20); /* Open the file with SWMR access and the non-default file access property list */ fid = H5Fopen(FILE, (H5F_ACC_RDONLY | H5F_ACC_SWMR_READ), fapl); -/* Get the file's file access roperty list */ +/* Get the file's file access property list */ file_fapl = H5Fget_access_plist(fid); /* Retrieve the # of read attempts from the file's file access property list */ @@ -38,7 +38,7 @@ H5Pset_metadata_read_attempts(fapl, 20); /* Open the file with SWMR access and the non-default file access property list */ fid = H5Fopen(FILE, H5F_ACC_RDONLY, fapl); -/* Get the file's file access roperty list */ +/* Get the file's file access property list */ file_fapl = H5Fget_access_plist(fid); /* Retrieve the # of read attempts from the file's file access property list */ |