diff --git a/src/exif.hpp b/src/exif.hpp index 7afe43dd..6e2522a0 100644 --- a/src/exif.hpp +++ b/src/exif.hpp @@ -21,7 +21,7 @@ /*! @file exif.hpp @brief Encoding and decoding of Exif data - @version $Name: $ $Revision: 1.58 $ + @version $Name: $ $Revision: 1.59 $ @author Andreas Huggel (ahu) ahuggel@gmx.net @date 09-Jan-04, ahu: created @@ -192,16 +192,17 @@ namespace Exiv2 { Rational toRational(long n =0) const { return value_.get() == 0 ? Rational(-1, 1) : value_->toRational(n); } /*! - @brief Return a pointer to a copy (clone) of the value. The caller - is responsible to delete this copy when it's no longer needed. + @brief Return an auto-pointer to a copy (clone) of the value. The + caller owns this copy and the auto-pointer ensures that it will + be deleted. This method is provided for users who need full control over the value. A caller may, e.g., downcast the pointer to the appropriate subclass of Value to make use of the interface of the subclass to set or modify its contents. - @return A pointer to a copy (clone) of the value, 0 if the value is - not set. + @return An auto-pointer to a copy (clone) of the value, 0 if the value + is not set. */ Value::AutoPtr getValue() const { return value_.get() == 0 ? Value::AutoPtr(0) : value_->clone(); } diff --git a/src/iptc.hpp b/src/iptc.hpp index 07159cd1..42c7cd76 100644 --- a/src/iptc.hpp +++ b/src/iptc.hpp @@ -21,7 +21,7 @@ /*! @file iptc.hpp @brief Encoding and decoding of Iptc data - @version $Name: $ $Revision: 1.9 $ + @version $Name: $ $Revision: 1.10 $ @author Brad Schick (brad) schick@robotbattle.com @date 31-Jul-04, brad: created @@ -63,7 +63,7 @@ namespace Exiv2 { set the value using setValue(). @param key The key of the %Iptcdatum. - @param value Pointer to a %Iptcdatum value. + @param pValue Pointer to a %Iptcdatum value. @throw Error ("Invalid key") if the key cannot be parsed and converted to a tag number and record id. */ @@ -178,16 +178,17 @@ namespace Exiv2 { Rational toRational(long n =0) const { return value_.get() == 0 ? Rational(-1, 1) : value_->toRational(n); } /*! - @brief Return a pointer to a copy (clone) of the value. The caller - is responsible to delete this copy when it's no longer needed. + @brief Return an auto-pointer to a copy (clone) of the value. The + caller owns this copy and the auto-pointer ensures that it will + be deleted. This method is provided for users who need full control over the value. A caller may, e.g., downcast the pointer to the appropriate subclass of Value to make use of the interface of the subclass to set or modify its contents. - @return A pointer to a copy (clone) of the value, 0 if the value is - not set. + @return An auto-pointer to a copy (clone) of the value, 0 if the value + is not set. */ Value::AutoPtr getValue() const { return value_.get() == 0 ? Value::AutoPtr(0) : value_->clone(); } diff --git a/src/makernote.hpp b/src/makernote.hpp index 0d15a965..89ace81a 100644 --- a/src/makernote.hpp +++ b/src/makernote.hpp @@ -22,7 +22,7 @@ @file makernote.hpp @brief Contains the Exif %MakerNote interface, IFD %MakerNote and a MakerNote factory - @version $Name: $ $Revision: 1.26 $ + @version $Name: $ $Revision: 1.27 $ @author Andreas Huggel (ahu) ahuggel@gmx.net @date 18-Feb-04, ahu: created @@ -167,9 +167,10 @@ namespace Exiv2 { //! Return the offset of the makernote from the start of the TIFF header long offset() const { return offset_; } /*! - @brief Return a pointer to an newly created, empty instance of the - same type as this. The makernote entries are not copied. - The caller owns the new object and is responsible to delete it! + @brief Return an auto-pointer to an newly created, empty instance of + the same type as this. The makernote entries are not + copied. The caller owns the new object and the auto-pointer + ensures that it will be deleted. @param alloc Memory management model for the clone. Indicates if memory required to store data should be allocated and deallocated diff --git a/src/value.hpp b/src/value.hpp index 1b5ec772..c9b0d136 100644 --- a/src/value.hpp +++ b/src/value.hpp @@ -21,7 +21,7 @@ /*! @file value.hpp @brief Value interface and concrete subclasses - @version $Name: $ $Revision: 1.17 $ + @version $Name: $ $Revision: 1.18 $ @author Andreas Huggel (ahu) ahuggel@gmx.net @date 09-Jan-04, ahu: created @@ -696,7 +696,7 @@ namespace Exiv2 { template class ValueType : public Value { public: - //! Shortcut for a %ValueType auto pointer. + //! Shortcut for a %ValueType\ auto pointer. typedef std::auto_ptr > AutoPtr; //! @name Creators