summaryrefslogtreecommitdiffstats
path: root/src/H5Amodule.h
diff options
context:
space:
mode:
authorLarry Knox <lrknox@hdfgroup.org>2020-11-26 12:32:33 (GMT)
committerGitHub <noreply@github.com>2020-11-26 12:32:33 (GMT)
commit71a42ab05e4c16f8d2915ddc131ef5892ddf9a24 (patch)
treebbc3807295b9cff2aab1bf57b1d86f7fcccebabc /src/H5Amodule.h
parentb7bfe68968330c3ac39f4d4179498caec1e0ae24 (diff)
downloadhdf5-71a42ab05e4c16f8d2915ddc131ef5892ddf9a24.zip
hdf5-71a42ab05e4c16f8d2915ddc131ef5892ddf9a24.tar.gz
hdf5-71a42ab05e4c16f8d2915ddc131ef5892ddf9a24.tar.bz2
Merge available RM doxygen from develop to hdf5 1 12 (#131)
* Snapshot version 1.12 release 1-3. Update version to 1.12.1-4. * First cut of the H5 public API documentation. (#80) * First cut of the H5 public API documentation. * Added H5Z "bonus track." * Applied Quincey's patch. * Added the missing patches from Quincey's original patch. * H5PL (complete) and basic H5VL API documentation. * Added H5I API docs. * Added H5L API docs. * First installment from Elena's H5T batch. * Second installment of Elena's H5T batch. * Final installment of Elena's H5T batch. * Full set of current H5F documentation. (#105) * First cut of the H5 public API documentation. * Added H5Z "bonus track." * Applied Quincey's patch. * Added the missing patches from Quincey's original patch. * H5PL (complete) and basic H5VL API documentation. * Added H5I API docs. * Added H5L API docs. * First installment from Elena's H5T batch. * Second installment of Elena's H5T batch. * Final installment of Elena's H5T batch. * Migrated documentation for SWMR functions. * Catching up on MDC functions. * Integrated the H5F MDC function documentation. * Added MDC and parallel H5F functions. * Slightly updated main page. * Added doxygen/dox/H5AC_cache_config_t.dox to MANIFEST. * Doxygen - added (mostly) beginner functions (#112) * Doxygen - added (mostly) beginner functions * Removed duplicate H5Pset_szip function * Add src/H5module.h to MANIFEST. Co-authored-by: Gerd Heber <gheber@hdfgroup.org> Co-authored-by: bljhdf <58825073+bljhdf@users.noreply.github.com>
Diffstat (limited to 'src/H5Amodule.h')
-rw-r--r--src/H5Amodule.h17
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 */