summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2017-09-15 16:46:22 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2017-09-15 16:46:22 (GMT)
commit92193e35bb75f0d18319c03d4fdd6a0b7aad7ab5 (patch)
treee0d5cdab9f5300a9fe4c224c5cbe7a229d128276
parent5cf381597dddc2f551a344a102a4975ea0d373af (diff)
downloadhdf5-92193e35bb75f0d18319c03d4fdd6a0b7aad7ab5.zip
hdf5-92193e35bb75f0d18319c03d4fdd6a0b7aad7ab5.tar.gz
hdf5-92193e35bb75f0d18319c03d4fdd6a0b7aad7ab5.tar.bz2
Miscellaneous code cleanup
Description: - Removed two inadvertently-added Group constructors in the header file. There was no implementation. - Removed deprecated H5Location and H5Object constructors that take an existing ID. - Miscellaneous improvements in comments, including updating URLs. Platforms tested: Linux/32 2.6 (jam) Linux/64 (jelly) Darwin (osx1010test)
-rw-r--r--c++/src/H5ArrayType.h3
-rw-r--r--c++/src/H5AtomType.cpp6
-rw-r--r--c++/src/H5AtomType.h3
-rw-r--r--c++/src/H5Attribute.h3
-rw-r--r--c++/src/H5CompType.h3
-rw-r--r--c++/src/H5CppDoc.h8
-rw-r--r--c++/src/H5DataSet.cpp2
-rw-r--r--c++/src/H5DataSet.h3
-rw-r--r--c++/src/H5DataSpace.cpp8
-rw-r--r--c++/src/H5DataSpace.h3
-rw-r--r--c++/src/H5DataType.cpp2
-rw-r--r--c++/src/H5DataType.h3
-rw-r--r--c++/src/H5DcreatProp.cpp10
-rw-r--r--c++/src/H5DcreatProp.h3
-rw-r--r--c++/src/H5DxferProp.cpp4
-rw-r--r--c++/src/H5DxferProp.h3
-rw-r--r--c++/src/H5EnumType.h3
-rw-r--r--c++/src/H5FaccProp.h3
-rw-r--r--c++/src/H5FcreatProp.h3
-rw-r--r--c++/src/H5File.h3
-rw-r--r--c++/src/H5FloatType.h3
-rw-r--r--c++/src/H5Group.h15
-rw-r--r--c++/src/H5IntType.h3
-rw-r--r--c++/src/H5LaccProp.h3
-rw-r--r--c++/src/H5Location.cpp5
-rw-r--r--c++/src/H5Location.h9
-rw-r--r--c++/src/H5Object.h5
-rw-r--r--c++/src/H5OcreatProp.h5
-rw-r--r--c++/src/H5PredType.h3
-rw-r--r--c++/src/H5PropList.h3
-rw-r--r--c++/src/H5StrType.h3
-rw-r--r--c++/src/H5VarLenType.h5
32 files changed, 51 insertions, 90 deletions
diff --git a/c++/src/H5ArrayType.h b/c++/src/H5ArrayType.h
index e3709cd..5443ae6 100644
--- a/c++/src/H5ArrayType.h
+++ b/c++/src/H5ArrayType.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class ArrayType
\brief Class ArrayType inherits from DataType and provides wrappers for
the HDF5's Array Datatypes.
-
- Inheritance: DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP ArrayType : public DataType {
public:
// Constructor that creates a new array data type based on the
diff --git a/c++/src/H5AtomType.cpp b/c++/src/H5AtomType.cpp
index 9fe7608..5e709af 100644
--- a/c++/src/H5AtomType.cpp
+++ b/c++/src/H5AtomType.cpp
@@ -176,7 +176,7 @@ size_t AtomType::getPrecision() const
///\exception H5::DataTypeIException
///\par Description
/// For information, please see C layer Reference Manuat at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetPrecision
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetPrecision
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void AtomType::setPrecision(size_t precision) const
@@ -196,7 +196,7 @@ void AtomType::setPrecision(size_t precision) const
///\exception H5::DataTypeIException
///\par Description
/// For information, please see C layer Reference Manuat at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetOffset
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetOffset
// Programmer Binh-Minh Ribler - 2000
// Modification
// 12/05/00: due to C API change
@@ -223,7 +223,7 @@ int AtomType::getOffset() const
///\exception H5::DataTypeIException
///\par Description
/// For information, please see C layer Reference Manuat at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetOffset
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetOffset
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void AtomType::setOffset(size_t offset) const
diff --git a/c++/src/H5AtomType.h b/c++/src/H5AtomType.h
index 0be3cb5..7ce66a0 100644
--- a/c++/src/H5AtomType.h
+++ b/c++/src/H5AtomType.h
@@ -23,9 +23,8 @@ namespace H5 {
AtomType provides operations on HDF5 atomic datatypes. It also inherits
from DataType.
-
- Inheritance: DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP AtomType : public DataType {
public:
// Returns the byte order of an atomic datatype.
diff --git a/c++/src/H5Attribute.h b/c++/src/H5Attribute.h
index 41e74d9..823947e 100644
--- a/c++/src/H5Attribute.h
+++ b/c++/src/H5Attribute.h
@@ -24,9 +24,8 @@ namespace H5 {
Attribute and DataSet are derivatives of AbstractDs. Attribute also
inherits from H5Location because an attribute can be used to specify
a location.
-
- Inheritance: multiple H5Location/AbstractDs -> IdComponent
*/
+// Inheritance: multiple H5Location/AbstractDs -> IdComponent
class H5_DLLCPP Attribute : public AbstractDs, public H5Location {
public:
diff --git a/c++/src/H5CompType.h b/c++/src/H5CompType.h
index bf687de..a811b4a 100644
--- a/c++/src/H5CompType.h
+++ b/c++/src/H5CompType.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class CompType
\brief CompType is a derivative of a DataType and operates on HDF5
compound datatypes.
-
- Inheritance: DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP CompType : public DataType {
public:
// Default constructor
diff --git a/c++/src/H5CppDoc.h b/c++/src/H5CppDoc.h
index 543f49b..0fd3a93 100644
--- a/c++/src/H5CppDoc.h
+++ b/c++/src/H5CppDoc.h
@@ -27,10 +27,10 @@
* The C++ API provides C++ wrappers for the HDF5 C Library.
*
* It is assumed that the user has knowledge of the
- * <a href="https://www.hdfgroup.org/HDF5/doc/H5.format.html">
+ * <a href="https://support.hdfgroup.org/HDF5/doc/H5.format.html">
* HDF5 file format</a> and its components.
* For more information on the HDF5 C Library, see the
- * <a href="https://www.hdfgroup.org/HDF5/doc/index.html">
+ * <a href="https://support.hdfgroup.org/HDF5/doc/index.html">
* HDF5 Software Documentation</a> page.
*
* Because the HDF5 C Library maps very well to
@@ -55,8 +55,8 @@
*
* The HDF5 C++ API is included with the HDF5 source code and can
* be obtained from
- * <a href="https://www.hdfgroup.org/HDF5/release/obtainsrc.html">
- * https://www.hdfgroup.org/HDF5/release/obtainsrc.html</a>.
+ * <a href="https://support.hdfgroup.org/HDF5/release/obtainsrc.html">
+ * https://support.hdfgroup.org/HDF5/release/obtainsrc.html</a>.
*
* Please refer to the release_docs/INSTALL file under the top directory
* of the HDF5 source code for information about installing, building,
diff --git a/c++/src/H5DataSet.cpp b/c++/src/H5DataSet.cpp
index dd2fd21..32377bc 100644
--- a/c++/src/H5DataSet.cpp
+++ b/c++/src/H5DataSet.cpp
@@ -580,7 +580,7 @@ int DataSet::iterateElems(void* buf, const DataType& type, const DataSpace& spac
/// For more information, please see the Description section in
/// C layer Reference Manual at:
///\par
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Extend
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Extend
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DataSet::extend(const hsize_t* size) const
diff --git a/c++/src/H5DataSet.h b/c++/src/H5DataSet.h
index 2f3eebe..f9d2ec3 100644
--- a/c++/src/H5DataSet.h
+++ b/c++/src/H5DataSet.h
@@ -23,9 +23,8 @@ namespace H5 {
An datasets has many characteristics similar to an attribute, thus both
Attribute and DataSet are derivatives of AbstractDs. DataSet also
inherits from H5Object because a dataset is an HDF5 object.
-
- Inheritance: multiple H5Object/AbstractDs -> H5Location -> IdComponent
*/
+// Inheritance: multiple H5Object/AbstractDs -> H5Location -> IdComponent
class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
public:
diff --git a/c++/src/H5DataSpace.cpp b/c++/src/H5DataSpace.cpp
index 49b8ea3..379de2f 100644
--- a/c++/src/H5DataSpace.cpp
+++ b/c++/src/H5DataSpace.cpp
@@ -468,7 +468,7 @@ hssize_t DataSpace::getSelectElemNpoints () const
///\par Description
/// For more information, please refer to the C layer Reference
/// Manual at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElemPointList
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElemPointList
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DataSpace::getSelectElemPointlist (hsize_t startpoint, hsize_t numpoints, hsize_t *buf) const
@@ -492,7 +492,7 @@ void DataSpace::getSelectElemPointlist (hsize_t startpoint, hsize_t numpoints, h
///\par Description
/// For more information, please refer to the C layer Reference
/// Manual at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectBounds
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectBounds
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DataSpace::getSelectBounds (hsize_t* start, hsize_t* end) const
@@ -518,7 +518,7 @@ void DataSpace::getSelectBounds (hsize_t* start, hsize_t* end) const
///\par Description
/// For more information, please refer to the C layer Reference
/// Manual at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElements
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElements
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DataSpace::selectElements (H5S_seloper_t op, const size_t num_elements, const hsize_t *coord) const
@@ -600,7 +600,7 @@ bool DataSpace::selectValid () const
///\par Description
/// For more information, please refer to the C layer Reference
/// Manual at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectHyperslab
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectHyperslab
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DataSpace::selectHyperslab(H5S_seloper_t op, const hsize_t *count, const hsize_t *start, const hsize_t *stride, const hsize_t *block) const
diff --git a/c++/src/H5DataSpace.h b/c++/src/H5DataSpace.h
index c0a1d2b..ed141a3 100644
--- a/c++/src/H5DataSpace.h
+++ b/c++/src/H5DataSpace.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class DataSpace
\brief Class DataSpace inherits from IdComponent and provides wrappers for
the HDF5's dataspaces.
-
- Inheritance: IdComponent
*/
+// Inheritance: IdComponent
class H5_DLLCPP DataSpace : public IdComponent {
public:
///\brief Default DataSpace objects
diff --git a/c++/src/H5DataType.cpp b/c++/src/H5DataType.cpp
index 90211b9..d2bfbda 100644
--- a/c++/src/H5DataType.cpp
+++ b/c++/src/H5DataType.cpp
@@ -654,7 +654,7 @@ DataType DataType::getSuper() const
///\exception H5::DataTypeIException
///\par Description
/// For more information, please see:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Register
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Register
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DataType::registerFunc(H5T_pers_t pers, const char* name, const DataType& dest, H5T_conv_t func) const
diff --git a/c++/src/H5DataType.h b/c++/src/H5DataType.h
index 6833a06..5b8f924 100644
--- a/c++/src/H5DataType.h
+++ b/c++/src/H5DataType.h
@@ -23,9 +23,8 @@ namespace H5 {
DataType inherits from H5Object because a named datatype is an HDF5
object and is a base class of ArrayType, AtomType, CompType, EnumType,
and VarLenType.
-
- Inheritance: DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP DataType : public H5Object {
public:
// Creates a datatype given its class and size
diff --git a/c++/src/H5DcreatProp.cpp b/c++/src/H5DcreatProp.cpp
index 67e4a1c..fd3cd17 100644
--- a/c++/src/H5DcreatProp.cpp
+++ b/c++/src/H5DcreatProp.cpp
@@ -159,7 +159,7 @@ int DSetCreatPropList::getChunk(int max_ndims, hsize_t* dim) const
///\exception H5::PropListIException
///\par Description
/// For information on valid layout types, please refer to
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLayout
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLayout
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DSetCreatPropList::setLayout(H5D_layout_t layout) const
@@ -235,7 +235,7 @@ void DSetCreatPropList::setDeflate(int level) const
/// H5Z_FILTER_SZIP, for a dataset. For more information about
/// SZIP and usage, please refer to the C layer Reference
/// Manual at:
-/// http://hdfgroup.org/HDF5/doc/RM_H5P.html#Property-SetSzip
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSzip
// Programmer Binh-Minh Ribler - Jan, 2007
//--------------------------------------------------------------------------
void DSetCreatPropList::setSzip(unsigned int options_mask, unsigned int pixels_per_block) const
@@ -257,7 +257,7 @@ void DSetCreatPropList::setSzip(unsigned int options_mask, unsigned int pixels_p
/// H5Z_FILTER_NBIT, for a dataset. For more information about
/// Nbit compression, please refer to the C layer Reference
/// Manual at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-setNbit
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-setNbit
// Programmer Binh-Minh Ribler - Apr, 2016
//--------------------------------------------------------------------------
void DSetCreatPropList::setNbit() const
@@ -285,7 +285,7 @@ void DSetCreatPropList::setNbit() const
///\par
/// For information on setting fill value, please refer to the
/// C layer Reference Manual at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFillValue
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFillValue
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DSetCreatPropList::setFillValue(const DataType& fvalue_type, const void* value) const
@@ -536,7 +536,7 @@ bool DSetCreatPropList::allFiltersAvail() const
///\par Description
/// Please refer to the Reference Manual of \c H5Pset_shuffle for
/// details.
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetShuffle
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetShuffle
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
void DSetCreatPropList::setShuffle() const
diff --git a/c++/src/H5DcreatProp.h b/c++/src/H5DcreatProp.h
index ebd2678..89318e8 100644
--- a/c++/src/H5DcreatProp.h
+++ b/c++/src/H5DcreatProp.h
@@ -24,9 +24,8 @@ class DataSpace;
/*! \class DSetCreatPropList
\brief Class DSetCreatPropList inherits from ObjCreatPropList and provides
wrappers for the HDF5 dataset creation property functions.
-
- Inheritance: ObjCreatPropList -> PropList -> IdComponent
*/
+// Inheritance: ObjCreatPropList -> PropList -> IdComponent
class H5_DLLCPP DSetCreatPropList : public ObjCreatPropList {
public:
///\brief Default dataset creation property list.
diff --git a/c++/src/H5DxferProp.cpp b/c++/src/H5DxferProp.cpp
index 4c767cb..3a72b28 100644
--- a/c++/src/H5DxferProp.cpp
+++ b/c++/src/H5DxferProp.cpp
@@ -435,7 +435,7 @@ void DSetMemXferPropList::getVlenMemManager(H5MM_allocate_t& alloc_func, void**
///\exception H5::PropListIException
///\par Description
/// For detail, please refer to the C layer Reference Manual at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSmallData
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSmallData
// Programmer Binh-Minh Ribler - April, 2004
//--------------------------------------------------------------------------
void DSetMemXferPropList::setSmallDataBlockSize(hsize_t size) const
@@ -475,7 +475,7 @@ hsize_t DSetMemXferPropList::getSmallDataBlockSize() const
///\par Description
/// For information, please refer to the C layer Reference
/// Manual at:
-/// http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetHyperVectorSize
+/// https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetHyperVectorSize
// Programmer Binh-Minh Ribler - April, 2004
//--------------------------------------------------------------------------
void DSetMemXferPropList::setHyperVectorSize(size_t vector_size) const
diff --git a/c++/src/H5DxferProp.h b/c++/src/H5DxferProp.h
index 4a66671..75205cf 100644
--- a/c++/src/H5DxferProp.h
+++ b/c++/src/H5DxferProp.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class DSetMemXferPropList
\brief Class DSetCreatPropList inherits from PropList and provides
wrappers for the HDF5 dataset memory and transfer property list.
-
- Inheritance: PropList -> IdComponent
*/
+// Inheritance: PropList -> IdComponent
class H5_DLLCPP DSetMemXferPropList : public PropList {
public:
///\brief Default dataset memory and transfer property list.
diff --git a/c++/src/H5EnumType.h b/c++/src/H5EnumType.h
index 6468bf7..e0d5b88 100644
--- a/c++/src/H5EnumType.h
+++ b/c++/src/H5EnumType.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class EnumType
\brief EnumType is a derivative of a DataType and operates on HDF5
enum datatypes.
-
- Inheritance: DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP EnumType : public DataType {
public:
diff --git a/c++/src/H5FaccProp.h b/c++/src/H5FaccProp.h
index 2563163..1df8fc8 100644
--- a/c++/src/H5FaccProp.h
+++ b/c++/src/H5FaccProp.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class FileAccPropList
\brief Class FileAccPropList inherits from PropList and provides
wrappers for the HDF5 file access property list.
-
- Inheritance: PropList -> IdComponent
*/
+// Inheritance: PropList -> IdComponent
class H5_DLLCPP FileAccPropList : public PropList {
public:
///\brief Default file access property list.
diff --git a/c++/src/H5FcreatProp.h b/c++/src/H5FcreatProp.h
index da620d4..31a944c 100644
--- a/c++/src/H5FcreatProp.h
+++ b/c++/src/H5FcreatProp.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class FileCreatPropList
\brief Class FileCreatPropList inherits from PropList and provides
wrappers for the HDF5 file create property list.
-
- Inheritance: PropList -> IdComponent
*/
+// Inheritance: PropList -> IdComponent
class H5_DLLCPP FileCreatPropList : public PropList {
public:
///\brief Default file creation property list.
diff --git a/c++/src/H5File.h b/c++/src/H5File.h
index 0f921ae..214feb0 100644
--- a/c++/src/H5File.h
+++ b/c++/src/H5File.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class H5File
\brief Class H5File represents an HDF5 file and inherits from class Group
as file is a root group.
-
- Inheritance: Group -> CommonFG/H5Object -> H5Location -> IdComponent
*/
+// Inheritance: Group -> CommonFG/H5Object -> H5Location -> IdComponent
class H5_DLLCPP H5File : public Group {
public:
// Creates or opens an HDF5 file.
diff --git a/c++/src/H5FloatType.h b/c++/src/H5FloatType.h
index 4f277c3..d26df5c 100644
--- a/c++/src/H5FloatType.h
+++ b/c++/src/H5FloatType.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class FloatType
\brief FloatType is a derivative of a DataType and operates on HDF5
floating point datatype.
-
- Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP FloatType : public AtomType {
public:
// Creates a floating-point type using a predefined type.
diff --git a/c++/src/H5Group.h b/c++/src/H5Group.h
index e5fa174..b3a9007 100644
--- a/c++/src/H5Group.h
+++ b/c++/src/H5Group.h
@@ -19,23 +19,10 @@ namespace H5 {
/*! \class Group
\brief Class Group represents an HDF5 group.
-
- Inheritance: H5Object -> H5Location -> IdComponent
*/
-// Class forwarding
-class ArrayType;
-class VarLenType;
-
+// Inheritance: CommonFG/H5Object -> H5Location -> IdComponent
class H5_DLLCPP Group : public H5Object, public CommonFG {
public:
- // Group constructor to create a group or file (aka root group).
- Group(const char* name, size_t size_hint = 0);
- Group(const H5std_string& name, size_t size_hint = 0);
-
- // Group constructor to open a group or file (aka root group).
- Group(const char* name);
- Group(const H5std_string& name);
-
// Close this group.
virtual void close();
diff --git a/c++/src/H5IntType.h b/c++/src/H5IntType.h
index 54a4975..a9ebad0 100644
--- a/c++/src/H5IntType.h
+++ b/c++/src/H5IntType.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class IntType
\brief IntType is a derivative of a DataType and operates on HDF5
integer datatype.
-
- Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP IntType : public AtomType {
public:
// Creates an integer type using a predefined type
diff --git a/c++/src/H5LaccProp.h b/c++/src/H5LaccProp.h
index 9772cde..6c86a85 100644
--- a/c++/src/H5LaccProp.h
+++ b/c++/src/H5LaccProp.h
@@ -23,9 +23,8 @@ namespace H5 {
/*! \class LinkAccPropList
\brief Class LinkAccPropList inherits from PropList and provides
wrappers for the HDF5 file access property list.
-
- Inheritance: PropList -> IdComponent
*/
+// Inheritance: PropList -> IdComponent
class H5_DLLCPP LinkAccPropList : public PropList {
public:
///\brief Default file access property list.
diff --git a/c++/src/H5Location.cpp b/c++/src/H5Location.cpp
index 35a4828..a00e181 100644
--- a/c++/src/H5Location.cpp
+++ b/c++/src/H5Location.cpp
@@ -137,7 +137,8 @@ void H5Location::flush(H5F_scope_t scope) const
//--------------------------------------------------------------------------
// Function: H5Location::getFileName
-///\brief Gets the name of the file, in which this HDF5 object belongs.
+///\brief Gets the name of the file, in which an HDF5 object at this
+/// location belongs.
///\return File name
///\exception H5::LocationException
// Programmer Binh-Minh Ribler - Jul, 2004
@@ -557,7 +558,7 @@ void H5Location::dereference(const H5Location& loc, const void* ref, H5R_type_t
/// \li \c H5G_TYPE Object - is a named datatype
/// \li \c H5G_LINK - Object is a symbolic link.
/// \li \c H5G_UDLINK - Object is a user-defined link.
-///\exception H5::LocationException
+///\exception H5::ReferenceException
// Programmer Binh-Minh Ribler - May, 2004
// Modification
// Sep 2012: Moved up from H5File, Group, DataSet, and DataType
diff --git a/c++/src/H5Location.h b/c++/src/H5Location.h
index f9c5a47..2631169 100644
--- a/c++/src/H5Location.h
+++ b/c++/src/H5Location.h
@@ -26,13 +26,8 @@ namespace H5 {
location identifier to specify the HDF5 object. The location identifier
can be either file, group, dataset, attribute, or named datatype.
Wrappers for H5A functions stay in H5Object.
-
- Inheritance: IdComponent
*/
-// Class forwarding
-//class H5_DLLCPP ArrayType;
-//class H5_DLLCPP LinkAccPropList;
-//class H5_DLLCPP VarLenType;
+// Inheritance: IdComponent
class H5_DLLCPP H5Location : public IdComponent {
public:
// Checks if a link of a given name exists in a location
@@ -195,7 +190,7 @@ class H5_DLLCPP H5Location : public IdComponent {
// removal does not raise any problems in two 1.10 releases.
// Creates a copy of an existing object giving the location id.
- H5Location(const hid_t loc_id);
+ // H5Location(const hid_t loc_id);
// Creates a reference to an HDF5 object or a dataset region.
void p_reference(void* ref, const char* name, hid_t space_id, H5R_type_t ref_type) const;
diff --git a/c++/src/H5Object.h b/c++/src/H5Object.h
index ba32b3e..3772e08 100644
--- a/c++/src/H5Object.h
+++ b/c++/src/H5Object.h
@@ -36,9 +36,8 @@ namespace H5 {
into H5Object. This way, C functions that takes attribute id
can be in H5Location and those that cannot take attribute id
can be in H5Object.
-
- Inheritance: H5Location -> IdComponent
*/
+// Inheritance: H5Location -> IdComponent
// Define the operator function pointer for H5Aiterate().
typedef void (*attr_operator_t)(H5Object& loc/*in*/,
@@ -113,7 +112,7 @@ class H5_DLLCPP H5Object : public H5Location {
// removal does not raise any problems in two 1.10 releases.
// Creates a copy of an existing object giving the object id
- H5Object(const hid_t object_id);
+ // H5Object(const hid_t object_id);
// Copy constructor: makes copy of an H5Object object.
// H5Object(const H5Object& original);
diff --git a/c++/src/H5OcreatProp.h b/c++/src/H5OcreatProp.h
index 878c67a..d1eae86 100644
--- a/c++/src/H5OcreatProp.h
+++ b/c++/src/H5OcreatProp.h
@@ -19,10 +19,9 @@ namespace H5 {
/*! \class ObjCreatPropList
\brief Class ObjCreatPropList inherits from PropList and provides
- wrappers for the HDF5 file create property list.
-
- Inheritance: PropList -> IdComponent
+ wrappers for the HDF5 object create property list.
*/
+// Inheritance: PropList -> IdComponent
class H5_DLLCPP ObjCreatPropList : public PropList {
public:
///\brief Default object creation property list.
diff --git a/c++/src/H5PredType.h b/c++/src/H5PredType.h
index 2ffc87f..c631fb9 100644
--- a/c++/src/H5PredType.h
+++ b/c++/src/H5PredType.h
@@ -23,9 +23,8 @@ namespace H5 {
These types can only be made copy of, not created by H5Tcreate or
closed by H5Tclose. They are treated as constants.
-
- Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP PredType : public AtomType {
public:
///\brief Returns this class name.
diff --git a/c++/src/H5PropList.h b/c++/src/H5PropList.h
index e1fe5b8..6e1e287 100644
--- a/c++/src/H5PropList.h
+++ b/c++/src/H5PropList.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class PropList
\brief Class PropList inherits from IdComponent and provides wrappers for
the HDF5 generic property list.
-
- Inheritance: IdComponent
*/
+// Inheritance: IdComponent
class H5_DLLCPP PropList : public IdComponent {
public:
///\brief Default property list
diff --git a/c++/src/H5StrType.h b/c++/src/H5StrType.h
index fd0402e..24c9ca3 100644
--- a/c++/src/H5StrType.h
+++ b/c++/src/H5StrType.h
@@ -20,9 +20,8 @@ namespace H5 {
/*! \class StrType
\brief StrType is a derivative of a DataType and operates on HDF5
string datatype.
-
- Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
*/
+// Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP StrType : public AtomType {
public:
// Creates a string type using a predefined type
diff --git a/c++/src/H5VarLenType.h b/c++/src/H5VarLenType.h
index 2524cf8..078b534 100644
--- a/c++/src/H5VarLenType.h
+++ b/c++/src/H5VarLenType.h
@@ -19,10 +19,9 @@ namespace H5 {
/*! \class VarLenType
\brief VarLenType is a derivative of a DataType and operates on HDF5
- C's Variable-length Datatypes.
-
- Inheritance: DataType -> H5Object -> H5Location -> IdComponent
+ Variable-length Datatypes.
*/
+// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP VarLenType : public DataType {
public:
// Constructor that creates a variable-length datatype based