Add documentation for QMailRetrievalAction::defaultMinimum(test

1 files changed, 12 insertions, 0 deletions

diff --git a/src/libraries/qmfclient/qmailserviceaction.cpp b/src/libraries/qmfclient/qmailserviceaction.cpp
index d7b9349e..a84b7d19 100644
--- a/src/libraries/qmfclient/qmailserviceaction.cpp
+++ b/src/libraries/qmfclient/qmailserviceaction.cpp
@@ -1266,6 +1266,18 @@ void QMailRetrievalAction::synchronize(const QMailAccountId &accountId, uint min
 }
 
 
+/*!
+    \fn QMailRetrievalAction::defaultMinimum()
+
+    Default minimum argument clients and protocol plugins should use when 
+    retrieving messages. Maybe be used by protocol plugins to determine if 
+    either new messages are being retrieved or if more messages are being 
+    retrieved.
+
+    \sa retrieveMessageList()
+*/
+
+
 QMailTransmitActionPrivate::QMailTransmitActionPrivate(QMailTransmitAction *i)
     : QMailServiceActionPrivate(this, i)
 {