Skip to content

Add a comment about the limitations of InvalidLink. #5660

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
copybara-service merged 1 commit into from
Mar 26, 2026
Merged

Add a comment about the limitations of InvalidLink. #5660

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions docs/bugpattern/InvalidLink.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,10 @@ Use the erased type of method parameters in `@link` tags. For example, write
`{@link #foo(List)}` instead of `{@link #foo(List<Bah>)}`. Javadoc does yet not
support generics in `@link` tags, due to a bug:
[JDK-5096551](https://bugs.openjdk.java.net/browse/JDK-5096551).

### Limitations

This check is very limited in terms of which unresolved links it can be *sure*
are unresolvable. Code within Google is often compiled on a per-package or even
per-file basis, and Error Prone only has visibility into the current
compilation.
Loading