diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2015-11-11 20:30:21 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2015-11-11 20:30:21 (GMT) |
commit | d16f75a6dd7f0c6a25497bf72081167e2237d9a4 (patch) | |
tree | d0cad53b093dd44b4563e11ef61ab74362059268 /c++/src | |
parent | 338c1d9af0e5eb514dcaa214057a980705f4155a (diff) | |
download | hdf5-d16f75a6dd7f0c6a25497bf72081167e2237d9a4.zip hdf5-d16f75a6dd7f0c6a25497bf72081167e2237d9a4.tar.gz hdf5-d16f75a6dd7f0c6a25497bf72081167e2237d9a4.tar.bz2 |
[svn-r28326] Purpose: Fix documents
Description:
Added "///" to between \brief and \exception to work around a Doxygen
bug and added a missing \return.
Platforms tested:
Linux/32 2.6 (jam) - only in function headers
Diffstat (limited to 'c++/src')
-rw-r--r-- | c++/src/H5DxferProp.cpp | 1 | ||||
-rw-r--r-- | c++/src/H5OcreatProp.cpp | 3 |
2 files changed, 2 insertions, 2 deletions
diff --git a/c++/src/H5DxferProp.cpp b/c++/src/H5DxferProp.cpp index 49bbfe6..21d8ff2 100644 --- a/c++/src/H5DxferProp.cpp +++ b/c++/src/H5DxferProp.cpp @@ -304,6 +304,7 @@ ssize_t DSetMemXferPropList::getDataTransform(char* exp, size_t buf_size) const // Function: DSetMemXferPropList::getDataTransform ///\brief This is an overloaded member function, provided for convenience. /// It takes no parameter and returns a \c H5std_string for the expression. +/// ///\exception H5::PropListIException // Programmer: Binh-Minh Ribler - Mar, 2014 //-------------------------------------------------------------------------- diff --git a/c++/src/H5OcreatProp.cpp b/c++/src/H5OcreatProp.cpp index 635ffe9..ca0e59e 100644 --- a/c++/src/H5OcreatProp.cpp +++ b/c++/src/H5OcreatProp.cpp @@ -188,8 +188,7 @@ 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 +///\return Attribute creation order ///\exception H5::PropListIException ///\par Description /// When no flag is set, i.e. crt_order_flags = 0, attribute |