@@ -26,20 +26,21 @@ typedef void (^FIRAppVoidBoolCallback)(BOOL success) NS_SWIFT_NAME(FirebaseAppVo
26
26
/* *
27
27
* The entry point of Firebase SDKs.
28
28
*
29
- * Initialize and configure FIRApp using +[FIRApp configure]
29
+ * Initialize and configure `FirebaseApp` using `FirebaseApp. configure()`
30
30
* or other customized ways as shown below.
31
31
*
32
32
* The logging system has two modes: default mode and debug mode. In default mode, only logs with
33
33
* log level Notice, Warning and Error will be sent to device. In debug mode, all logs will be sent
34
34
* to device. The log levels that Firebase uses are consistent with the ASL log levels.
35
35
*
36
- * Enable debug mode by passing the -FIRDebugEnabled argument to the application. You can add this
37
- * argument in the application's Xcode scheme. When debug mode is enabled via -FIRDebugEnabled,
36
+ * Enable debug mode by passing the ` -FIRDebugEnabled` argument to the application. You can add this
37
+ * argument in the application's Xcode scheme. When debug mode is enabled via ` -FIRDebugEnabled` ,
38
38
* further executions of the application will also be in debug mode. In order to return to default
39
- * mode, you must explicitly disable the debug mode with the application argument -FIRDebugDisabled.
39
+ * mode, you must explicitly disable the debug mode with the application argument
40
+ * `-FIRDebugDisabled`.
40
41
*
41
- * It is also possible to change the default logging level in code by calling setLoggerLevel: on
42
- * the FIRConfiguration interface .
42
+ * It is also possible to change the default logging level in code by calling
43
+ * `FirebaseConfiguration.shared.setLoggerLevel(_:)` with the desired level .
43
44
*/
44
45
NS_SWIFT_NAME (FirebaseApp)
45
46
@interface FIRApp : NSObject
@@ -75,31 +76,31 @@ NS_SWIFT_NAME(FirebaseApp)
75
76
// clang-format on
76
77
77
78
/* *
78
- * Returns the default app, or nil if the default app does not exist.
79
+ * Returns the default app, or ` nil` if the default app does not exist.
79
80
*/
80
81
+ (nullable FIRApp *)defaultApp NS_SWIFT_NAME (app());
81
82
82
83
/* *
83
- * Returns a previously created FIRApp instance with the given name, or nil if no such app exists.
84
- * This method is thread safe.
84
+ * Returns a previously created `FirebaseApp` instance with the given name, or ` nil` if no such app
85
+ * exists. This method is thread safe.
85
86
*/
86
87
+ (nullable FIRApp *)appNamed:(NSString *)name NS_SWIFT_NAME (app(name:));
87
88
88
89
/* *
89
- * Returns the set of all extant FIRApp instances, or nil if there are no FIRApp instances. This
90
- * method is thread safe.
90
+ * Returns the set of all extant `FirebaseApp` instances, or ` nil` if there are no `FirebaseApp`
91
+ * instances. This method is thread safe.
91
92
*/
92
93
@property(class, readonly, nullable) NSDictionary <NSString *, FIRApp *> *allApps;
93
94
94
95
/* *
95
- * Cleans up the current FIRApp , freeing associated data and returning its name to the pool for
96
- * future use. This method is thread safe.
96
+ * Cleans up the current `FirebaseApp` , freeing associated data and returning its name to the pool
97
+ * for future use. This method is thread safe.
97
98
*/
98
99
- (void )deleteApp:(FIRAppVoidBoolCallback)completion;
99
100
100
101
/* *
101
- * FIRApp instances should not be initialized directly. Call +[FIRApp configure] ,
102
- * +[FIRApp configureWithOptions:] , or +[FIRApp configureWithNames :options:] directly.
102
+ * `FirebaseApp` instances should not be initialized directly. Call `FirebaseApp. configure()` ,
103
+ * `FirebaseApp.configure(options:)` , or `FirebaseApp.configure(name :options:)` directly.
103
104
*/
104
105
- (instancetype )init NS_UNAVAILABLE;
105
106
@@ -114,7 +115,7 @@ NS_SWIFT_NAME(FirebaseApp)
114
115
@property(nonatomic, copy, readonly) FIROptions *options;
115
116
116
117
/* *
117
- * Gets or sets whether automatic data collection is enabled for all products. Defaults to `YES `
118
+ * Gets or sets whether automatic data collection is enabled for all products. Defaults to `true `
118
119
* unless `FirebaseDataCollectionDefaultEnabled` is set to `NO` in your app's Info.plist. This value
119
120
* is persisted across runs of the app so that it can be set once when users have consented to
120
121
* collection.
0 commit comments