diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2013-10-15 05:31:20 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2013-10-15 05:31:20 (GMT) |
| commit | 370e6f3f56bafa13c19eaa292a16929a8b918120 (patch) | |
| tree | ed45d5ac11273900605e3f7fb8457acef5932cca /c++/src/H5Attribute.h | |
| parent | 82beeef27243f1bcbbeb45631bc4ba6c510b6c92 (diff) | |
| download | hdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.zip hdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.tar.gz hdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.tar.bz2 | |
[svn-r24291] Description:
- Added a lot of documentation to classes for Reference Manual.
- Fixed some format inconsistencies
Platforms tested:
Linux/ppc64 (ostrich)
Linux/32 2.6 (jam)
Linux/64 2.6 (koala)/PGI compilers
Diffstat (limited to 'c++/src/H5Attribute.h')
| -rw-r--r-- | c++/src/H5Attribute.h | 10 |
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 |