parameter types in @link tag
Anna Kozlova
anna.kozlova at jetbrains.com
Mon Jan 17 12:36:59 UTC 2022
Hi all!
I am trying to figure out if the javadoc tool should be ok with a short
class name as parameter type. Is there any specification on @link tag
format?
E.g. javadoc for `java.io.File#isDirectory` contains the following "{@link
java.nio.file.Files#readAttributes(Path,Class,LinkOption[])". LinkOption
isn't resolved but the generated html correctly navigates the
"readAttributes" method. This makes me suspect that the signatures are
checked by short names only.
But this leads to the problem with the ambiguity:
```class Foo {
/**
* {@link #bar(Bar)}
*/
void foo() {}
void bar(Foo2.Bar f) {}
void bar(Foo1.Bar f) {}
}
class Foo1 {
static class Bar {}
}
class Foo2 {
static class Bar {}
}```
Here the link points to the first method as it is written in the class
"Foo" which looks wrong, or is it ok?
Thank you,
Anna Kozlova
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20220117/3fa62176/attachment.htm>
More information about the javadoc-dev
mailing list