From d259d6e0ab00c75c00a9e7ec65cae4e918a2fc3c Mon Sep 17 00:00:00 2001 From: Binh-Minh Ribler Date: Fri, 11 Apr 2014 20:04:47 -0500 Subject: [svn-r25020] Description: - Fixed a few comments that Doxygen gave warnings on. - Removed stylesheet from configuration so Doxygen will use the default stylesheet and removed the CLANG-related lines to eliminate another error since we're not using that feature, so the lines should not present. (from cpp_doc_config) Platforms tested: Linux/32 2.6 (jam) - only changing comments --- c++/src/H5Attribute.cpp | 2 ++ c++/src/H5CommonFG.h | 2 +- c++/src/H5DxferProp.cpp | 2 +- c++/src/H5File.cpp | 26 +++++++++++++------------- c++/src/H5Group.cpp | 2 ++ c++/src/H5Location.cpp | 2 ++ c++/src/header_files/hdf_logo.jpg | Bin 0 -> 1964 bytes c++/src/header_files/help.jpg | Bin 0 -> 3280 bytes 8 files changed, 21 insertions(+), 15 deletions(-) create mode 100644 c++/src/header_files/hdf_logo.jpg create mode 100644 c++/src/header_files/help.jpg diff --git a/c++/src/H5Attribute.cpp b/c++/src/H5Attribute.cpp index 4625c2c..204535e 100644 --- a/c++/src/H5Attribute.cpp +++ b/c++/src/H5Attribute.cpp @@ -566,6 +566,7 @@ void Attribute::p_read_variable_len(const DataType& mem_type, H5std_string& strg HDfree(strg_C); } +#ifndef DOXYGEN_SHOULD_SKIP_THIS //-------------------------------------------------------------------------- // Function: Attribute::p_setId ///\brief Sets the identifier of this object to a new value. @@ -590,6 +591,7 @@ void Attribute::p_setId(const hid_t new_id) // reset object's id to the given id id = new_id; } +#endif // DOXYGEN_SHOULD_SKIP_THIS //-------------------------------------------------------------------------- // Function: Attribute::close diff --git a/c++/src/H5CommonFG.h b/c++/src/H5CommonFG.h index 9275342..4cb366f 100644 --- a/c++/src/H5CommonFG.h +++ b/c++/src/H5CommonFG.h @@ -27,7 +27,7 @@ class ArrayType; class VarLenType; /*! \class CommonFG - \brief \i CommonFG is an abstract base class of H5File and H5Group. + \brief \a CommonFG is an abstract base class of H5File and H5Group. It provides common operations of H5File and H5Group. */ diff --git a/c++/src/H5DxferProp.cpp b/c++/src/H5DxferProp.cpp index c58eeda..1f4a638 100644 --- a/c++/src/H5DxferProp.cpp +++ b/c++/src/H5DxferProp.cpp @@ -229,7 +229,7 @@ void DSetMemXferPropList::setDataTransform(const H5std_string& expression) const //-------------------------------------------------------------------------- // Function: DSetMemXferPropList::getDataTransform ///\brief Sets data transform expression. -///\param expression - OUT: buffer for data transform expression (char*) +///\param exp - OUT: buffer for data transform expression (char*) ///\param buf_size - IN: size of buffer for expression, including the /// null terminator ///\exception H5::PropListIException diff --git a/c++/src/H5File.cpp b/c++/src/H5File.cpp index c3a7e71..9669aa7 100644 --- a/c++/src/H5File.cpp +++ b/c++/src/H5File.cpp @@ -493,19 +493,6 @@ hsize_t H5File::getFileSize() const } //-------------------------------------------------------------------------- -// Function: H5File::getLocId -// Purpose: Get the id of this file -// Description -// This function is a redefinition of CommonFG::getLocId. It -// is used by CommonFG member functions to get the file id. -// Programmer Binh-Minh Ribler - 2000 -//-------------------------------------------------------------------------- -hid_t H5File::getLocId() const -{ - return( getId() ); -} - -//-------------------------------------------------------------------------- // Function: H5File::getId ///\brief Get the id of this file ///\return File identifier @@ -524,6 +511,19 @@ hid_t H5File::getId() const #ifndef DOXYGEN_SHOULD_SKIP_THIS //-------------------------------------------------------------------------- +// Function: H5File::getLocId +// Purpose: Get the id of this file +// Description +// This function is a redefinition of CommonFG::getLocId. It +// is used by CommonFG member functions to get the file id. +// Programmer Binh-Minh Ribler - 2000 +//-------------------------------------------------------------------------- +hid_t H5File::getLocId() const +{ + return( getId() ); +} + +//-------------------------------------------------------------------------- // Function: H5File::reopen // Purpose: Reopens this file. // Exception H5::FileIException diff --git a/c++/src/H5Group.cpp b/c++/src/H5Group.cpp index 5d5b124..7679315 100644 --- a/c++/src/H5Group.cpp +++ b/c++/src/H5Group.cpp @@ -93,6 +93,7 @@ Group::Group(const hid_t existing_id) : H5Object() ///\param loc - IN: Specifying location referenced object is in ///\param ref - IN: Reference pointer ///\param ref_type - IN: Reference type - default to H5R_OBJECT +///\param plist - IN: Property list - default to PropList::DEFAULT ///\exception H5::ReferenceException ///\par Description /// \c obj can be DataSet, Group, or named DataType, that @@ -110,6 +111,7 @@ Group::Group(const H5Location& loc, const void* ref, H5R_type_t ref_type, const ///\param attr - IN: Specifying location where the referenced object is in ///\param ref - IN: Reference pointer ///\param ref_type - IN: Reference type - default to H5R_OBJECT +///\param plist - IN: Property list - default to PropList::DEFAULT ///\exception H5::ReferenceException // Programmer Binh-Minh Ribler - Oct, 2006 //-------------------------------------------------------------------------- diff --git a/c++/src/H5Location.cpp b/c++/src/H5Location.cpp index 5743875..9d3d7bf 100644 --- a/c++/src/H5Location.cpp +++ b/c++/src/H5Location.cpp @@ -700,6 +700,8 @@ void H5Location::reference(void* ref, const H5std_string& name, H5R_type_t ref_t // referenced object // ref - IN: Reference pointer // ref_type - IN: Reference type +// plist - IN: Property list - default to PropList::DEFAULT +// from_func - IN: Name of the calling function // Exception H5::ReferenceException // Programmer Binh-Minh Ribler - Oct, 2006 // Modification diff --git a/c++/src/header_files/hdf_logo.jpg b/c++/src/header_files/hdf_logo.jpg new file mode 100644 index 0000000..2770aa4 Binary files /dev/null and b/c++/src/header_files/hdf_logo.jpg differ diff --git a/c++/src/header_files/help.jpg b/c++/src/header_files/help.jpg new file mode 100644 index 0000000..f30550a Binary files /dev/null and b/c++/src/header_files/help.jpg differ -- cgit v0.12