diff options
Diffstat (limited to 'src/objc/smtp/MCOSMTPOperation.h')
| -rw-r--r-- | src/objc/smtp/MCOSMTPOperation.h | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/src/objc/smtp/MCOSMTPOperation.h b/src/objc/smtp/MCOSMTPOperation.h index 32d98dc8..7e6fa3f8 100644 --- a/src/objc/smtp/MCOSMTPOperation.h +++ b/src/objc/smtp/MCOSMTPOperation.h @@ -12,13 +12,20 @@ #import <MailCore/MCOOperation.h> -// This is an asynchronous SMTP operation. +/** This is an asynchronous SMTP operation, used for sending messages. */ @interface MCOSMTPOperation : MCOOperation -// 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. +/** + Starts the asynchronous operation. + + @param completionBlock Called when the operation is finished. + + - On success `error` will be nil + + - 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 |