summaryrefslogtreecommitdiffstats
path: root/c++/src/H5Library.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2013-10-15 05:31:20 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2013-10-15 05:31:20 (GMT)
commit370e6f3f56bafa13c19eaa292a16929a8b918120 (patch)
treeed45d5ac11273900605e3f7fb8457acef5932cca /c++/src/H5Library.h
parent82beeef27243f1bcbbeb45631bc4ba6c510b6c92 (diff)
downloadhdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.zip
hdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.tar.gz
hdf5-370e6f3f56bafa13c19eaa292a16929a8b918120.tar.bz2
[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
Diffstat (limited to 'c++/src/H5Library.h')
-rw-r--r--c++/src/H5Library.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/c++/src/H5Library.h b/c++/src/H5Library.h
index c92a943..e5365f9 100644
--- a/c++/src/H5Library.h
+++ b/c++/src/H5Library.h
@@ -29,6 +29,12 @@ namespace H5 {
// calling H5close
#endif // DOXYGEN_SHOULD_SKIP_THIS
+/*! \class H5Library
+ \brief Class H5Library operates the HDF5 library globably.
+
+ It is not neccessary to construct an instance of H5Library to use the
+ methods.
+*/
class H5_DLLCPP H5Library {
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS