summaryrefslogtreecommitdiffstats
path: root/src/H5Fmodule.h
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2021-09-07 21:08:41 (GMT)
committerGitHub <noreply@github.com>2021-09-07 21:08:41 (GMT)
commitd0507c23f30fc1ff66ae4a31d41f681612e51851 (patch)
tree18032d7c438334900adf45d22659b70cee072215 /src/H5Fmodule.h
parentf5709db18e10993de3bc4668ad07b66d14279877 (diff)
downloadhdf5-d0507c23f30fc1ff66ae4a31d41f681612e51851.zip
hdf5-d0507c23f30fc1ff66ae4a31d41f681612e51851.tar.gz
hdf5-d0507c23f30fc1ff66ae4a31d41f681612e51851.tar.bz2
1.12 Merge A batch of life-cycle examples for different modules #654 (#987)
* Merge A batch of life-cycle examples for different modules #654 * Remove generated file * Change doxygen generated file location
Diffstat (limited to 'src/H5Fmodule.h')
-rw-r--r--src/H5Fmodule.h19
1 files changed, 13 insertions, 6 deletions
diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h
index 7f0299a..81c1ede 100644
--- a/src/H5Fmodule.h
+++ b/src/H5Fmodule.h
@@ -29,8 +29,7 @@
#define H5_MY_PKG_ERR H5E_FILE
#define H5_MY_PKG_INIT YES
-/**
- * \defgroup H5F H5F
+/**\defgroup H5F H5F
*
* Use the functions in this module to manage HDF5 files.
*
@@ -41,15 +40,23 @@
* creation or access \c mode control the interaction with the underlying
* storage such as file systems.
*
- * \Emph{Proper error handling is part of the life cycle.}
* <table>
- * <tr><th>Create</th><th>Open</th></tr>
+ * <tr><th>Create</th><th>Read</th></tr>
* <tr valign="top">
* <td>
- * \snippet H5F_examples.c life_cycle
+ * \snippet{lineno} H5F_examples.c create
* </td>
* <td>
- * \snippet H5F_examples.c life_cycle_w_open
+ * \snippet{lineno} H5F_examples.c read
+ * </td>
+ * </tr>
+ * <tr><th>Update</th><th>Delete</th></tr>
+ * <tr valign="top">
+ * <td>
+ * \snippet{lineno} H5F_examples.c update
+ * </td>
+ * <td>
+ * \snippet{lineno} H5F_examples.c delete
* </td>
* </tr>
* </table>