Skip to content

Commit 55ecf8c

Browse files
committed
Backporting documentation changes
1 parent 3b5a1f4 commit 55ecf8c

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestore.java

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -376,21 +376,22 @@ public static void setLoggingEnabled(boolean loggingEnabled) {
376376
}
377377

378378
/**
379-
* Clears the persistent storage. This includes pending writes and cached documents.
379+
* Clears the persistent storage, including pending writes and cached documents.
380380
*
381-
* <p>Must be called while the firestore instance is not started (after the app is shutdown or
382-
* when the app is first initialized). On startup, this method must be called before other methods
383-
* (other than setFirestoreSettings()). If the firestore instance is still running, the Task will
384-
* fail with an error code of FAILED_PRECONDITION.
381+
* <p>Must be called while the FirebaseFirestore instance is not started (after the app is
382+
* shutdown or when the app is first initialized). On startup, this method must be called before
383+
* other methods (other than <code>setFirestoreSettings()</code>). If the FirebaseFirestore
384+
* instance is still running, the <code>Task</code> will fail with an error code of
385+
* <code>FAILED_PRECONDITION</code>.
385386
*
386-
* <p>Note: clearPersistence() is primarily intended to help write reliable tests that use
387-
* Firestore. It uses the most efficient mechanism possible for dropping existing data but does
387+
* <p>Note: <code>clearPersistence()</code> is primarily intended to help write reliable tests
388+
* that use Cloud Firestore. It uses an efficient mechanism for dropping existing data but does
388389
* not attempt to securely overwrite or otherwise make cached data unrecoverable. For applications
389-
* that are sensitive to the disclosure of cache data in between user sessions we strongly
390-
* recommend not to enable persistence in the first place.
390+
* that are sensitive to the disclosure of cached data in between user sessions, we strongly
391+
* recommend not enabling persistence at all.
391392
*
392-
* @return A Task that is resolved once the persistent storage has been cleared. Otherwise, the
393-
* Task is rejected with an error.
393+
* @return A <code>Task</code> that is resolved when the persistent storage is cleared. Otherwise,
394+
* the <code>Task</code> is rejected with an error.
394395
*/
395396
@PublicApi
396397
public Task<Void> clearPersistence() {

0 commit comments

Comments
 (0)