aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objc/imap/MCOIMAPCapabilityOperation.h
diff options
context:
space:
mode:
authorGravatar Matt Ronge <mronge@mronge.com>2013-06-02 20:41:28 -0500
committerGravatar Matt Ronge <mronge@mronge.com>2013-06-02 20:41:28 -0500
commit3ae5bf7a1d806c749c28f641be34733c85808efe (patch)
tree27513da58055e421686ace2601d37a1e23eacb28 /src/objc/imap/MCOIMAPCapabilityOperation.h
parent6fbe6f212003b97860a23c254e5124f0b2578366 (diff)
Finished formatting docs for Appledoc for IMAP and SMTP
Diffstat (limited to 'src/objc/imap/MCOIMAPCapabilityOperation.h')
-rw-r--r--src/objc/imap/MCOIMAPCapabilityOperation.h22
1 files changed, 16 insertions, 6 deletions
diff --git a/src/objc/imap/MCOIMAPCapabilityOperation.h b/src/objc/imap/MCOIMAPCapabilityOperation.h
index 38166e0b..29b0d3be 100644
--- a/src/objc/imap/MCOIMAPCapabilityOperation.h
+++ b/src/objc/imap/MCOIMAPCapabilityOperation.h
@@ -10,7 +10,10 @@
#define __MAILCORE_MCOIMAPCAPBILITYOPERATION_H_
-// This class implements an operation to query capabilities.
+/**
+ This class implements an operation to query for IMAP capabilities,
+ like for example the extensions UIDPLUS, IDLE, NAMESPACE, ... etc
+*/
#import <MailCore/MCOIMAPBaseOperation.h>
@@ -18,11 +21,18 @@
@interface MCOIMAPCapabilityOperation : MCOIMAPBaseOperation
-// Starts the asynchronous operation.
-// On success, the completion block will be called with nil as error. capabilities is a set of IMAP capabilities.
-// See MCOConstants.h / MCOIMAPCapability.
-// 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 capabilities operation.
+
+ @param completionBlock Called when the operation is finished.
+
+ - On success `error` will be nil and `capabilities` will contain a set of IMAP capabilities.
+ See `MCOConstants.h` under `MCOIMAPCapability` for a list of possible values.
+
+ - On failure, `error` will be set with `MCOErrorDomain` as domain and an
+ error code available in MCOConstants.h, `capabilities` will be nil
+*/
- (void) start:(void (^)(NSError * error, MCOIndexSet * capabilities))completionBlock;
@end