Auth jazzy fixes and Swift sample updates (#19)

* Removes the '@c' that would cause Jazzy issue down the road.

4 files changed, 27 insertions, 26 deletions

diff --git a/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h b/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h
index bc12b43..6102822 100644
--- a/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h
+++ b/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h
@@ -16,9 +16,9 @@
 
 #import <Foundation/Foundation.h>
 
-#import "FIRAuth.h"
 #import "FIRAuthSwiftNameSupport.h"
 
+@class FIRAuth;
 @class FIRPhoneAuthCredential;
 
 NS_ASSUME_NONNULL_BEGIN
@@ -38,8 +38,8 @@ typedef void (^FIRVerificationResultCallback)(NSString *_Nullable verificationID
                                               NSError *_Nullable error)
     FIR_SWIFT_NAME(VerificationResultCallback);
 
-/** @class FIRPhoneNumberProvider
-    @brief A concrete implementation of @c FIRAuthProvider for Phone Auth Providers.
+/** @class FIRPhoneAuthProvider
+    @brief A concrete implementation of @c FIRAuthProvider for phone auth providers.
  */
 FIR_SWIFT_NAME(PhoneAuthProvider)
 @interface FIRPhoneAuthProvider : NSObject
@@ -52,7 +52,7 @@ FIR_SWIFT_NAME(PhoneAuthProvider)
 /** @fn providerWithAuth:
     @brief Returns an instance of @c FIRPhoneAuthProvider for the provided @c FIRAuth object.
 
-    @param auth The auth object to associate with the @c PhoneauthProvider instance.
+    @param auth The auth object to associate with the phone auth provider instance.
  */
 + (instancetype)providerWithAuth:(FIRAuth *)auth FIR_SWIFT_NAME(provider(auth:));
 
@@ -70,18 +70,18 @@ FIR_SWIFT_NAME(PhoneAuthProvider)
     @brief Creates an @c FIRAuthCredential for the phone number provider identified by the
         verification ID and verification code.
 
-    @param verificationID The verification ID obtained from invoking @c
+    @param verificationID The verification ID obtained from invoking
         verifyPhoneNumber:completion:
     @param verificationCode The verification code obtained from the user.
-    @return The corresponding @c FIRAuthCredential for the verification ID and verification code
+    @return The corresponding phone auth credential for the verification ID and verification code
         provided.
  */
 - (FIRPhoneAuthCredential *)credentialWithVerificationID:(NSString *)verificationID
                                         verificationCode:(NSString *)verificationCode;
 
 /** @fn init
-    @brief Please use the @c provider or @providerWithAuth: methods to obtain an instance of @c
-        FIRPhoneAuthProvider.
+    @brief Please use the @c provider or @c providerWithAuth: methods to obtain an instance of
+        @c FIRPhoneAuthProvider.
  */
 - (instancetype)init NS_UNAVAILABLE;
 
diff --git a/Firebase/Auth/Source/FIRAuth.h b/Firebase/Auth/Source/FIRAuth.h
index b913380..6e59e86 100644
--- a/Firebase/Auth/Source/FIRAuth.h
+++ b/Firebase/Auth/Source/FIRAuth.h
@@ -62,8 +62,8 @@ typedef void(^FIRIDTokenDidChangeListenerBlock)(FIRAuth *auth, FIRUser *_Nullabl
 /** @typedef FIRAuthDataResultCallback
     @brief The type of block invoked when sign-in related events complete.
 
-    @param authResult Optionally; Result of sign-in request containing @c FIRUser and
-       @c FIRAdditionalUserInfo.
+    @param authResult Optionally; Result of sign-in request containing both the user and
+       the additional user info.
     @param error Optionally; the error which occurred - or nil if the request was successful.
  */
 typedef void (^FIRAuthDataResultCallback)(FIRAuthDataResult *_Nullable authResult,
@@ -151,8 +151,8 @@ typedef void (^FIRApplyActionCodeCallback)(NSError *_Nullable error)
     FIR_SWIFT_NAME(ApplyActionCodeCallback);
 
 /**
-    @brief Keys used to retrieve operation data from a @c FIRActionCodeInfo object by the @c
-        dataForKey method.
+    @brief Keys used to retrieve operation data from a @c FIRActionCodeInfo object by the
+        @c dataForKey method.
   */
 typedef NS_ENUM(NSInteger, FIRActionDataKey) {
   /**
@@ -598,8 +598,8 @@ FIR_SWIFT_NAME(Auth)
     @brief Whether the specific remote notification is handled by @c FIRAuth .
     @param userInfo A dictionary that contains information related to the
         notification in question.
-    @return Whether or the notification is handled. @c YES means the notification is for @c FIRAuth
-        so the caller should ignore the notification from further processing, and @c NO means the
+    @return Whether or the notification is handled. YES means the notification is for Firebase Auth
+        so the caller should ignore the notification from further processing, and NO means the
         the notification is for the app (or another libaray) so the caller should continue handling
         this notification as usual.
     @remarks If swizzling is disabled, related remote notifications must be forwarded to this method
diff --git a/Firebase/Auth/Source/FIRAuthErrorUtils.m b/Firebase/Auth/Source/FIRAuthErrorUtils.m
index 8179d02..dbeb5d1 100644
--- a/Firebase/Auth/Source/FIRAuthErrorUtils.m
+++ b/Firebase/Auth/Source/FIRAuthErrorUtils.m
@@ -241,20 +241,20 @@ static NSString *const kFIRAuthErrorMessageInvalidPhoneNumber =
     @brief Message for @c FIRAuthErrorCodeMissingVerificationCode error code.
  */
 static NSString *const kFIRAuthErrorMessageMissingVerificationCode =
-    @"The Phone Auth Credential was created with an empty SMS verification Code.";
+    @"The phone auth credential was created with an empty SMS verification Code.";
 
 /** @var kFIRAuthErrorMessageInvalidVerificationCode
     @brief Message for @c FIRAuthErrorCodeInvalidVerificationCode error code.
  */
 static NSString *const kFIRAuthErrorMessageInvalidVerificationCode =
     @"The SMS verification code used to create the phone auth credential is invalid. Please resend "
-    "the verification code sms and be sure use the verification code provided by the user.";
+    "the verification code SMS and be sure to use the verification code provided by the user.";
 
 /** @var kFIRAuthErrorMessageMissingVerificationID
     @brief Message for @c FIRAuthErrorCodeInvalidVerificationID error code.
  */
 static NSString *const kFIRAuthErrorMessageMissingVerificationID =
-    @"The Phone Auth Credential was created with an empty verification ID.";
+    @"The phone auth credential was created with an empty verification ID.";
 
 /** @var kFIRAuthErrorMessageInvalidVerificationID
     @brief Message for @c FIRAuthErrorCodeInvalidVerificationID error code.
@@ -280,13 +280,14 @@ static NSString *const kFIRAuthErrorMessageMissingAppCredential = @"The phone ve
     @brief Message for @c FIRAuthErrorCodeInvalidAppCredential error code.
  */
 static NSString *const kFIRAuthErrorMessageInvalidAppCredential = @"The APNs device token provided "
-    "may be incorrect or does not match the private certificate uploaded to the Firebase Console.";
+    "is either incorrect or does not match the private certificate uploaded to the Firebase "
+    "Console.";
 
 /** @var kFIRAuthErrorMessageQuotaExceeded
     @brief Message for @c FIRAuthErrorCodeQuotaExceeded error code.
  */
-static NSString *const kFIRAuthErrorMessageQuotaExceeded = @"The SMS quota for this project has "
-    "been exceeded.";
+static NSString *const kFIRAuthErrorMessageQuotaExceeded = @"The phone verification quota for this "
+    "project has been exceeded.";
 
 /** @var kFIRAuthErrorMessageMissingAppToken
     @brief Message for @c FIRAuthErrorCodeMissingAppToken error code.
diff --git a/Firebase/Auth/Source/FIRAuthErrors.h b/Firebase/Auth/Source/FIRAuthErrors.h
index c1e7900..8a35ff5 100644
--- a/Firebase/Auth/Source/FIRAuthErrors.h
+++ b/Firebase/Auth/Source/FIRAuthErrors.h
@@ -128,8 +128,8 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
     FIRAuthErrorCodeInvalidUserToken = 17017,
 
     /** Indicates a network error occurred (such as a timeout, interrupted connection, or
-        unreachable host). These types of errors are often recoverable with a retry. The @c
-        NSUnderlyingError field in the @c NSError.userInfo dictionary will contain the error
+        unreachable host). These types of errors are often recoverable with a retry. The
+        @c NSUnderlyingError field in the @c NSError.userInfo dictionary will contain the error
         encountered.
      */
     FIRAuthErrorCodeNetworkError = 17020,
@@ -187,13 +187,13 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
     // The enum values between 17033 and 17041 are reserved and should NOT be used for new error
     // codes.
 
-    /** Indicates that a phone number was not provided in a call to @c
-        verifyPhoneNumber:completion:.
+    /** Indicates that a phone number was not provided in a call to
+        @c verifyPhoneNumber:completion:.
      */
     FIRAuthErrorCodeMissingPhoneNumber = 17041,
 
-    /** Indicates that an invalid phone number was provided in a call to @c
-        verifyPhoneNumber:completion:.
+    /** Indicates that an invalid phone number was provided in a call to
+        @c verifyPhoneNumber:completion:.
      */
     FIRAuthErrorCodeInvalidPhoneNumber = 17042,