[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, 24 insertions, 13 deletions

diff --git a/c++/src/H5PropList.cpp b/c++/src/H5PropList.cpp
index d2fb66f..a9dd22a 100644
--- a/c++/src/H5PropList.cpp
+++ b/c++/src/H5PropList.cpp
@@ -29,15 +29,14 @@ namespace H5 {
 #endif
 
 //--------------------------------------------------------------------------
-///\brief	Constant for default property
+///\brief	Constant for default property.
 //--------------------------------------------------------------------------
 const PropList PropList::DEFAULT( H5P_DEFAULT );
 
 //--------------------------------------------------------------------------
 // Function	Default constructor
-///\brief	Default constructor - Creates a stub property list object.
-///\par Description
-///		The id of this property list is set to 0.
+///\brief	Default constructor: creates a stub property list object.
+// Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 PropList::PropList() : IdComponent( 0 ) {}
 
@@ -45,6 +44,7 @@ PropList::PropList() : IdComponent( 0 ) {}
 // Function:	PropList copy constructor
 ///\brief	Copy constructor
 ///\param	original - IN: The original property list to copy
+// Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 PropList::PropList( const PropList& original ) : IdComponent( original ) {}
 
@@ -60,6 +60,7 @@ PropList::PropList( const PropList& original ) : IdComponent( original ) {}
 //		property's id to H5P_DEFAULT, otherwise, to the given id.  
 //		Note: someone else added this code without comments and this 
 //		description was what I came up with from reading the code.
+// Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 PropList::PropList( const hid_t plist_id ) : IdComponent(0)
 {
@@ -81,9 +82,10 @@ PropList::PropList( const hid_t plist_id ) : IdComponent(0)
 
 //--------------------------------------------------------------------------
 // Function:	PropList::copy
-///\brief	Makes a copy of an existing property list
+///\brief	Makes a copy of an existing property list.
 ///\param	like_plist - IN: Reference to the existing property list
 ///\exception	H5::PropListIException
+// Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 void PropList::copy( const PropList& like_plist )
 {
@@ -105,12 +107,13 @@ void PropList::copy( const PropList& like_plist )
 
 //--------------------------------------------------------------------------
 // Function:	PropList::operator=
-///\brief	Assignment operator
+///\brief	Assignment operator.
 ///\param	rhs - IN: Reference to the existing property list
-///
+///\exception	H5::PropListIException
 // Description
 //		Makes a copy of the property list on the right hand side 
 //		and stores the new id in the left hand side object.
+// Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 PropList& PropList::operator=( const PropList& rhs )
 {
@@ -124,6 +127,8 @@ PropList& PropList::operator=( const PropList& rhs )
 ///\param	dest - IN: Destination property list or class
 ///\param	src  - IN: Source property list or class
 ///\param	name - IN: Name of the property to copy - \c char pointer
+///\exception	H5::PropListIException
+// Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 void PropList::copyProp( PropList& dest, PropList& src, const char *name ) const
 {
@@ -145,6 +150,7 @@ void PropList::copyProp( PropList& dest, PropList& src, const char *name ) const
 ///\param	dest - IN: Destination property list or class
 ///\param	src  - IN: Source property list or class
 ///\param	name - IN: Name of the property to copy - \c std::string
+// Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 void PropList::copyProp( PropList& dest, PropList& src, const string& name ) const
 {
@@ -157,6 +163,7 @@ void PropList::copyProp( PropList& dest, PropList& src, const string& name ) con
 ///\brief	Returns the class of this property list, i.e. \c H5P_FILE_CREATE...
 ///\return	The property list class if it is not equal to \c H5P_NO_CLASS
 ///\exception	H5::PropListIException
+// Programmer	Binh-Minh Ribler - April, 2004
 //--------------------------------------------------------------------------
 hid_t PropList::getClass() const
 {
@@ -214,7 +221,7 @@ bool PropList::propExist(const string& name ) const
 ///\brief	Close a property list class.
 ///\exception	H5::PropListIException
 ///\par Description
-///		Releases memory and de-attaches a class from the property 
+///		Releases memory and detaches a class from the property 
 ///		list class hierarchy.
 // Programmer:  Binh-Minh Ribler - April, 2004
 //--------------------------------------------------------------------------
@@ -234,8 +241,9 @@ void PropList::closeClass() const
 ///\param	value - OUT: Pointer to the buffer for the property value
 ///\exception	H5::PropListIException
 ///\par Description
-///   Retrieves a copy of the value for a property in a property list.  The
-///   property name must exist or this routine will throw an exception.
+///		Retrieves a copy of the value for a property in a property 
+///		list.  The property name must exist or this routine will 
+///		throw an exception.
 // Programmer:  Binh-Minh Ribler - April, 2004
 //--------------------------------------------------------------------------
 void PropList::getProperty(const char* name, void* value) const
@@ -338,7 +346,7 @@ size_t PropList::getPropSize(const string& name) const
 
 //--------------------------------------------------------------------------
 // Function:	PropList::getClassName
-///\brief	Return the name of a generic property list class
+///\brief	Return the name of a generic property list class.
 ///\return	A string containing the class name, if success, otherwise,
 ///		a NULL string.
 // Programmer:  Binh-Minh Ribler - April, 2004
@@ -452,7 +460,7 @@ void PropList::setProperty(const string& name, string& strg) const
 
 //--------------------------------------------------------------------------
 // Function:	PropList::isAClass
-///\brief	Determines whether a property list is a certain class
+///\brief	Determines whether a property list is a certain class.
 ///\param	prop_class - IN: Property class to query
 ///\return	true if the property list is a member of the property list 
 ///		class, and false, otherwise.
@@ -475,7 +483,7 @@ bool PropList::isAClass(const PropList& prop_class) const
 
 //--------------------------------------------------------------------------
 // Function:	PropList::removeProp
-///\brief	Removes a property from a property list
+///\brief	Removes a property from a property list.
 ///\param	name - IN: Name of property to remove - \c char pointer
 ///\exception	H5::PropListIException
 // Programmer:  Binh-Minh Ribler - April, 2004
@@ -546,6 +554,9 @@ PropList PropList::getClassParent() const
 // Function:	PropList destructor
 ///\brief	Properly terminates access to this property list.
 // Programmer	Binh-Minh Ribler - 2000
+// Modification
+//		Replaced resetIdComponent with decRefCount to use new ID 
+//		reference counting mechanisms by Quincey Koziol, June 1, 2004
 //--------------------------------------------------------------------------
 PropList::~PropList()
 {