From 3844f6a8290b473b8b09b1299b016edfb16a5081 Mon Sep 17 00:00:00 2001
From: Thomas McGuire <mcguire@kde.org>
Date: Fri, 12 Dec 2008 22:12:14 +0000
Subject: [PATCH] doc++ SVN_SILENT

svn path=/trunk/KDE/kdepim/; revision=896228
---
 messageproperty.h | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/messageproperty.h b/messageproperty.h
index 752fd90dc..7e0df3777 100644
--- a/messageproperty.h
+++ b/messageproperty.h
@@ -82,9 +82,18 @@ public:
   static void setSerialCache( const KMMsgBase*, quint32 );
   static quint32 serialCache( const KMMsgBase* );
 
-  /* Set the transferInProgress for a message
-     This property becomes invalid when the message is destructed or
-     assigned a new value */
+  /**
+   * Set the transferInProgress for a message.
+   *
+   * The number of calls to setTransferInProgress() with transfer = true is counted,
+   * e.g. if you call setTransferInProgress() with transfer = true two times, and
+   * then setTransferInProgress() with transfer = false once, transferInProgres()
+   * will return true. transferInProgress() only returns false after an additional
+   * call to setTransferInProgress() with transfer = false.
+   *
+   * This property becomes invalid when the message is destructed or
+   * assigned a new value.
+   */
   static void setTransferInProgress( const KMMsgBase*, bool, bool = false );
   static bool transferInProgress( const KMMsgBase* );
   static void setTransferInProgress( quint32, bool, bool = false );