Skip to content

Commit c99b61c

Browse files
authored
Address reference doc review comments (#1919)
1 parent 55e6921 commit c99b61c

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

firebase-database/src/main/java/com/google/firebase/database/FirebaseDatabase.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -305,12 +305,12 @@ public synchronized void setPersistenceCacheSizeBytes(long cacheSizeInBytes) {
305305
}
306306

307307
/**
308-
* Modify this FirebaseDatabase instance to communicate with the Realtime Database emulator.
308+
* Modifies this FirebaseDatabase instance to communicate with the Realtime Database emulator.
309309
*
310-
* <p>Note: this must be called before this instance has been used to do any database operations.
310+
* <p>Note: Call this method before using the instance to do any database operations.
311311
*
312-
* @param host the emulator host (ex: 10.0.2.2)
313-
* @param port the emulator port (ex: 9000)
312+
* @param host the emulator host (for example, 10.0.2.2)
313+
* @param port the emulator port (for example, 9000)
314314
*/
315315
public void useEmulator(@NonNull String host, int port) {
316316
if (this.repo != null) {

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,12 +204,12 @@ public void setFirestoreSettings(@NonNull FirebaseFirestoreSettings settings) {
204204
}
205205

206206
/**
207-
* Modify this FirebaseDatabase instance to communicate with the Cloud Firestore emulator.
207+
* Modifies this FirebaseDatabase instance to communicate with the Cloud Firestore emulator.
208208
*
209-
* <p>Note: this must be called before this instance has been used to do any operations.
209+
* <p>Note: Call this method before using the instance to do any database operations.
210210
*
211-
* @param host the emulator host (ex: 10.0.2.2)
212-
* @param port the emulator port (ex: 8080)
211+
* @param host the emulator host (for example, 10.0.2.2)
212+
* @param port the emulator port (for example, 8080)
213213
*/
214214
public void useEmulator(@NonNull String host, int port) {
215215
if (this.client != null) {

firebase-functions/src/main/java/com/google/firebase/functions/FirebaseFunctions.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -209,19 +209,19 @@ URL getURL(String function) {
209209
}
210210
}
211211

212-
/** @deprecated see {@link #useEmulator(String, int)} */
212+
/** @deprecated Use {@link #useEmulator(String, int)} to connect to the emulator. */
213213
public void useFunctionsEmulator(@NonNull String origin) {
214214
Preconditions.checkNotNull(origin, "origin cannot be null");
215215
urlFormat = origin + "/%2$s/%1$s/%3$s";
216216
}
217217

218218
/**
219-
* Modify this FirebaseFunctions instance to communicate with the Cloud Functions emulator.
219+
* Modifies this FirebaseFunctions instance to communicate with the Cloud Functions emulator.
220220
*
221-
* <p>Note: this must be called before this instance has been used to do any operations.
221+
* <p>Note: Call this method before using the instance to do any functions operations.
222222
*
223-
* @param host the emulator host (ex: 10.0.2.2)
224-
* @param port the emulator port (ex: 5001)
223+
* @param host the emulator host (for example, 10.0.2.2)
224+
* @param port the emulator port (for example, 5001)
225225
*/
226226
public void useEmulator(@NonNull String host, int port) {
227227
this.emulatorSettings = new EmulatedServiceSettings(host, port);

0 commit comments

Comments
 (0)