summaryrefslogtreecommitdiffstats
path: root/src/H5Gmodule.h
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2021-09-07 20:53:01 (GMT)
committerGitHub <noreply@github.com>2021-09-07 20:53:01 (GMT)
commit46c22bcde2a38cc05e0cd97da8063b36016a9c67 (patch)
treea196047d1f243e68f6dc2f0d8f81a3f9ab43c575 /src/H5Gmodule.h
parent474adfa3b59146ffbbd655e004d9f896cb7f3020 (diff)
downloadhdf5-46c22bcde2a38cc05e0cd97da8063b36016a9c67.zip
hdf5-46c22bcde2a38cc05e0cd97da8063b36016a9c67.tar.gz
hdf5-46c22bcde2a38cc05e0cd97da8063b36016a9c67.tar.bz2
1.10 Merge A batch of life-cycle examples for different modules #654 (#988)
* Merge A batch of life-cycle examples for different modules #654 * Change doxygen generated file location
Diffstat (limited to 'src/H5Gmodule.h')
-rw-r--r--src/H5Gmodule.h25
1 files changed, 23 insertions, 2 deletions
diff --git a/src/H5Gmodule.h b/src/H5Gmodule.h
index fe26bd2..a0e121d 100644
--- a/src/H5Gmodule.h
+++ b/src/H5Gmodule.h
@@ -29,8 +29,29 @@
#define H5_MY_PKG_ERR H5E_SYM
#define H5_MY_PKG_INIT YES
-/**
- * \defgroup H5G H5G
+/** \defgroup H5G H5G
+ *
+ * Use the functions in this module to manage HDF5 groups.
+ *
+ * <table>
+ * <tr><th>Create</th><th>Read</th></tr>
+ * <tr valign="top">
+ * <td>
+ * \snippet{lineno} H5G_examples.c create
+ * </td>
+ * <td>
+ * \snippet{lineno} H5G_examples.c read
+ * </td>
+ * <tr><th>Update</th><th>Delete</th></tr>
+ * <tr valign="top">
+ * <td>
+ * \snippet{lineno} H5G_examples.c update
+ * </td>
+ * <td>
+ * \snippet{lineno} H5G_examples.c delete
+ * </td>
+ * </tr>
+ * </table>
*
* \details \Bold{Groups in HDF5:} A group associates names with objects and
* provides a mechanism for mapping a name to an object. Since all