diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2013-10-14 22:05:22 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2013-10-14 22:05:22 (GMT) |
commit | 26713999ba25815466ccc8368322f340c4c45119 (patch) | |
tree | 2f11b788d7e74cebbfe1ae3dd249d2a2d044ae26 /c++/src/H5CommonFG.h | |
parent | 3cb8591786fccaa5b06dd535aa004dceb3bbcc50 (diff) | |
download | hdf5-26713999ba25815466ccc8368322f340c4c45119.zip hdf5-26713999ba25815466ccc8368322f340c4c45119.tar.gz hdf5-26713999ba25815466ccc8368322f340c4c45119.tar.bz2 |
[svn-r24290] 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/H5CommonFG.h')
-rw-r--r-- | c++/src/H5CommonFG.h | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/c++/src/H5CommonFG.h b/c++/src/H5CommonFG.h index 1748d1d..3b20f5c 100644 --- a/c++/src/H5CommonFG.h +++ b/c++/src/H5CommonFG.h @@ -14,10 +14,6 @@ * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -// CommonFG is a protocol class. Its existence is simply to provide the -// common services that are provided by H5File and Group. The file or -// group in the context of this class is referred to as 'location'. - #ifndef __CommonFG_H #define __CommonFG_H @@ -25,10 +21,17 @@ namespace H5 { #endif +// Class forwarding class Group; class H5File; class ArrayType; class VarLenType; + +/*! \class CommonFG + \brief \i CommonFG is an abstract base class of H5File and H5Group. + + It provides common operations of H5File and H5Group. +*/ class H5_DLLCPP CommonFG { public: // Creates a new group at this location which can be a file |