summaryrefslogtreecommitdiffstats
path: root/c++/src/H5AbstractDs.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2013-10-14 22:05:22 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2013-10-14 22:05:22 (GMT)
commit26713999ba25815466ccc8368322f340c4c45119 (patch)
tree2f11b788d7e74cebbfe1ae3dd249d2a2d044ae26 /c++/src/H5AbstractDs.h
parent3cb8591786fccaa5b06dd535aa004dceb3bbcc50 (diff)
downloadhdf5-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/H5AbstractDs.h')
-rw-r--r--c++/src/H5AbstractDs.h13
1 files changed, 8 insertions, 5 deletions
diff --git a/c++/src/H5AbstractDs.h b/c++/src/H5AbstractDs.h
index e1e78e9..6904d76 100644
--- a/c++/src/H5AbstractDs.h
+++ b/c++/src/H5AbstractDs.h
@@ -14,11 +14,6 @@
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-// Class AbstractDs is an abstract base class, from which Attribute and
-// DataSet inherit. It provides the services that are common to both
-// Attribute and DataSet. It also inherits from H5Object and passes down
-// the services that H5Object provides.
-
#ifndef __AbstractDs_H
#define __AbstractDs_H
@@ -33,6 +28,14 @@ class FloatType;
class IntType;
class StrType;
class VarLenType;
+
+/*! \class AbstractDs
+ \brief AbstractDs is an abstract base class, inherited by Attribute
+ and DataSet.
+
+ It provides a collection of services that are common to both Attribute
+ and DataSet. AbstractDs inherits from H5Object.
+*/
class H5_DLLCPP AbstractDs {
public:
// Gets a copy the datatype of that this abstract dataset uses.