Skip to content

Commit c4b5a92

Browse files
authored
Clarify multi db documentation (#5158)
* Clarify multi db documentation * Clarify multi db documentation
1 parent c77027e commit c4b5a92

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ private static FirebaseApp getDefaultFirebaseApp() {
117117
* Returns the default {@link FirebaseFirestore} instance for the default {@link FirebaseApp}.
118118
*
119119
* <p>Returns the same instance for all invocations. If no instance exists, initializes a new
120-
* instance with default settings.
120+
* instance.
121121
*
122122
* @returns The {@link FirebaseFirestore} instance.
123123
*/
@@ -130,9 +130,9 @@ public static FirebaseFirestore getInstance() {
130130
* Returns the default {@link FirebaseFirestore} instance for the provided {@link FirebaseApp}.
131131
*
132132
* <p>For a given {@link FirebaseApp}, invocation always returns the same instance. If no instance
133-
* exists, initializes a new instance with default settings.
133+
* exists, initializes a new instance.
134134
*
135-
* @param app - The {@link FirebaseApp} instance that the returned {@link FirebaseFirestore}
135+
* @param app The {@link FirebaseApp} instance that the returned {@link FirebaseFirestore}
136136
* instance is associated with.
137137
* @returns The {@link FirebaseFirestore} instance.
138138
*/
@@ -145,9 +145,9 @@ public static FirebaseFirestore getInstance(@NonNull FirebaseApp app) {
145145
* Returns the {@link FirebaseFirestore} instance for the default {@link FirebaseApp}.
146146
*
147147
* <p>Returns the same instance for all invocations given the same database parameter. If no
148-
* instance exists, initializes a new instance with default settings.
148+
* instance exists, initializes a new instance.
149149
*
150-
* @param database - The name of database.
150+
* @param database The database ID.
151151
* @returns The {@link FirebaseFirestore} instance.
152152
*/
153153
@NonNull
@@ -159,11 +159,11 @@ public static FirebaseFirestore getInstance(@NonNull String database) {
159159
* Returns the {@link FirebaseFirestore} instance for the provided {@link FirebaseApp}.
160160
*
161161
* <p>Returns the same instance for all invocations given the same {@link FirebaseApp} and
162-
* database parameter. If no instance exists, initializes a new instance with default settings.
162+
* database parameter. If no instance exists, initializes a new instance.
163163
*
164-
* @param app - The {@link FirebaseApp} instance that the returned {@link FirebaseFirestore}
164+
* @param app The {@link FirebaseApp} instance that the returned {@link FirebaseFirestore}
165165
* instance is associated with.
166-
* @param database - The name of database.
166+
* @param database The database ID.
167167
* @returns The {@link FirebaseFirestore} instance.
168168
*/
169169
@NonNull

0 commit comments

Comments
 (0)