Skip to content

Fix broken code links in comments of SetOptions.java #2162

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 3 commits into from
Nov 10, 2020
Merged

Fix broken code links in comments of SetOptions.java #2162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf3dba7
Fix broken code links in comments of SetOptions.java
wu-hui Nov 9, 2020
46ba9b5
No generics.
wu-hui Nov 10, 2020
d4077de
Fix DocumentId too.
wu-hui Nov 10, 2020
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
13 changes: 7 additions & 6 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentId.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* Annotation used to mark a POJO property to be automatically populated with the document's ID when
* the POJO is created from a Cloud Firestore document (for example, via {@link
* DocumentSnapshot#toObject}).
* DocumentSnapshot#toObject(Class)}).
*
* <ul>
* Any of the following will throw a runtime exception:
Expand All @@ -33,14 +33,15 @@
* <li>This annotation is applied to a property with a name that conflicts with a read document
* field. For example, if a POJO has a field `firstName` annotated by {@code @DocumentId}, and
* there is a property from the document named `firstName` as well, an exception is thrown
* when you try to read the document into the POJO via {@link DocumentSnapshot#toObject} or
* {@link DocumentReference#get}.
* when you try to read the document into the POJO via {@link
* DocumentSnapshot#toObject(Class)} or {@link DocumentReference#get()}.
* <li>
* </ul>
*
* <p>When using a POJO to write to a document (via {@link DocumentReference#set} or @{@link
* WriteBatch#set}), the property annotated by {@code @DocumentId} is ignored, which allows writing
* the POJO back to any document, even if it's not the origin of the POJO.
* <p>When using a POJO to write to a document (via {@link DocumentReference#set(Object)} or @{@link
* WriteBatch#set(DocumentReference, Object)}), the property annotated by {@code @DocumentId} is
* ignored, which allows writing the POJO back to any document, even if it's not the origin of the
* POJO.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
Expand Down
8 changes: 4 additions & 4 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/SetOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@

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

Expand Down