[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

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.