[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, 6 insertions, 4 deletions

diff --git a/c++/src/H5CommonFG.h b/c++/src/H5CommonFG.h
index 1748d1d..2f10e8e 100644
--- a/c++/src/H5CommonFG.h
+++ b/c++/src/H5CommonFG.h
@@ -14,10 +14,6 @@
  * access to either file, you may request a copy from help@hdfgroup.org.     *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
-// CommonFG is a protocol class.  Its existence is simply to provide the
-// common services that are provided by H5File and Group.  The file or
-// group in the context of this class is referred to as 'location'.
-
 #ifndef __CommonFG_H
 #define __CommonFG_H
 
@@ -29,6 +25,12 @@ class Group;
 class H5File;
 class ArrayType;
 class VarLenType;
+
+/*! \class CommonFG
+    \brief \i CommonFG is an abstract base class of H5File and H5Group.
+
+    It provides common operations of H5File and H5Group.
+*/
 class H5_DLLCPP CommonFG {
    public:
 	// Creates a new group at this location which can be a file