Skip to content

Commit 7a273e7

Browse files
authored
fix returns typo (#9541)
1 parent 82f163b commit 7a273e7

File tree

11 files changed

+15
-15
lines changed

11 files changed

+15
-15
lines changed

FirebaseAppCheck/Sources/AppAttestProvider/Storage/FIRAppAttestKeyIDStorage.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ NS_ASSUME_NONNULL_BEGIN
2525

2626
/** Manages storage of an app attest key ID.
2727
* @param keyID The app attest key ID to store or `nil` to remove the existing app attest key ID.
28-
* @returns A promise that is resolved with a stored app attest key ID or `nil` if the existing app
28+
* @return A promise that is resolved with a stored app attest key ID or `nil` if the existing app
2929
* attest key ID has been removed.
3030
*/
3131
- (FBLPromise<NSString *> *)setAppAttestKeyID:(nullable NSString *)keyID;
3232

3333
/** Reads a stored app attest key ID.
34-
* @returns A promise that is resolved with a stored app attest key ID or `nil` if there is not a
34+
* @return A promise that is resolved with a stored app attest key ID or `nil` if there is not a
3535
* stored app attest key ID. The promise is rejected with an error in the case of a missing app
3636
* attest key ID .
3737
*/

FirebaseAppCheck/Sources/Core/Storage/FIRAppCheckStorage.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ NS_ASSUME_NONNULL_BEGIN
2626

2727
/** Manages storage of the FAA token.
2828
* @param token A token object to store or `nil` to remove existing token.
29-
* @returns A promise that is resolved with the stored object in the case of success or is rejected
29+
* @return A promise that is resolved with the stored object in the case of success or is rejected
3030
* with a specific error otherwise.
3131
*/
3232
- (FBLPromise<FIRAppCheckToken *> *)setToken:(nullable FIRAppCheckToken *)token;
3333

3434
/** Reads a stored FAA token.
35-
* @returns A promise that is resolved with a stored token or `nil` if there is not a stored token.
35+
* @return A promise that is resolved with a stored token or `nil` if there is not a stored token.
3636
* The promise is rejected with an error in the case of a failure.
3737
*/
3838
- (FBLPromise<FIRAppCheckToken *> *)getToken;

FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheck.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ NS_SWIFT_NAME(AppCheck)
4747

4848
/// Returns an instance of `AppCheck` for an application.
4949
/// @param firebaseApp A configured `FirebaseApp` instance if exists.
50-
/// @returns An instance of `AppCheck` corresponding to the passed application.
50+
/// @return An instance of `AppCheck` corresponding to the passed application.
5151
/// @throw Throws an exception if required `FirebaseApp` options are missing.
5252
+ (nullable instancetype)appCheckWithApp:(FIRApp *)firebaseApp NS_SWIFT_NAME(appCheck(app:));
5353

FirebaseAuth/Sources/Auth/FIRAuthDispatcher.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ typedef void (^FIRAuthDispatcherImplBlock)(NSTimeInterval delay,
5454

5555
/** @fn sharedInstance
5656
@brief Gets the shared instance of this class.
57-
@returns The shared instance of this clss
57+
@return The shared instance of this clss
5858
*/
5959
+ (instancetype)sharedInstance;
6060

FirebaseAuth/Sources/Utilities/FIRAuthErrorUtils.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ NS_ASSUME_NONNULL_BEGIN
110110
@param underlyingError The error that caused this error. If this parameter is nil, the
111111
NSUnderlyingErrorKey value will not be set.
112112
@remarks This error is returned when JWT parsing fails.
113-
@returns An @c FIRAuthErrorCodeMalformedJWT error wrapping an underlying error, if available.
113+
@return An @c FIRAuthErrorCodeMalformedJWT error wrapping an underlying error, if available.
114114
*/
115115
+ (NSError *)malformedJWTErrorWithToken:(NSString *)token
116116
underlyingError:(NSError *_Nullable)underlyingError;

FirebaseAuth/Tests/Sample/Sample/AppManager.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ + (FIRPhoneAuthProvider *)phoneAuthProvider {
9797
/** @fn appNameWithIndex:
9898
@brief Gets the app name for the given index.
9999
@param index The index of the app managed by this instance.
100-
@returns The app name for the FIRApp instance.
100+
@return The app name for the FIRApp instance.
101101
*/
102102
- (NSString *)appNameWithIndex:(int)index {
103103
return [NSString stringWithFormat:@"APP_%02d", index];

FirebaseInAppMessaging/Sources/Runtime/FIRIAMActionURLFollower.m

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ - (void)followActionURL:(NSURL *)actionURL withCompletionBlock:(void (^)(BOOL su
153153

154154
// Try to handle the url as a custom scheme url link by triggering
155155
// application:openURL:options: on App's delegate object directly.
156-
// @returns YES if that delegate method is defined and returns YES.
156+
// @return YES if that delegate method is defined and returns YES.
157157
- (BOOL)followURLWithAppDelegateOpenURLActivity:(NSURL *)url {
158158
if (self.isNewAppDelegateOpenURLDefined) {
159159
FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM210008",
@@ -168,7 +168,7 @@ - (BOOL)followURLWithAppDelegateOpenURLActivity:(NSURL *)url {
168168

169169
// Try to handle the url as a universal link by triggering
170170
// application:continueUserActivity:restorationHandler: on App's delegate object directly.
171-
// @returns YES if that delegate method is defined and seeing a YES being returned from
171+
// @return YES if that delegate method is defined and seeing a YES being returned from
172172
// trigging it
173173
- (BOOL)followURLWithContinueUserActivity:(NSURL *)url {
174174
if (self.isContinueUserActivityMethodDefined) {

FirebaseInstallations/Source/Library/Public/FirebaseInstallations/FIRInstallations.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ NS_SWIFT_NAME(Installations)
6464

6565
/**
6666
* Returns a default instance of `Installations`.
67-
* @returns An instance of `Installations` for `FirebaseApp.defaultApp().
67+
* @return An instance of `Installations` for `FirebaseApp.defaultApp().
6868
* @throw Throws an exception if the default app is not configured yet or required `FirebaseApp`
6969
* options are missing.
7070
*/
@@ -73,7 +73,7 @@ NS_SWIFT_NAME(Installations)
7373
/**
7474
* Returns an instance of `Installations` for an application.
7575
* @param application A configured `FirebaseApp` instance.
76-
* @returns An instance of `Installations` corresponding to the passed application.
76+
* @return An instance of `Installations` corresponding to the passed application.
7777
* @throw Throws an exception if required `FirebaseApp` options are missing.
7878
*/
7979
+ (FIRInstallations *)installationsWithApp:(FIRApp *)application NS_SWIFT_NAME(installations(app:));

FirebaseMessaging/Sources/FIRMessagingRmqManager.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
/**
8282
* Returns path for database with specified name.
8383
* @param databaseName The database name without extension: "<databaseName>.sqlite".
84-
* @returns Path to the database with the specified name.
84+
* @return Path to the database with the specified name.
8585
*/
8686
+ (NSString *)pathForDatabaseWithName:(NSString *)databaseName;
8787

Firestore/Example/Tests/API/FSTAPIHelpers.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ FIRDocumentReference *FSTTestDocRef(const char *path);
5858
* contents.
5959
* @param hasPendingWrites Whether the query snapshot has pending writes to the server.
6060
* @param fromCache Whether the query snapshot is cache result.
61-
* @returns A query snapshot that consists of both sets of documents.
61+
* @return A query snapshot that consists of both sets of documents.
6262
*/
6363
FIRQuerySnapshot *FSTTestQuerySnapshot(
6464
const char *path,

Firestore/core/src/util/filesystem.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ class Filesystem {
9090
*
9191
* @param app_name The name of the application.
9292
*
93-
* @returns The documents directory path or a status with
93+
* @return The documents directory path or a status with
9494
* Error::kErrorUnimplemented if the current platform does not have a legacy
9595
* documents directory.
9696
*/

0 commit comments

Comments
 (0)