A batch of life-cycle examples for different modules (#654)

* Create a tag file for permalinks.

* Added DOXYGEN_TAG_FILE.

* Added Doxygen life-cycle examples for different modules.

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

1 files changed, 22 insertions, 14 deletions

diff --git a/src/H5Epublic.h b/src/H5Epublic.h
index 0294023..9dfd1fc 100644
--- a/src/H5Epublic.h
+++ b/src/H5Epublic.h
@@ -716,12 +716,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);
 /**
@@ -737,6 +738,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
@@ -763,8 +767,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);
 /**
@@ -781,6 +783,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
@@ -791,8 +796,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);
@@ -805,6 +808,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:
@@ -815,8 +821,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);
 /**
@@ -829,6 +833,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
@@ -845,8 +852,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);
 /**
@@ -860,6 +865,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.
  *
@@ -877,8 +885,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);
 /**
@@ -891,6 +897,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.
  *
@@ -898,7 +906,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);
 /**
@@ -911,6 +918,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.
  *
@@ -920,7 +929,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 */