summaryrefslogtreecommitdiffstats
path: root/c++/src
diff options
context:
space:
mode:
Diffstat (limited to 'c++/src')
-rw-r--r--c++/src/H5AbstractDs.h7
-rw-r--r--c++/src/H5AtomType.cpp4
-rw-r--r--c++/src/H5AtomType.h2
-rw-r--r--c++/src/H5Attribute.cpp3
-rw-r--r--c++/src/H5CommonFG.cpp2
-rw-r--r--c++/src/H5CommonFG.h2
-rw-r--r--c++/src/H5DataSet.cpp7
-rw-r--r--c++/src/H5DataSet.h2
-rw-r--r--c++/src/H5DataSpace.cpp5
-rw-r--r--c++/src/H5DataSpace.h3
-rw-r--r--c++/src/H5DataType.cpp5
-rw-r--r--c++/src/H5DataType.h2
-rw-r--r--c++/src/H5File.cpp9
-rw-r--r--c++/src/H5File.h3
-rw-r--r--c++/src/H5Group.cpp5
-rw-r--r--c++/src/H5Group.h2
-rw-r--r--c++/src/H5IdComponent.cpp8
-rw-r--r--c++/src/H5IdComponent.h2
-rw-r--r--c++/src/H5Location.cpp32
-rw-r--r--c++/src/H5Location.h2
-rw-r--r--c++/src/H5Object.cpp2
-rw-r--r--c++/src/H5Object.h2
-rw-r--r--c++/src/H5PredType.cpp2
-rw-r--r--c++/src/H5PredType.h2
-rw-r--r--c++/src/H5PropList.cpp5
-rw-r--r--c++/src/H5PropList.h2
26 files changed, 90 insertions, 32 deletions
diff --git a/c++/src/H5AbstractDs.h b/c++/src/H5AbstractDs.h
index 354b47b..192f8ce 100644
--- a/c++/src/H5AbstractDs.h
+++ b/c++/src/H5AbstractDs.h
@@ -51,18 +51,17 @@ class H5_DLLCPP AbstractDs {
StrType getStrType() const;
VarLenType getVarLenType() const;
- // Gets the size in memory of this abstract dataset.
+ ///\brief Gets the size in memory of this abstract dataset.
virtual size_t getInMemDataSize() const = 0;
- // Gets the dataspace of this abstract dataset - pure virtual.
+ ///\brief Gets the dataspace of this abstract dataset - pure virtual.
virtual DataSpace getSpace() const = 0;
// Gets the class of the datatype that is used by this abstract
// dataset.
H5T_class_t getTypeClass() const;
- // Returns the amount of storage size required for this abstract
- // dataset - pure virtual.
+ ///\brief Returns the amount of storage size required - pure virtual.
virtual hsize_t getStorageSize() const = 0;
///\brief Returns this class name.
diff --git a/c++/src/H5AtomType.cpp b/c++/src/H5AtomType.cpp
index 975cad6..09f762f 100644
--- a/c++/src/H5AtomType.cpp
+++ b/c++/src/H5AtomType.cpp
@@ -45,7 +45,6 @@ AtomType::AtomType() : DataType() {}
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
AtomType::AtomType( const hid_t existing_id ) : DataType( existing_id ) {}
-#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: AtomType copy constructor
@@ -53,6 +52,7 @@ AtomType::AtomType( const hid_t existing_id ) : DataType( existing_id ) {}
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
AtomType::AtomType( const AtomType& original ) : DataType( original ) {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: AtomType::setSize
@@ -285,12 +285,14 @@ void AtomType::setPad( H5T_pad_t lsb, H5T_pad_t msb ) const
}
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: AtomType destructor
///\brief Noop destructor.
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
AtomType::~AtomType() {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
#ifndef H5_NO_NAMESPACE
} // end namespace
diff --git a/c++/src/H5AtomType.h b/c++/src/H5AtomType.h
index 25770f5..7c9a891 100644
--- a/c++/src/H5AtomType.h
+++ b/c++/src/H5AtomType.h
@@ -60,11 +60,13 @@ class H5_DLLCPP AtomType : public DataType {
///\brief Returns this class name.
virtual H5std_string fromClass () const { return("AtomType"); }
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Copy constructor - makes copy of the original object
AtomType( const AtomType& original );
// Noop destructor
virtual ~AtomType();
+#endif // DOXYGEN_SHOULD_SKIP_THIS
protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
diff --git a/c++/src/H5Attribute.cpp b/c++/src/H5Attribute.cpp
index 120ed39..d684b8f 100644
--- a/c++/src/H5Attribute.cpp
+++ b/c++/src/H5Attribute.cpp
@@ -411,7 +411,8 @@ void Attribute::flush(H5F_scope_t scope) const
//--------------------------------------------------------------------------
// Function: Attribute::getId
-// Purpose: Get the id of this attribute
+///\brief Get the id of this attribute
+///\return Attribute identifier
// Description:
// Class hierarchy is revised to address bugzilla 1068. Class
// AbstractDS and Attribute are moved out of H5Object. In
diff --git a/c++/src/H5CommonFG.cpp b/c++/src/H5CommonFG.cpp
index 0651c29..d6fe5dc 100644
--- a/c++/src/H5CommonFG.cpp
+++ b/c++/src/H5CommonFG.cpp
@@ -1138,6 +1138,7 @@ H5G_obj_t CommonFG::getObjTypeByIdx(hsize_t idx, H5std_string& type_name) const
}
#endif /* H5_NO_DEPRECATED_SYMBOLS */
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: CommonFG default constructor
///\brief Default constructor.
@@ -1151,6 +1152,7 @@ CommonFG::CommonFG() {}
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
CommonFG::~CommonFG() {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
#ifndef H5_NO_NAMESPACE
}
diff --git a/c++/src/H5CommonFG.h b/c++/src/H5CommonFG.h
index 4f32d21..22e193a 100644
--- a/c++/src/H5CommonFG.h
+++ b/c++/src/H5CommonFG.h
@@ -152,7 +152,6 @@ class H5_DLLCPP CommonFG {
/// object id, i.e. file or group id.
virtual hid_t getLocId() const = 0;
-#endif // DOXYGEN_SHOULD_SKIP_THIS
/// For subclasses, H5File and Group, to throw appropriate exception.
virtual void throwException(const H5std_string& func_name, const H5std_string& msg) const = 0;
@@ -162,6 +161,7 @@ class H5_DLLCPP CommonFG {
// Noop destructor.
virtual ~CommonFG();
+#endif // DOXYGEN_SHOULD_SKIP_THIS
}; // end of CommonFG declaration
diff --git a/c++/src/H5DataSet.cpp b/c++/src/H5DataSet.cpp
index 6a1524d..3e3893c 100644
--- a/c++/src/H5DataSet.cpp
+++ b/c++/src/H5DataSet.cpp
@@ -430,7 +430,7 @@ void DataSet::read( void* buf, const DataType& mem_type, const DataSpace& mem_sp
// Function: DataSet::read
///\brief This is an overloaded member function, provided for convenience.
/// It takes a reference to a \c H5std_string for the buffer.
-///\param buf - IN: Buffer for read data
+///\param strg - IN: Buffer for read data string
///\param mem_type - IN: Memory datatype
///\param mem_space - IN: Memory dataspace
///\param file_space - IN: Dataset's dataspace in the file
@@ -647,6 +647,7 @@ void DataSet::fillMemBuf(void *buf, DataType& buf_type, DataSpace& space)
//--------------------------------------------------------------------------
// Function: DataSet::getId
///\brief Get the id of this dataset.
+///\return DataSet identifier
// Description:
// Class hierarchy is revised to address bugzilla 1068. Class
// AbstractDs and Attribute are moved out of H5Object. In
@@ -726,8 +727,9 @@ void DataSet::p_read_variable_len(const hid_t mem_type_id, const hid_t mem_space
HDfree(strg_C);
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
-// Function: DataSet::p_setId (private)
+// Function: DataSet::p_setId (protected)
///\brief Sets the identifier of this dataset to a new value.
///
///\exception H5::IdComponentException when the attempt to close the HDF5
@@ -753,6 +755,7 @@ void DataSet::p_setId(const hid_t new_id)
// increment the reference counter of the new id
//incRefCount();
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: DataSet::close
diff --git a/c++/src/H5DataSet.h b/c++/src/H5DataSet.h
index 54e9d6f..bc80046 100644
--- a/c++/src/H5DataSet.h
+++ b/c++/src/H5DataSet.h
@@ -105,7 +105,6 @@ class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
private:
hid_t id; // HDF5 dataset id
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
// This function contains the common code that is used by
// getTypeClass and various API functions getXxxType
// defined in AbstractDs for generic datatype and specific
@@ -117,6 +116,7 @@ class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
void p_read_variable_len(const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id, const hid_t xfer_plist_id, H5std_string& strg) const;
protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Sets the dataset id.
virtual void p_setId(const hid_t new_id);
#endif // DOXYGEN_SHOULD_SKIP_THIS
diff --git a/c++/src/H5DataSpace.cpp b/c++/src/H5DataSpace.cpp
index 755ca5b..2e2bb35 100644
--- a/c++/src/H5DataSpace.cpp
+++ b/c++/src/H5DataSpace.cpp
@@ -556,7 +556,8 @@ void DataSpace::selectHyperslab( H5S_seloper_t op, const hsize_t *count, const h
//--------------------------------------------------------------------------
// Function: DataSpace::getId
-// Purpose: Get the id of this attribute
+///\brief Get the id of this dataspace
+///\return Dataspace identifier
// Modification:
// May 2008 - BMR
// Class hierarchy is revised to address bugzilla 1068. Class
@@ -570,6 +571,7 @@ hid_t DataSpace::getId() const
return(id);
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: DataSpace::p_setId
///\brief Sets the identifier of this object to a new value.
@@ -594,6 +596,7 @@ void DataSpace::p_setId(const hid_t new_id)
// reset object's id to the given id
id = new_id;
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: DataSpace::close
diff --git a/c++/src/H5DataSpace.h b/c++/src/H5DataSpace.h
index 9afb8ab..b88144a 100644
--- a/c++/src/H5DataSpace.h
+++ b/c++/src/H5DataSpace.h
@@ -122,8 +122,11 @@ class H5_DLLCPP DataSpace : public IdComponent {
hid_t id; // HDF5 dataspace id
protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Sets the dataspace id.
virtual void p_setId(const hid_t new_id);
+#endif // DOXYGEN_SHOULD_SKIP_THIS
+
};
#ifndef H5_NO_NAMESPACE
}
diff --git a/c++/src/H5DataType.cpp b/c++/src/H5DataType.cpp
index 99525bc..8a62471 100644
--- a/c++/src/H5DataType.cpp
+++ b/c++/src/H5DataType.cpp
@@ -681,7 +681,8 @@ bool DataType::isVariableStr() const
//--------------------------------------------------------------------------
// Function: DataType::getId
-// Purpose: Get the id of this attribute
+///\brief Get the id of this datatype
+///\return Datatype identifier
// Modification:
// May 2008 - BMR
// Class hierarchy is revised to address bugzilla 1068. Class
@@ -695,6 +696,7 @@ hid_t DataType::getId() const
return(id);
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: DataType::p_setId
///\brief Sets the identifier of this object to a new value.
@@ -719,6 +721,7 @@ void DataType::p_setId(const hid_t new_id)
// reset object's id to the given id
id = new_id;
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: DataType::close
diff --git a/c++/src/H5DataType.h b/c++/src/H5DataType.h
index 98514bb..6e56622 100644
--- a/c++/src/H5DataType.h
+++ b/c++/src/H5DataType.h
@@ -120,10 +120,12 @@ class H5_DLLCPP DataType : public H5Object {
virtual ~DataType();
protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
hid_t id; // HDF5 datatype id
// Sets the datatype id.
virtual void p_setId(const hid_t new_id);
+#endif // DOXYGEN_SHOULD_SKIP_THIS
private:
void p_commit(hid_t loc_id, const char* name);
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
diff --git a/c++/src/H5File.h b/c++/src/H5File.h
index cfb6bdf..f906de6 100644
--- a/c++/src/H5File.h
+++ b/c++/src/H5File.h
@@ -100,13 +100,12 @@ class H5_DLLCPP H5File : public H5Location, public CommonFG {
private:
hid_t id; // HDF5 file id
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
// This function is private and contains common code between the
// constructors taking a string or a char*
void p_get_file( const char* name, unsigned int flags, const FileCreatPropList& create_plist, const FileAccPropList& access_plist );
protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Sets the HDF5 file id.
virtual void p_setId(const hid_t new_id);
diff --git a/c++/src/H5Group.cpp b/c++/src/H5Group.cpp
index e83b635..eff7e50 100644
--- a/c++/src/H5Group.cpp
+++ b/c++/src/H5Group.cpp
@@ -149,7 +149,8 @@ Group::Group(Attribute& attr, const void* ref, H5R_type_t ref_type) : H5Object()
//--------------------------------------------------------------------------
// Function: Group::getId
-// Purpose: Get the id of this attribute
+///\brief Get the id of this group
+///\return Group identifier
// Modification:
// May 2008 - BMR
// Class hierarchy is revised to address bugzilla 1068. Class
@@ -163,6 +164,7 @@ hid_t Group::getId() const
return(id);
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: Group::p_setId
///\brief Sets the identifier of this object to a new value.
@@ -187,6 +189,7 @@ void Group::p_setId(const hid_t new_id)
// reset object's id to the given id
id = new_id;
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: Group::close
diff --git a/c++/src/H5Group.h b/c++/src/H5Group.h
index e4c2415..3b53293 100644
--- a/c++/src/H5Group.h
+++ b/c++/src/H5Group.h
@@ -62,8 +62,10 @@ class H5_DLLCPP Group : public H5Object, public CommonFG {
hid_t id; // HDF5 group id
protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Sets the group id.
virtual void p_setId(const hid_t new_id);
+#endif // DOXYGEN_SHOULD_SKIP_THIS
};
#ifndef H5_NO_NAMESPACE
}
diff --git a/c++/src/H5IdComponent.cpp b/c++/src/H5IdComponent.cpp
index 9f96277..4a997ab 100644
--- a/c++/src/H5IdComponent.cpp
+++ b/c++/src/H5IdComponent.cpp
@@ -321,6 +321,14 @@ bool IdComponent::p_valid_id(const hid_t obj_id)
return true;
}
+// Notes about IdComponent::id
+// May 2008 - BMR
+// Class hierarchy is revised to address bugzilla 1068...
+// ...member IdComponent::id is moved into subclasses, and
+// IdComponent::getId now becomes pure virtual function.
+// (reasons: 1. encountered problems when adding H5Location;
+// 2. Scott Meyers, item 33)
+
#endif // DOXYGEN_SHOULD_SKIP_THIS
#ifndef H5_NO_NAMESPACE
diff --git a/c++/src/H5IdComponent.h b/c++/src/H5IdComponent.h
index 7dc1da3..17ed552 100644
--- a/c++/src/H5IdComponent.h
+++ b/c++/src/H5IdComponent.h
@@ -44,8 +44,10 @@ class H5_DLLCPP IdComponent {
// Assignment operator.
IdComponent& operator=( const IdComponent& rhs );
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Gets the identifier of this object.
virtual hid_t getId () const = 0;
+#endif // DOXYGEN_SHOULD_SKIP_THIS
// Sets the identifier of this object to a new value.
void setId(const hid_t new_id);
diff --git a/c++/src/H5Location.cpp b/c++/src/H5Location.cpp
index 98878d7..fcf7ff4 100644
--- a/c++/src/H5Location.cpp
+++ b/c++/src/H5Location.cpp
@@ -69,8 +69,6 @@ H5Location::H5Location() : IdComponent(0) {}
//--------------------------------------------------------------------------
H5Location::H5Location(const hid_t object_id) : IdComponent(object_id) {}
-#endif // DOXYGEN_SHOULD_SKIP_THIS
-
//--------------------------------------------------------------------------
// Function: H5Location copy constructor
///\brief Copy constructor: makes a copy of the original H5Location
@@ -80,6 +78,8 @@ H5Location::H5Location(const hid_t object_id) : IdComponent(object_id) {}
//--------------------------------------------------------------------------
H5Location::H5Location( const H5Location& original ) : IdComponent( original ) {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
+
//--------------------------------------------------------------------------
// Function: H5Location::createAttribute
///\brief Creates an attribute for a group, dataset, or named datatype.
@@ -376,6 +376,8 @@ H5std_string H5Location::getFileName() const
}
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+
//--------------------------------------------------------------------------
// Function: H5Location::p_reference (protected)
// Purpose Creates a reference to an HDF5 object or a dataset region.
@@ -395,6 +397,8 @@ void H5Location::p_reference(void* ref, const char* name, hid_t space_id, H5R_ty
}
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
+
//--------------------------------------------------------------------------
// Function: H5Location::reference
///\brief Creates a reference to an HDF5 object or a dataset region.
@@ -456,6 +460,7 @@ void H5Location::reference(void* ref, const H5std_string& name) const
reference(ref, name.c_str());
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: H5Location::p_dereference (protected)
// Purpose Dereference a ref into an hdf5 object.
@@ -482,6 +487,7 @@ hid_t H5Location::p_dereference(hid_t loc_id, const void* ref, H5R_type_t ref_ty
// No failure, set id to the object
return(temp_id);
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: H5Location::dereference
@@ -560,16 +566,16 @@ void H5Location::dereference(Attribute& attr, const void* ref, H5R_type_t ref_ty
// Function: H5Location::getObjType
///\brief Retrieves the type of object that an object reference points to.
///\param ref_type - IN: Type of reference to query, valid values are:
-/// \li \c H5R_OBJECT \tReference is an object reference.
-/// \li \c H5R_DATASET_REGION \tReference is a dataset region reference.
+/// \li \c H5R_OBJECT - Reference is an object reference.
+/// \li \c H5R_DATASET_REGION - Reference is a dataset region reference.
///\param ref - IN: Reference to query
///\return An object type, which can be one of the following:
-/// \li \c H5G_UNKNOWN \tA failure occurs. (-1)
-/// \li \c H5G_GROUP \tObject is a group.
-/// \li \c H5G_DATASET \tObject is a dataset.
-/// \li \c H5G_TYPE Object \tis a named datatype
-/// \li \c H5G_LINK \tObject is a symbolic link.
-/// \li \c H5G_UDLINK \tObject is a user-defined link.
+/// \li \c H5G_UNKNOWN - A failure occurs. (-1)
+/// \li \c H5G_GROUP - Object is a group.
+/// \li \c H5G_DATASET - Object is a dataset.
+/// \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::ReferenceException
// Programmer Binh-Minh Ribler - May, 2004
// Modification
@@ -585,6 +591,7 @@ H5G_obj_t H5Location::getObjType(void *ref, H5R_type_t ref_type) const
}
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: H5Location::p_get_obj_type (protected)
// Purpose Retrieves the type of object that an object reference points to.
@@ -611,9 +618,9 @@ H5G_obj_t H5Location::p_get_obj_type(void *ref, H5R_type_t ref_type) const
}
return(obj_type);
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
#endif /* H5_NO_DEPRECATED_SYMBOLS */
-
//--------------------------------------------------------------------------
// Function: H5Location::getRefObjType
///\brief Retrieves the type of object that an object reference points to.
@@ -640,6 +647,7 @@ H5O_type_t H5Location::getRefObjType(void *ref, H5R_type_t ref_type) const
}
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: H5Location::p_get_ref_obj_type (protected)
// Purpose Retrieves the type of object that an object reference points to.
@@ -697,6 +705,8 @@ hid_t H5Location::p_get_region(void *ref, H5R_type_t ref_type) const
//--------------------------------------------------------------------------
H5Location::~H5Location() {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
+
#ifndef H5_NO_NAMESPACE
} // end namespace
#endif
diff --git a/c++/src/H5Location.h b/c++/src/H5Location.h
index 8eae454..1f54439 100644
--- a/c++/src/H5Location.h
+++ b/c++/src/H5Location.h
@@ -106,7 +106,7 @@ class H5_DLLCPP H5Location : public IdComponent {
void dereference(H5Object& obj, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
void dereference(Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
- // For subclasses.
+ ///\brief Returns an identifier. (pure virtual)
virtual hid_t getId() const = 0;
protected:
diff --git a/c++/src/H5Object.cpp b/c++/src/H5Object.cpp
index e29e80e..b596092 100644
--- a/c++/src/H5Object.cpp
+++ b/c++/src/H5Object.cpp
@@ -52,7 +52,6 @@ H5Object::H5Object() : H5Location() {}
//--------------------------------------------------------------------------
H5Object::H5Object( const hid_t object_id ) : H5Location( object_id ) {}
-#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: H5Object copy constructor
@@ -69,6 +68,7 @@ H5Object::H5Object( const H5Object& original ) : H5Location( original ) {}
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
H5Object::~H5Object() {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
#ifndef H5_NO_NAMESPACE
} // end namespace
diff --git a/c++/src/H5Object.h b/c++/src/H5Object.h
index bfd5e6f..8441491 100644
--- a/c++/src/H5Object.h
+++ b/c++/src/H5Object.h
@@ -40,6 +40,7 @@ namespace H5 {
class H5_DLLCPP H5Object : public H5Location {
public:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Copy constructor: makes copy of an H5Object object.
H5Object(const H5Object& original);
@@ -47,7 +48,6 @@ class H5_DLLCPP H5Object : public H5Location {
virtual ~H5Object();
protected:
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Default constructor
H5Object();
diff --git a/c++/src/H5PredType.cpp b/c++/src/H5PredType.cpp
index 9dfc760..27cfd3a 100644
--- a/c++/src/H5PredType.cpp
+++ b/c++/src/H5PredType.cpp
@@ -56,6 +56,7 @@ PredType::PredType( const hid_t predtype_id ) : AtomType( predtype_id )
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
PredType::PredType() : AtomType() {}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: PredType copy constructor
@@ -65,6 +66,7 @@ PredType::PredType() : AtomType() {}
//--------------------------------------------------------------------------
PredType::PredType( const PredType& original ) : AtomType( original ) {}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Flag to terminate HDF5 library in DataType::~DataType
const PredType PredType::AtExit(H5CPP_EXITED);
diff --git a/c++/src/H5PredType.h b/c++/src/H5PredType.h
index 8a04f0c..5dc5d36 100644
--- a/c++/src/H5PredType.h
+++ b/c++/src/H5PredType.h
@@ -32,7 +32,9 @@ namespace H5 {
before the other PredType objects are created. At exit, when this special
PredType object is to be destructed, no HDF5 library function will be called
and the library will be terminated. -BMR, Mar 30, 2012 */
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define H5CPP_EXITED -3 // -3 is less likely to be used elsewhere
+#endif // DOXYGEN_SHOULD_SKIP_THIS
class H5_DLLCPP PredType : public AtomType {
public:
diff --git a/c++/src/H5PropList.cpp b/c++/src/H5PropList.cpp
index ceea15f..c14d74f 100644
--- a/c++/src/H5PropList.cpp
+++ b/c++/src/H5PropList.cpp
@@ -216,7 +216,8 @@ void PropList::copyProp( PropList& dest, PropList& src, const H5std_string& name
//--------------------------------------------------------------------------
// Function: PropList::getId
-// Purpose: Get the id of this attribute
+///\brief Get the id of this property list
+///\return Property list identifier
// Description:
// Class hierarchy is revised to address bugzilla 1068. Class
// AbstractDS and Attribute are moved out of H5Object. In
@@ -229,6 +230,7 @@ hid_t PropList::getId() const
return(id);
}
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: PropList::p_setId
///\brief Sets the identifier of this object to a new value.
@@ -253,6 +255,7 @@ void PropList::p_setId(const hid_t new_id)
// reset object's id to the given id
id = new_id;
}
+#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: PropList::close
diff --git a/c++/src/H5PropList.h b/c++/src/H5PropList.h
index 7e47b32..a4057d4 100644
--- a/c++/src/H5PropList.h
+++ b/c++/src/H5PropList.h
@@ -110,10 +110,12 @@ class H5_DLLCPP PropList : public IdComponent {
virtual ~PropList();
protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
hid_t id; // HDF5 property list id
// Sets the property list id.
virtual void p_setId(const hid_t new_id);
+#endif // DOXYGEN_SHOULD_SKIP_THIS
};
#ifndef H5_NO_NAMESPACE
generated by cgit v0.12 at 2024-11-01 06:50:43 (GMT)