Updating the Auth header comments for Jazzy syntax (#535)

Author: alexg33

Firebase/Auth/Source/Public/FIRAdditionalUserInfo.h

@@ -27,8 +27,8 @@ NS_SWIFT_NAME(AdditionalUserInfo)
 @interface FIRAdditionalUserInfo : NSObject
 
 /** @fn init
-    @brief This class should not be initialized manually. @c FIRAdditionalUserInfo can be retrieved
-        from from an instance of @c FIRAuthDataResult.
+    @brief This class should not be initialized manually. `FIRAdditionalUserInfo` can be retrieved
+        from from an instance of `FIRAuthDataResult`.
  */
 - (instancetype)init NS_UNAVAILABLE;
 

Firebase/Auth/Source/Public/FIRAuth.h

@@ -29,8 +29,8 @@ NS_SWIFT_NAME(AuthDataResult)
 @interface FIRAuthDataResult : NSObject
 
 /** @fn init
-    @brief This class should not be initialized manually. @c FIRAuthDataResult instance is
-        returned as part of @c FIRAuthDataResultCallback .
+    @brief This class should not be initialized manually. `FIRAuthDataResult` instance is
+        returned as part of `FIRAuthDataResultCallback`.
  */
 - (instancetype)init NS_UNAVAILABLE;
 

Firebase/Auth/Source/Public/FIRAuthDataResult.h

@@ -18,21 +18,21 @@
 
 /** @class FIRAuthErrors
     @remarks Error Codes common to all API Methods:
-    <ul>
-        <li>@c FIRAuthErrorCodeNetworkError</li>
-        <li>@c FIRAuthErrorCodeUserNotFound</li>
-        <li>@c FIRAuthErrorCodeUserTokenExpired</li>
-        <li>@c FIRAuthErrorCodeTooManyRequests</li>
-        <li>@c FIRAuthErrorCodeInvalidAPIKey</li>
-        <li>@c FIRAuthErrorCodeAppNotAuthorized</li>
-        <li>@c FIRAuthErrorCodeKeychainError</li>
-        <li>@c FIRAuthErrorCodeInternalError</li>
-    </ul>
-    @remarks Common error codes for @c FIRUser operations:
-    <ul>
-        <li>@c FIRAuthErrorCodeInvalidUserToken</li>
-        <li>@c FIRAuthErrorCodeUserDisabled</li>
-    </ul>
+
+        + `FIRAuthErrorCodeNetworkError`
+        + `FIRAuthErrorCodeUserNotFound`
+        + `FIRAuthErrorCodeUserTokenExpired`
+        + `FIRAuthErrorCodeTooManyRequests`
+        + `FIRAuthErrorCodeInvalidAPIKey`
+        + `FIRAuthErrorCodeAppNotAuthorized`
+        + `FIRAuthErrorCodeKeychainError`
+        + `FIRAuthErrorCodeInternalError`
+
+    @remarks Common error codes for `FIRUser` operations:
+
+        + `FIRAuthErrorCodeInvalidUserToken`
+        + `FIRAuthErrorCodeUserDisabled`
+
  */
 NS_SWIFT_NAME(AuthErrors)
 @interface FIRAuthErrors
@@ -54,8 +54,8 @@ extern NSString *const FIRAuthUpdatedCredentialKey NS_SWIFT_NAME(AuthUpdatedCred
 extern NSString *const FIRAuthErrorNameKey NS_SWIFT_NAME(AuthErrorNameKey);
 
 /**
-    @brief Errors with the code @c FIRAuthErrorCodeAccountExistsWithDifferentCredential may contain
-        an @c NSError.userInfo dictinary object which contains this key. The value associated with
+    @brief Errors with the code `FIRAuthErrorCodeAccountExistsWithDifferentCredential` may contain
+        an `NSError.userInfo` dictinary object which contains this key. The value associated with
         this key is an NSString of the email address of the account that already exists.
  */
 extern NSString *const FIRAuthErrorUserInfoEmailKey NS_SWIFT_NAME(AuthErrorUserInfoEmailKey);
@@ -127,7 +127,7 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
 
     /** 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
+        `NSUnderlyingError` field in the `NSError.userInfo` dictionary will contain the error
         encountered.
      */
     FIRAuthErrorCodeNetworkError = 17020,
@@ -192,7 +192,7 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
      */
     FIRAuthErrorCodeMissingIosBundleID = 17036,
 
-    /** Indicates that the android package name is missing when the @c androidInstallApp flag is set
+    /** Indicates that the android package name is missing when the `androidInstallApp` flag is set
         to true.
      */
     FIRAuthErrorCodeMissingAndroidPackageName = 17037,
@@ -212,12 +212,12 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
     FIRAuthErrorCodeMissingContinueURI = 17040,
 
     /** Indicates that a phone number was not provided in a call to
-        @c verifyPhoneNumber:completion:.
+        `verifyPhoneNumber:completion:`.
      */
     FIRAuthErrorCodeMissingPhoneNumber = 17041,
 
     /** Indicates that an invalid phone number was provided in a call to
-        @c verifyPhoneNumber:completion:.
+        `verifyPhoneNumber:completion:`.
      */
     FIRAuthErrorCodeInvalidPhoneNumber = 17042,
 
@@ -295,7 +295,7 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
      */
     FIRAuthErrorCodeWebNetworkRequestFailed = 17061,
 
-    /** Indicates that an internal error occured within a SFSafariViewController or UIWebview.
+    /** Indicates that an internal error occurred within a SFSafariViewController or UIWebview.
      */
     FIRAuthErrorCodeWebInternalError = 17062,
 

Firebase/Auth/Source/Public/FIRAuthErrors.h

@@ -26,24 +26,24 @@ NS_ASSUME_NONNULL_BEGIN
 extern NSString *const FIREmailAuthProviderID NS_SWIFT_NAME(EmailAuthProviderID);
 
 /**
-    @brief please use @c FIREmailAuthProviderID instead.
+    @brief please use `FIREmailAuthProviderID` instead.
  */
 extern NSString *const FIREmailPasswordAuthProviderID __attribute__((deprecated));
 
 /** @class FIREmailAuthProvider
-    @brief A concrete implementation of @c FIRAuthProvider for Email & Password Sign In.
+    @brief A concrete implementation of `FIRAuthProvider` for Email & Password Sign In.
  */
 NS_SWIFT_NAME(EmailAuthProvider)
 @interface FIREmailAuthProvider : NSObject
 
 /** @typedef FIREmailPasswordAuthProvider
-    @brief Please use @c FIREmailAuthProvider instead.
+    @brief Please use `FIREmailAuthProvider` instead.
  */
 typedef FIREmailAuthProvider FIREmailPasswordAuthProvider __attribute__((deprecated));
 
 
 /** @fn credentialWithEmail:password:
-    @brief Creates an @c FIRAuthCredential for an email & password sign in.
+    @brief Creates an `FIRAuthCredential` for an email & password sign in.
 
     @param email The user's email address.
     @param password The user's password.

Firebase/Auth/Source/Public/FIREmailAuthProvider.h

@@ -32,7 +32,7 @@ NS_SWIFT_NAME(FacebookAuthProvider)
 @interface FIRFacebookAuthProvider : NSObject
 
 /** @fn credentialWithAccessToken:
-    @brief Creates an @c FIRAuthCredential for a Facebook sign in.
+    @brief Creates an `FIRAuthCredential` for a Facebook sign in.
 
     @param accessToken The Access Token from Facebook.
     @return A FIRAuthCredential containing the Facebook credentials.

Firebase/Auth/Source/Public/FIRFacebookAuthProvider.h

@@ -32,7 +32,7 @@ NS_SWIFT_NAME(GitHubAuthProvider)
 @interface FIRGitHubAuthProvider : NSObject
 
 /** @fn credentialWithToken:
-    @brief Creates an @c FIRAuthCredential for a GitHub sign in.
+    @brief Creates an `FIRAuthCredential` for a GitHub sign in.
 
     @param token The GitHub OAuth access token.
     @return A FIRAuthCredential containing the GitHub credential.

Firebase/Auth/Source/Public/FIRGitHubAuthProvider.h

@@ -32,7 +32,7 @@ NS_SWIFT_NAME(GoogleAuthProvider)
 @interface FIRGoogleAuthProvider : NSObject
 
 /** @fn credentialWithIDToken:accessToken:
-    @brief Creates an @c FIRAuthCredential for a Google sign in.
+    @brief Creates an `FIRAuthCredential` for a Google sign in.
 
     @param IDToken The ID Token from Google.
     @param accessToken The Access Token from Google.

Firebase/Auth/Source/Public/FIRGoogleAuthProvider.h

@@ -21,13 +21,13 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /** @class FIROAuthProvider
-    @brief A concrete implementation of @c FIRAuthProvider for generic OAuth Providers.
+    @brief A concrete implementation of `FIRAuthProvider` for generic OAuth Providers.
  */
 NS_SWIFT_NAME(OAuthProvider)
 @interface FIROAuthProvider : NSObject
 
 /** @fn credentialWithProviderID:IDToken:accessToken:
-    @brief Creates an @c FIRAuthCredential for that OAuth 2 provider identified by providerID, ID
+    @brief Creates an `FIRAuthCredential` for that OAuth 2 provider identified by providerID, ID
         token and access token.
 
     @param providerID The provider ID associated with the Auth credential being created.
@@ -42,7 +42,7 @@ NS_SWIFT_NAME(OAuthProvider)
 
 
 /** @fn credentialWithProviderID:accessToken:
-    @brief Creates an @c FIRAuthCredential for that OAuth 2 provider identified by providerID using
+    @brief Creates an `FIRAuthCredential` for that OAuth 2 provider identified by providerID using
       an ID token.
 
     @param providerID The provider ID associated with the Auth credential being created.

Firebase/Auth/Source/Public/FIROAuthProvider.h

@@ -38,47 +38,44 @@ typedef void (^FIRVerificationResultCallback)(NSString *_Nullable verificationID
     NS_SWIFT_NAME(VerificationResultCallback);
 
 /** @class FIRPhoneAuthProvider
-    @brief A concrete implementation of @c FIRAuthProvider for phone auth providers.
+    @brief A concrete implementation of `FIRAuthProvider` for phone auth providers.
  */
 NS_SWIFT_NAME(PhoneAuthProvider)
 @interface FIRPhoneAuthProvider : NSObject
 
 /** @fn provider
-    @brief Returns an instance of @c FIRPhoneAuthProvider for the default @c FIRAuth object.
+    @brief Returns an instance of `FIRPhoneAuthProvider` for the default `FIRAuth` object.
  */
 + (instancetype)provider NS_SWIFT_NAME(provider());
 
 /** @fn providerWithAuth:
-    @brief Returns an instance of @c FIRPhoneAuthProvider for the provided @c FIRAuth object.
+    @brief Returns an instance of `FIRPhoneAuthProvider` for the provided `FIRAuth` object.
 
     @param auth The auth object to associate with the phone auth provider instance.
  */
 + (instancetype)providerWithAuth:(FIRAuth *)auth NS_SWIFT_NAME(provider(auth:));
 
 /** @fn verifyPhoneNumber:completion:
-    @brief Please use @c verifyPhoneNumber:UIDelegate:completion: instead.
+    @brief Please use `verifyPhoneNumber:UIDelegate:completion:` instead.
 
     @param phoneNumber The phone number to be verified.
     @param completion The callback to be invoked when the verification flow is finished.
 
     @remarks Possible error codes:
-    <ul>
-        <li>@c FIRAuthErrorCodeAppNotVerified - Indicates that Firebase could not retrieve the
-            silent push notification and therefore could not verify your app.</li>
-        <li>@c FIRAuthErrorCodeInvalidAppCredential - Indicates that The APNs device token provided
+
+        + `FIRAuthErrorCodeAppNotVerified` - Indicates that Firebase could not retrieve the
+            silent push notification and therefore could not verify your app.
+        + `FIRAuthErrorCodeInvalidAppCredential` - Indicates that The APNs device token provided
             is either incorrect or does not match the private certificate uploaded to the Firebase
-            Console.</li>
-        <li>@c FIRAuthErrorCodeQuotaExceeded - Indicates that the phone verification quota for this
-            project has been exceeded.</li>
-        <li>@c FIRAuthErrorCodeInvalidPhoneNumber - Indicates that the phone number provided is
-            invalid.</li>
-        <li>@c FIRAuthErrorCodeMissingPhoneNumber - Indicates that a phone number was not provided.
-        </li>
-        <li>@c FIRAuthErrorCodeMissingAppToken - Indicates that the APNs device token could not be
+            Console.
+        + `FIRAuthErrorCodeQuotaExceeded` - Indicates that the phone verification quota for this
+            project has been exceeded.
+        + `FIRAuthErrorCodeInvalidPhoneNumber` - Indicates that the phone number provided is
+            invalid.
+        + `FIRAuthErrorCodeMissingPhoneNumber` - Indicates that a phone number was not provided.
+        + `FIRAuthErrorCodeMissingAppToken` - Indicates that the APNs device token could not be
             obtained. The app may not have set up remote notification correctly, or may fail to
             forward the APNs device token to FIRAuth if app delegate swizzling is disabled.
-        </li>
-    </ul>
  */
 - (void)verifyPhoneNumber:(NSString *)phoneNumber
                completion:(nullable FIRVerificationResultCallback)completion
@@ -92,23 +89,21 @@ NS_SWIFT_NAME(PhoneAuthProvider)
         by this method until the completion block is executed.
     @param completion The callback to be invoked when the verification flow is finished.
     @remarks Possible error codes:
-    <ul>
-        <li>@c FIRAuthErrorCodeCaptchaCheckFailed - Indicates that the reCAPTCHA token obtained by
-            the Firebase Auth is invalid or has expired.</li>
-        <li>@c FIRAuthErrorCodeQuotaExceeded - Indicates that the phone verification quota for this
-            project has been exceeded.</li>
-        <li>@c FIRAuthErrorCodeInvalidPhoneNumber - Indicates that the phone number provided is
-            invalid.</li>
-        <li>@c FIRAuthErrorCodeMissingPhoneNumber - Indicates that a phone number was not provided.
-        </li>
-    </ul>
+
+        + `FIRAuthErrorCodeCaptchaCheckFailed` - Indicates that the reCAPTCHA token obtained by
+            the Firebase Auth is invalid or has expired.
+        + `FIRAuthErrorCodeQuotaExceeded` - Indicates that the phone verification quota for this
+            project has been exceeded.
+        + `FIRAuthErrorCodeInvalidPhoneNumber` - Indicates that the phone number provided is
+            invalid.
+        + `FIRAuthErrorCodeMissingPhoneNumber` - Indicates that a phone number was not provided.
  */
 - (void)verifyPhoneNumber:(NSString *)phoneNumber
                UIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
                completion:(nullable FIRVerificationResultCallback)completion;
 
 /** @fn credentialWithVerificationID:verificationCode:
-    @brief Creates an @c FIRAuthCredential for the phone number provider identified by the
+    @brief Creates an `FIRAuthCredential` for the phone number provider identified by the
         verification ID and verification code.
 
     @param verificationID The verification ID obtained from invoking
@@ -121,8 +116,8 @@ NS_SWIFT_NAME(PhoneAuthProvider)
                                         verificationCode:(NSString *)verificationCode;
 
 /** @fn init
-    @brief Please use the @c provider or @c providerWithAuth: methods to obtain an instance of
-        @c FIRPhoneAuthProvider.
+    @brief Please use the `provider` or `providerWithAuth:` methods to obtain an instance of
+        `FIRPhoneAuthProvider`.
  */
 - (instancetype)init NS_UNAVAILABLE;