[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

1 files changed, 11 insertions, 7 deletions

diff --git a/c++/src/H5File.h b/c++/src/H5File.h
index 830dda0..5fdbcdc 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.
@@ -94,6 +99,12 @@ class H5_DLLCPP H5File : public H5Location, public CommonFG {
 	// H5File destructor.
 	virtual ~H5File();
 
+   protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+	// Sets the HDF5 file id.
+	virtual void p_setId(const hid_t new_id);
+#endif // DOXYGEN_SHOULD_SKIP_THIS
+
    private:
 	hid_t id;	// HDF5 file id
 
@@ -101,13 +112,6 @@ class H5_DLLCPP H5File : public H5Location, public CommonFG {
 	// constructors taking a string or a char*
 	void p_get_file( const char* name, unsigned int flags, const FileCreatPropList& create_plist, const FileAccPropList& access_plist );
 
-   protected:
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-	// Sets the HDF5 file id.
-	virtual void p_setId(const hid_t new_id);
-
-#endif // DOXYGEN_SHOULD_SKIP_THIS
-
 };
 #ifndef H5_NO_NAMESPACE
 }