1.8 Merge doxygen changes from develop (#1545)

* Merge doxygen changes from develop

* revert macro code change

* Format correction

1 files changed, 44 insertions, 16 deletions

diff --git a/src/H5Epublic.h b/src/H5Epublic.h
index f95261a..9ec9d32 100644
--- a/src/H5Epublic.h
+++ b/src/H5Epublic.h
@@ -16,6 +16,26 @@
  * Use the functions in this module to manage HDF5 error stacks and error
  * messages.
  *
+ * <table>
+ * <tr><th>Create</th><th>Read</th></tr>
+ * <tr valign="top">
+ *   <td>
+ *   \snippet{lineno} H5E_examples.c create
+ *   </td>
+ *   <td>
+ *   \snippet{lineno} H5E_examples.c read
+ *   </td>
+ * <tr><th>Update</th><th>Delete</th></tr>
+ * <tr valign="top">
+ *   <td>
+ *   \snippet{lineno} H5E_examples.c update
+ *   </td>
+ *   <td>
+ *   \snippet{lineno} H5E_examples.c delete
+ *   </td>
+ * </tr>
+ * </table>
+ *
  * \internal The \c FUNC_ENTER macro clears the error stack whenever an
  *           interface function is entered. When an error is detected, an entry
  *           is pushed onto the stack. As the functions unwind, additional
@@ -68,9 +88,9 @@ typedef struct H5E_error2_t {
     hid_t cls_id;
     /**< Class ID                           */
     hid_t maj_num;
-    /**< Major error ID		                */
+    /**< Major error ID                        */
     hid_t min_num;
-    /**< Minor error number		            */
+    /**< Minor error number                    */
     unsigned line;
     /**< Line in file where error occurs    */
     const char *func_name;
@@ -726,12 +746,13 @@ typedef herr_t (*H5E_auto1_t)(void *client_data);
  *
  * \return \herr_t
  *
+ * \deprecated 1.8.0 Function H5Eclear() renamed to H5Eclear1() and deprecated
+ *                   in this release.
+ *
  * \details H5Eclear1() clears the error stack for the current thread.\n
  *          The stack is also cleared whenever an API function is called, with
  *          certain exceptions (for instance, H5Eprint1()).
  *
- * \deprecated 1.8.0 Function H5Eclear() renamed to H5Eclear1() and deprecated
- *                   in this release.
  */
 H5_DLL herr_t H5Eclear1(void);
 /**
@@ -747,6 +768,9 @@ H5_DLL herr_t H5Eclear1(void);
  *                         function
  * \return \herr_t
  *
+ * \deprecated 1.8.0 Function H5Eget_auto() renamed to H5Eget_auto1() and
+ *                   deprecated in this release.
+ *
  * \details H5Eget_auto1() returns the current settings for the automatic error
  *          stack traversal function, \p func, and its data,
  *          \p client_data. Either or both arguments may be \c NULL, in which case the
@@ -773,8 +797,6 @@ H5_DLL herr_t H5Eclear1(void);
  *          H5Eprint2(), mixing H5Eset_auto1() and H5Eget_auto2() or mixing
  *          H5Eset_auto2() and H5Eget_auto1() does not fail.
  *
- * \deprecated 1.8.0 Function H5Eget_auto() renamed to H5Eget_auto1() and
- *                   deprecated in this release.
  */
 H5_DLL herr_t H5Eget_auto1(H5E_auto1_t *func, void **client_data);
 /**
@@ -791,6 +813,9 @@ H5_DLL herr_t H5Eget_auto1(H5E_auto1_t *func, void **client_data);
  * \param[in] str Error description string
  * \return \herr_t
  *
+ * \deprecated 1.8.0 Function H5Epush() renamed to H5Epush1() and
+ *                   deprecated in this release.
+ *
  * \details H5Epush1() pushes a new error record onto the error stack for the
  *          current thread.\n
  *          The error has major and minor numbers \p maj_num
@@ -801,8 +826,6 @@ H5_DLL herr_t H5Eget_auto1(H5E_auto1_t *func, void **client_data);
  *          allocated.
  *
  * \since 1.4.0
- * \deprecated 1.8.0 Function H5Epush() renamed to H5Epush1() and
- *                   deprecated in this release.
  */
 H5_DLL herr_t H5Epush1(const char *file, const char *func, unsigned line, H5E_major_t maj, H5E_minor_t min,
                        const char *str);
@@ -815,6 +838,9 @@ H5_DLL herr_t H5Epush1(const char *file, const char *func, unsigned line, H5E_ma
  * \param[in] stream File pointer, or \c NULL for \c stderr
  * \return \herr_t
  *
+ * \deprecated 1.8.0 Function H5Eprint() renamed to H5Eprint1() and
+ *                   deprecated in this release.
+ *
  * \details H5Eprint1() prints prints the error stack for the current thread
  *          on the specified stream, \p stream. Even if the error stack is empty, a
  *          one-line message of the following form will be printed:
@@ -825,8 +851,6 @@ H5_DLL herr_t H5Epush1(const char *file, const char *func, unsigned line, H5E_ma
  *          that prints error messages. Users are encouraged to write their own
  *          more specific error handlers.
  *
- * \deprecated 1.8.0 Function H5Eprint() renamed to H5Eprint1() and
- *                   deprecated in this release.
  */
 H5_DLL herr_t H5Eprint1(FILE *stream);
 /**
@@ -839,6 +863,9 @@ H5_DLL herr_t H5Eprint1(FILE *stream);
  * \param[in] client_data Data passed to the error function
  * \return \herr_t
  *
+ * \deprecated 1.8.0 Function H5Eset_auto() renamed to H5Eset_auto1() and
+ *                   deprecated in this release.
+ *
  * \details H5Eset_auto1() turns on or off automatic printing of errors. When
  *          turned on (non-null \p func pointer), any API function which returns
  *          an error indication will first call \p func, passing it \p
@@ -855,8 +882,6 @@ H5_DLL herr_t H5Eprint1(FILE *stream);
  *          Automatic stack traversal is always in the #H5E_WALK_DOWNWARD
  *          direction.
  *
- * \deprecated 1.8.0 Function H5Eset_auto() renamed to H5Eset_auto1() and
- *                   deprecated in this release.
  */
 H5_DLL herr_t H5Eset_auto1(H5E_auto1_t func, void *client_data);
 /**
@@ -870,6 +895,9 @@ H5_DLL herr_t H5Eset_auto1(H5E_auto1_t func, void *client_data);
  * \param[in] client_data Data to be passed to \p func
  * \return \herr_t
  *
+ * \deprecated 1.8.0 Function H5Ewalk() renamed to H5Ewalk1() and
+ *                   deprecated in this release.
+ *
  * \details H5Ewalk1() walks the error stack for the current thread and calls
  *          the function specified in \p func for each error along the way.
  *
@@ -887,8 +915,6 @@ H5_DLL herr_t H5Eset_auto1(H5E_auto1_t func, void *client_data);
  *          is as follows:
  *          \snippet this H5E_walk1_t_snip
  *
- * \deprecated 1.8.0 Function H5Ewalk() renamed to H5Ewalk1() and
- *                   deprecated in this release.
  */
 H5_DLL herr_t H5Ewalk1(H5E_direction_t direction, H5E_walk1_t func, void *client_data);
 /**
@@ -901,6 +927,8 @@ H5_DLL herr_t H5Ewalk1(H5E_direction_t direction, H5E_walk1_t func, void *client
  * \param[in] maj Major error number
  * \return \herr_t
  *
+ * \deprecated 1.8.0 Function deprecated in this release.
+ *
  * \details Given a major error number, H5Eget_major() returns a constant
  *          character string that describes the error.
  *
@@ -908,7 +936,6 @@ H5_DLL herr_t H5Ewalk1(H5E_direction_t direction, H5E_walk1_t func, void *client
  *            array). An application calling this function must free the memory
  *            associated with the return value to prevent a memory leak.
  *
- * \deprecated 1.8.0 Function deprecated in this release.
  */
 H5_DLL char *H5Eget_major(H5E_major_t maj);
 /**
@@ -921,6 +948,8 @@ H5_DLL char *H5Eget_major(H5E_major_t maj);
  * \param[in] min Minor error number
  * \return \herr_t
  *
+ * \deprecated 1.8.0 Function deprecated and return type changed in this release.
+ *
  * \details Given a minor error number, H5Eget_minor() returns a constant
  *          character string that describes the error.
  *
@@ -930,7 +959,6 @@ H5_DLL char *H5Eget_major(H5E_major_t maj);
  *            the memory associated with the return value to prevent a memory
  *            leak. This is a change from the 1.6.x release series.
  *
- * \deprecated 1.8.0 Function deprecated and return type changed in this release.
  */
 H5_DLL char *H5Eget_minor(H5E_minor_t min);
 #endif /* H5_NO_DEPRECATED_SYMBOLS */