summaryrefslogtreecommitdiffstats
path: root/doxygen/aliases
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2023-06-05 23:22:10 (GMT)
committerGitHub <noreply@github.com>2023-06-05 23:22:10 (GMT)
commitcd18732c2ee6e06384d5dfb033f9a9dc1c60ab0d (patch)
tree62b93d13cd3fcd8e60a9b9ad736dde00894a1522 /doxygen/aliases
parent6787a5bbef0e69aacadc9182f773ffc8a6d12127 (diff)
downloadhdf5-cd18732c2ee6e06384d5dfb033f9a9dc1c60ab0d.zip
hdf5-cd18732c2ee6e06384d5dfb033f9a9dc1c60ab0d.tar.gz
hdf5-cd18732c2ee6e06384d5dfb033f9a9dc1c60ab0d.tar.bz2
Remove most unused options which are defaulted #2998 (#3046)
* Remove most unused options which are defaulted #2998 * Correct doxygen predefined list * Correct doxygen list of predefineds
Diffstat (limited to 'doxygen/aliases')
-rw-r--r--doxygen/aliases4
1 files changed, 2 insertions, 2 deletions
diff --git a/doxygen/aliases b/doxygen/aliases
index dc79623..8e447d1 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. "
@@ -74,7 +74,7 @@ ALIASES += space_id="\param[in] space_id Dataspace identifier"
ALIASES += space_id{1}="\param[in] \1 Dataspace identifier"
################################################################################
-# Dataypes
+# Datatypes
################################################################################
ALIASES += type_id="\param[in] type_id Datatype identifier"