diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2005-05-29 22:26:56 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2005-05-29 22:26:56 (GMT) |
| commit | 3c48d3637b4c742dc960bb641efc8681686a90d3 (patch) | |
| tree | 7f45d59a7ad884440bd03d85923918494c3e3bef /c++/src/H5Library.cpp | |
| parent | e5e38a376000cd84b683d88310c2bb80514ffd6d (diff) | |
| download | hdf5-3c48d3637b4c742dc960bb641efc8681686a90d3.zip hdf5-3c48d3637b4c742dc960bb641efc8681686a90d3.tar.gz hdf5-3c48d3637b4c742dc960bb641efc8681686a90d3.tar.bz2 | |
[svn-r10825] Purpose: Fix RM bug
Description:
Doxygen 1.4.2 has a bug that when an \exception immediately
follows a \brief, the exception will be displayed prominently
in the brief section.
Solution:
Temporarily added /// to after \brief to work around this
problem and notified the Doxygen's author.
Platforms tested:
Linux 2.4 (heping) - only in documentation sections
Diffstat (limited to 'c++/src/H5Library.cpp')
| -rw-r--r-- | c++/src/H5Library.cpp | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/c++/src/H5Library.cpp b/c++/src/H5Library.cpp index ff9a7d1..8c0aace 100644 --- a/c++/src/H5Library.cpp +++ b/c++/src/H5Library.cpp @@ -31,6 +31,7 @@ bool H5Library::need_cleanup = false; //-------------------------------------------------------------------------- // Function: H5Library::open ///\brief Initializes the HDF5 library. +/// ///\exception H5::LibraryIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -46,6 +47,7 @@ void H5Library::open() //-------------------------------------------------------------------------- // Function: H5Library::close ///\brief Flushes all data to disk, closes files, and cleans up memory. +/// ///\exception H5::LibraryIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -61,6 +63,7 @@ void H5Library::close() //-------------------------------------------------------------------------- // Function: H5Library::dontAtExit ///\brief Instructs library not to install \c atexit cleanup routine +/// ///\exception H5::LibraryIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -119,6 +122,7 @@ void H5Library::checkVersion(unsigned majnum, unsigned minnum, unsigned relnum) ///\brief Walks through all the garbage collection routines for the /// library, which are supposed to free any unused memory they /// have allocated. +/// ///\exception H5::LibraryIException ///\par Description /// It is not required that H5Library::garbageCollect be called |