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/MCOIMAPFetchFoldersOperation.h | |
parent | 6fbe6f212003b97860a23c254e5124f0b2578366 (diff) |
Finished formatting docs for Appledoc for IMAP and SMTP
Diffstat (limited to 'src/objc/imap/MCOIMAPFetchFoldersOperation.h')
-rw-r--r-- | src/objc/imap/MCOIMAPFetchFoldersOperation.h | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/src/objc/imap/MCOIMAPFetchFoldersOperation.h b/src/objc/imap/MCOIMAPFetchFoldersOperation.h index 90feb870..e4352bd2 100644 --- a/src/objc/imap/MCOIMAPFetchFoldersOperation.h +++ b/src/objc/imap/MCOIMAPFetchFoldersOperation.h @@ -10,16 +10,22 @@ #define __MAILCORE_MCOIMAPFETCHFOLDERSOPERATION_H_ -// This class implements an operation to fetch a list of folders. +/** This class implements an operation to fetch a list of folders. */ #import <MailCore/MCOIMAPBaseOperation.h> @interface MCOIMAPFetchFoldersOperation : MCOIMAPBaseOperation -// Starts the asynchronous operation. -// On success, the completion block will be called with nil as error. folders will be an array of MCOIMAPFolder. -// On failure, error will be set with MCOErrorDomain as domain and an error code available in MCOConstants.h. -// folders will be nil. +/** + Starts the asynchronous fetch operation. + + @param completionBlock Called when the operation is finished. + + - On success `error` will be nil and `folders` will contain an array of MCOIMAPFolder + + - On failure, `error` will be set with `MCOErrorDomain` as domain and an + error code available in `MCOConstants.h`, `folders` will be nil +*/ - (void) start:(void (^)(NSError * error, NSArray * /* MCOIMAPFolder */ folders))completionBlock; @end |