diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-05-26 07:02:51 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-05-26 07:02:51 (GMT) |
| commit | 80816a3dde8614c52d80f0090f8a5d08fc4546e7 (patch) | |
| tree | 1b32a2bdc1d0831783a4f513b46f1885b968b6b8 /c++/src/H5DataType.cpp | |
| parent | 2e588eef3fe7e7108168d095d385502fd8e41b9d (diff) | |
| download | hdf5-80816a3dde8614c52d80f0090f8a5d08fc4546e7.zip hdf5-80816a3dde8614c52d80f0090f8a5d08fc4546e7.tar.gz hdf5-80816a3dde8614c52d80f0090f8a5d08fc4546e7.tar.bz2 | |
[svn-r8576] Purpose:
Add more C++ wrapper and documentation - incrementally check-in
Description:
Added doxygen documentation to:
H5DataSet.cpp
H5DataSpace.cpp
H5CommonFG.cpp
and a wrapper for H5Rcreate to H5Object.* with tests will be added
later.
There are more documentation need to be added to these files but
to preserve the changes, I check them in now.
Platforms:
SunOS 5.7 (arabica)
Linux 2.4 (eirene)
Misc. update:
Diffstat (limited to 'c++/src/H5DataType.cpp')
| -rw-r--r-- | c++/src/H5DataType.cpp | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/c++/src/H5DataType.cpp b/c++/src/H5DataType.cpp index 867eb4e..1b268e7 100644 --- a/c++/src/H5DataType.cpp +++ b/c++/src/H5DataType.cpp @@ -120,8 +120,8 @@ void DataType::copy( const DataType& like_type ) // Function: DataType::operator= ///\brief Assignment operator ///\param rhs - IN: Reference to the existing datatype +///\return Reference to DataType instance ///\exception H5::DataTypeIException -/// // Description // Makes a copy of the type on the right hand side and stores // the new id in the left hand side object. @@ -458,7 +458,7 @@ void DataType::setTag( const string& tag ) const } //-------------------------------------------------------------------------- -// Function: DataType::setTag +// Function: DataType::getTag ///\brief Gets the tag associated with an opaque datatype. ///\return Tag associated with the opaque datatype ///\exception H5::DataTypeIException @@ -529,9 +529,13 @@ bool DataType::isVariableStr() const } //-------------------------------------------------------------------------- -// This private function calls the C API H5Tclose to close this datatype. -// Used by H5Object::p_reset. -// Programmer Binh-Minh Ribler - 2000 +// Function: DataType::p_close (private) +///\brief Closes this datatype. +///\exception H5::DataTypeIException +///\note +/// This function will be obsolete because its functionality +/// is recently handled by the C library layer. +// Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void DataType::p_close() const { |