summaryrefslogtreecommitdiffstats
path: root/c++/src/H5StrType.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2016-09-27 04:08:38 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2016-09-27 04:08:38 (GMT)
commite0bf9046c20a1e356e110c03713506261b445182 (patch)
tree3e9f3b24aa6af1bbfb969b2202909794b0af1c50 /c++/src/H5StrType.h
parent3291ceb0eeee73321f814bcb509543b2ccaadaab (diff)
downloadhdf5-e0bf9046c20a1e356e110c03713506261b445182.zip
hdf5-e0bf9046c20a1e356e110c03713506261b445182.tar.gz
hdf5-e0bf9046c20a1e356e110c03713506261b445182.tar.bz2
Purpose: Updated documentation
Description: Revised class brief description and other comments for up-to-date info. Platforms tested: Linux/32 2.6 (jam) Linux/64 (platypus) Darwin (osx1010test)
Diffstat (limited to 'c++/src/H5StrType.h')
-rw-r--r--c++/src/H5StrType.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/c++/src/H5StrType.h b/c++/src/H5StrType.h
index 8b3a773..eac6693 100644
--- a/c++/src/H5StrType.h
+++ b/c++/src/H5StrType.h
@@ -21,7 +21,12 @@
namespace H5 {
#endif
-//! Class StrType operates on HDF5 string datatypes.
+/*! \class StrType
+ \brief StrType is a derivative of a DataType and operates on HDF5
+ string datatype.
+
+ Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
+*/
class H5_DLLCPP StrType : public AtomType {
public:
// Creates a string type using a predefined type