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/H5Rmodule.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/H5Rmodule.h')
| -rw-r--r-- | src/H5Rmodule.h | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/src/H5Rmodule.h b/src/H5Rmodule.h index 2a34d56..fe28bb2 100644 --- a/src/H5Rmodule.h +++ b/src/H5Rmodule.h @@ -27,9 +27,32 @@ /** * \defgroup H5R H5R - * \brief Reference Interface - * \details The HDF5 Reference Interface, H5R, provides a mechanism for managing - * HDF5 referenced objects. + * + * Use the functions in this module to manage HDF5 references. Referents can + * be HDF5 objects, attributes, and selections on datasets a.k.a. dataset + * regions. + * + * + * <table> + * <tr><th>Create</th><th>Read</th></tr> + * <tr valign="top"> + * <td> + * \snippet{lineno} H5R_examples.c create + * </td> + * <td> + * \snippet{lineno} H5R_examples.c read + * </td> + * <tr><th>Update</th><th>Delete</th></tr> + * <tr valign="top"> + * <td> + * \snippet{lineno} H5R_examples.c update + * </td> + * <td> + * \snippet{lineno} H5R_examples.c delete + * </td> + * </tr> + * </table> + * */ #endif /* H5Rmodule_H */ |