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/H5Gpublic.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/H5Gpublic.h')
-rw-r--r-- | src/H5Gpublic.h | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h index b8b0421..4110cb7 100644 --- a/src/H5Gpublic.h +++ b/src/H5Gpublic.h @@ -15,6 +15,26 @@ * * Use the functions in this module to manage HDF5 groups. * + * <table> + * <tr><th>Create</th><th>Read</th></tr> + * <tr valign="top"> + * <td> + * \snippet{lineno} H5G_examples.c create + * </td> + * <td> + * \snippet{lineno} H5G_examples.c read + * </td> + * <tr><th>Update</th><th>Delete</th></tr> + * <tr valign="top"> + * <td> + * \snippet{lineno} H5G_examples.c update + * </td> + * <td> + * \snippet{lineno} H5G_examples.c delete + * </td> + * </tr> + * </table> + * * \details \Bold{Groups in HDF5:} A group associates names with objects and * provides a mechanism for mapping a name to an object. Since all * objects appear in at least one group (with the possible exception of @@ -1131,7 +1151,7 @@ H5_DLL herr_t H5Gget_objinfo(hid_t loc_id, const char *name, hbool_t follow_link * actual object name length, the object name is truncated to * \Code{max_size - 1} characters. * - * Note that if the size of the object's name is unkown, a preliminary + * Note that if the size of the object's name is unknown, a preliminary * call to H5Gget_objname_by_idx() with \p name set to \c NULL will * return the length of the object's name. A second call to * H5Gget_objname_by_idx() can then be used to retrieve the actual |