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

Changes from 1 commit
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
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<String>)} and {@link
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's valid syntax. it should be something like:

Suggested change
* SetOptions objects returned by {@link #merge()}, {@link #mergeFields(List<String>)} and {@link
* SetOptions objects returned by {@link #merge()}, {@link #mergeFields(List)} and {@link

i.e. without generic parameters.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

* #mergeFieldPaths(List<FieldPath>)}, 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