diff options
author | Dana Robinson <derobins@hdfgroup.org> | 2021-05-07 17:56:07 (GMT) |
---|---|---|
committer | Dana Robinson <derobins@hdfgroup.org> | 2021-05-07 17:56:07 (GMT) |
commit | 7f58a89578b64df2b040d97294cb1cf2a82bebd3 (patch) | |
tree | de9971f9f1537a23e2ab59fa1ad4c2631164d20e /src/H5Amodule.h | |
parent | 79b92df2a262c09eb7461c5bbd9500209573653b (diff) | |
download | hdf5-7f58a89578b64df2b040d97294cb1cf2a82bebd3.zip hdf5-7f58a89578b64df2b040d97294cb1cf2a82bebd3.tar.gz hdf5-7f58a89578b64df2b040d97294cb1cf2a82bebd3.tar.bz2 |
Misc normalization from develop
Diffstat (limited to 'src/H5Amodule.h')
-rw-r--r-- | src/H5Amodule.h | 40 |
1 files changed, 30 insertions, 10 deletions
diff --git a/src/H5Amodule.h b/src/H5Amodule.h index 45172bf..c89c93f 100644 --- a/src/H5Amodule.h +++ b/src/H5Amodule.h @@ -30,19 +30,39 @@ #define H5_MY_PKG_INIT YES /**\defgroup H5A H5A - * \brief Attribute Interface * - * \details The Attribute Interface, H5A, provides a mechanism for attaching - * additional information to a dataset, group, or named datatype. + * Use the functions in this module to manage HDF5 attributes. * - * 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. + * The Attribute Interface, H5A, provides a mechanism for attaching additional + * information to a dataset, group, or named datatype. * - * 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. + * 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> * */ |