summaryrefslogtreecommitdiffstats
path: root/c++/src/H5Location.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/H5Location.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/H5Location.h')
-rw-r--r--c++/src/H5Location.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/c++/src/H5Location.h b/c++/src/H5Location.h
index 1c0f26f..b93c71e 100644
--- a/c++/src/H5Location.h
+++ b/c++/src/H5Location.h
@@ -20,7 +20,16 @@
#include "H5Classes.h" // constains forward class declarations
namespace H5 {
+/*! \class H5Location
+ \brief H5Location is an abstract base class, added in version 1.8.12.
+
+ It provides a collection of wrappers for the C functions that take a
+ location identifier to specify the HDF5 object. The location identifier
+ can be either file, group, dataset, attribute, or named datatype.
+ Wrappers for H5A functions stay in H5Object.
+ Inheritance: IdComponent
+*/
class H5_DLLCPP H5Location; // forward declaration for UserData4Aiterate
// Define the operator function pointer for H5Aiterate().
@@ -169,7 +178,7 @@ class H5_DLLCPP H5Location : public IdComponent {
// Noop destructor.
virtual ~H5Location();
-}; /* end class H5Location */
+}; // end of H5Location
+} // namespace H5
-}
#endif // __H5Location_H