Skip to content
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

Jump to bottom

Fix javadoc links in the Graph package. #3481

Closed
wants to merge 1 commit into from
Closed

Fix javadoc links in the Graph package. #3481

wants to merge 1 commit into from

Conversation

WilliamCollishaw
Copy link
Contributor

@WilliamCollishaw WilliamCollishaw commented May 24, 2019 •
edited
Loading

The following warning was observed when building with JDK 8:

INFO] --- maven-javadoc-plugin:3.0.1:jar (attach-docs) @ guava ---
[INFO] 
4 warnings
[WARNING] Javadoc Warnings
[WARNING] ~/Documents/GitHub/guava/guava/src/com/google/common/graph/GraphBuilder.java:101: warning - Tag @link: can't find Builder in com.google.common.graph.ImmutableGraph
[WARNING] ~/Documents/GitHub/guava/guava/src/com/google/common/graph/NetworkBuilder.java:113: warning - Tag @link: can't find Builder in com.google.common.graph.ImmutableNetwork
[WARNING] ~/Documents/GitHub/guava/guava/src/com/google/common/graph/ValueGraphBuilder.java:107: warning - Tag @link: can't find Builder in com.google.common.graph.ImmutableValueGraph
[WARNING] ~/Documents/GitHub/guava/guava/src/com/google/common/collect/ImmutableTable.java:225: warning - Tag @link: can't find Builder() in com.google.common.collect.ImmutableTable.Builder

Did not edit the ImmutableTable link due to it being fully functional in JDK 11 and it was previously discussed in #2908

The resolved links were not functional in either JDK 8 or 11 prior to this fix.

@netdpb netdpb self-assigned this May 24, 2019
@netdpb
Copy link
Member

netdpb commented May 24, 2019

Thanks!

@jrtom
Copy link
Member

jrtom commented May 24, 2019

As the person who wrote the Javadoc, thanks for catching that. :)

@ronshapiro ronshapiro mentioned this pull request May 28, 2019
Merged
ronshapiro pushed a commit that referenced this pull request May 28, 2019
@ronshapiro
Fix Javadoc links.
86be2d1 
Fixes #3481

RELNOTES=n/a

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=249894052
ronshapiro pushed a commit that referenced this pull request May 28, 2019
@ronshapiro
Fix Javadoc links.
285fc3f 
Fixes #3481

RELNOTES=n/a

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=249894052
@WilliamCollishaw WilliamCollishaw deleted the fix-javadoc-links-v2 branch May 28, 2019 15:02
@WilliamCollishaw
Copy link
Contributor Author

WilliamCollishaw commented May 28, 2019 •
edited
Loading

@ronshapiro the author for this PR and #3478 looks wrong.
Screen Shot 2019-05-28 at 9 16 38 AM

Also Github doesn't recognize this account as the author, #3465 looks correct though :)
Thanks for the merges.

@ronshapiro
Copy link
Contributor

Looks like @netdpb used the wrong syntax for this. I'm not sure if there's anything we can do to retroactively fix this :-/

@WilliamCollishaw
Copy link
Contributor Author

Looks like @netdpb used the wrong syntax for this. I'm not sure if there's anything we can do to retroactively fix this :-/

It can be done with a rebase (reference). Not sure how much work that is on your end though :)

@netdpb
Copy link
Member

netdpb commented May 28, 2019

I'm sorry about that, @WilliamCollishaw.

@WilliamCollishaw
Copy link
Contributor Author

I'm sorry about that, @WilliamCollishaw.

No worries

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@netdpb netdpb

Labels
cla: yes package=graph status=in-progress status=triaged type=api-docs Change/add API documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@WilliamCollishaw @netdpb @jrtom @ronshapiro @googlebot