Documented the Obj-C API for providers

1 files changed, 16 insertions, 0 deletions

diff --git a/src/objc/provider/MCONetService.h b/src/objc/provider/MCONetService.h
index 9eeb3649..482ae4dc 100644
--- a/src/objc/provider/MCONetService.h
+++ b/src/objc/provider/MCONetService.h
@@ -9,10 +9,22 @@
 #import <Foundation/Foundation.h>
 #import <MailCore/MCOConstants.h>
 
+/**
+   This class provides a specific way to access a given service
+*/
+
 @interface MCONetService : NSObject
 
+/**
+   The hostname of the server. [MCONetService hostnameWithEmail:] is recommended
+   instead as it can handle services with custom domains 
+*/
 @property (nonatomic, copy) NSString * hostname;
+
+/** The port number of the service */
 @property (nonatomic, assign) unsigned int port;
+
+/** What kind of connection type is supported, like SSL, Start TLS, Plain etc. */
 @property (nonatomic, assign) MCOConnectionType connectionType;
 
 + (MCONetService *) serviceWithInfo:(NSDictionary *)info;
@@ -20,6 +32,10 @@
 - (id) initWithInfo:(NSDictionary *)info;
 - (NSDictionary *) info;
 
+/** 
+    If the service uses a custom domain this will return the proper hostname based
+    off the email address
+*/
 - (NSString *) hostnameWithEmail:(NSString *)email;
 
 @end