summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2005-05-29 22:26:56 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2005-05-29 22:26:56 (GMT)
commit3c48d3637b4c742dc960bb641efc8681686a90d3 (patch)
tree7f45d59a7ad884440bd03d85923918494c3e3bef
parente5e38a376000cd84b683d88310c2bb80514ffd6d (diff)
downloadhdf5-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
-rw-r--r--c++/src/H5Attribute.cpp3
-rw-r--r--c++/src/H5CompType.cpp1
-rw-r--r--c++/src/H5DataSet.cpp1
-rw-r--r--c++/src/H5DataSpace.cpp4
-rw-r--r--c++/src/H5DataType.cpp2
-rw-r--r--c++/src/H5DcreatProp.cpp2
-rw-r--r--c++/src/H5DxferProp.cpp2
-rw-r--r--c++/src/H5FaccProp.cpp2
-rw-r--r--c++/src/H5FcreatProp.cpp2
-rw-r--r--c++/src/H5File.cpp45
-rw-r--r--c++/src/H5Group.cpp1
-rw-r--r--c++/src/H5IdComponent.cpp1
-rw-r--r--c++/src/H5Library.cpp4
-rw-r--r--c++/src/H5PropList.cpp2
14 files changed, 52 insertions, 20 deletions
diff --git a/c++/src/H5Attribute.cpp b/c++/src/H5Attribute.cpp
index f97c29f..515415d 100644
--- a/c++/src/H5Attribute.cpp
+++ b/c++/src/H5Attribute.cpp
@@ -258,7 +258,8 @@ string Attribute::getName() const
//--------------------------------------------------------------------------
// Function: Attribute::close
-///\brief: Closes this attribute.
+///\brief Closes this attribute.
+///
///\exception H5::AttributeIException
// Programmer Binh-Minh Ribler - Mar 9, 2005
//--------------------------------------------------------------------------
diff --git a/c++/src/H5CompType.cpp b/c++/src/H5CompType.cpp
index dfc357b..2991f10 100644
--- a/c++/src/H5CompType.cpp
+++ b/c++/src/H5CompType.cpp
@@ -384,6 +384,7 @@ void CompType::insertMember( const string& name, size_t offset, const DataType&
//--------------------------------------------------------------------------
// Function: CompType::pack
///\brief Recursively removes padding from within a compound datatype.
+///
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
diff --git a/c++/src/H5DataSet.cpp b/c++/src/H5DataSet.cpp
index 4cb84e9..899155d 100644
--- a/c++/src/H5DataSet.cpp
+++ b/c++/src/H5DataSet.cpp
@@ -477,6 +477,7 @@ DataSpace DataSet::getRegion(void *ref, H5R_type_t ref_type) const
//--------------------------------------------------------------------------
// Function: DataSet::close
///\brief Closes this dataset.
+///
///\exception H5::DataSetIException
// Programmer Binh-Minh Ribler - Mar 9, 2005
//--------------------------------------------------------------------------
diff --git a/c++/src/H5DataSpace.cpp b/c++/src/H5DataSpace.cpp
index 9936f93..a2d1a4e 100644
--- a/c++/src/H5DataSpace.cpp
+++ b/c++/src/H5DataSpace.cpp
@@ -297,6 +297,7 @@ void DataSpace::setExtentSimple( int rank, const hsize_t *current_size, const hs
//--------------------------------------------------------------------------
// Function: DataSpace::setExtentNone
///\brief Removes the extent from a dataspace.
+///
///\exception H5::DataSpaceIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
@@ -460,6 +461,7 @@ void DataSpace::selectElements ( H5S_seloper_t op, const size_t num_elements, co
//--------------------------------------------------------------------------
// Function: DataSpace::selectAll
///\brief Selects the entire dataspace.
+///
///\exception H5::DataSpaceIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
@@ -475,6 +477,7 @@ void DataSpace::selectAll () const
//--------------------------------------------------------------------------
// Function: DataSpace::selectNone
///\brief Resets the selection region to include no elements.
+///
///\exception H5::DataSpaceIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
@@ -540,6 +543,7 @@ void DataSpace::selectHyperslab( H5S_seloper_t op, const hsize_t *count, const h
//--------------------------------------------------------------------------
// Function: DataSpace::close
///\brief Closes this dataspace.
+///
///\exception H5::DataSpaceIException
// Programmer Binh-Minh Ribler - Mar 9, 2005
//--------------------------------------------------------------------------
diff --git a/c++/src/H5DataType.cpp b/c++/src/H5DataType.cpp
index c6e7560..6e5d584 100644
--- a/c++/src/H5DataType.cpp
+++ b/c++/src/H5DataType.cpp
@@ -267,6 +267,7 @@ void DataType::convert( const DataType& dest, size_t nelmts, void *buf, void *ba
//--------------------------------------------------------------------------
// Function: DataType::lock
///\brief Locks a datatype, making it read-only and non-destructible.
+///
///\exception H5::DataTypeIException
///\par Descrition
/// This is normally done by the library for predefined data
@@ -600,6 +601,7 @@ DataSpace DataType::getRegion(void *ref, H5R_type_t ref_type) const
//--------------------------------------------------------------------------
// Function: DataType::close
///\brief Closes the datatype if it is not a predefined type.
+///
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Mar 9, 2005
//--------------------------------------------------------------------------
diff --git a/c++/src/H5DcreatProp.cpp b/c++/src/H5DcreatProp.cpp
index 8379b57..b5e7288 100644
--- a/c++/src/H5DcreatProp.cpp
+++ b/c++/src/H5DcreatProp.cpp
@@ -428,6 +428,7 @@ bool DSetCreatPropList::allFiltersAvail()
//--------------------------------------------------------------------------
// Function: DSetCreatPropList::setShuffle
///\brief Sets method of the shuffle filter
+///
///\exception H5::PropListIException
///\par Description
/// Please refer to the Reference Manual of \c H5Pset_shuffle for
@@ -543,6 +544,7 @@ void DSetCreatPropList::setFillTime(H5D_fill_time_t fill_time)
//--------------------------------------------------------------------------
// Function: DSetCreatPropList::setFletcher32
///\brief Sets Fletcher32 checksum of EDC for this property list.
+///
///\exception H5::PropListIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
diff --git a/c++/src/H5DxferProp.cpp b/c++/src/H5DxferProp.cpp
index 602246a..14cdbd9 100644
--- a/c++/src/H5DxferProp.cpp
+++ b/c++/src/H5DxferProp.cpp
@@ -235,6 +235,7 @@ void DSetMemXferPropList::setVlenMemManager( H5MM_allocate_t alloc_func, void* a
// Function: DSetMemXferPropList::setVlenMemManager
///\brief Sets the memory manager for variable-length datatype
/// allocation - system \c malloc and \c free will be used.
+///
///\exception H5::PropListIException
// Programmer: Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
@@ -342,6 +343,7 @@ hsize_t DSetMemXferPropList::getSmallDataBlockSize()
//--------------------------------------------------------------------------
// Function: DSetMemXferPropList::setHyperVectorSize
///\brief Sets number of I/O vectors to be read/written in hyperslab I/O.
+///
///\exception H5::PropListIException
///\par Description
/// For information, please refer to the C layer Reference
diff --git a/c++/src/H5FaccProp.cpp b/c++/src/H5FaccProp.cpp
index 3e8446a..ec7d7be 100644
--- a/c++/src/H5FaccProp.cpp
+++ b/c++/src/H5FaccProp.cpp
@@ -55,6 +55,7 @@ FileAccPropList::FileAccPropList(const hid_t plist_id) : PropList(plist_id) {}
//--------------------------------------------------------------------------
// Function: FileAccPropList::setStdio
///\brief Modifies this property list to use the \c H5FD_STDIO driver.
+///
///\exception H5::PropListIException
// Programmer: Binh-Minh Ribler - April, 2004
//--------------------------------------------------------------------------
@@ -449,6 +450,7 @@ void FileAccPropList::setLog(const string& logfile, unsigned flags, size_t buf_s
// Function: FileAccPropList::setSec2
///\brief Modifies this file access property list to use the sec2
/// driver.
+///
///\exception H5::PropListIException
// Programmer: Binh-Minh Ribler - April, 2004
//--------------------------------------------------------------------------
diff --git a/c++/src/H5FcreatProp.cpp b/c++/src/H5FcreatProp.cpp
index 7d1d228..7cafd52 100644
--- a/c++/src/H5FcreatProp.cpp
+++ b/c++/src/H5FcreatProp.cpp
@@ -142,6 +142,7 @@ void FileCreatPropList::setSizes( size_t sizeof_addr, size_t sizeof_size ) const
// Function: FileCreatPropList::getSizes
///\brief Retrieves the size of the offsets and lengths used in an
/// HDF5 file.
+///
///\exception H5::PropListIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
@@ -181,6 +182,7 @@ void FileCreatPropList::setSymk( unsigned ik, unsigned lk ) const
// Function: FileCreatPropList::getSymk
///\brief Retrieves the size of the symbol table B-tree 1/2 rank and
/// the symbol table leaf node 1/2 size.
+///
///\exception H5::PropListIException
///\par Description
/// For information, please see
diff --git a/c++/src/H5File.cpp b/c++/src/H5File.cpp
index 9a50ca7..1025c41 100644
--- a/c++/src/H5File.cpp
+++ b/c++/src/H5File.cpp
@@ -176,6 +176,7 @@ bool H5File::isHdf5(const string& name )
//--------------------------------------------------------------------------
// Function: H5File::reOpen
///\brief Reopens this file.
+///
///\exception H5::FileIException
// Description
// If this object has represented another HDF5 file, the previous
@@ -208,6 +209,7 @@ void H5File::reOpen()
//--------------------------------------------------------------------------
// Function: H5File::reopen
///\brief Reopens this file.
+///
///\exception H5::FileIException
///\par Description
/// This function will be replaced by the above function \c reOpen
@@ -293,14 +295,16 @@ hssize_t H5File::getFreeSpace() const
///\return Number of opened object IDs
///\exception H5::FileIException
///\par Description
-/// The valid values for \a types include:
-/// \li \c H5F_OBJ_FILE Files only
-/// \li \c H5F_OBJ_DATASET Datasets only
-/// \li \c H5F_OBJ_GROUP Groups only
-/// \li \c H5F_OBJ_DATATYPE Named datatypes only
-/// \li \c H5F_OBJ_ATTR Attributes only
-/// \li \c H5F_OBJ_ALL All of the above
-/// \li \c (i.e., H5F_OBJ_FILE | H5F_OBJ_DATASET | H5F_OBJ_GROUP | H5F_OBJ_DATATYPE | H5F_OBJ_ATTR )
+/// The valid values for \a types include:
+/// \li \c H5F_OBJ_FILE - Files only
+/// \li \c H5F_OBJ_DATASET - Datasets only
+/// \li \c H5F_OBJ_GROUP - Groups only
+/// \li \c H5F_OBJ_DATATYPE - Named datatypes only
+/// \li \c H5F_OBJ_ATTR - Attributes only
+/// \li \c H5F_OBJ_ALL - All of the above, i.e., \c H5F_OBJ_FILE
+/// | \c H5F_OBJ_DATASET | \c H5F_OBJ_GROUP
+/// | \c H5F_OBJ_DATATYPE | \c H5F_OBJ_ATTR
+///\par
/// Multiple object types can be combined with the logical OR operator (|).
// Programmer Binh-Minh Ribler - May 2004
//--------------------------------------------------------------------------
@@ -343,14 +347,16 @@ int H5File::getObjCount() const
///\param oid_list - List of open object identifiers
///\exception H5::FileIException
///\par Description
-/// The valid values for \a types include:
-/// \li \c H5F_OBJ_FILE Files only
-/// \li \c H5F_OBJ_DATASET Datasets only
-/// \li \c H5F_OBJ_GROUP Groups only
-/// \li \c H5F_OBJ_DATATYPE Named datatypes only
-/// \li \c H5F_OBJ_ATTR Attributes only
-/// \li \c H5F_OBJ_ALL All of the above
-/// \li \c (I.e., H5F_OBJ_FILE | H5F_OBJ_DATASET | H5F_OBJ_GROUP | H5F_OBJ_DATATYPE | H5F_OBJ_ATTR )
+/// The valid values for \a types include:
+/// \li \c H5F_OBJ_FILE - Files only
+/// \li \c H5F_OBJ_DATASET - Datasets only
+/// \li \c H5F_OBJ_GROUP - Groups only
+/// \li \c H5F_OBJ_DATATYPE - Named datatypes only
+/// \li \c H5F_OBJ_ATTR - Attributes only
+/// \li \c H5F_OBJ_ALL - All of the above, i.e., \c H5F_OBJ_FILE
+/// | \c H5F_OBJ_DATASET | \c H5F_OBJ_GROUP
+/// | \c H5F_OBJ_DATATYPE | \c H5F_OBJ_ATTR
+///\par
/// Multiple object types can be combined with the logical OR operator (|).
//
// Notes: will do the overload for this one after hearing from Quincey???
@@ -374,10 +380,10 @@ void H5File::getObjIDs(unsigned types, int max_objs, hid_t *oid_list) const
/// the low-level virtual file driver
///\exception H5::FileIException
///\par Description
-/// For the FAMILY or MULTI drivers, \a fapl should be
+/// For the \c FAMILY or \c MULTI drivers, \a fapl should be
/// defined through the property list functions:
-/// \c FileAccPropList::setFamilyOffset for the FAMILY driver
-/// and \c FileAccPropList::setMultiType for the MULTI driver.
+/// \c FileAccPropList::setFamilyOffset for the \c FAMILY driver
+/// and \c FileAccPropList::setMultiType for the \c MULTI driver.
///
/// The obtained file handle is dynamic and is valid only while
/// the file remains open; it will be invalid if the file is
@@ -534,6 +540,7 @@ hid_t H5File::getLocId() const
//--------------------------------------------------------------------------
// Function: H5File::close
///\brief Closes this HDF5 file.
+///
///\exception H5::FileIException
// Programmer Binh-Minh Ribler - Mar 9, 2005
//--------------------------------------------------------------------------
diff --git a/c++/src/H5Group.cpp b/c++/src/H5Group.cpp
index 22dad7b..50bc87f 100644
--- a/c++/src/H5Group.cpp
+++ b/c++/src/H5Group.cpp
@@ -144,6 +144,7 @@ DataSpace Group::getRegion(void *ref, H5R_type_t ref_type) const
//--------------------------------------------------------------------------
// Function: Group::close
///\brief Closes this group.
+///
///\exception H5::GroupIException
// Programmer Binh-Minh Ribler - Mar 9, 2005
//--------------------------------------------------------------------------
diff --git a/c++/src/H5IdComponent.cpp b/c++/src/H5IdComponent.cpp
index 4d7841c..e4c5305 100644
--- a/c++/src/H5IdComponent.cpp
+++ b/c++/src/H5IdComponent.cpp
@@ -103,6 +103,7 @@ IdComponent& IdComponent::operator=( const IdComponent& rhs )
//--------------------------------------------------------------------------
// Function: IdComponent::setId
///\brief Sets the identifier of this object to a new value.
+///
///\exception H5::IdComponentException when the attempt to close the HDF5
/// object fails
// Description:
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
diff --git a/c++/src/H5PropList.cpp b/c++/src/H5PropList.cpp
index 3c8b70c..11595f4 100644
--- a/c++/src/H5PropList.cpp
+++ b/c++/src/H5PropList.cpp
@@ -163,6 +163,7 @@ void PropList::copyProp( PropList& dest, PropList& src, const string& name ) con
//--------------------------------------------------------------------------
// Function: PropList::close
///\brief Closes the property list if it is not a default one.
+///
///\exception H5::PropListIException
// Programmer Binh-Minh Ribler - Mar 9, 2005
//--------------------------------------------------------------------------
@@ -243,6 +244,7 @@ bool PropList::propExist(const string& name ) const
//--------------------------------------------------------------------------
// Function: PropList::closeClass
///\brief Close a property list class.
+///
///\exception H5::PropListIException
///\par Description
/// Releases memory and detaches a class from the property