[svn-r15998] Description:

    Fixed various comments/headers to update the C++ reference manual.

Platforms tested:
    Linux 2.6 (kagiso) - to make certain no typo introduced

1 files changed, 12 insertions, 12 deletions

diff --git a/c++/src/H5DataSet.cpp b/c++/src/H5DataSet.cpp
index 494d3ea..5a09af4 100644
--- a/c++/src/H5DataSet.cpp
+++ b/c++/src/H5DataSet.cpp
@@ -363,7 +363,7 @@ void DataSet::read( void* buf, const DataType& mem_type, const DataSpace& mem_sp
 //--------------------------------------------------------------------------
 // Function:	DataSet::read
 ///\brief	This is an overloaded member function, provided for convenience.
-///		It takes a reference to a \c std::string for the buffer.
+///		It takes a reference to a \c H5std_string for the buffer.
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 void DataSet::read( H5std_string& strg, const DataType& mem_type, const DataSpace& mem_space, const DataSpace& file_space, const DSetMemXferPropList& xfer_plist ) const
@@ -414,7 +414,7 @@ void DataSet::write( const void* buf, const DataType& mem_type, const DataSpace&
 //--------------------------------------------------------------------------
 // Function:	DataSet::write
 ///\brief	This is an overloaded member function, provided for convenience.
-///		It takes a reference to a \c std::string for the buffer.
+///		It takes a reference to a \c H5std_string for the buffer.
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 void DataSet::write( const H5std_string& strg, const DataType& mem_type, const DataSpace& mem_space, const DataSpace& file_space, const DSetMemXferPropList& xfer_plist ) const
@@ -467,7 +467,7 @@ int DataSet::iterateElems( void* buf, const DataType& type, const DataSpace& spa
 ///		For more information, please see the Description section in
 ///		C layer Reference Manual at:
 ///\par
-/// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5D.html#Dataset-Extend
+/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Extend
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 void DataSet::extend( const hsize_t* size ) const
@@ -527,14 +527,14 @@ void DataSet::fillMemBuf(void *buf, DataType& buf_type, DataSpace& space)
 // Function:	DataSet::getObjType
 ///\brief	Retrieves the type of object that an object reference points to.
 ///\param	ref_type - IN: Type of reference to query, valid values are:
-///		\li \c H5R_OBJECT \tReference is an object reference.
-///		\li \c H5R_DATASET_REGION \tReference is a dataset region reference.
+///		\li \c H5R_OBJECT         - Reference is an object reference.
+///		\li \c H5R_DATASET_REGION - Reference is a dataset region reference.
 ///\param	ref      - IN: Reference to query
 ///\return	An object type, which can be one of the following:
-///		\li \c H5G_LINK (0) \tObject is a symbolic link.
-///		\li \c H5G_GROUP (1) \tObject is a group.
-///		\li \c H5G_DATASET (2) \tObject is a dataset.
-///		\li \c H5G_TYPE Object (3) \tis a named datatype
+///		\li \c H5G_LINK (0)    - Object is a symbolic link.
+///		\li \c H5G_GROUP (1)   - Object is a group.
+///		\li \c H5G_DATASET (2) - Object is a dataset.
+///		\li \c H5G_TYPE (3)    - Object is a named datatype
 ///\exception	H5::DataSetIException
 // Programmer	Binh-Minh Ribler - May, 2004
 //--------------------------------------------------------------------------
@@ -552,9 +552,9 @@ H5G_obj_t DataSet::getObjType(void *ref, H5R_type_t ref_type) const
 //--------------------------------------------------------------------------
 // Function:	DataSet::getRegion
 ///\brief	Retrieves a dataspace with the region pointed to selected.
+///\param	ref      - IN: Reference to get region of
 ///\param	ref_type - IN: Type of reference to get region of - default
 ///		to H5R_DATASET_REGION
-///\param	ref      - IN: Reference to get region of
 ///\return	DataSpace instance
 ///\exception	H5::DataSetIException
 // Programmer	Binh-Minh Ribler - May, 2004
@@ -572,7 +572,7 @@ DataSpace DataSet::getRegion(void *ref, H5R_type_t ref_type) const
 
 //--------------------------------------------------------------------------
 // Function:    DataSet::getId
-// Purpose:     Get the id of this attribute
+///\brief	Get the id of this dataset.
 // Description:
 //              Class hierarchy is revised to address bugzilla 1068.  Class
 //              AbstractDs and Attribute are moved out of H5Object.  In
@@ -587,7 +587,7 @@ hid_t DataSet::getId() const
 
 //--------------------------------------------------------------------------
 // Function:    DataSet::p_setId
-///\brief       Sets the identifier of this object to a new value.
+///\brief       Sets the identifier of this dataset to a new value.
 ///
 ///\exception   H5::IdComponentException when the attempt to close the HDF5
 ///             object fails