diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2023-03-23 00:37:04 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-23 00:37:04 (GMT) |
| commit | 7b4387df4322c3a953f5747c3ffbf907875ca815 (patch) | |
| tree | a2f3147456059ebb06b3fbe9675c5fc83b87863a /doxygen | |
| parent | 98728706dd800e365cee6f601873b515e5f8822c (diff) | |
| download | hdf5-7b4387df4322c3a953f5747c3ffbf907875ca815.zip hdf5-7b4387df4322c3a953f5747c3ffbf907875ca815.tar.gz hdf5-7b4387df4322c3a953f5747c3ffbf907875ca815.tar.bz2 | |
Merge CMake cleanup process from develop (#2622)
* Merge CMake cleanup process from develop
* Update test script files
Diffstat (limited to 'doxygen')
| -rw-r--r-- | doxygen/aliases | 2 | ||||
| -rw-r--r-- | doxygen/dox/ReferenceManual.dox | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/doxygen/aliases b/doxygen/aliases index 38a5a40..60d037d 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/dox/ReferenceManual.dox b/doxygen/dox/ReferenceManual.dox index 135e7e6..5b46a19 100644 --- a/doxygen/dox/ReferenceManual.dox +++ b/doxygen/dox/ReferenceManual.dox @@ -150,7 +150,7 @@ Follow these simple rules and stay out of trouble: \li \Bold{Dynamic memory allocation:} The API contains a few functions in which the HDF5 library dynamically allocates memory on the caller's behalf. The caller owns this memory and eventually must free it by calling H5free_memory() and not language-explicit memory functions. -\li \Bold{Be careful with that saw:} Do not modify the underlying collection when an +\li \Bold{Don't modify while iterating:} Do not modify the underlying collection when an iteration is in progress! \li \Bold{Use of locations:} Certain API functions, typically called \Code{H5***_by_name} use a combination of identifiers and path names to refer to HDF5 objects. |