Fixed documentation

Description:
    - Updated the description of copy constructor for clarification.
    - Removed unnecessary comments.
Platforms tested:
    Linux/64 (jelly)
This commit is contained in:
Binh-Minh Ribler
2018-03-12 19:39:20 -05:00
parent b638bbd74b
commit 2d4d39d157
52 changed files with 81 additions and 146 deletions

View File

@@ -60,21 +60,8 @@ class H5_DLLCPP IdComponent {
// Sets the identifier of this object to a new value.
void setId(const hid_t new_id);
// *** Deprecation warning ***
// The following two constructors are no longer appropriate after the
// data member "id" had been moved to the sub-classes.
// The copy constructor is a noop and is removed in 1.8.15 and the
// other will be removed from 1.10 release, and then from 1.8 if its
// removal does not raise any problems in two 1.10 releases.
// Creates an object to hold an HDF5 identifier.
// IdComponent(const hid_t h5_id); - removed from 1.10.1
#ifndef DOXYGEN_SHOULD_SKIP_THIS
// Copy constructor: makes copy of the original IdComponent object.
// IdComponent(const IdComponent& original); - removed from 1.8.15
// Gets the identifier of this object.
virtual hid_t getId () const = 0;