[svn-r9129] Purpose: Updating documentation

Description:
    Updated various function headers for the RM as reviewing progresses.
    Rearranged functions in header files for more sensible look of the RM.

Platforms tested:
    SunOS 5.7 (arabica)
    Linux 2.4 (eirene)

1 files changed, 17 insertions, 15 deletions

diff --git a/c++/src/H5AtomType.cpp b/c++/src/H5AtomType.cpp
index b041d53..902d07c 100644
--- a/c++/src/H5AtomType.cpp
+++ b/c++/src/H5AtomType.cpp
@@ -28,21 +28,23 @@
 namespace H5 {
 #endif
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 //--------------------------------------------------------------------------
-// Function:	AtomType default constructor
-///\brief	Default constructor: Creates a stub datatype
+// Function:	AtomType default constructor [protected]
+// Purpose	Default constructor: creates a stub atomic datatype.
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 AtomType::AtomType() : DataType() {}
 
 //--------------------------------------------------------------------------
-// Function:	AtomType overloaded constructor
-///\brief	Creates an AtomType object using an existing id.
-///\param	existing_id - IN: Id of an existing datatype
-///\exception   H5::DataTypeIException
+// Function:	AtomType overloaded constructor [protected]
+// Purpose	Creates an AtomType object using an existing id.
+// Parameter	existing_id - IN: Id of an existing datatype
+// Exception	H5::DataTypeIException
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 AtomType::AtomType( const hid_t existing_id ) : DataType( existing_id ) {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
 
 //--------------------------------------------------------------------------
 // Function:	AtomType copy constructor
@@ -55,7 +57,7 @@ AtomType::AtomType( const AtomType& original ) : DataType( original ) {}
 // Function:	AtomType::setSize
 ///\brief	Sets the total size for an atomic datatype. 
 ///\param	size - IN: Size to set
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 void AtomType::setSize( size_t size ) const
@@ -76,7 +78,7 @@ void AtomType::setSize( size_t size ) const
 ///		\li \c H5T_ORDER_LE
 ///		\li \c H5T_ORDER_BE
 ///		\li \c H5T_ORDER_VAX
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 H5T_order_t AtomType::getOrder( string& order_string ) const
@@ -106,7 +108,7 @@ H5T_order_t AtomType::getOrder( string& order_string ) const
 ///		\li \c H5T_ORDER_LE
 ///		\li \c H5T_ORDER_BE
 ///		\li \c H5T_ORDER_VAX
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 void AtomType::setOrder( H5T_order_t order ) const
@@ -123,7 +125,7 @@ void AtomType::setOrder( H5T_order_t order ) const
 // Function:	AtomType::getPrecision
 ///\brief	Returns the precision of an atomic datatype. 
 ///\return	Number of significant bits 
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 ///\par Description
 ///		The precision is the number of significant bits which, 
 ///		unless padding is present, is 8 times larger than the 
@@ -147,7 +149,7 @@ size_t AtomType::getPrecision() const
 // Function:	AtomType::setPrecision
 ///\brief	Sets the precision of an atomic datatype. 
 ///\param	precision - IN: Number of bits of precision
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 ///\par Description
 ///		For information, please see C layer Reference Manuat at:
 /// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5T.html#Datatype-SetPrecision
@@ -167,7 +169,7 @@ void AtomType::setPrecision( size_t precision ) const
 // Function:	AtomType::getOffset
 ///\brief	Retrieves the bit offset of the first significant bit. 
 ///\return	Offset value
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 ///\par Description
 ///		For information, please see C layer Reference Manuat at:
 /// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5T.html#Datatype-GetOffset
@@ -194,7 +196,7 @@ int AtomType::getOffset() const
 // Function:	AtomType::setOffset
 ///\brief	Sets the bit offset of the first significant bit. 
 ///\param	offset - IN: Offset of first significant bit
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 ///\par Description
 ///		For information, please see C layer Reference Manuat at:
 /// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5T.html#Datatype-SetOffset
@@ -216,7 +218,7 @@ void AtomType::setOffset( size_t offset ) const
 ///		bit padding. 
 ///\param	lsb - OUT: Least-significant bit padding type
 ///\param	msb - OUT: Most-significant bit padding type
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 ///\par Description
 ///		Possible values for \a lsb and \a msb include:
 ///		\li \c H5T_PAD_ZERO (0) - Set background to zeros. 
@@ -239,7 +241,7 @@ void AtomType::getPad( H5T_pad_t& lsb, H5T_pad_t& msb ) const
 ///\brief	Sets the least and most-significant bits padding types.
 ///\param	lsb - IN: Least-significant bit padding type
 ///\param	msb - IN: Most-significant bit padding type
-///\exception   H5::DataTypeIException
+///\exception	H5::DataTypeIException
 ///\par Description
 ///		Valid values for \a lsb and \a msb include:
 ///		\li \c H5T_PAD_ZERO (0) - Set background to zeros.