diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2018-07-17 06:32:07 (GMT) |
|---|---|---|
| committer | M. Scot Breitenfeld <brtnfld@hdfgroup.org> | 2018-07-26 22:20:12 (GMT) |
| commit | edeac9f067b462e4d7dc8c43413b34c94865e5d4 (patch) | |
| tree | 8d02366b9305c1b6dedd4a787b79e51db400f48c | |
| parent | f706bd0da150c27646fbfeb4812b24a902b6189a (diff) | |
| download | hdf5-edeac9f067b462e4d7dc8c43413b34c94865e5d4.zip hdf5-edeac9f067b462e4d7dc8c43413b34c94865e5d4.tar.gz hdf5-edeac9f067b462e4d7dc8c43413b34c94865e5d4.tar.bz2 | |
Fixed comments
| -rw-r--r-- | c++/src/H5Object.cpp | 19 | ||||
| -rw-r--r-- | c++/src/H5Object.h | 1 |
2 files changed, 14 insertions, 6 deletions
diff --git a/c++/src/H5Object.cpp b/c++/src/H5Object.cpp index 940a7c6..58b34ae 100644 --- a/c++/src/H5Object.cpp +++ b/c++/src/H5Object.cpp @@ -229,8 +229,9 @@ int H5Object::iterateAttrs(attr_operator_t user_op, unsigned *_idx, void *op_dat //-------------------------------------------------------------------------- // Function: H5Object::getInfo ///\brief Returns information about an HDF5 object. -///\return Struct containing the object info -///\exception +///\param objinfo - OUT: Struct containing the object info +///\param fields - IN: Indicates the group of information to be retrieved +/// - default to H5O_INFO_BASIC // July, 2018 //-------------------------------------------------------------------------- void H5Object::getInfo(H5O_info_t& objinfo, unsigned fields) const @@ -247,8 +248,11 @@ void H5Object::getInfo(H5O_info_t& objinfo, unsigned fields) const //-------------------------------------------------------------------------- // Function: H5Object::getInfo ///\brief Returns information about an HDF5 object given its name. -///\return Struct containing the object info -///\exception +///\param name - IN: Name of the object to be queried - \c char * +///\param objinfo - OUT: Struct containing the object info +///\param fields - IN: Indicates the group of information to be retrieved +/// - default to H5O_INFO_BASIC +///\param lapl - IN: Link access property list // July, 2018 //-------------------------------------------------------------------------- void H5Object::getInfo(const char* name, H5O_info_t& objinfo, unsigned fields, const LinkAccPropList& lapl) const @@ -266,8 +270,11 @@ void H5Object::getInfo(const char* name, H5O_info_t& objinfo, unsigned fields, c ///\brief This is an overloaded member function, provided for convenience. /// It differs from the above function in that it takes /// a reference to an \c H5std_string for \a name. -///\return Struct containing the object info -///\exception +///\param name - IN: Name of the object to be queried - \c H5std_string +///\param objinfo - OUT: Struct containing the object info +///\param fields - IN: Indicates the group of information to be retrieved +/// - default to H5O_INFO_BASIC +///\param lapl - IN: Link access property list // July, 2018 //-------------------------------------------------------------------------- void H5Object::getInfo(const H5std_string& name, H5O_info_t& objinfo, unsigned fields, const LinkAccPropList& lapl) const diff --git a/c++/src/H5Object.h b/c++/src/H5Object.h index 606b0ce..f15c8eb 100644 --- a/c++/src/H5Object.h +++ b/c++/src/H5Object.h @@ -94,6 +94,7 @@ class H5_DLLCPP H5Object : public H5Location { // Returns information about an HDF5 object. void getInfo(H5O_info_t& objinfo, unsigned fields = H5O_INFO_BASIC) const; + // Returns information about an HDF5 object, given its name. void getInfo(const char* name, H5O_info_t& objinfo, unsigned fields = H5O_INFO_BASIC, const LinkAccPropList& lapl = LinkAccPropList::DEFAULT) const; void getInfo(const H5std_string& name, H5O_info_t& objinfo, unsigned fields = H5O_INFO_BASIC, const LinkAccPropList& lapl = LinkAccPropList::DEFAULT) const; |