diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2022-03-31 13:23:35 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-31 13:23:35 (GMT) |
| commit | 9fdf9546541866f989b4f46aad6f6ac975563777 (patch) | |
| tree | e56a66816abf1a6c16c9db2874d25b1c0dbeb3e8 /src/H5Rpublic.h | |
| parent | dcdbeb7124c28f87d96bb9900f3d92e2a07bcd6b (diff) | |
| download | hdf5-9fdf9546541866f989b4f46aad6f6ac975563777.zip hdf5-9fdf9546541866f989b4f46aad6f6ac975563777.tar.gz hdf5-9fdf9546541866f989b4f46aad6f6ac975563777.tar.bz2 | |
1.8 Merge doxygen changes from develop (#1545)
* Merge doxygen changes from develop
* revert macro code change
* Format correction
Diffstat (limited to 'src/H5Rpublic.h')
| -rw-r--r-- | src/H5Rpublic.h | 34 |
1 files changed, 27 insertions, 7 deletions
diff --git a/src/H5Rpublic.h b/src/H5Rpublic.h index 4ba7da1..a84e4e8 100644 --- a/src/H5Rpublic.h +++ b/src/H5Rpublic.h @@ -11,6 +11,12 @@ * help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ +/* + * This file contains public declarations for the H5R module. + */ +#ifndef H5Rpublic_H +#define H5Rpublic_H + /** * \defgroup H5R H5R * @@ -18,14 +24,28 @@ * 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> + * */ -/* - * This file contains public declarations for the H5R module. - */ -#ifndef H5Rpublic_H -#define H5Rpublic_H - /* Public headers needed by this file */ #include "H5public.h" #include "H5Gpublic.h" @@ -62,7 +82,7 @@ typedef enum { H5R_BADTYPE = (-1), /**< Invalid reference type */ H5R_OBJECT, /**< Object reference */ H5R_DATASET_REGION, /**< Dataset Region Reference */ - H5R_MAXTYPE /**< Highest type (Invalid as true type) */ + H5R_MAXTYPE /**< Highest type (invalid) */ } H5R_type_t; //! <!-- [H5R_type_t_snip] --> |