summaryrefslogtreecommitdiffstats
path: root/src/H5Amodule.h
diff options
context:
space:
mode:
authorDana Robinson <derobins@hdfgroup.org>2021-04-06 01:34:37 (GMT)
committerDana Robinson <derobins@hdfgroup.org>2021-04-06 01:34:37 (GMT)
commitf0d1a03aa18843b8260c234cd535978a2145941e (patch)
treef374735b3ad301df210890fa3c2a74c0e0e63d94 /src/H5Amodule.h
parent32e6c3dcae77e67f8649d61ece4be3c203b7f497 (diff)
downloadhdf5-f0d1a03aa18843b8260c234cd535978a2145941e.zip
hdf5-f0d1a03aa18843b8260c234cd535978a2145941e.tar.gz
hdf5-f0d1a03aa18843b8260c234cd535978a2145941e.tar.bz2
Brings the rest of the header changes from develop
Diffstat (limited to 'src/H5Amodule.h')
-rw-r--r--src/H5Amodule.h25
1 files changed, 21 insertions, 4 deletions
diff --git a/src/H5Amodule.h b/src/H5Amodule.h
index 8a745b2..45172bf 100644
--- a/src/H5Amodule.h
+++ b/src/H5Amodule.h
@@ -11,15 +11,15 @@
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
- * Programmer: Quincey Koziol <koziol@hdfgroup.org>
+ * Programmer: Quincey Koziol
* Saturday, September 12, 2015
*
* Purpose: This file contains declarations which define macros for the
* H5A package. Including this header means that the source file
* is part of the H5A package.
*/
-#ifndef _H5Amodule_H
-#define _H5Amodule_H
+#ifndef H5Amodule_H
+#define H5Amodule_H
/* Define the proper control macros for the generic FUNC_ENTER/LEAVE and error
* reporting macros.
@@ -29,4 +29,21 @@
#define H5_MY_PKG_ERR H5E_ATTR
#define H5_MY_PKG_INIT YES
-#endif /* _H5Amodule_H */
+/**\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 */