Skip to content

Commit fd76164

Browse files
authored
Fix broken code links in comments of SetOptions.java (#2162)
* Fix broken code links in comments of SetOptions.java * No generics. * Fix DocumentId too.
1 parent 4073143 commit fd76164

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
/**
2323
* Annotation used to mark a POJO property to be automatically populated with the document's ID when
2424
* the POJO is created from a Cloud Firestore document (for example, via {@link
25-
* DocumentSnapshot#toObject}).
25+
* DocumentSnapshot#toObject(Class)}).
2626
*
2727
* <ul>
2828
* Any of the following will throw a runtime exception:
@@ -33,14 +33,15 @@
3333
* <li>This annotation is applied to a property with a name that conflicts with a read document
3434
* field. For example, if a POJO has a field `firstName` annotated by {@code @DocumentId}, and
3535
* there is a property from the document named `firstName` as well, an exception is thrown
36-
* when you try to read the document into the POJO via {@link DocumentSnapshot#toObject} or
37-
* {@link DocumentReference#get}.
36+
* when you try to read the document into the POJO via {@link
37+
* DocumentSnapshot#toObject(Class)} or {@link DocumentReference#get()}.
3838
* <li>
3939
* </ul>
4040
*
41-
* <p>When using a POJO to write to a document (via {@link DocumentReference#set} or @{@link
42-
* WriteBatch#set}), the property annotated by {@code @DocumentId} is ignored, which allows writing
43-
* the POJO back to any document, even if it's not the origin of the POJO.
41+
* <p>When using a POJO to write to a document (via {@link DocumentReference#set(Object)} or @{@link
42+
* WriteBatch#set(DocumentReference, Object)}), the property annotated by {@code @DocumentId} is
43+
* ignored, which allows writing the POJO back to any document, even if it's not the origin of the
44+
* POJO.
4445
*/
4546
@Retention(RetentionPolicy.RUNTIME)
4647
@Target({ElementType.FIELD, ElementType.METHOD})

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@
2626

2727
/**
2828
* An options object that configures the behavior of {@code set()} calls. By providing one of the
29-
* SetOptions objects returned by {@link #merge}, {@link #mergeFields} and {@link #mergeFieldPaths},
30-
* the {@code set()} calls in {@link DocumentReference}, {@link WriteBatch} and {@link Transaction}
31-
* can be configured to perform granular merges instead of overwriting the target documents in their
32-
* entirety.
29+
* SetOptions objects returned by {@link #merge()}, {@link #mergeFields(List)} and {@link
30+
* #mergeFieldPaths(List)}, the {@code set()} calls in {@link DocumentReference}, {@link WriteBatch}
31+
* and {@link Transaction} can be configured to perform granular merges instead of overwriting the
32+
* target documents in their entirety.
3333
*/
3434
public final class SetOptions {
3535

0 commit comments

Comments
 (0)