diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2006-01-28 03:03:36 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2006-01-28 03:03:36 (GMT) |
| commit | 4110e9f1a9749497129a696234c292209823c750 (patch) | |
| tree | 017ea80b6a75e8d7a841bc1226b612f7bc1ae03d /release_docs/INSTALL | |
| parent | 4ae6106b6ad6e6771e735565755fb43bb88fa271 (diff) | |
| download | hdf5-4110e9f1a9749497129a696234c292209823c750.zip hdf5-4110e9f1a9749497129a696234c292209823c750.tar.gz hdf5-4110e9f1a9749497129a696234c292209823c750.tar.bz2 | |
[svn-r11898] Purpose: Adding C++ information
Description:
Added section "6.1 Using the C++ API" for information on how to work
with the C++ API and its Reference Manual.
Diffstat (limited to 'release_docs/INSTALL')
| -rw-r--r-- | release_docs/INSTALL | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/release_docs/INSTALL b/release_docs/INSTALL index a793357..24d5f27 100644 --- a/release_docs/INSTALL +++ b/release_docs/INSTALL @@ -645,5 +645,22 @@ scripts are installed under bin subdirectory when make install is run. +6.1 Using the C++ API + To use the C++ API, one must include the header file H5Cpp.h + in the application. Please refer to the examples in c++/examples + for sample code. + + A doxygen-generated Reference Manual of the C++ API is provided + in the doc/html/cpplus_RM directory. It can be invoked from + index.html. If an updated version or a different format is + desired, users can re-generate this document with Doxygen. + + When running in c++/src, Doxygen will put the generated html + files in doc/html/cpplus_RM. Users may specify a different + location by editing the field OUTPUT_DIRECTORY in the configuration + file c++/src/cpp_doc_config. The field HTML_STYLESHEET specifies + the stylesheet that can be used to change the document layout. + + 7. Support Support is described in the README file. |