Work in progress on IMAP documentation.

1 files changed, 10 insertions, 1 deletions

diff --git a/src/objc/imap/MCOIMAPFolderInfoOperation.h b/src/objc/imap/MCOIMAPFolderInfoOperation.h
index feb9ea39..d05da566 100644
--- a/src/objc/imap/MCOIMAPFolderInfoOperation.h
+++ b/src/objc/imap/MCOIMAPFolderInfoOperation.h
@@ -12,10 +12,19 @@
 
 #import <MailCore/MCOIMAPBaseOperation.h>
 
+// This class implements the operation that will fetch some folder information
+// (uidNext uidValidity, modSequenceValue, messageCount).
+
 @class MCOIMAPFolderInfo;
 
 @interface MCOIMAPFolderInfoOperation : MCOIMAPBaseOperation
-- (void)start:(void (^)(NSError *error, MCOIMAPFolderInfo *info))completionBlock;
+
+// Starts the asynchronous operation.
+// On success, the completion block will be called with nil as error. info contains the folder information.
+// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h.
+// info will be nil.
+- (void) start:(void (^)(NSError * error, MCOIMAPFolderInfo *info))completionBlock;
+
 @end
 
 #endif