summaryrefslogtreecommitdiffstats
path: root/c++/src/H5OcreatProp.cpp
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2017-03-21 02:56:50 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2017-03-21 02:56:50 (GMT)
commit44626957a67f333369506cc32d42e95977600fd7 (patch)
tree9a48bffdb76a37903c18316815a50c933d8eb368 /c++/src/H5OcreatProp.cpp
parentd8199a74ee5251be30b72d1b50a855192650c9d1 (diff)
downloadhdf5-44626957a67f333369506cc32d42e95977600fd7.zip
hdf5-44626957a67f333369506cc32d42e95977600fd7.tar.gz
hdf5-44626957a67f333369506cc32d42e95977600fd7.tar.bz2
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)
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