Documented the Obj-C API for providers

1 files changed, 24 insertions, 0 deletions

diff --git a/src/objc/provider/MCOMailProvidersManager.h b/src/objc/provider/MCOMailProvidersManager.h
index 78d10ff2..1c4ef60f 100644
--- a/src/objc/provider/MCOMailProvidersManager.h
+++ b/src/objc/provider/MCOMailProvidersManager.h
@@ -8,14 +8,38 @@
 
 #import <Foundation/Foundation.h>
 
+/**
+   This class is used to detect an email provider and it's associated
+   metadata either by MX record or by the email addresss.
+
+   An app might want to use this during setup to limit the number of settings
+   a user has to input.
+*/
+
 @class MCOMailProvider;
 
 @interface MCOMailProvidersManager : NSObject
 
+/** The shared manager that is used for all lookups */
 + (MCOMailProvidersManager *) sharedManager;
 
+/** 
+    Given an email address will try to determine the provider
+    @return The email provider info or nil if it can't be determined.
+*/
 - (MCOMailProvider *) providerForEmail:(NSString *)email;
+
+/** 
+    Given the DNS MX record will try to determine the provider
+    @return The email provider info or nil if it can't be determined.
+*/
 - (MCOMailProvider *) providerForMX:(NSString *)hostname;
+
+/**
+   Will return information about a provider. Useful if you already know the
+   provider (like if it has been determined previously)
+   @return The email provider info or nil if none matches
+*/
 - (MCOMailProvider *) providerForIdentifier:(NSString *)identifier;
 
 @end