From 4b3ebf1646df8a613d53dad96f82eb0bb68f0aa2 Mon Sep 17 00:00:00 2001
From: Binh-Minh Ribler <bmribler@hdfgroup.org>
Date: Sat, 7 Aug 2004 00:41:24 -0500
Subject: [svn-r9045] Purpose: Updated documentation

Description:
    Added mainpage to the RM via the new file H5CppDoc.h.

Platforms tested:
    SunOS 5.7 (arabica)
    Linux 2.4 (verbena)
    This new file will be added to windows project soon.

Misc. update:
---
 c++/src/H5CppDoc.h | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 c++/src/H5CppDoc.h

diff --git a/c++/src/H5CppDoc.h b/c++/src/H5CppDoc.h
new file mode 100644
index 0000000..daa5236
--- /dev/null
+++ b/c++/src/H5CppDoc.h
@@ -0,0 +1,69 @@
+// C++ informative line for the emacs editor: -*- C++ -*-
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+  * Copyright by the Board of Trustees of the University of Illinois.         *
+  * All rights reserved.                                                      *
+  *                                                                           *
+  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
+  * terms governing use, modification, and redistribution, is contained in    *
+  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
+  * of the source code distribution tree; Copyright.html can be found at the  *
+  * root level of an installed copy of the electronic HDF5 document set and   *
+  * is linked from the top-level documents page.  It can also be found at     *
+  * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
+  * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
+  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+#ifndef _H5CPPDOC_H
+#define _H5CPPDOC_H
+
+//-------------------------------------------------------------------------
+// The following section will be used to generate the 'Mainpage' 
+// and the 'Examples' for the RM.
+// ------------------------------------------------------------------------
+
+/*! \mainpage notitle
+ *
+ * \section intro_sec Introduction
+ *
+ * The C++ API provides C++ wrappers for the HDF5 C library.
+ * It is assumed that the user has knowledge of the HDF5 file format 
+ * and its components.  If you are not familiar with HDF5 file format,
+ * and would like to find out more, please refer to the HDF5 documentation
+ * at http://hdf.ncsa.uiuc.edu/HDF5/doc/H5.intro.html
+ *
+ * Because the HDF5 library maps very well to 
+ * the object oriented design approach, classes in the C++ API can 
+ * closely represent the interfaces of the HDF5 APIs, as followed:
+ * 
+ * \verbatim
+ 	HDF5 C APIs				C++ Classes
+ 	-----------				-----------
+ 	Attribute Interface (H5A)		Attribute
+ 	Datasets Interface (H5D)		DataSet
+ 	Error Interface (H5E)			Exception
+ 	File Interface (H5F)			H5File
+ 	Group Interface (H5G)			Group
+ 	Identifier Interface (H5I)		IdComponent
+ 	Property List Interface (H5P)		PropList
+ 	Reference Interface (H5R)		Reference
+ 	Dataspace Interface (H5S)		DataSpace
+ 	Datatype Interface (H5T)		DataType
+  \endverbatim
+ * \section install_sec Installation
+ *
+ * Please refer to the file release_docs/INSTALL
+ * under the top directory for information about installing, building,
+ * and testing the C++ API.
+ *
+ *  
+ */
+
+///\par Dataset example:
+///   This example shows how to create datasets.
+///\example     create.cpp
+
+///\par Another example:
+///   This example shows how to write datasets.
+///\example     writedata.cpp
+
+#endif
-- 
cgit v0.12