summaryrefslogtreecommitdiffstats
path: root/c++/src/H5DataType.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2013-10-15 05:31:20 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2013-10-15 05:31:20 (GMT)
commit370e6f3f56bafa13c19eaa292a16929a8b918120 (patch)
treeed45d5ac11273900605e3f7fb8457acef5932cca /c++/src/H5DataType.h
parent82beeef27243f1bcbbeb45631bc4ba6c510b6c92 (diff)
downloadhdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.zip
hdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.tar.gz
hdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.tar.bz2
[svn-r24291] Description:
- Added a lot of documentation to classes for Reference Manual. - Fixed some format inconsistencies Platforms tested: Linux/ppc64 (ostrich) Linux/32 2.6 (jam) Linux/64 2.6 (koala)/PGI compilers
Diffstat (limited to 'c++/src/H5DataType.h')
-rw-r--r--c++/src/H5DataType.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/c++/src/H5DataType.h b/c++/src/H5DataType.h
index 104eed4..c5c8a7d 100644
--- a/c++/src/H5DataType.h
+++ b/c++/src/H5DataType.h
@@ -21,6 +21,13 @@
namespace H5 {
#endif
+/*! \class DataType
+ \brief Class DataType provides generic operations on HDF5 datatypes.
+
+ DataType inherits from H5Object because a named datatype is an HDF5
+ object and is a base class of ArrayType, AtomType, CompType, EnumType,
+ and VarLenType.
+*/
class H5_DLLCPP DataType : public H5Object {
public:
// Creates a datatype given its class and size
@@ -47,10 +54,8 @@ class H5_DLLCPP DataType : public H5Object {
// Commits a transient datatype to a file; this datatype becomes
// a named datatype which can be accessed from the location.
- void commit( H5File& loc, const char* name);
- void commit( H5File& loc, const H5std_string& name);
- void commit( H5Object& loc, const char* name);
- void commit( H5Object& loc, const H5std_string& name);
+ void commit(H5Location& loc, const char* name);
+ void commit(H5Location& loc, const H5std_string& name);
// Determines whether this datatype is a named datatype or
// a transient datatype.