aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Core/Public/FIROptions.h
diff options
context:
space:
mode:
authorGravatar Ryan Wilson <wilsonryan@google.com>2018-03-21 12:01:03 -0400
committerGravatar GitHub <noreply@github.com>2018-03-21 12:01:03 -0400
commit7854c5164b4440201514b5ab0d90554dd94e9455 (patch)
treeb348fb1e20a78a1a6ba76ab66b6c9020d948ff97 /Firebase/Core/Public/FIROptions.h
parent51ffae2650e35ee63a313d6fd5ed558024a72317 (diff)
Add file I/O usage to Core documentation. (#959)
* Add file I/O usage to documentation. * Update defaultOptions message. * Fix grammatical error.
Diffstat (limited to 'Firebase/Core/Public/FIROptions.h')
-rw-r--r--Firebase/Core/Public/FIROptions.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/Firebase/Core/Public/FIROptions.h b/Firebase/Core/Public/FIROptions.h
index eba0657..b4e3b3b 100644
--- a/Firebase/Core/Public/FIROptions.h
+++ b/Firebase/Core/Public/FIROptions.h
@@ -25,7 +25,8 @@ NS_SWIFT_NAME(FirebaseOptions)
@interface FIROptions : NSObject <NSCopying>
/**
- * Returns the default options.
+ * Returns the default options. The first time this is called it synchronously reads
+ * GoogleService-Info.plist from disk.
*/
+ (nullable FIROptions *)defaultOptions NS_SWIFT_NAME(defaultOptions());
@@ -109,7 +110,8 @@ NS_SWIFT_NAME(FirebaseOptions)
"setters instead.");
/**
- * Initializes a customized instance of FIROptions from the file at the given plist file path.
+ * Initializes a customized instance of FIROptions from the file at the given plist file path. This
+ * will read the file synchronously from disk.
* For example,
* NSString *filePath =
* [[NSBundle mainBundle] pathForResource:@"GoogleService-Info" ofType:@"plist"];