Work in progress on IMAP documentation.

1 files changed, 10 insertions, 1 deletions

diff --git a/src/objc/imap/MCOIMAPFetchMessagesOperation.h b/src/objc/imap/MCOIMAPFetchMessagesOperation.h
index adde2dbd..32a3a451 100644
--- a/src/objc/imap/MCOIMAPFetchMessagesOperation.h
+++ b/src/objc/imap/MCOIMAPFetchMessagesOperation.h
@@ -13,13 +13,22 @@
 #import <MailCore/MCOIMAPBaseOperation.h>
 #import <MailCore/MCOConstants.h>
 
+// This class implements an operation to fetch a list of messages.
+
 @class MCOIndexSet;
 
 @interface MCOIMAPFetchMessagesOperation : MCOIMAPBaseOperation
 
+// This block will be called each time a new message information will be downloaded.
 @property (nonatomic, copy) MCOIMAPBaseOperationItemProgressBlock progress;
 
-- (void)start:(void (^)(NSError *error, NSArray * messages, MCOIndexSet * vanishedMessages))completionBlock;
+// Starts the asynchronous operation.
+// On success, the completion block will be called with nil as error. messages will be an array of MCOIMAPMessage.
+// vanishedMessages will contain the messages removed on the server if the server supports QRESYNC and if it was a sync request.
+// In other case, vanishedMessages will be nil.
+// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h.
+// messages and vanishedMessages will be nil.
+- (void) start:(void (^)(NSError * error, NSArray * /* MCOIMAPMessage */ messages, MCOIndexSet * vanishedMessages))completionBlock;
 
 @end