summaryrefslogtreecommitdiffstats
path: root/c++/src/H5Object.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2017-04-13 05:41:57 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2017-04-13 05:41:57 (GMT)
commitb9ca32f29a59dd0998c649dff64a03ae4d1ab9a7 (patch)
tree4e35a442e01f1d21688088f68cf6d12a390c45e0 /c++/src/H5Object.h
parentbee3ca742946eff20f64e35048dc00429b99e362 (diff)
downloadhdf5-b9ca32f29a59dd0998c649dff64a03ae4d1ab9a7.zip
hdf5-b9ca32f29a59dd0998c649dff64a03ae4d1ab9a7.tar.gz
hdf5-b9ca32f29a59dd0998c649dff64a03ae4d1ab9a7.tar.bz2
Miscellaneous clean-up: format and comments
Platforms tested: Linux/64 (jelly) - very minor
Diffstat (limited to 'c++/src/H5Object.h')
-rw-r--r--c++/src/H5Object.h33
1 files changed, 15 insertions, 18 deletions
diff --git a/c++/src/H5Object.h b/c++/src/H5Object.h
index a30a65f..016f5a2 100644
--- a/c++/src/H5Object.h
+++ b/c++/src/H5Object.h
@@ -20,27 +20,24 @@
#include "H5Location.h"
#include "H5Classes.h" // constains forward class declarations
-// H5Object is a baseclass. It has these subclasses:
-// Group, DataSet, and DataType.
-// DataType, in turn, has several specific datatypes as subclasses.
-// Modification:
-// Sept 18, 2012: Added class H5Location in between IdComponent and
-// H5Object. An H5File now inherits from H5Location. All HDF5
-// wrappers in H5Object are moved up to H5Location. H5Object
-// is left mostly empty for future wrappers that are only for
-// group, dataset, and named datatype. Note that the reason for
-// adding H5Location instead of simply moving H5File to be under
-// H5Object is H5File is not an HDF5 object, and renaming H5Object
-// to H5Location will risk breaking user applications.
-// -BMR
-// Apr 2, 2014: Added wrapper getObjName for H5Iget_name
namespace H5 {
-
/*! \class H5Object
\brief Class H5Object is a bridge between H5Location and DataSet, DataType,
and Group.
- All the wrappers in H5Object were moved to H5Location.
+ Modification:
+ Sept 18, 2012: Added class H5Location in between IdComponent and
+ H5Object. An H5File now inherits from H5Location. All HDF5
+ wrappers in H5Object are moved up to H5Location. H5Object
+ is left mostly empty for future wrappers that are only for
+ group, dataset, and named datatype. Note that the reason for
+ adding H5Location instead of simply moving H5File to be under
+ H5Object is H5File is not an HDF5 object, and renaming H5Object
+ to H5Location will risk breaking user applications.
+ -BMR
+ Apr 2, 2014: Added wrapper getObjName for H5Iget_name
+
+ Inheritance: H5Location -> IdComponent
*/
class H5_DLLCPP H5Object : public H5Location {
public:
@@ -73,7 +70,7 @@ class H5_DLLCPP H5Object : public H5Location {
#endif // DOXYGEN_SHOULD_SKIP_THIS
-}; /* end class H5Object */
+}; // end of H5Object
+} // namespace H5
-}
#endif // __H5Object_H