diff options
Diffstat (limited to 'src/H5Amodule.h')
| -rw-r--r-- | src/H5Amodule.h | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/src/H5Amodule.h b/src/H5Amodule.h index eb3a133..c89c93f 100644 --- a/src/H5Amodule.h +++ b/src/H5Amodule.h @@ -29,4 +29,41 @@ #define H5_MY_PKG_ERR H5E_ATTR #define H5_MY_PKG_INIT YES +/**\defgroup H5A H5A + * + * Use the functions in this module to manage HDF5 attributes. + * + * The Attribute Interface, H5A, provides a mechanism for attaching additional + * information to a dataset, group, or named datatype. + * + * Attributes are accessed by opening the object that they are attached to and + * are not independent objects. Typically an attribute is small in size and + * contains user metadata about the object that it is attached to. + * + * Attributes look similar to HDF5 datasets in that they have a datatype and + * dataspace. However, they do not support partial I/O operations and cannot be + * compressed or extended. + * + * <table> + * <tr><th>Create</th><th>Read</th></tr> + * <tr valign="top"> + * <td> + * \snippet H5A_examples.c create + * </td> + * <td> + * \snippet H5A_examples.c read + * </td> + * <tr><th>Update</th><th>Delete</th></tr> + * <tr valign="top"> + * <td> + * \snippet H5A_examples.c update + * </td> + * <td> + * \snippet H5A_examples.c delete + * </td> + * </tr> + * </table> + * + */ + #endif /* H5Amodule_H */ |