[svn-r8555] Purpose:

    Add documentation

Description:
    Added doxygen documentation and removed incorrect comments.

Platforms:
    SunOS 5.7 (arabica)
    Linux 2.4 (eirene)
    Windows 2000

Misc. update:

1 files changed, 77 insertions, 50 deletions

diff --git a/c++/src/H5AbstractDs.cpp b/c++/src/H5AbstractDs.cpp
index d677237..108a847 100644
--- a/c++/src/H5AbstractDs.cpp
+++ b/c++/src/H5AbstractDs.cpp
@@ -27,17 +27,35 @@
 namespace H5 {
 #endif
 
-// Default constructor
+//--------------------------------------------------------------------------
+// Function:	AbstractDs default constructor
+///\brief	Default constructor
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 AbstractDs::AbstractDs() : H5Object() {}
 
-// Constructor that takes an id
+//--------------------------------------------------------------------------
+// Function:	AbstractDs default constructor
+///\brief	Creates an AbstractDs instance using an existing id.
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 AbstractDs::AbstractDs( const hid_t ds_id ) : H5Object( ds_id ) {}
 
-// Copy constructor: makes copy of the original object; simply invokes
-// base-class copy constructor.
+//--------------------------------------------------------------------------
+// Function:	AbstractDs copy constructor
+///\brief	Copy constructor: makes a copy of the original AbstractDs object.
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 AbstractDs::AbstractDs( const AbstractDs& original ) : H5Object( original ) {}
 
-// Returns the class of the datatype that is used by this dataset
+//--------------------------------------------------------------------------
+// Function:	AbstractDs::getTypeClass
+///\brief	Returns the class of the datatype that is used by this 
+///		object, which can be a dataset or an attribute.
+///\return      Datatype class identifier
+///\exception	H5::DataTypeIException
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 H5T_class_t AbstractDs::getTypeClass() const
 {
    // Gets the datatype used by this dataset or attribute.
@@ -52,12 +70,18 @@ H5T_class_t AbstractDs::getTypeClass() const
    else
    {
       throw DataTypeIException("AbstractDs::getTypeClass", 
-		"H5Tget_class returns something different than H5T_NO_CLASS");
+		"H5Tget_class returns H5T_NO_CLASS");
    }
 }
 
-// Returns the generic datatype of this abstract dataset which 
-// can be a dataset or an attribute.
+//--------------------------------------------------------------------------
+// Function:	AbstractDs::getDataType
+///\brief	Returns the generic datatype of this abstract dataset, which
+///		can be a dataset or an attribute.
+///\return      DataType instance
+///\exception	H5::DataTypeIException
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 DataType AbstractDs::getDataType() const
 {
    // Gets the id of the datatype used by this dataset or attribute.
@@ -70,79 +94,82 @@ DataType AbstractDs::getDataType() const
    return( datatype );
 }
 
-// Returns the enumeration datatype of this abstract dataset which 
 // can be a dataset or an attribute.
+//--------------------------------------------------------------------------
+// Function:	AbstractDs::getEnumType
+///\brief	Returns the enumeration datatype of this abstract dataset which 
+///		can be a dataset or an attribute.
+///\return      EnumType instance
+///\exception	H5::DataTypeIException
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 EnumType AbstractDs::getEnumType() const
 {
    EnumType enumtype( p_getType());
    return( enumtype );
 }
 
-// Returns the compound datatype of this abstract dataset which 
-// can be a dataset or an attribute.
+//--------------------------------------------------------------------------
+// Function:	AbstractDs::getCompType
+///\brief	Returns the compound datatype of this abstract dataset which 
+///		can be a dataset or an attribute.
+///\return      CompType instance
+///\exception	H5::DataTypeIException
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 CompType AbstractDs::getCompType() const
 {
    CompType comptype( p_getType());
    return( comptype );
 }
 
-// Returns the integer datatype of this abstract dataset which 
-// can be a dataset or an attribute.
+//--------------------------------------------------------------------------
+// Function:	AbstractDs::getIntType
+///\brief	Returns the integer datatype of this abstract dataset which 
+///		can be a dataset or an attribute.
+///\return      IntType instance
+///\exception	H5::DataTypeIException
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 IntType AbstractDs::getIntType() const
 {
    IntType inttype( p_getType());
    return( inttype );
 }
 
-// Returns the floating-point datatype of this abstract dataset which 
-// can be a dataset or an attribute.
+//--------------------------------------------------------------------------
+// Function:	AbstractDs::getFloatType
+///\brief	Returns the floating-point datatype of this abstract dataset,
+///		which can be a dataset or an attribute.
+///\return      FloatType instance
+///\exception	H5::DataTypeIException
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 FloatType AbstractDs::getFloatType() const
 {
    FloatType floatype( p_getType());
    return( floatype );
 }
 
-// Returns the string datatype of this abstract dataset which 
-// can be a dataset or an attribute.
+//--------------------------------------------------------------------------
+// Function:	AbstractDs::getStrType
+///\brief	Returns the string datatype of this abstract dataset which 
+///		can be a dataset or an attribute.
+///\return      StrType instance
+///\exception	H5::DataTypeIException
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 StrType AbstractDs::getStrType() const
 {
    StrType strtype( p_getType());
    return( strtype );
 }
 
-/* This version of getDataType is older style.  New style above doesn't
-use overloading.  Remove it when knowing for sure that the other way
-is prefered
-// Gets the specific datatype of this abstract dataset which can be a 
-// dataset or an attribute.  Several overloaded getDataType's below
-// are for specific sub-datatypes.
-void AbstractDs::getDataType( EnumType& enumtype ) const
-{
-   enumtype.setId( p_getType());
-}
-
-void AbstractDs::getDataType( CompType& comptype ) const
-{
-   comptype.setId( p_getType());
-}
-
-void AbstractDs::getDataType( IntType& inttype ) const
-{
-   inttype.setId( p_getType());
-}
-
-void AbstractDs::getDataType( FloatType& floatype ) const
-{
-   floatype.setId( p_getType());
-}
-
-void AbstractDs::getDataType( StrType& strtype ) const
-{
-   strtype.setId( p_getType());
-}
-end of old style of getDataType */
-
-// Default destructor
+//--------------------------------------------------------------------------
+// Function:	StrType destructor
+///\brief	Default destructor
+// Programmer	Binh-Minh Ribler - 2000
+//--------------------------------------------------------------------------
 AbstractDs::~AbstractDs() {}
 
 #ifndef H5_NO_NAMESPACE