Skip to content

Commit 4c2c86d

Browse files
authored
fix doc comments in auth header (#9846)
1 parent 55a8146 commit 4c2c86d

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuthErrors.h

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ NS_ASSUME_NONNULL_BEGIN
2121
/** @class FIRAuthErrors
2222
@remarks Error Codes common to all API Methods:
2323
24-
+ `FIRAuthErrorCodeNetworkError`
25-
+ `FIRAuthErrorCodeUserNotFound`
26-
+ `FIRAuthErrorCodeUserTokenExpired`
27-
+ `FIRAuthErrorCodeTooManyRequests`
28-
+ `FIRAuthErrorCodeInvalidAPIKey`
29-
+ `FIRAuthErrorCodeAppNotAuthorized`
30-
+ `FIRAuthErrorCodeKeychainError`
31-
+ `FIRAuthErrorCodeInternalError`
24+
+ `AuthErrorCodeNetworkError`
25+
+ `AuthErrorCodeUserNotFound`
26+
+ `AuthErrorCodeUserTokenExpired`
27+
+ `AuthErrorCodeTooManyRequests`
28+
+ `AuthErrorCodeInvalidAPIKey`
29+
+ `AuthErrorCodeAppNotAuthorized`
30+
+ `AuthErrorCodeKeychainError`
31+
+ `AuthErrorCodeInternalError`
3232
33-
@remarks Common error codes for `FIRUser` operations:
33+
@remarks Common error codes for `User` operations:
3434
35-
+ `FIRAuthErrorCodeInvalidUserToken`
36-
+ `FIRAuthErrorCodeUserDisabled`
35+
+ `AuthErrorCodeInvalidUserToken`
36+
+ `AuthErrorCodeUserDisabled`
3737
3838
*/
3939
NS_SWIFT_NAME(AuthErrors)
@@ -51,10 +51,10 @@ extern NSString *const FIRAuthErrorUserInfoNameKey NS_SWIFT_NAME(AuthErrorUserIn
5151

5252
/**
5353
@brief Errors with one of the following three codes:
54-
- `FIRAuthErrorCodeAccountExistsWithDifferentCredential`
55-
- `FIRAuthErrorCodeCredentialAlreadyInUse`
56-
- `FIRAuthErrorCodeEmailAlreadyInUse`
57-
may contain an `NSError.userInfo` dictinary object which contains this key. The value
54+
- `AuthErrorCodeAccountExistsWithDifferentCredential`
55+
- `AuthErrorCodeCredentialAlreadyInUse`
56+
- `AuthErrorCodeEmailAlreadyInUse`
57+
may contain an `NSError.userInfo` dictinary object which contains this key. The value
5858
associated with this key is an NSString of the email address of the account that already
5959
exists.
6060
*/
@@ -275,12 +275,12 @@ typedef NS_ERROR_ENUM(FIRAuthErrorDomain, FIRAuthErrorCode){
275275
FIRAuthErrorCodeQuotaExceeded = 17052,
276276

277277
/** Indicates that the APNs device token could not be obtained. The app may not have set up
278-
remote notification correctly, or may fail to forward the APNs device token to FIRAuth
278+
remote notification correctly, or may fail to forward the APNs device token to Auth
279279
if app delegate swizzling is disabled.
280280
*/
281281
FIRAuthErrorCodeMissingAppToken = 17053,
282282

283-
/** Indicates that the app fails to forward remote notification to FIRAuth.
283+
/** Indicates that the app fails to forward remote notification to Auth.
284284
*/
285285
FIRAuthErrorCodeNotificationNotForwarded = 17054,
286286

0 commit comments

Comments
 (0)