summaryrefslogtreecommitdiffstats
path: root/c++/src/H5File.cpp
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2013-09-16 14:39:52 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2013-09-16 14:39:52 (GMT)
commitafb5fc5c35eaa01b086390ab8691aea49a4a93a4 (patch)
tree2ebf6c586677373ee31a45967952f51809e123d4 /c++/src/H5File.cpp
parent27ed849cad4c7e88a540a34f46e70acde04721da (diff)
downloadhdf5-afb5fc5c35eaa01b086390ab8691aea49a4a93a4.zip
hdf5-afb5fc5c35eaa01b086390ab8691aea49a4a93a4.tar.gz
hdf5-afb5fc5c35eaa01b086390ab8691aea49a4a93a4.tar.bz2
[svn-r24143] Description:
Fixed comments, documentation, and mis-matched DOXYGEN_SHOULD_SKIP_THIS pairs. Platforms tested: Linux/32 2.6 (jam) Regenerated and verified generated documentation.
Diffstat (limited to 'c++/src/H5File.cpp')
-rw-r--r--c++/src/H5File.cpp9
1 files changed, 7 insertions, 2 deletions
diff --git a/c++/src/H5File.cpp b/c++/src/H5File.cpp
index ede7469..65191ae 100644
--- a/c++/src/H5File.cpp
+++ b/c++/src/H5File.cpp
@@ -116,6 +116,7 @@ H5File::H5File( const H5std_string& name, unsigned int flags, const FileCreatPro
}
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// This function is private and contains common code between the
// constructors taking a string or a char*
@@ -146,6 +147,7 @@ void H5File::p_get_file(const char* name, unsigned int flags, const FileCreatPro
}
}
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: H5File copy constructor
@@ -518,7 +520,8 @@ hid_t H5File::getLocId() const
//--------------------------------------------------------------------------
// Function: H5File::getId
-// Purpose: Get the id of this attribute
+///\brief Get the id of this file
+///\return File identifier
// Modification:
// May 2008 - BMR
// Class hierarchy is revised to address bugzilla 1068. Class
@@ -532,8 +535,9 @@ hid_t H5File::getId() const
return(id);
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
-// Function: H5File::p_setId
+// Function: H5File::p_setId (protected)
///\brief Sets the identifier of this object to a new value.
///
///\exception H5::IdComponentException when the attempt to close the HDF5
@@ -556,6 +560,7 @@ void H5File::p_setId(const hid_t new_id)
// reset object's id to the given id
id = new_id;
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: H5File::close