summaryrefslogtreecommitdiffstats
path: root/src/H5module.h
diff options
context:
space:
mode:
authorvchoi-hdfgroup <55293060+vchoi-hdfgroup@users.noreply.github.com>2022-01-04 23:23:33 (GMT)
committerGitHub <noreply@github.com>2022-01-04 23:23:33 (GMT)
commitd8ef511b2afac659b7aed3490fedc963b70785d8 (patch)
treedbd1d5bfc413ad6b49d9ca2179d369a64e6e9df0 /src/H5module.h
parent5d453a6055b994978a3795ee2873bc4170bc576c (diff)
parenta30ca5afcd9f2e35b3a37f74286a6fe264b946f2 (diff)
downloadhdf5-d8ef511b2afac659b7aed3490fedc963b70785d8.zip
hdf5-d8ef511b2afac659b7aed3490fedc963b70785d8.tar.gz
hdf5-d8ef511b2afac659b7aed3490fedc963b70785d8.tar.bz2
Merge pull request #49 from vchoi-hdfgroup/feature/vfd_swmr
Feature/vfd swmr
Diffstat (limited to 'src/H5module.h')
-rw-r--r--src/H5module.h27
1 files changed, 25 insertions, 2 deletions
diff --git a/src/H5module.h b/src/H5module.h
index 64081bf..6d3cba8 100644
--- a/src/H5module.h
+++ b/src/H5module.h
@@ -27,8 +27,31 @@
#define H5_MY_PKG_INIT YES
/**\defgroup H5 H5
- * \brief General Library Functions
- * \todo Describe concisely what the functions in this module are about.
+ *
+ * Use the functions in this module to manage the life cycle of HDF5 library
+ * instances.
+ *
+ * <table>
+ * <tr><th>Create</th><th>Read</th></tr>
+ * <tr valign="top">
+ * <td>
+ * \snippet{lineno} H5_examples.c create
+ * </td>
+ * <td>
+ * \snippet{lineno} H5_examples.c read
+ * </td>
+ * <tr><th>Update</th><th>Delete</th></tr>
+ * <tr valign="top">
+ * <td>
+ * \snippet{lineno} H5_examples.c update
+ * </td>
+ * <td>
+ * \snippet{lineno} H5_examples.c closing_shop
+ * \snippet{lineno} H5_examples.c delete
+ * </td>
+ * </tr>
+ * </table>
+ *
*/
#endif /* H5module_H */