Skip to content

Commit 7854c51

Browse files
authored
Add file I/O usage to Core documentation. (#959)
* Add file I/O usage to documentation. * Update defaultOptions message. * Fix grammatical error.
1 parent 51ffae2 commit 7854c51

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

Firebase/Core/Public/FIRApp.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ NS_SWIFT_NAME(FirebaseApp)
5252
/**
5353
* Configures a default Firebase app. Raises an exception if any configuration step fails. The
5454
* default app is named "__FIRAPP_DEFAULT". This method should be called after the app is launched
55-
* and before using Firebase services. This method is thread safe.
55+
* and before using Firebase services. This method is thread safe and contains synchronous file I/O
56+
* (reading GoogleService-Info.plist from disk).
5657
*/
5758
+ (void)configure;
5859

Firebase/Core/Public/FIROptions.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ NS_SWIFT_NAME(FirebaseOptions)
2525
@interface FIROptions : NSObject <NSCopying>
2626

2727
/**
28-
* Returns the default options.
28+
* Returns the default options. The first time this is called it synchronously reads
29+
* GoogleService-Info.plist from disk.
2930
*/
3031
+ (nullable FIROptions *)defaultOptions NS_SWIFT_NAME(defaultOptions());
3132

@@ -109,7 +110,8 @@ NS_SWIFT_NAME(FirebaseOptions)
109110
"setters instead.");
110111

111112
/**
112-
* Initializes a customized instance of FIROptions from the file at the given plist file path.
113+
* Initializes a customized instance of FIROptions from the file at the given plist file path. This
114+
* will read the file synchronously from disk.
113115
* For example,
114116
* NSString *filePath =
115117
* [[NSBundle mainBundle] pathForResource:@"GoogleService-Info" ofType:@"plist"];

0 commit comments

Comments
 (0)