diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-05-28 06:25:56 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-05-28 06:25:56 (GMT) |
| commit | dee9ad2b7e4b4cde4d0b1940089bd772fa2838e6 (patch) | |
| tree | 4a1aa6bd2ff975a50d776a183171ea1b4a44d2f6 /c++/src/H5CommonFG.cpp | |
| parent | 2f4d0aad2417e7ed65bf71f13f5e4f8272315edd (diff) | |
| download | hdf5-dee9ad2b7e4b4cde4d0b1940089bd772fa2838e6.zip hdf5-dee9ad2b7e4b4cde4d0b1940089bd772fa2838e6.tar.gz hdf5-dee9ad2b7e4b4cde4d0b1940089bd772fa2838e6.tar.bz2 | |
[svn-r8595] Purpose:
Add/Improve documentation
Description
Added doxygen documentation to H5PredType.cpp and made minor changes
to the others for either correction or clarification.
Platforms:
SunOS 5.7 (arabica)
Linux 2.4 (eirene)
Misc. update:
Diffstat (limited to 'c++/src/H5CommonFG.cpp')
| -rw-r--r-- | c++/src/H5CommonFG.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/c++/src/H5CommonFG.cpp b/c++/src/H5CommonFG.cpp index 97ce0a1..54009f3 100644 --- a/c++/src/H5CommonFG.cpp +++ b/c++/src/H5CommonFG.cpp @@ -216,7 +216,7 @@ DataSet CommonFG::openDataSet( const string& name ) const //-------------------------------------------------------------------------- // Function: CommonFG::link ///\brief Creates a link of the specified type from \a new_name to -/// \a curr_name; +/// \a curr_name. ///\param link_type - IN: Link type; possible values are /// \li \c H5G_LINK_HARD /// \li \c H5G_LINK_SOFT @@ -374,9 +374,9 @@ string CommonFG::getLinkval( const string& name, size_t size ) const //-------------------------------------------------------------------------- // Function: CommonFG::setComment -///\brief Sets the comment for an object specified by its name. -///\param name - IN: -///\param comment - IN: New comment; +///\brief Sets or resets the comment for an object specified by its name. +///\param name - IN: Name of the object +///\param comment - IN: New comment ///\exception H5::FileIException or H5::GroupIException ///\par Description /// If \a comment is an empty string or a null pointer, the comment @@ -448,7 +448,7 @@ string CommonFG::getComment( const string& name, size_t bufsize ) const //-------------------------------------------------------------------------- // Function: CommonFG::mount -///\brief Mounts the file 'child' onto this group. +///\brief Mounts the file \a child onto this group. ///\param name - IN: Name of the group ///\param child - IN: File to mount ///\param plist - IN: Property list to use |