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/H5AtomType.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/H5AtomType.h')
-rw-r--r-- | c++/src/H5AtomType.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/c++/src/H5AtomType.h b/c++/src/H5AtomType.h index e8d6513..792312a 100644 --- a/c++/src/H5AtomType.h +++ b/c++/src/H5AtomType.h @@ -14,11 +14,6 @@ * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -// Class AtomType is a base class, from which IntType, FloatType, StrType, -// and PredType inherit. It provides the services that are common to these -// subclasses. It also inherits from DataType and passes down the -// services that are common to all the datatypes. - #ifndef __H5AtomType_H #define __H5AtomType_H @@ -26,6 +21,13 @@ namespace H5 { #endif +/*! \class AtomType + \brief AtomType is a base class, inherited by IntType, FloatType, + StrType, and PredType. + + AtomType provides operations on HDF5 atomic datatypes. It also inherits + from DataType. +*/ class H5_DLLCPP AtomType : public DataType { public: // Returns the byte order of an atomic datatype. |