diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2017-02-16 06:35:44 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2017-02-16 06:35:44 (GMT) |
| commit | 5f759d6d9f804d99572f605f9d9933c897ef3671 (patch) | |
| tree | 4d762099b2c56bbbbcf27b240ac9248bec09c0d4 /c++ | |
| parent | f51f05ec20f5b585bd0f49f088d402a2f3410044 (diff) | |
| download | hdf5-5f759d6d9f804d99572f605f9d9933c897ef3671.zip hdf5-5f759d6d9f804d99572f605f9d9933c897ef3671.tar.gz hdf5-5f759d6d9f804d99572f605f9d9933c897ef3671.tar.bz2 | |
Description:
Fixed and added function comments.
Platform tested:
Jam (very minor)
Diffstat (limited to 'c++')
| -rw-r--r-- | c++/src/H5FcreatProp.cpp | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/c++/src/H5FcreatProp.cpp b/c++/src/H5FcreatProp.cpp index a51f83d..ed6064f 100644 --- a/c++/src/H5FcreatProp.cpp +++ b/c++/src/H5FcreatProp.cpp @@ -298,14 +298,22 @@ unsigned FileCreatPropList::getIstorek() const // Function: FileCreatPropList::setFileSpace ///\brief Sets the strategy and the threshold value that the library /// will employ in managing file space. -///\param ik - IN: Symbol table tree rank -///\param lk - IN: Symbol table node size +///\param strategy - IN: Strategy for file space management +///\param threshold - IN: Free-space section threshold. The library +/// default is 1, which is to track all free-space sections. ///\exception H5::PropListIException ///\par Description /// If the given strategy is zero, the property will not be /// changed and the existing strategy will be retained. /// If the given threshold value is zero, the property will not be /// changed and the existing threshold will be retained. +/// Valid values of \a libver_low are as follows: +/// \li \c H5F_FILE_SPACE_ALL (Default) +/// \li \c H5F_FILE_SPACE_ALL_PERSIST +/// \li \c H5F_FILE_SPACE_AGGR_VFD +/// \li \c H5F_FILE_SPACE_VFD +/// For information, please see the C layer Reference Manual at: +/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFileSpace // Programmer Binh-Minh Ribler - Feb, 2017 //-------------------------------------------------------------------------- void FileCreatPropList::setFileSpace(H5F_file_space_type_t strategy, hsize_t threshold) const |