summaryrefslogtreecommitdiffstats
path: root/c++/src/H5CppDoc.h
diff options
context:
space:
mode:
authorMark Evans <evan@hdfgroup.org>2014-06-18 16:10:27 (GMT)
committerMark Evans <evan@hdfgroup.org>2014-06-18 16:10:27 (GMT)
commit471aedb1e85ba6b4c5b829373963c21d77ce0835 (patch)
tree4d55b489de5f9c0349a62f2da8d09a247e09bf54 /c++/src/H5CppDoc.h
parentc194e9c9a790e6da354b84e9d909f3cd43747e27 (diff)
downloadhdf5-471aedb1e85ba6b4c5b829373963c21d77ce0835.zip
hdf5-471aedb1e85ba6b4c5b829373963c21d77ce0835.tar.gz
hdf5-471aedb1e85ba6b4c5b829373963c21d77ce0835.tar.bz2
[svn-r25317] Edited the Introduction section.
Tested: Doxygen and Firefox
Diffstat (limited to 'c++/src/H5CppDoc.h')
-rw-r--r--c++/src/H5CppDoc.h39
1 files changed, 21 insertions, 18 deletions
diff --git a/c++/src/H5CppDoc.h b/c++/src/H5CppDoc.h
index f3ed040..5ba5bd4 100644
--- a/c++/src/H5CppDoc.h
+++ b/c++/src/H5CppDoc.h
@@ -26,28 +26,31 @@
*
* \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://www.hdfgroup.org/HDF5/doc/index.html
+ * The C++ API provides C++ wrappers for the HDF5 C Library.
+ *
+ * It is assumed that the user has knowledge of the
+ * <a href="http://www.hdfgroup.org/HDF5/doc/H5.format.html">
+ * HDF5 file format</a> and its components.
+ * For more information on the HDF5 C Library, see the
+ * <a href="http://www.hdfgroup.org/HDF5/doc/index.html">
+ * HDF5 Software Documentation</a> page.
*
- * Because the HDF5 library maps very well to
+ * Because the HDF5 C 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:
+ * closely represent the interfaces of the C APIs as follows:
*
* \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 and subclasses
- Dataspace Interface (H5S) DataSpace
- Datatype Interface (H5T) DataType and subclasses
+ 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 and subclasses
+ Dataspace Interface (H5S) DataSpace
+ Datatype Interface (H5T) DataType and subclasses
\endverbatim
* \section install_sec Installation
*