diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-08-20 04:35:18 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-08-20 04:35:18 (GMT) |
commit | 824ba5e2fde476934df42284271c358b14e1a6af (patch) | |
tree | caf62890a1527b0fdc2a77a550c7e11f30c48584 /c++/src/H5ArrayType.cpp | |
parent | b142a4144862b22c37c27aa11e2ee519a08ede2f (diff) | |
download | hdf5-824ba5e2fde476934df42284271c358b14e1a6af.zip hdf5-824ba5e2fde476934df42284271c358b14e1a6af.tar.gz hdf5-824ba5e2fde476934df42284271c358b14e1a6af.tar.bz2 |
[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)
Diffstat (limited to 'c++/src/H5ArrayType.cpp')
-rw-r--r-- | c++/src/H5ArrayType.cpp | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/c++/src/H5ArrayType.cpp b/c++/src/H5ArrayType.cpp index ed69a8c..b580660 100644 --- a/c++/src/H5ArrayType.cpp +++ b/c++/src/H5ArrayType.cpp @@ -41,10 +41,10 @@ ArrayType::ArrayType() : DataType() } //-------------------------------------------------------------------------- -// Function: ArrayType overloaded constructor -///\brief Creates an ArrayType object using an existing id. -///\param existing_id - IN: Id of an existing datatype -///\exception H5::DataTypeIException +// Function: ArrayType overloaded constructor +///\brief Creates an ArrayType object using an existing id. +///\param existing_id - IN: Id of an existing datatype +///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- ArrayType::ArrayType( const hid_t existing_id ) : DataType( existing_id ) @@ -80,13 +80,13 @@ ArrayType::ArrayType( const ArrayType& original ) : DataType( original ) } //-------------------------------------------------------------------------- -// Function: ArrayType overloaded constructor -///\brief Creates a new array data type based on the specified +// Function: ArrayType overloaded constructor +///\brief Creates a new array data type based on the specified /// \a base_type. -///\param base_type - IN: Existing datatype -///\param ndims - IN: Rank of the array, [0..H5S_MAX_RANK] -///\param dims - IN: Size of each array dimension -///\exception H5::DataTypeIException +///\param base_type - IN: Existing datatype +///\param ndims - IN: Rank of the array, [0..H5S_MAX_RANK] +///\param dims - IN: Size of each array dimension +///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- ArrayType::ArrayType(const DataType& base_type, int ndims, const hsize_t* dims) : DataType() @@ -104,10 +104,10 @@ ArrayType::ArrayType(const DataType& base_type, int ndims, const hsize_t* dims) } //-------------------------------------------------------------------------- -// Function: ArrayType::getArrayNDims -///\brief Returns the number of dimensions for an array datatype. +// Function: ArrayType::getArrayNDims +///\brief Returns the number of dimensions for an array datatype. ///\return Number of dimensions -///\exception H5::DataTypeIException +///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- int ArrayType::getArrayNDims() @@ -126,11 +126,11 @@ int ArrayType::getArrayNDims() } //-------------------------------------------------------------------------- -// Function: ArrayType::getArrayDims -///\brief Retrieves the size of all dimensions of an array datatype. +// Function: ArrayType::getArrayDims +///\brief Retrieves the size of all dimensions of an array datatype. ///\param dims - OUT: Sizes of dimensions ///\return Number of dimensions -///\exception H5::DataTypeIException +///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- int ArrayType::getArrayDims(hsize_t* dims) |