summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2018-05-14 19:19:23 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2018-05-14 19:19:23 (GMT)
commit9b127e38fbd024b20217d12a91a789649848c412 (patch)
treeba4755703ecf3713e24d521f16664efc125b9dc1
parente5b337dd881b60a5300675f6b30ca3429020acbe (diff)
downloadhdf5-9b127e38fbd024b20217d12a91a789649848c412.zip
hdf5-9b127e38fbd024b20217d12a91a789649848c412.tar.gz
hdf5-9b127e38fbd024b20217d12a91a789649848c412.tar.bz2
Fixed typos
Description: Fixed miscellaneous typos that caused warnings when generating the documents with doxygen. Platforms tested: Linux/64 (jelly) Darwin (osx1010test)
-rw-r--r--c++/src/H5Location.cpp18
-rw-r--r--c++/src/H5StrcreatProp.cpp5
2 files changed, 14 insertions, 9 deletions
diff --git a/c++/src/H5Location.cpp b/c++/src/H5Location.cpp
index 6894fdd..c62437c 100644
--- a/c++/src/H5Location.cpp
+++ b/c++/src/H5Location.cpp
@@ -162,8 +162,7 @@ int H5Location::getNumAttrs() const
if(H5Oget_info(getId(), &objinfo) < 0)
throwException("getNumAttrs", "H5Oget_info failed");
- else
- return(static_cast<int>(objinfo.num_attrs));
+ return(static_cast<int>(objinfo.num_attrs));
}
//--------------------------------------------------------------------------
@@ -823,11 +822,11 @@ void H5Location::dereference(const H5Location& loc, const void* ref, H5R_type_t
//--------------------------------------------------------------------------
// Function: H5Location::dereference
-///\brief Dereferences a reference into an HDF5 object, given an attribute.
-///\param attr - IN: Attribute specifying the location of the referenced object
-///\param ref - IN: Reference pointer
-///\param ref_type - IN: Reference type
-///\exception H5::ReferenceException
+// brief Dereferences a reference into an HDF5 object, given an attribute.
+// param attr - IN: Attribute specifying the location of the referenced object
+// param ref - IN: Reference pointer
+// param ref_type - IN: Reference type
+// exception H5::ReferenceException
// October 2006
// Modification
// May, 2008
@@ -1093,7 +1092,7 @@ void H5Location::link(const H5std_string& curr_name, const H5Location& new_loc,
///\brief Creates a hard link from \a new_name to \a curr_name - can be
/// used to pass in H5L_SAME_LOC.
///\param curr_name - IN: Name of the existing object
-///\param loc_id - IN: Location ID, or H5L_SAME_LOC
+///\param same_loc - IN: Location ID, or H5L_SAME_LOC
///\param new_name - IN: New name for the link
///\param lcpl - IN: Link creation plist - default to LinkCreatPropList::DEFAULT
///\param lapl - IN: Link access plist - default to LinkAccPropList::DEFAULT
@@ -1322,6 +1321,7 @@ void H5Location::moveLink(const H5std_string& src_name,
// Function: H5Location::unlink
///\brief Removes the specified link from this location.
///\param name - IN: Name of the object to be removed
+///\param lapl - IN: Link access plist - default to LinkAccPropList::DEFAULT
///\exception One of the following:
/// H5::GroupIException
/// H5::FileIException
@@ -1357,7 +1357,7 @@ void H5Location::unlink(const H5std_string& name, const LinkAccPropList& lapl) c
// Function: H5Location::getLinkInfo
///\brief Returns the information of the named link.
///\param link_name - IN: Symbolic link to the object
-///\param size - IN: Maximum number of characters of value to be returned
+///\param lapl - IN: Link access plist - default LinkAccPropList::DEFAULT
///\return Name of the object
///\exception H5::FileIException/H5::GroupIException/H5::LocationException
// 2000
diff --git a/c++/src/H5StrcreatProp.cpp b/c++/src/H5StrcreatProp.cpp
index eb8ae6f..b296a65 100644
--- a/c++/src/H5StrcreatProp.cpp
+++ b/c++/src/H5StrcreatProp.cpp
@@ -26,6 +26,9 @@
namespace H5 {
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+// Currently, StrCreatPropList is an internal base class.
+
//--------------------------------------------------------------------------
// Function: StrCreatPropList default constructor
///\brief Default constructor: Creates a string create property list
@@ -51,6 +54,8 @@ StrCreatPropList::StrCreatPropList(const StrCreatPropList& original) : PropList(
//--------------------------------------------------------------------------
StrCreatPropList::StrCreatPropList(const hid_t plist_id) : PropList(plist_id) {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
+
//--------------------------------------------------------------------------
// Function: StrCreatPropList::setCharEncoding
///\brief Sets the character encoding of the string.