summaryrefslogtreecommitdiffstats
path: root/c++/src/H5DataType.cpp
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2016-04-22 16:46:58 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2016-04-22 16:46:58 (GMT)
commit487ccb3e59efe1365879e25e67bfa12299c93433 (patch)
tree55b8de0aaeb09027b093309898b1d0a4b2eb657d /c++/src/H5DataType.cpp
parent5aea4260b5537793352e6c78a7737d700159f16f (diff)
downloadhdf5-487ccb3e59efe1365879e25e67bfa12299c93433.zip
hdf5-487ccb3e59efe1365879e25e67bfa12299c93433.tar.gz
hdf5-487ccb3e59efe1365879e25e67bfa12299c93433.tar.bz2
[svn-r29762] 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. Merge from trunk r29322. Platforms tested: Linux/32 2.6 (jam) Linux/64 (platypus) Darwin (osx1010test)
Diffstat (limited to 'c++/src/H5DataType.cpp')
-rw-r--r--c++/src/H5DataType.cpp30
1 files changed, 18 insertions, 12 deletions
diff --git a/c++/src/H5DataType.cpp b/c++/src/H5DataType.cpp
index cb48942..3b5d05b 100644
--- a/c++/src/H5DataType.cpp
+++ b/c++/src/H5DataType.cpp
@@ -302,13 +302,16 @@ void DataType::commit(const H5Location& loc, const char* name)
//--------------------------------------------------------------------------
// Function: DataType::commit
-///\brief This is an overloaded member function, kept for backward
-/// compatibility. It differs from the above function in that it
-/// misses const's. This wrapper will be removed in future release.
-///\param loc - IN: A location (file, dataset, datatype, or group)
-///\param name - IN: Name of the datatype
-///\exception H5::DataTypeIException
+// Purpose This is an overloaded member function, kept for backward
+// compatibility. It differs from the above function in that it
+// misses const's. This wrapper will be removed in future release.
+// Param loc - IN: A location (file, dataset, datatype, or group)
+// Param name - IN: Name of the datatype
+// Exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Jan, 2007
+// Modification
+// Planned for removal. -BMR, 2014/04/16
+// Removed from documentation. -BMR, 2016/03/07
//--------------------------------------------------------------------------
void DataType::commit(H5Location& loc, const char* name)
{
@@ -329,13 +332,16 @@ void DataType::commit(const H5Location& loc, const H5std_string& name)
//--------------------------------------------------------------------------
// Function: DataType::commit
-///\brief This is an overloaded member function, kept for backward
-/// compatibility. It differs from the above function in that it
-/// misses const's. This wrapper will be removed in future release.
-///\param loc - IN: A location (file, dataset, datatype, or group)
-///\param name - IN: Name of the datatype
-///\exception H5::DataTypeIException
+// Purpose This is an overloaded member function, kept for backward
+// compatibility. It differs from the above function in that it
+// misses const's. This wrapper will be removed in future release.
+// Param loc - IN: A location (file, dataset, datatype, or group)
+// Param name - IN: Name of the datatype
+// Exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Jan, 2007
+// Modification
+// Planned for removal. -BMR, 2014/04/16
+// Removed from documentation. -BMR, 2016/03/07
//--------------------------------------------------------------------------
void DataType::commit(H5Location& loc, const H5std_string& name)
{