diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2013-10-14 22:05:22 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2013-10-14 22:05:22 (GMT) |
| commit | 26713999ba25815466ccc8368322f340c4c45119 (patch) | |
| tree | 2f11b788d7e74cebbfe1ae3dd249d2a2d044ae26 /c++/src/H5DataSet.h | |
| parent | 3cb8591786fccaa5b06dd535aa004dceb3bbcc50 (diff) | |
| download | hdf5-26713999ba25815466ccc8368322f340c4c45119.zip hdf5-26713999ba25815466ccc8368322f340c4c45119.tar.gz hdf5-26713999ba25815466ccc8368322f340c4c45119.tar.bz2 | |
[svn-r24290] 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/H5DataSet.h')
| -rw-r--r-- | c++/src/H5DataSet.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/c++/src/H5DataSet.h b/c++/src/H5DataSet.h index 8fdc47e..c407727 100644 --- a/c++/src/H5DataSet.h +++ b/c++/src/H5DataSet.h @@ -14,8 +14,6 @@ * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -// Class DataSet inherits from AbstractDs and provides accesses to a dataset. - #ifndef __H5DataSet_H #define __H5DataSet_H @@ -23,6 +21,13 @@ namespace H5 { #endif +/*! \class DataSet + \brief Class DataSet operates on HDF5 datasets. + + An datasets has many characteristics similar to an attribute, thus both + Attribute and DataSet are derivatives of AbstractDs. DataSet also + inherits from H5Object because a dataset is an HDF5 object. +*/ class H5_DLLCPP DataSet : public H5Object, public AbstractDs { public: // Close this dataset. |