[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, 21 insertions, 20 deletions

diff --git a/c++/src/H5DataSet.h b/c++/src/H5DataSet.h
index 6730c94..83cb1ad 100644
--- a/c++/src/H5DataSet.h
+++ b/c++/src/H5DataSet.h
@@ -24,21 +24,29 @@ namespace H5 {
 
 class H5_DLLCPP DataSet : public AbstractDs {
    public:
-	// Gets the dataspace of this dataset.
-	virtual DataSpace getSpace() const;
+	// Extends the dataset with unlimited dimension.
+	void extend( const hsize_t* size ) const;
+
+	// Fills a selection in memory with a value
+	void fillMemBuf(const void *fill, DataType& fill_type, void *buf, DataType& buf_type, DataSpace& space);
+	// Fills a selection in memory with zero 
+	void fillMemBuf(void *buf, DataType& buf_type, DataSpace& space);
 
 	// Gets the creation property list of this dataset.
 	DSetCreatPropList getCreatePlist() const;
 
-	// Gets the storage size of this dataset.
-	hsize_t getStorageSize() const;
-
 	// Returns the address of this dataset in the file.
 	haddr_t getOffset() const;
 	
+	// Gets the dataspace of this dataset.
+	virtual DataSpace getSpace() const;
+
 	// Determines whether space has been allocated for a dataset.
 	void getSpaceStatus(H5D_space_status_t& status) const;
 
+	// Gets the storage size of this dataset.
+	hsize_t getStorageSize() const;
+
 	// not yet implemented??
 	hsize_t getVlenBufSize( DataType& type, DataSpace& space ) const;
 	void vlenReclaim( DataType& type, DataSpace& space, DSetMemXferPropList& xfer_plist, void* buf ) const;
@@ -58,26 +66,18 @@ class H5_DLLCPP DataSet : public AbstractDs {
 	// Iterates the selected elements in the specified dataspace - not implemented in C++ style yet
         int iterateElems( void* buf, const DataType& type, const DataSpace& space, H5D_operator_t op, void* op_data = NULL );
 
-	// Extends the dataset with unlimited dimension.
-	void extend( const hsize_t* size ) const;
-
-	// Fills a selection in memory with a value
-	void fillMemBuf(const void *fill, DataType& fill_type, void *buf, DataType& buf_type, DataSpace& space);
-	// Fills a selection in memory with zero 
-	void fillMemBuf(void *buf, DataType& buf_type, DataSpace& space);
+	// Retrieves the type of object that an object reference points to.
+	H5G_obj_t getObjType(void *ref, H5R_type_t ref_type) const;
 
-	// Creates a reference to a named Hdf5 object in this object.
-	void* Reference(const char* name) const;
+	// Retrieves a dataspace with the region pointed to selected.
+	DataSpace getRegion(void *ref, H5R_type_t ref_type = H5R_DATASET_REGION) const;
 
 	// Creates a reference to a named Hdf5 object or to a dataset region
 	// in this object.
 	void* Reference(const char* name, DataSpace& dataspace, H5R_type_t ref_type = H5R_DATASET_REGION) const;
 
-	// Retrieves the type of object that an object reference points to.
-	H5G_obj_t getObjType(void *ref, H5R_type_t ref_type) const;
-
-	// Retrieves a dataspace with the region pointed to selected.
-	DataSpace getRegion(void *ref, H5R_type_t ref_type = H5R_DATASET_REGION) const;
+	// Creates a reference to a named Hdf5 object in this object.
+	void* Reference(const char* name) const;
 
 	// Creates a copy of an existing DataSet using its id.
 	DataSet(const hid_t existing_id);
@@ -88,6 +88,7 @@ class H5_DLLCPP DataSet : public AbstractDs {
 	// Copy constructor.
 	DataSet( const DataSet& original );
 
+	// Destructor: properly terminates access to this dataset.
 	virtual ~DataSet();
 
    private:
@@ -95,7 +96,7 @@ class H5_DLLCPP DataSet : public AbstractDs {
         // getTypeClass and various API functions getXxxType 
         // defined in AbstractDs for generic datatype and specific
         // sub-types
-	virtual hid_t p_getType() const;
+	virtual hid_t p_get_type() const;
 };
 #ifndef H5_NO_NAMESPACE
 }