diff options
| author | bljhdf <58825073+bljhdf@users.noreply.github.com> | 2020-11-23 22:17:44 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-23 22:17:44 (GMT) |
| commit | c56464fc36a78167c22b84e4cfef0e0c2aafce80 (patch) | |
| tree | e10abc0a4c439f6723295a3aa7227e3d54b4552c /src/H5Amodule.h | |
| parent | ecbcb4356c2bbdad7ad801f9c61fe695082a6b25 (diff) | |
| download | hdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.zip hdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.tar.gz hdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.tar.bz2 | |
Doxygen - added (mostly) beginner functions (#112)
* Doxygen - added (mostly) beginner functions
* Removed duplicate H5Pset_szip function
Diffstat (limited to 'src/H5Amodule.h')
| -rw-r--r-- | src/H5Amodule.h | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/H5Amodule.h b/src/H5Amodule.h index 707fc54..09e6c4a 100644 --- a/src/H5Amodule.h +++ b/src/H5Amodule.h @@ -29,4 +29,21 @@ #define H5_MY_PKG_ERR H5E_ATTR #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. + * + * 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. + * + */ + #endif /* _H5Amodule_H */ |