summaryrefslogtreecommitdiffstats
path: root/src/H5Epublic.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/H5Epublic.h')
-rw-r--r--src/H5Epublic.h15
1 files changed, 8 insertions, 7 deletions
diff --git a/src/H5Epublic.h b/src/H5Epublic.h
index a22c9c6..0d5993e 100644
--- a/src/H5Epublic.h
+++ b/src/H5Epublic.h
@@ -250,12 +250,12 @@ H5_DLL herr_t H5Eclose_msg(hid_t err_id);
* --------------------------------------------------------------------------
* \ingroup H5E
*
- * \brief Adds a major error message to an error class
+ * \brief Adds a major or minor error message to an error class
*
* \param[in] cls An error class identifier
* \param[in] msg_type The type of the error message
- * \param[in] msg Major error message
- * \return \herr_t
+ * \param[in] msg Error message
+ * \return An error ID (success), H5I_INVALID_HID (failure)
*
* \details H5Ecreate_msg() adds an error message to an error class defined by
* client library or application program. The error message can be
@@ -625,7 +625,7 @@ H5_DLL herr_t H5Eauto_is_v2(hid_t err_stack, unsigned *is_stack);
* \brief Retrieves an error message
*
* \param[in] msg_id Error message identifier
- * \param[out] type The type of the error message Valid values are #H5E_MAJOR
+ * \param[out] type The type of the error message. Valid values are #H5E_MAJOR
* and #H5E_MINOR.
* \param[out] msg Error message buffer
* \param[in] size The length of error message to be returned by this function
@@ -651,7 +651,8 @@ H5_DLL ssize_t H5Eget_msg(hid_t msg_id, H5E_type_t *type, char *msg, size_t size
* \brief Retrieves the number of error messages in an error stack
*
* \estack_id{error_stack_id}
- * \return Returns a non-negative value on success; otherwise returns a negative value.
+ * \return Returns number of error messages in an error stack on
+ * success; otherwise returns a negative value.
*
* \details H5Eget_num() retrieves the number of error records in the error
* stack specified by \p error_stack_id (including major, minor
@@ -916,7 +917,7 @@ H5_DLL herr_t H5Ewalk1(H5E_direction_t direction, H5E_walk1_t func, void *client
* error number
*
* \param[in] maj Major error number
- * \return \herr_t
+ * \return Pointer to the message (success), or NULL (failure)
*
* \deprecated 1.8.0 Function deprecated in this release.
*
@@ -939,7 +940,7 @@ H5_DLL char *H5Eget_major(H5E_major_t maj);
* error number
*
* \param[in] min Minor error number
- * \return \herr_t
+ * \return Pointer to the message (success), or NULL (failure)
*
* \deprecated 1.8.0 Function deprecated and return type changed in this release.
*