Skip to content

Commit 933ee54

Browse files
authored
Update Javadocs for setCrashlyticsCollectionEnabled API (firebase#1850)
1 parent ed4d371 commit 933ee54

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/FirebaseCrashlytics.java

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -444,10 +444,10 @@ public boolean didCrashOnPreviousExecution() {
444444
}
445445

446446
/**
447-
* Enables/disables automatic data collection by Crashlytics.
447+
* Enables or disables the automatic data collection configuration for Crashlytics.
448448
*
449-
* <p>If this is set, it overrides the data collection settings provided by the Android Manifest,
450-
* as well as any Firebase-wide automatic data collection settings.
449+
* <p>If this is set, it overrides any automatic data collection settings configured in the
450+
* AndroidManifest.xml as well as any Firebase-wide settings.
451451
*
452452
* <p>If automatic data collection is disabled for Crashlytics, crash reports are stored on the
453453
* device. To check for reports, use the {@link #checkForUnsentReports()} method. Use {@link
@@ -456,28 +456,31 @@ public boolean didCrashOnPreviousExecution() {
456456
* sending them to Crashlytics.
457457
*
458458
* @param enabled whether to enable automatic data collection. When set to `false`, the new value
459-
* does not apply until the next run of the app. If you want to disable data collection by
460-
* default for all app runs, add the `firebase_crashlytics_collection_enabled` flag to your
461-
* app's AndroidManifest.xml.
459+
* does not apply until the next run of the app. To disable data collection by default for all
460+
* app runs, add the `firebase_crashlytics_collection_enabled` flag to your app's
461+
* AndroidManifest.xml.
462462
*/
463463
public void setCrashlyticsCollectionEnabled(boolean enabled) {
464464
core.setCrashlyticsCollectionEnabled(enabled);
465465
}
466466

467467
/**
468-
* Enables/disables/clears automatic data collection config by Crashlytics.
468+
* Enables or disables the automatic data collection configuration for Crashlytics.
469469
*
470-
* <p>If this is set, it overrides the data collection settings provided by the Android Manifest,
471-
* as well as any Firebase-wide automatic data collection settings.
470+
* <p>If this is set, it overrides any automatic data collection settings configured in the
471+
* AndroidManifest.xml as well as any Firebase-wide settings. If set to `null`, the override is
472+
* cleared.
472473
*
473474
* <p>If automatic data collection is disabled for Crashlytics, crash reports are stored on the
474475
* device. To check for reports, use the {@link #checkForUnsentReports()} method. Use {@link
475476
* #sendUnsentReports()} to upload existing reports even when automatic data collection is
476477
* disabled. Use {@link #deleteUnsentReports()} to delete any reports stored on the device without
477478
* sending them to Crashlytics.
478479
*
479-
* @param enabled whether to enable automatic data collection. The value of null would clear the
480-
* Crashlytics config and the enablement of data collection would depend on other settings.
480+
* @param enabled whether to enable or disable automatic data collection. When set to `false`, the
481+
* new value does not apply until the next run of the app. When set to `null`, the override is
482+
* cleared and automatic data collection settings are determined by the configuration in your
483+
* AndroidManifest.xml or other Firebase-wide settings.
481484
*/
482485
public void setCrashlyticsCollectionEnabled(@Nullable Boolean enabled) {
483486
core.setCrashlyticsCollectionEnabled(enabled);

0 commit comments

Comments
 (0)