third_party/exiv2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor doc fixes

Browse Source
This commit is contained in:
Andreas Huggel 2004-10-16 15:57:48 +00:00
parent 307f0480e8
commit ab69a6be66
4 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/exif.hpp
View File

@ -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)
<a href="mailto:ahuggel@gmx.net">ahuggel@gmx.net</a>
@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(); }

13
src/iptc.hpp
View File

@ -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)
<a href="mailto:schick@robotbattle.com">schick@robotbattle.com</a>
@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(); }

9
src/makernote.hpp
View File

@ -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)
<a href="mailto:ahuggel@gmx.net">ahuggel@gmx.net</a>
@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 <B>not</B> 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 <B>not</B>
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

4
src/value.hpp
View File

@ -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)
<a href="mailto:ahuggel@gmx.net">ahuggel@gmx.net</a>
@date 09-Jan-04, ahu: created
@ -696,7 +696,7 @@ namespace Exiv2 {
template<typename T>
class ValueType : public Value {
public:
//! Shortcut for a %ValueType<T> auto pointer.
//! Shortcut for a %ValueType\<T\> auto pointer.
typedef std::auto_ptr<ValueType<T> > AutoPtr;
//! @name Creators