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/H5Amodule.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/H5Amodule.h')
| -rw-r--r-- | src/H5Amodule.h | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/src/H5Amodule.h b/src/H5Amodule.h index c89c93f..9f86ddd 100644 --- a/src/H5Amodule.h +++ b/src/H5Amodule.h @@ -33,33 +33,29 @@ * * 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. + * Like HDF5 datasets, HDF5 attributes are array variables which have an element + * datatype and a shape (dataspace). However, they perform a different function: + * Attributes decorate other HDF5 objects, and are typically used to + * represent application metadata. Unlike datasets, the HDF5 library does not + * support partial I/O operations for attributes and they cannot be compressed + * or extended. * * <table> * <tr><th>Create</th><th>Read</th></tr> * <tr valign="top"> * <td> - * \snippet H5A_examples.c create + * \snippet{lineno} H5A_examples.c create * </td> * <td> - * \snippet H5A_examples.c read + * \snippet{lineno} H5A_examples.c read * </td> * <tr><th>Update</th><th>Delete</th></tr> * <tr valign="top"> * <td> - * \snippet H5A_examples.c update + * \snippet{lineno} H5A_examples.c update * </td> * <td> - * \snippet H5A_examples.c delete + * \snippet{lineno} H5A_examples.c delete * </td> * </tr> * </table> |