Skip to content

Commit 672b16b

Browse files
graememorganError Prone Team
authored andcommitted
Add a comment about the limitations of InvalidLink.
Fixes external #5609. PiperOrigin-RevId: 889207246
1 parent eee32c3 commit 672b16b

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

docs/bugpattern/InvalidLink.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,10 @@ Use the erased type of method parameters in `@link` tags. For example, write
1010
`{@link #foo(List)}` instead of `{@link #foo(List<Bah>)}`. Javadoc does yet not
1111
support generics in `@link` tags, due to a bug:
1212
[JDK-5096551](https://bugs.openjdk.java.net/browse/JDK-5096551).
13+
14+
### Limitations
15+
16+
This check is very limited in terms of which unresolved links it can be *sure*
17+
are unresolvable. Code within Google is often compiled on a per-package or even
18+
per-file basis, and Error Prone only has visibility into the current
19+
compilation.

0 commit comments

Comments
 (0)