summaryrefslogtreecommitdiffstats
path: root/c++/src/H5OcreatProp.cpp
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2017-03-21 19:40:18 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2017-03-21 19:40:18 (GMT)
commitd605ce46b37a1ca33d1e474fda78009e9bdabb18 (patch)
tree0211c506a3cc95280a24cb2426a4d99a5b3aefa8 /c++/src/H5OcreatProp.cpp
parent41a54b4fab616246ba3954e217827a7808c6adea (diff)
parent7a799387e100138f1300c29810e9032f66436fcf (diff)
downloadhdf5-d605ce46b37a1ca33d1e474fda78009e9bdabb18.zip
hdf5-d605ce46b37a1ca33d1e474fda78009e9bdabb18.tar.gz
hdf5-d605ce46b37a1ca33d1e474fda78009e9bdabb18.tar.bz2
Merge pull request #357 in HDFFV/hdf5 from ~BMRIBLER/hdf5_1_10_bmr:hdf5_1_10 to hdf5_1_10
* commit '7a799387e100138f1300c29810e9032f66436fcf': Description: Fixed typos and missing items in function headers, that were revealed by Doxygen, and revised various comments. Platforms tested: Linux/32 2.6 (jam) Linux/64 (platypus) Darwin (osx1010test) Description: Updated the C++ API sections.
Diffstat (limited to 'c++/src/H5OcreatProp.cpp')
-rw-r--r--c++/src/H5OcreatProp.cpp9
1 files changed, 4 insertions, 5 deletions
diff --git a/c++/src/H5OcreatProp.cpp b/c++/src/H5OcreatProp.cpp
index 6fdd9dc..9a3af7e 100644
--- a/c++/src/H5OcreatProp.cpp
+++ b/c++/src/H5OcreatProp.cpp
@@ -155,7 +155,7 @@ void ObjCreatPropList::getAttrPhaseChange(unsigned& max_compact, unsigned& min_d
//--------------------------------------------------------------------------
// Function: ObjCreatPropList::setAttrCrtOrder
-///\brief Sets tracking and indexing of attribute creation order.
+///\brief Set the flags for creation order of attributes on an object
///\param crt_order_flags - IN: Flags specifying whether to track and
/// index attribute creation order. Default: No flag set
///\exception H5::PropListIException
@@ -183,10 +183,9 @@ void ObjCreatPropList::setAttrCrtOrder(unsigned crt_order_flags) const
//--------------------------------------------------------------------------
// Function: ObjCreatPropList::getAttrCrtOrder
-///\brief Gets tracking and indexing settings for attribute
-/// creation order.
-///\param crt_order_flags - OUT: Flags specifying whether to track and
-/// index attribute creation order
+///\brief Returns the flags indicating creation order is tracked/indexed
+/// for attributes on an object.
+///\return The flags
///\exception H5::PropListIException
///\par Description
/// When no flag is set, i.e. crt_order_flags = 0, attribute