From 3ae5bf7a1d806c749c28f641be34733c85808efe Mon Sep 17 00:00:00 2001 From: Matt Ronge Date: Sun, 2 Jun 2013 20:41:28 -0500 Subject: Finished formatting docs for Appledoc for IMAP and SMTP --- src/objc/imap/MCOIMAPCopyMessagesOperation.h | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) (limited to 'src/objc/imap/MCOIMAPCopyMessagesOperation.h') diff --git a/src/objc/imap/MCOIMAPCopyMessagesOperation.h b/src/objc/imap/MCOIMAPCopyMessagesOperation.h index 0fb3c5ad..c916e1d7 100644 --- a/src/objc/imap/MCOIMAPCopyMessagesOperation.h +++ b/src/objc/imap/MCOIMAPCopyMessagesOperation.h @@ -12,17 +12,24 @@ #define __MAILCORE_MCOCOPYMESSAGESOPERATION_H_ -// This class implements an operation to copy messages. +/** Implements an operation for copying messages between folders */ @class MCOIndexSet; @interface MCOIMAPCopyMessagesOperation : MCOIMAPBaseOperation -// Starts the asynchronous operation. -// On success, the completion block will be called with nil as error. destUids will contain the UID of the messages -// created in the destination folder if UIDPLUS is supported. destUids will be nil if UIDPLUS is not supported. -// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h. -// info will be nil. +/** + Starts the asynchronous copy operation. + + @param completionBlock Called when the operation is finished. + + - On success `error` will be nil and `destUids` will contain the UIDs of the messages created + in the destination folder. If the server doesn't support UIDPLUS then `destUids` will be nil. + + - On failure, `error` will be set with `MCOErrorDomain` as domain and an + error code available in `MCOConstants.h`, `destUids` will be nil +*/ + - (void) start:(void (^)(NSError * error, MCOIndexSet * destUids))completionBlock; @end -- cgit v1.2.3