Skip to content

Commit 484371e

Browse files
authored
Fix broken documentation found while reviewing C# docs. (#670)
1 parent 8f00bad commit 484371e

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
/**
4040
* A {@code DocumentSnapshot} contains data read from a document in your Cloud Firestore database.
41-
* The data can be extracted with the {@link #getData()} or {@link #get()} methods.
41+
* The data can be extracted with the {@link #getData()} or {@link #get(String)} methods.
4242
*
4343
* <p>If the {@code DocumentSnapshot} points to a non-existing document, {@link #getData()} and its
4444
* corresponding methods will return {@code null}. You can always explicitly check for a document's

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ public Query getQuery() {
8282
return originalQuery;
8383
}
8484

85-
/** @return The metadata for this document snapshot. */
85+
/** @return The metadata for this query snapshot. */
8686
@NonNull
8787
public SnapshotMetadata getMetadata() {
8888
return metadata;

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ public static SetOptions merge() {
6767
}
6868

6969
/**
70-
* Changes the behavior of {@code set()} calls to only replace the fields under fieldPaths. Any
71-
* field that is not specified in fieldPaths is ignored and remains untouched.
70+
* Changes the behavior of {@code set()} calls to only replace the given fields. Any field that is
71+
* not specified in {@code fields} is ignored and remains untouched.
7272
*
7373
* <p>It is an error to pass a {@code SetOptions} object to a {@code set()} call that is missing a
7474
* value for any of the fields specified here.
@@ -88,8 +88,8 @@ public static SetOptions mergeFields(@NonNull List<String> fields) {
8888
}
8989

9090
/**
91-
* Changes the behavior of {@code set()} calls to only replace the fields under fieldPaths. Any
92-
* field that is not specified in fieldPaths is ignored and remains untouched.
91+
* Changes the behavior of {@code set()} calls to only replace the given fields. Any field that is
92+
* not specified in {@code fields} is ignored and remains untouched.
9393
*
9494
* <p>It is an error to pass a {@code SetOptions} object to a {@code set()} call that is missing a
9595
* value for any of the fields specified here.
@@ -109,8 +109,8 @@ public static SetOptions mergeFields(String... fields) {
109109
}
110110

111111
/**
112-
* Changes the behavior of {@code set()} calls to only replace the fields under fieldPaths. Any
113-
* field that is not specified in fieldPaths is ignored and remains untouched.
112+
* Changes the behavior of {@code set()} calls to only replace the given fields. Any field that is
113+
* not specified in {@code fields} is ignored and remains untouched.
114114
*
115115
* <p>It is an error to pass a {@code SetOptions} object to a {@code set()} call that is missing a
116116
* value for any of the fields specified here in its to data argument.

0 commit comments

Comments
 (0)