summaryrefslogtreecommitdiffstats
path: root/c++/src/H5StrType.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/H5StrType.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/H5StrType.cpp')
-rw-r--r--c++/src/H5StrType.cpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/c++/src/H5StrType.cpp b/c++/src/H5StrType.cpp
index 54981ab..db1cf04 100644
--- a/c++/src/H5StrType.cpp
+++ b/c++/src/H5StrType.cpp
@@ -148,11 +148,12 @@ StrType::StrType(const DataSet& dataset) : AtomType ()
// Function: StrType overloaded constructor
///\brief Creates an StrType instance by opening an HDF5 string datatype
/// given its name, provided as a C character string.
+///\param loc - IN: Location of the type
///\param dtype_name - IN: String type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
-// In 1.10.1, this constructor was introduced and will replace the
+// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openStrType(const char*) to
// improve usability.
// -BMR, Dec 2016
@@ -166,11 +167,12 @@ StrType::StrType(const H5Location& loc, const char *dtype_name) : AtomType()
// Function: StrType overloaded constructor
///\brief Creates an StrType instance by opening an HDF5 string datatype
/// given its name, provided as an \c H5std_string.
+///\param loc - IN: Location of the type
///\param dtype_name - IN: String type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
-// In 1.10.1, this constructor was introduced and will replace the
+// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openStrType(const H5std_string&)
// to improve usability.
// -BMR, Dec 2016