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/H5File.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/H5File.h')
| -rw-r--r-- | c++/src/H5File.h | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/c++/src/H5File.h b/c++/src/H5File.h index 830dda0..06b4fec 100644 --- a/c++/src/H5File.h +++ b/c++/src/H5File.h @@ -21,6 +21,11 @@ namespace H5 { #endif +/*! \class H5File + \brief Class H5File represents an HDF5 file. + + It inherits from H5Location and CommonFG. +*/ class H5_DLLCPP H5File : public H5Location, public CommonFG { public: // Creates or opens an HDF5 file. @@ -71,7 +76,13 @@ class H5_DLLCPP H5File : public H5Location, public CommonFG { // Reopens this file. void reOpen(); // added for better name - void reopen(); +#ifndef DOXYGEN_SHOULD_SKIP_THIS + void reopen(); // obsolete in favor of reOpen() + + // Gets the file id + virtual hid_t getLocId() const; + +#endif // DOXYGEN_SHOULD_SKIP_THIS ///\brief Returns this class name. virtual H5std_string fromClass () const { return("H5File"); } @@ -79,9 +90,6 @@ class H5_DLLCPP H5File : public H5Location, public CommonFG { // Throw file exception. virtual void throwException(const H5std_string& func_name, const H5std_string& msg) const; - // Gets the file id - virtual hid_t getLocId() const; - // Default constructor H5File(); |