[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

1 files changed, 19 insertions, 14 deletions

diff --git a/c++/src/H5PredType.h b/c++/src/H5PredType.h
index 65e1c07..c929a70 100644
--- a/c++/src/H5PredType.h
+++ b/c++/src/H5PredType.h
@@ -14,11 +14,6 @@
  * access to either file, you may request a copy from help@hdfgroup.org.     *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
-// PredType holds the definition of all the HDF5 predefined datatypes.
-// These types can only be made copy of, not created by H5Tcreate or
-// closed by H5Tclose.  They are treated as constants.
-/////////////////////////////////////////////////////////////////////
-
 #ifndef __H5PredType_H
 #define __H5PredType_H
 
@@ -36,6 +31,13 @@ namespace H5 {
 #define H5CPP_EXITED	-3  // -3 is less likely to be used elsewhere
 #endif // DOXYGEN_SHOULD_SKIP_THIS
 
+/*! \class PredType
+    \brief Class PredType holds the definition of all the HDF5 predefined
+    datatypes.
+
+    These types can only be made copy of, not created by H5Tcreate or
+    closed by H5Tclose.  They are treated as constants.
+*/
 class H5_DLLCPP PredType : public AtomType {
    public:
 	///\brief Returns this class name.
@@ -228,16 +230,20 @@ class H5_DLLCPP PredType : public AtomType {
 	static const PredType NATIVE_UINT_FAST64;
 #endif /* H5_SIZEOF_UINT_FAST64_T */
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-	// These dummy functions do not inherit from DataType - they'll
-	// throw a DataTypeIException if invoked.
-	void commit( H5File& loc, const H5std_string& name );
-	void commit( H5File& loc, const char* name );
-	void commit( H5Object& loc, const H5std_string& name );
-	void commit( H5Object& loc, const char* name );
+	/*! \brief This dummy function do not inherit from DataType - it will
+	    throw a DataTypeIException if invoked.
+	*/
+	void commit(H5Location& loc, const H5std_string& name );
+	/*! \brief This dummy function do not inherit from DataType - it will
+	    throw a DataTypeIException if invoked.
+	*/
+	void commit(H5Location& loc, const char* name );
+	/*! \brief This dummy function do not inherit from DataType - it will
+	    throw a DataTypeIException if invoked.
+	*/
 	bool committed();
-#endif // DOXYGEN_SHOULD_SKIP_THIS
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
    private:
 	// Added this to work around the atexit/global destructor problem.
 	// It'll help to terminate the library after other PredType instances
@@ -245,7 +251,6 @@ class H5_DLLCPP PredType : public AtomType {
 	static const PredType AtExit;
 
    protected:
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
 	// Default constructor
 	PredType();