Work in progress on IMAP documentation.

3 files changed, 13 insertions, 3 deletions

diff --git a/src/objc/smtp/MCOSMTPOperation.h b/src/objc/smtp/MCOSMTPOperation.h
index 1b3b4b83..32d98dc8 100644
--- a/src/objc/smtp/MCOSMTPOperation.h
+++ b/src/objc/smtp/MCOSMTPOperation.h
@@ -15,7 +15,12 @@
 // This is an asynchronous SMTP operation.
 
 @interface MCOSMTPOperation : MCOOperation
-- (void)start:(void (^)(NSError *error))completionBlock;
+
+// Starts the asynchronous operation.
+// On success, the completion block will be called with nil as error.
+// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h.
+- (void) start:(void (^)(NSError * error))completionBlock;
+
 @end
 
 #endif
diff --git a/src/objc/smtp/MCOSMTPSendOperation.h b/src/objc/smtp/MCOSMTPSendOperation.h
index 2174df91..e8a0f6b5 100644
--- a/src/objc/smtp/MCOSMTPSendOperation.h
+++ b/src/objc/smtp/MCOSMTPSendOperation.h
@@ -18,11 +18,14 @@ typedef void (^MCOSMTPOperationProgressBlock)(unsigned int current, unsigned int
 
 @interface MCOSMTPSendOperation : MCOSMTPOperation
 
-// This block will be called during the progression of the send of the message
+// This block will be called during the progression while sending the message
 // when some bytes have been sent to the network.
 @property (nonatomic, copy) MCOSMTPOperationProgressBlock progress;
 
-- (void)start:(void (^)(NSError *error))completionBlock;
+// Starts the asynchronous operation.
+// On success, the completion block will be called with nil as error.
+// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h.
+- (void) start:(void (^)(NSError * error))completionBlock;
 
 @end
 
diff --git a/src/objc/smtp/MCOSMTPSession.h b/src/objc/smtp/MCOSMTPSession.h
index b9fb9225..3b29ddf7 100644
--- a/src/objc/smtp/MCOSMTPSession.h
+++ b/src/objc/smtp/MCOSMTPSession.h
@@ -55,6 +55,7 @@
 @property (nonatomic, assign, getter=isUseHeloIPEnabled) BOOL useHeloIPEnabled;
 
 // Returns an operation that will send the given message through SMTP.
+// The operation needs to be started.
 // It will use the recipient set in the message data (To, Cc and Bcc).
 // It will also filter out Bcc from the content of the message.
 //
@@ -69,6 +70,7 @@
 - (MCOSMTPSendOperation *) sendOperationWithData:(NSData *)messageData;
 
 // Returns an operation that will check whether the SMTP account is valid.
+// The operation needs to be started.
 //
 // {
 //   ...