diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2021-09-07 21:08:41 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-07 21:08:41 (GMT) |
| commit | d0507c23f30fc1ff66ae4a31d41f681612e51851 (patch) | |
| tree | 18032d7c438334900adf45d22659b70cee072215 /src/H5module.h | |
| parent | f5709db18e10993de3bc4668ad07b66d14279877 (diff) | |
| download | hdf5-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/H5module.h')
| -rw-r--r-- | src/H5module.h | 33 |
1 files changed, 28 insertions, 5 deletions
diff --git a/src/H5module.h b/src/H5module.h index 64081bf..f7d3cd6 100644 --- a/src/H5module.h +++ b/src/H5module.h @@ -11,9 +11,9 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* - * Purpose: This file contains declarations which define macros for the - * H5 package. Including this header means that the source file - * is part of the H5 package. + * Purpose: This file contains declarations which define macros for the + * H5 package. Including this header means that the source file + * is part of the H5 package. */ #ifndef H5module_H #define 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 */ |