[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: KDE/kdelibs/kabc
From: Thomas Kadauke <tkadauke () gmx ! de>
Date: 2005-10-31 22:19:25
Message-ID: 1130797165.341968.31702.nullmailer () svn ! kde ! org
[Download RAW message or body]
SVN commit 476222 by tkadauke:
DOX: KABC::Addressbook::(Const)Iterator dox
M +132 -0 addressbook.h
--- trunk/KDE/kdelibs/kabc/addressbook.h #476221:476222
@@ -57,19 +57,85 @@
class KABC_EXPORT Iterator
{
public:
+ /**
+ * Default constructor
+ */
Iterator();
+ /**
+ * Copy constructor
+ */
Iterator( const Iterator & );
~Iterator();
+ /**
+ * Assignment operator. Assignes the given iterator to
+ * @c *this.
+ *
+ * @return this iterator, @c *this
+ */
Iterator &operator=( const Iterator & );
+ /**
+ * Constant Dereference operator.
+ * @note For invalid iterators, the result is undefined.
+ *
+ * @return the @c const Addressee object the iterator points to.
+ */
const Addressee &operator*() const;
+ /**
+ * Dereference operator.
+ * @note For invalid iterators, the result is undefined.
+ *
+ * @return the Addressee object the iterator points to.
+ */
Addressee &operator*();
+ /**
+ * Arrow Dereference operator, provided for convenience.
+ * @note For invalid iterators, the result is undefined.
+ *
+ * @return the Addressee object the iterator points to.
+ */
Addressee* operator->();
+ /**
+ * Preincrement operator. Advances the iterator by one.
+ *
+ * @return this iterator, @c *this
+ */
Iterator &operator++();
+ /**
+ * Postincrement operator. Advances the iterator by one.
+ * @note This function does not copy the iterator object.
+ *
+ * @return this iterator, @c *this
+ */
Iterator &operator++(int);
+ /**
+ * Predecrement operator. Decreases the iterator by one.
+ *
+ * @return this iterator, @c *this
+ */
Iterator &operator--();
+ /**
+ * Postdecrement operator. Decreases the iterator by one.
+ * @note This function does not copy the iterator object.
+ *
+ * @return this iterator, @c *this
+ */
Iterator &operator--(int);
+ /**
+ * Equality operator. Compares this iterator to @p it
+ *
+ * @param it the iterator to compare this iterator to
+ * @return @c true if both iterators are equal,
+ * @c false otherwise
+ */
bool operator==( const Iterator &it ) const;
+ /**
+ * Inequality operator. Compares this iterator to @p it
+ *
+ * @param it the iterator to compare this iterator to
+ * @return @c true if the iterators are not equal,
+ * @c false otherwise
+ */
bool operator!=( const Iterator &it ) const;
struct IteratorData;
@@ -84,19 +150,85 @@
class KABC_EXPORT ConstIterator
{
public:
+ /**
+ * Default constructor
+ */
ConstIterator();
+ /**
+ * Copy constructor
+ */
ConstIterator( const ConstIterator & );
+ /**
+ * Copy constructor. Constructs a ConstIterator from
+ * an non-@c const Iterator
+ */
ConstIterator( const Iterator & );
~ConstIterator();
+ /**
+ * Assignment operator. Assignes the given iterator to
+ * @c *this.
+ *
+ * @return this iterator, @c *this
+ */
ConstIterator &operator=( const ConstIterator & );
+ /**
+ * Constant Dereference operator.
+ * @note For invalid iterators, the result is undefined.
+ * @note Unlike in Iterator, there is no non-constant
+ * dereference operator.
+ *
+ * @return the @c const Addressee object the iterator points to.
+ */
const Addressee &operator*() const;
+ /**
+ * Arrow Dereference operator, provided for convenience.
+ * @note For invalid iterators, the result is undefined.
+ *
+ * @return the Addressee object the iterator points to.
+ */
const Addressee* operator->() const;
+ /**
+ * Preincrement operator. Advances the iterator by one.
+ *
+ * @return this iterator, @c *this
+ */
ConstIterator &operator++();
+ /**
+ * Postincrement operator. Advances the iterator by one.
+ * @note This function does not copy the iterator object.
+ *
+ * @return this iterator, @c *this
+ */
ConstIterator &operator++(int);
+ /**
+ * Predecrement operator. Decreases the iterator by one.
+ *
+ * @return this iterator, @c *this
+ */
ConstIterator &operator--();
+ /**
+ * Postdecrement operator. Decreases the iterator by one.
+ * @note This function does not copy the iterator object.
+ *
+ * @return this iterator, @c *this
+ */
ConstIterator &operator--(int);
+ /**
+ * Equality operator. Compares this iterator to @p it
+ *
+ * @param it the iterator to compare this iterator to
+ * @return @c true if both iterators are equal,
+ * @c false otherwise
+ */
bool operator==( const ConstIterator &it ) const;
+ /**
+ * Inequality operator. Compares this iterator to @p it
+ *
+ * @param it the iterator to compare this iterator to
+ * @return @c true if the iterators are not equal,
+ * @c false otherwise
+ */
bool operator!=( const ConstIterator &it ) const;
struct ConstIteratorData;
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic