From 929675899fcfb9c2cdd6f8f4644a0524fa1579bb Mon Sep 17 00:00:00 2001 From: Binh-Minh Ribler Date: Mon, 30 Jul 2018 11:04:16 -0500 Subject: Merge pull request #1158 in HDFFV/hdf5 from ~BMRIBLER/hdf5_bmr_cpp4:develop to develop Typos in comments * commit '7d9f5ed49a560fe8801b77cce8ffb60a2ec5e846': Fixed document format Platforms tested: Linux/64 (jelly) (only in comment sections) Fixed missing backslash --- c++/src/H5ArrayType.cpp | 1 + c++/src/H5CompType.cpp | 1 + c++/src/H5DataType.cpp | 3 +++ c++/src/H5DcreatProp.cpp | 1 + c++/src/H5DxferProp.cpp | 1 + c++/src/H5EnumType.cpp | 1 + c++/src/H5FloatType.cpp | 1 + c++/src/H5Group.cpp | 1 + c++/src/H5IntType.cpp | 1 + c++/src/H5LaccProp.cpp | 2 ++ c++/src/H5LcreatProp.cpp | 2 ++ c++/src/H5StrType.cpp | 1 + c++/src/H5VarLenType.cpp | 1 + 13 files changed, 17 insertions(+) diff --git a/c++/src/H5ArrayType.cpp b/c++/src/H5ArrayType.cpp index 8ecb6da..0dab8ef 100644 --- a/c++/src/H5ArrayType.cpp +++ b/c++/src/H5ArrayType.cpp @@ -143,6 +143,7 @@ ArrayType& ArrayType::operator=(const ArrayType& rhs) // Function: ArrayType::decode ///\brief Returns an ArrayType object via DataType* by decoding the /// binary object description of this type. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5CompType.cpp b/c++/src/H5CompType.cpp index ae22f18..fe96bb0 100644 --- a/c++/src/H5CompType.cpp +++ b/c++/src/H5CompType.cpp @@ -129,6 +129,7 @@ CompType::CompType(const H5Location& loc, const H5std_string& dtype_name) : Data // Function: CompType::decode ///\brief Returns a CompType object via DataType* by decoding the /// binary object description of this datatype. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5DataType.cpp b/c++/src/H5DataType.cpp index bb27d47..081cc03 100644 --- a/c++/src/H5DataType.cpp +++ b/c++/src/H5DataType.cpp @@ -281,6 +281,7 @@ hid_t DataType::p_decode() const // Function: DataType::decode ///\brief Returns a DataType instance by decoding the binary object /// description of this datatype. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- @@ -301,6 +302,7 @@ DataType* DataType::decode() const //-------------------------------------------------------------------------- // Function: DataType::encode ///\brief Creates a binary object description of this datatype. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- @@ -333,6 +335,7 @@ void DataType::encode() // Function: DataType::hasBinaryDesc ///\brief Determines whether this datatype has a binary object /// description. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5DcreatProp.cpp b/c++/src/H5DcreatProp.cpp index bb899d7..79ff100 100644 --- a/c++/src/H5DcreatProp.cpp +++ b/c++/src/H5DcreatProp.cpp @@ -253,6 +253,7 @@ void DSetCreatPropList::setSzip(unsigned int options_mask, unsigned int pixels_p // Function: DSetCreatPropList::setNbit ///\brief Sets up for the use of the Nbit compression filter. ///\exception H5::PropListIException +/// ///\par Description /// The associate C function sets an Nbit compression filter, /// H5Z_FILTER_NBIT, for a dataset. For more information about diff --git a/c++/src/H5DxferProp.cpp b/c++/src/H5DxferProp.cpp index 90ecf88..9cc6961 100644 --- a/c++/src/H5DxferProp.cpp +++ b/c++/src/H5DxferProp.cpp @@ -299,6 +299,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/H5EnumType.cpp b/c++/src/H5EnumType.cpp index 9a4ccf1..f9adc47 100644 --- a/c++/src/H5EnumType.cpp +++ b/c++/src/H5EnumType.cpp @@ -151,6 +151,7 @@ EnumType::EnumType(const H5Location& loc, const H5std_string& dtype_name) : Data // Function: EnumType::decode ///\brief Returns an EnumType object via DataType* by decoding the /// binary object description of this type. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5FloatType.cpp b/c++/src/H5FloatType.cpp index 5fb1cb7..aba826e 100644 --- a/c++/src/H5FloatType.cpp +++ b/c++/src/H5FloatType.cpp @@ -133,6 +133,7 @@ FloatType::FloatType(const H5Location& loc, const H5std_string& dtype_name) : At // Function: FloatType::decode ///\brief Returns an FloatType object via DataType* by decoding the /// binary object description of this type. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5Group.cpp b/c++/src/H5Group.cpp index 0c2c4e8..7132bdf 100644 --- a/c++/src/H5Group.cpp +++ b/c++/src/H5Group.cpp @@ -66,6 +66,7 @@ Group::Group(const Group& original) : H5Object(), CommonFG(), id(original.id) //-------------------------------------------------------------------------- // Function: Group::closeObjId ///\brief Closes an object, which was opened with Group::getObjId +/// ///\exception H5::FileIException or H5::GroupIException // Programmer Binh-Minh Ribler - March, 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5IntType.cpp b/c++/src/H5IntType.cpp index 8e19d1e..49c638e 100644 --- a/c++/src/H5IntType.cpp +++ b/c++/src/H5IntType.cpp @@ -132,6 +132,7 @@ IntType::IntType(const H5Location& loc, const H5std_string& dtype_name) : AtomTy // Function: IntType::decode ///\brief Returns an IntType object via DataType* by decoding the /// binary object description of this type. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5LaccProp.cpp b/c++/src/H5LaccProp.cpp index 49ffa2b..1905cce 100644 --- a/c++/src/H5LaccProp.cpp +++ b/c++/src/H5LaccProp.cpp @@ -107,6 +107,7 @@ LinkAccPropList::LinkAccPropList(const hid_t plist_id) : PropList(plist_id) {} ///\brief Set the number of soft or user-defined link traversals allowed /// before the library assumes it has found a cycle and aborts the /// traversal. +/// ///\exception H5::PropListIException // Programmer Binh-Minh Ribler - March 1, 2017 //-------------------------------------------------------------------------- @@ -124,6 +125,7 @@ void LinkAccPropList::setNumLinks(size_t nlinks) const // Function: LinkAccPropList::getNumLinks ///\brief Gets the number of soft or user-defined links that can be /// traversed before a failure occurs. +/// ///\exception H5::PropListIException // Programmer Binh-Minh Ribler - March 1, 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5LcreatProp.cpp b/c++/src/H5LcreatProp.cpp index 8bece44..695c1fe 100644 --- a/c++/src/H5LcreatProp.cpp +++ b/c++/src/H5LcreatProp.cpp @@ -105,6 +105,7 @@ LinkCreatPropList::LinkCreatPropList(const hid_t plist_id) : PropList(plist_id) //-------------------------------------------------------------------------- // Function: LinkCreatPropList::setCharEncoding ///\brief Sets the character encoding of the string. +/// ///\exception H5::PropListIException // March, 2018 //-------------------------------------------------------------------------- @@ -121,6 +122,7 @@ void LinkCreatPropList::setCharEncoding(H5T_cset_t encoding) const //-------------------------------------------------------------------------- // Function: LinkCreatPropList::getCharEncoding ///\brief Gets the character encoding of the string. +///\return The character encoding ///\exception H5::PropListIException // March, 2018 //-------------------------------------------------------------------------- diff --git a/c++/src/H5StrType.cpp b/c++/src/H5StrType.cpp index 0cf2a4e..f5b65e4 100644 --- a/c++/src/H5StrType.cpp +++ b/c++/src/H5StrType.cpp @@ -186,6 +186,7 @@ StrType::StrType(const H5Location& loc, const H5std_string& dtype_name) : AtomTy // Function: StrType::decode ///\brief Returns an StrType object via DataType* by decoding the /// binary object description of this type. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- diff --git a/c++/src/H5VarLenType.cpp b/c++/src/H5VarLenType.cpp index 18cd831..094af61 100644 --- a/c++/src/H5VarLenType.cpp +++ b/c++/src/H5VarLenType.cpp @@ -133,6 +133,7 @@ VarLenType::VarLenType(const H5Location& loc, const H5std_string& dtype_name) : // Function: VarLenType::decode ///\brief Returns an VarLenType object via DataType* by decoding the /// binary object description of this type. +/// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - Aug 2017 //-------------------------------------------------------------------------- -- cgit v0.12