[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
This commit is contained in:
@@ -566,6 +566,7 @@ void Attribute::p_read_variable_len(const DataType& mem_type, H5std_string& strg
|
|||||||
HDfree(strg_C);
|
HDfree(strg_C);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
||||||
//--------------------------------------------------------------------------
|
//--------------------------------------------------------------------------
|
||||||
// Function: Attribute::p_setId
|
// Function: Attribute::p_setId
|
||||||
///\brief Sets the identifier of this object to a new value.
|
///\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
|
// reset object's id to the given id
|
||||||
id = new_id;
|
id = new_id;
|
||||||
}
|
}
|
||||||
|
#endif // DOXYGEN_SHOULD_SKIP_THIS
|
||||||
|
|
||||||
//--------------------------------------------------------------------------
|
//--------------------------------------------------------------------------
|
||||||
// Function: Attribute::close
|
// Function: Attribute::close
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ class ArrayType;
|
|||||||
class VarLenType;
|
class VarLenType;
|
||||||
|
|
||||||
/*! \class CommonFG
|
/*! \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.
|
It provides common operations of H5File and H5Group.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -229,7 +229,7 @@ void DSetMemXferPropList::setDataTransform(const H5std_string& expression) const
|
|||||||
//--------------------------------------------------------------------------
|
//--------------------------------------------------------------------------
|
||||||
// Function: DSetMemXferPropList::getDataTransform
|
// Function: DSetMemXferPropList::getDataTransform
|
||||||
///\brief Sets data transform expression.
|
///\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
|
///\param buf_size - IN: size of buffer for expression, including the
|
||||||
/// null terminator
|
/// null terminator
|
||||||
///\exception H5::PropListIException
|
///\exception H5::PropListIException
|
||||||
|
|||||||
@@ -492,19 +492,6 @@ hsize_t H5File::getFileSize() const
|
|||||||
return (file_size);
|
return (file_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
//--------------------------------------------------------------------------
|
|
||||||
// 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
|
// Function: H5File::getId
|
||||||
///\brief Get the id of this file
|
///\brief Get the id of this file
|
||||||
@@ -523,6 +510,19 @@ hid_t H5File::getId() const
|
|||||||
}
|
}
|
||||||
|
|
||||||
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
#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
|
// Function: H5File::reopen
|
||||||
// Purpose: Reopens this file.
|
// Purpose: Reopens this file.
|
||||||
|
|||||||
@@ -93,6 +93,7 @@ Group::Group(const hid_t existing_id) : H5Object()
|
|||||||
///\param loc - IN: Specifying location referenced object is in
|
///\param loc - IN: Specifying location referenced object is in
|
||||||
///\param ref - IN: Reference pointer
|
///\param ref - IN: Reference pointer
|
||||||
///\param ref_type - IN: Reference type - default to H5R_OBJECT
|
///\param ref_type - IN: Reference type - default to H5R_OBJECT
|
||||||
|
///\param plist - IN: Property list - default to PropList::DEFAULT
|
||||||
///\exception H5::ReferenceException
|
///\exception H5::ReferenceException
|
||||||
///\par Description
|
///\par Description
|
||||||
/// \c obj can be DataSet, Group, or named DataType, that
|
/// \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 attr - IN: Specifying location where the referenced object is in
|
||||||
///\param ref - IN: Reference pointer
|
///\param ref - IN: Reference pointer
|
||||||
///\param ref_type - IN: Reference type - default to H5R_OBJECT
|
///\param ref_type - IN: Reference type - default to H5R_OBJECT
|
||||||
|
///\param plist - IN: Property list - default to PropList::DEFAULT
|
||||||
///\exception H5::ReferenceException
|
///\exception H5::ReferenceException
|
||||||
// Programmer Binh-Minh Ribler - Oct, 2006
|
// Programmer Binh-Minh Ribler - Oct, 2006
|
||||||
//--------------------------------------------------------------------------
|
//--------------------------------------------------------------------------
|
||||||
|
|||||||
@@ -700,6 +700,8 @@ void H5Location::reference(void* ref, const H5std_string& name, H5R_type_t ref_t
|
|||||||
// referenced object
|
// referenced object
|
||||||
// ref - IN: Reference pointer
|
// ref - IN: Reference pointer
|
||||||
// ref_type - IN: Reference type
|
// ref_type - IN: Reference type
|
||||||
|
// plist - IN: Property list - default to PropList::DEFAULT
|
||||||
|
// from_func - IN: Name of the calling function
|
||||||
// Exception H5::ReferenceException
|
// Exception H5::ReferenceException
|
||||||
// Programmer Binh-Minh Ribler - Oct, 2006
|
// Programmer Binh-Minh Ribler - Oct, 2006
|
||||||
// Modification
|
// Modification
|
||||||
|
|||||||
BIN
c++/src/header_files/hdf_logo.jpg
Normal file
BIN
c++/src/header_files/hdf_logo.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.9 KiB |
BIN
c++/src/header_files/help.jpg
Normal file
BIN
c++/src/header_files/help.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.2 KiB |
Reference in New Issue
Block a user