From 3151a61ac3dd633a6b3c9c17ae2ca63f0c4fa698 Mon Sep 17 00:00:00 2001 From: Zsika Phillip Date: Tue, 15 Aug 2017 12:54:05 -0700 Subject: Small improvements to reference docs (#193) --- Firebase/Auth/Source/Public/FIRActionCodeSettings.h | 8 ++++---- Firebase/Auth/Source/Public/FIRAuth.h | 6 +++--- Firebase/Auth/Source/Public/FIRUser.h | 2 +- Firebase/Auth/Source/RPCs/FIRGetOOBConfirmationCodeRequest.h | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) (limited to 'Firebase') diff --git a/Firebase/Auth/Source/Public/FIRActionCodeSettings.h b/Firebase/Auth/Source/Public/FIRActionCodeSettings.h index e5fe114..d0a54e4 100644 --- a/Firebase/Auth/Source/Public/FIRActionCodeSettings.h +++ b/Firebase/Auth/Source/Public/FIRActionCodeSettings.h @@ -21,7 +21,7 @@ NS_ASSUME_NONNULL_BEGIN /** @class FIRActionCodeSettings - @brief Used to set and retrieve settings related to the handling action codes. + @brief Used to set and retrieve settings related to handling action codes. */ FIR_SWIFT_NAME(ActionCodeSettings) @interface FIRActionCodeSettings : NSObject @@ -30,12 +30,12 @@ @brief This URL represents the state/Continue URL in the form of a universal link. @remarks This URL can should be contructed as a universal link that would either directly open the app where the action code would be handled or continue to the app after the action code - handled by Firebase. + is handled by Firebase. */ @property(nonatomic, copy, nullable) NSURL *URL; /** @property handleCodeInApp - @brief Indicates whether or not the action code link will open the app directly or after being + @brief Indicates whether the action code link will open the app directly or after being redirected from a Firebase owned web widget. */ @property(assign, nonatomic) BOOL handleCodeInApp; @@ -56,7 +56,7 @@ @property(nonatomic, copy, readonly, nullable) NSString *androidMinimumVersion; /** @property androidInstallIfNotAvailable - @brief Indicates whether the Android app should be installed or not on a device where it is not + @brief Indicates whether the Android app should be installed on a device where it is not available. */ @property(nonatomic, assign, readonly) BOOL androidInstallIfNotAvailable; diff --git a/Firebase/Auth/Source/Public/FIRAuth.h b/Firebase/Auth/Source/Public/FIRAuth.h index e3b6b3c..ad6b635 100644 --- a/Firebase/Auth/Source/Public/FIRAuth.h +++ b/Firebase/Auth/Source/Public/FIRAuth.h @@ -67,7 +67,7 @@ typedef void(^FIRIDTokenDidChangeListenerBlock)(FIRAuth *auth, FIRUser *_Nullabl @brief The type of block invoked when sign-in related events complete. @param authResult Optionally; Result of sign-in request containing both the user and - the additional user info. + the additional user info associated with the user. @param error Optionally; the error which occurred - or nil if the request was successful. */ typedef void (^FIRAuthDataResultCallback)(FIRAuthDataResult *_Nullable authResult, @@ -548,7 +548,7 @@ FIR_SWIFT_NAME(Auth) @brief Initiates a password reset for the given email address and @FIRActionCodeSettings object. @param email The email address of the user. - @param actionCodeSettings An @c FIRActionCodeSettings object containing settings related to the + @param actionCodeSettings An @c FIRActionCodeSettings object containing settings related to handling action codes. @param completion Optionally; a block which is invoked when the request finishes. Invoked asynchronously on the main thread in the future. @@ -565,7 +565,7 @@ FIR_SWIFT_NAME(Auth) sending update email.
  • @c FIRAuthErrorCodeMissingIosBundleID - Indicates that the iOS bundle ID is missing when - a iOS App Store ID is provided. + @c handleCodeInApp is set to YES.
  • @c FIRAuthErrorCodeMissingAndroidPackageName - Indicates that the android package name is missing when the @c androidInstallApp flag is set to true. diff --git a/Firebase/Auth/Source/Public/FIRUser.h b/Firebase/Auth/Source/Public/FIRUser.h index 8d0e8f6..d87f639 100644 --- a/Firebase/Auth/Source/Public/FIRUser.h +++ b/Firebase/Auth/Source/Public/FIRUser.h @@ -404,7 +404,7 @@ FIR_SWIFT_NAME(User) /** @fn sendEmailVerificationWithActionCodeSettings:completion: @brief Initiates email verification for the user. - @param actionCodeSettings An @c FIRActionCodeSettings object containing settings related to the + @param actionCodeSettings An @c FIRActionCodeSettings object containing settings related to handling action codes. @remarks Possible error codes: diff --git a/Firebase/Auth/Source/RPCs/FIRGetOOBConfirmationCodeRequest.h b/Firebase/Auth/Source/RPCs/FIRGetOOBConfirmationCodeRequest.h index 34714e5..abd59b4 100644 --- a/Firebase/Auth/Source/RPCs/FIRGetOOBConfirmationCodeRequest.h +++ b/Firebase/Auth/Source/RPCs/FIRGetOOBConfirmationCodeRequest.h @@ -86,7 +86,7 @@ typedef NS_ENUM(NSInteger, FIRGetOOBConfirmationCodeRequestType) { @property(nonatomic, assign, readonly) BOOL androidInstallApp; /** @property handleCodeInApp - @brief Indicates whether or not the action code link will open the app directly or after being + @brief Indicates whether the action code link will open the app directly or after being redirected from a Firebase owned web widget. */ @property(assign, nonatomic) BOOL handleCodeInApp; -- cgit v1.2.3