summaryrefslogtreecommitdiffstats
path: root/c++/src/H5Attribute.h
diff options
context:
space:
mode:
Diffstat (limited to 'c++/src/H5Attribute.h')
-rw-r--r--c++/src/H5Attribute.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/c++/src/H5Attribute.h b/c++/src/H5Attribute.h
index 2d01205..dbfbbb2 100644
--- a/c++/src/H5Attribute.h
+++ b/c++/src/H5Attribute.h
@@ -21,6 +21,14 @@
namespace H5 {
#endif
+/*! \class Attribute
+ \brief Class Attribute operates on HDF5 attributes.
+
+ An attribute has many characteristics similar to a dataset, thus both
+ Attribute and DataSet are derivatives of AbstractDs. Attribute also
+ inherits from IdComponent because an attribute is an HDF5 component that
+ is identified by an identifier.
+*/
class H5_DLLCPP Attribute : public AbstractDs, public IdComponent {
public:
// Closes this attribute.
@@ -74,8 +82,10 @@ class H5_DLLCPP Attribute : public AbstractDs, public IdComponent {
virtual ~Attribute();
protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Sets the attribute id.
virtual void p_setId(const hid_t new_id);
+#endif // DOXYGEN_SHOULD_SKIP_THIS
private:
hid_t id; // HDF5 attribute id