diff options
author | Matt Ronge <mronge@mronge.com> | 2013-06-02 20:41:28 -0500 |
---|---|---|
committer | Matt Ronge <mronge@mronge.com> | 2013-06-02 20:41:28 -0500 |
commit | 3ae5bf7a1d806c749c28f641be34733c85808efe (patch) | |
tree | 27513da58055e421686ace2601d37a1e23eacb28 /src/objc/imap/MCOIMAPFetchContentOperation.h | |
parent | 6fbe6f212003b97860a23c254e5124f0b2578366 (diff) |
Finished formatting docs for Appledoc for IMAP and SMTP
Diffstat (limited to 'src/objc/imap/MCOIMAPFetchContentOperation.h')
-rw-r--r-- | src/objc/imap/MCOIMAPFetchContentOperation.h | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/src/objc/imap/MCOIMAPFetchContentOperation.h b/src/objc/imap/MCOIMAPFetchContentOperation.h index f43425bb..1886981a 100644 --- a/src/objc/imap/MCOIMAPFetchContentOperation.h +++ b/src/objc/imap/MCOIMAPFetchContentOperation.h @@ -10,22 +10,32 @@ #define __MAILCORE_MCOIMAPFETCHCONTENTOPERATION_H_ -// This class implements an operation to fetch the content of a message. -// It can be a part or a full message. +/** + This class implements an operation to fetch the content of a message. + It can be a part or a full message. +*/ #import <MailCore/MCOIMAPBaseOperation.h> #import <MailCore/MCOConstants.h> @interface MCOIMAPFetchContentOperation : MCOIMAPBaseOperation -// This block will be called during the progression while receiving the message -// when some bytes have been downloaded from the network. +/** + This block will be called as bytes are received from the network +*/ @property (nonatomic, copy) MCOIMAPBaseOperationProgressBlock progress; -// Starts the asynchronous operation. -// On success, the completion block will be called with nil as error. data contains the requested data of the message. -// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h. -// data will be nil. +/** + Starts the asynchronous fetch operation. + + @param completionBlock Called when the operation is finished. + + - On success `error` will be nil and `data` will contain the requested data + + - On failure, `error` will be set with `MCOErrorDomain` as domain and an + error code available in `MCOConstants.h`, `data` will be nil +*/ + - (void) start:(void (^)(NSError * error, NSData * data))completionBlock; @end |