summaryrefslogtreecommitdiffstats
path: root/c++/src/H5StrType.cpp
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2016-03-07 21:02:17 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2016-03-07 21:02:17 (GMT)
commit36c46346060c867d0782043f5f67be12acfc2241 (patch)
treea93f9fd02d3daefa2374c119c53a1708f5fbf4c1 /c++/src/H5StrType.cpp
parent767520bfe207b05ad9bee7f45353b6c379a167be (diff)
downloadhdf5-36c46346060c867d0782043f5f67be12acfc2241.zip
hdf5-36c46346060c867d0782043f5f67be12acfc2241.tar.gz
hdf5-36c46346060c867d0782043f5f67be12acfc2241.tar.bz2
[svn-r29322] Purpose: Remove obsoletes
Description: Removed obsolete functions from the documentation. They are still in the code, however, until the next two releases, just in case. 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.cpp21
1 files changed, 12 insertions, 9 deletions
diff --git a/c++/src/H5StrType.cpp b/c++/src/H5StrType.cpp
index b067746..3cfa342 100644
--- a/c++/src/H5StrType.cpp
+++ b/c++/src/H5StrType.cpp
@@ -58,10 +58,10 @@ StrType::StrType( const PredType& pred_type ) : AtomType()
//--------------------------------------------------------------------------
// Function: StrType overloaded constructor
-///\brief Creates a string datatype with a specified length
-///\param pred_type - IN: String predefined type to replicate.
-///\param size - IN: Length of the new string type
-///\exception H5::DataTypeIException
+// Purpose Creates a string datatype with a specified length
+// Param pred_type - IN: String predefined type to replicate.
+// Param size - IN: Length of the new string type
+// Exception H5::DataTypeIException
// Description
// The 1st argument could have been skipped, but this
// constructor will collide with the one that takes an
@@ -71,10 +71,13 @@ StrType::StrType( const PredType& pred_type ) : AtomType()
// avoid the clashing problem, that doesn't eliminate the
// the 1st argument but it's simpler for the user to type
// a '0' than PredType::C_S1. - Dec 2, 2005
-///\note
-/// The use of this constructor can be shortened by using
-/// its overloaded below as StrType(0, size).
+// Note
+// The use of this constructor can be shortened by using
+// its overloaded below as StrType(0, size).
// Programmer Binh-Minh Ribler - 2000
+// Modification
+// Planned for removal. -BMR, 2005/12/02
+// Removed from documentation. -BMR, 2016/03/07
//--------------------------------------------------------------------------
StrType::StrType( const PredType& pred_type, const size_t& size ) : AtomType()
{
@@ -96,8 +99,8 @@ StrType::StrType( const PredType& pred_type, const size_t& size ) : AtomType()
/// previous constructor, such as:
/// StrType atype(0, size) instead of
/// StrType atype(PredType::C_S1, size)
-///\note
-/// This constructor may replace the previous one in the future.
+// Note
+// This constructor replaced the previous one.
// Programmer Binh-Minh Ribler - Nov 28, 2005
//--------------------------------------------------------------------------
StrType::StrType( const int dummy, const size_t& size ) : AtomType()