Skip to content

Clarify multi db documentation #5158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 14, 2023
Merged

Clarify multi db documentation #5158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a866ff2
Clarify multi db documentation
tom-andersen Jul 12, 2023
b5d65ba
Clarify multi db documentation
tom-andersen Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ private static FirebaseApp getDefaultFirebaseApp() {
* Returns the default {@link FirebaseFirestore} instance for the default {@link FirebaseApp}.
*
* <p>Returns the same instance for all invocations. If no instance exists, initializes a new
* instance with default settings.
* instance.
*
* @returns The {@link FirebaseFirestore} instance.
*/
Expand All @@ -130,9 +130,9 @@ public static FirebaseFirestore getInstance() {
* Returns the default {@link FirebaseFirestore} instance for the provided {@link FirebaseApp}.
*
* <p>For a given {@link FirebaseApp}, invocation always returns the same instance. If no instance
* exists, initializes a new instance with default settings.
* exists, initializes a new instance.
*
* @param app - The {@link FirebaseApp} instance that the returned {@link FirebaseFirestore}
* @param app The {@link FirebaseApp} instance that the returned {@link FirebaseFirestore}
* instance is associated with.
* @returns The {@link FirebaseFirestore} instance.
*/
Expand All @@ -145,9 +145,9 @@ public static FirebaseFirestore getInstance(@NonNull FirebaseApp app) {
* Returns the {@link FirebaseFirestore} instance for the default {@link FirebaseApp}.
*
* <p>Returns the same instance for all invocations given the same database parameter. If no
* instance exists, initializes a new instance with default settings.
* instance exists, initializes a new instance.
*
* @param database - The name of database.
* @param database The database ID.
* @returns The {@link FirebaseFirestore} instance.
*/
@NonNull
Expand All @@ -159,11 +159,11 @@ public static FirebaseFirestore getInstance(@NonNull String database) {
* Returns the {@link FirebaseFirestore} instance for the provided {@link FirebaseApp}.
*
* <p>Returns the same instance for all invocations given the same {@link FirebaseApp} and
* database parameter. If no instance exists, initializes a new instance with default settings.
* database parameter. If no instance exists, initializes a new instance.
*
* @param app - The {@link FirebaseApp} instance that the returned {@link FirebaseFirestore}
* @param app The {@link FirebaseApp} instance that the returned {@link FirebaseFirestore}
* instance is associated with.
* @param database - The name of database.
* @param database The database ID.
* @returns The {@link FirebaseFirestore} instance.
*/
@NonNull
Expand Down