diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2021-09-07 20:53:01 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-07 20:53:01 (GMT) |
| commit | 46c22bcde2a38cc05e0cd97da8063b36016a9c67 (patch) | |
| tree | a196047d1f243e68f6dc2f0d8f81a3f9ab43c575 /src/H5Lmodule.h | |
| parent | 474adfa3b59146ffbbd655e004d9f896cb7f3020 (diff) | |
| download | hdf5-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/H5Lmodule.h')
| -rw-r--r-- | src/H5Lmodule.h | 27 |
1 files changed, 25 insertions, 2 deletions
diff --git a/src/H5Lmodule.h b/src/H5Lmodule.h index 54b94a4..cffd25c 100644 --- a/src/H5Lmodule.h +++ b/src/H5Lmodule.h @@ -30,11 +30,34 @@ #define H5_MY_PKG_INIT YES /**\defgroup H5L H5L - * \brief Link Interface - * \todo Describe concisely what the functions in this module are about. + * + * Use the functions in this module to manage HDF5 links and link types. + * + * <table> + * <tr><th>Create</th><th>Read</th></tr> + * <tr valign="top"> + * <td> + * \snippet{lineno} H5L_examples.c create + * </td> + * <td> + * \snippet{lineno} H5L_examples.c iter_cb + * \snippet{lineno} H5L_examples.c read + * </td> + * <tr><th>Update</th><th>Delete</th></tr> + * <tr valign="top"> + * <td> + * \snippet{lineno} H5L_examples.c update + * </td> + * <td> + * \snippet{lineno} H5L_examples.c delete + * </td> + * </tr> + * </table> * * \defgroup TRAV Link Traversal * \ingroup H5L + * \defgroup H5LA Advanced Link Functions + * \ingroup H5L */ #endif /* H5Lmodule_H */ |