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, 14 insertions, 19 deletions

diff --git a/src/H5Ipublic.h b/src/H5Ipublic.h
index a5f830b..8d4dbf8 100644
--- a/src/H5Ipublic.h
+++ b/src/H5Ipublic.h
@@ -106,7 +106,7 @@ extern "C" {
 /* Public API functions */
 
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Registers an object under a type and returns an ID for it
  *
@@ -128,7 +128,7 @@ extern "C" {
  */
 H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Returns the object referenced by an ID
  *
@@ -151,7 +151,7 @@ H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object);
  */
 H5_DLL void *H5Iobject_verify(hid_t id, H5I_type_t type);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Removes an ID from its type
  *
@@ -190,12 +190,7 @@ H5_DLL void *H5Iremove_verify(hid_t id, H5I_type_t type);
  * \return Returns the object type if successful; otherwise #H5I_BADID.
  *
  * \details H5Iget_type() retrieves the type of the object identified by
- *          \p id.
- *
- *          Valid types returned by the function are:
- *          \id_types
- *
- *          If no valid type can be determined or the identifier submitted is
+ *          \p id. If no valid type can be determined or the identifier submitted is
  *          invalid, the function returns #H5I_BADID.
  *
  *          This function is of particular use in determining the type of
@@ -391,7 +386,7 @@ H5_DLL int H5Idec_ref(hid_t id);
  */
 H5_DLL int H5Iget_ref(hid_t id);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Creates and returns a new ID type
  *
@@ -423,7 +418,7 @@ H5_DLL int H5Iget_ref(hid_t id);
  */
 H5_DLL H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free_t free_func);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Deletes all identifiers of the given type
  *
@@ -447,7 +442,7 @@ H5_DLL H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free
  */
 H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Removes an identifier type and all identifiers within that type
  *
@@ -470,7 +465,7 @@ H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force);
  */
 H5_DLL herr_t H5Idestroy_type(H5I_type_t type);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Increments the reference count on an ID type
  *
@@ -489,7 +484,7 @@ H5_DLL herr_t H5Idestroy_type(H5I_type_t type);
  */
 H5_DLL int H5Iinc_type_ref(H5I_type_t type);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Decrements the reference count on an identifier type
  *
@@ -509,7 +504,7 @@ H5_DLL int H5Iinc_type_ref(H5I_type_t type);
  */
 H5_DLL int H5Idec_type_ref(H5I_type_t type);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Retrieves the reference count on an ID type
  *
@@ -528,7 +523,7 @@ H5_DLL int H5Idec_type_ref(H5I_type_t type);
  */
 H5_DLL int H5Iget_type_ref(H5I_type_t type);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Finds the memory referred to by an ID within the given ID type such
  *        that some criterion is satisfied
@@ -569,7 +564,7 @@ H5_DLL int H5Iget_type_ref(H5I_type_t type);
  */
 H5_DLL void *H5Isearch(H5I_type_t type, H5I_search_func_t func, void *key);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Calls a callback for each member of the identifier type specified
  *
@@ -598,7 +593,7 @@ H5_DLL void *H5Isearch(H5I_type_t type, H5I_search_func_t func, void *key);
  */
 H5_DLL herr_t H5Iiterate(H5I_type_t type, H5I_iterate_func_t op, void *op_data);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Returns the number of identifiers in a given identifier type
  *
@@ -618,7 +613,7 @@ H5_DLL herr_t H5Iiterate(H5I_type_t type, H5I_iterate_func_t op, void *op_data);
  */
 H5_DLL herr_t H5Inmembers(H5I_type_t type, hsize_t *num_members);
 /**
- * \ingroup H5I
+ * \ingroup H5IUD
  *
  * \brief Determines whether an identifier type is registered
  *