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/H5FcreatProp.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/H5FcreatProp.cpp')
-rw-r--r-- | c++/src/H5FcreatProp.cpp | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/c++/src/H5FcreatProp.cpp b/c++/src/H5FcreatProp.cpp index 657b04b..7d1d228 100644 --- a/c++/src/H5FcreatProp.cpp +++ b/c++/src/H5FcreatProp.cpp @@ -38,19 +38,29 @@ FileCreatPropList::FileCreatPropList() : PropList( H5P_FILE_CREATE ) {} //-------------------------------------------------------------------------- // Function: FileCreatPropList copy constructor -///\brief Copy constructor: makes a copy of the original FileCreatPropList object. +///\brief Copy constructor: makes a copy of the original +/// FileCreatPropList object. ///\param original - IN: FileCreatPropList instance to copy // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- FileCreatPropList::FileCreatPropList( const FileCreatPropList& original ) : PropList( original ) {} //-------------------------------------------------------------------------- +// Function: FileCreatPropList overloaded constructor +///\brief Creates a file creation property list using the id of an +/// existing one. +///\param plist_id - IN: FileCreatPropList id to use +// Programmer Binh-Minh Ribler - 2000 +//-------------------------------------------------------------------------- +FileCreatPropList::FileCreatPropList(const hid_t plist_id) : PropList(plist_id) {} + +//-------------------------------------------------------------------------- // Function: FileCreatPropList::getVersion ///\brief Retrieves version information for various parts of a file. -///\param super - OUT: The file super block. +///\param super - OUT: The file super block. ///\param freelist - OUT: The global free list. -///\param stab - OUT: The root symbol table entry. -///\param shhdr - OUT: Shared object headers. +///\param stab - OUT: The root symbol table entry. +///\param shhdr - OUT: Shared object headers. ///\exception H5::PropListIException ///\par Description /// Any (or even all) of the output arguments can be null pointers. |