RFR(xs): JDK-8178447 - Remove link from JavaDoc to Dev guide
David Holmes
david.holmes at oracle.com
Thu Apr 13 01:50:41 UTC 2017
Hi Jesper,
On 13/04/2017 1:40 AM, jesper.wilhelmsson at oracle.com wrote:
> David,
>
> Thanks for looking!
>
> Do you have a link to the page you refer to? It sounds to me as you refer to a page that is not part of the JavaDoc. One of the reasons we found this link is that the docs team is reorganising the docs and are trying to avoid links for the JavaDoc into the guides etc. As the guides etc are moving to the new format an indirection link would be required to refer into the new place, which is of course doable, but some more work than just removing the old link.
I don't know how everything will end up being laid out in the new doc
set. But no it isn't API Javadoc, but tool doc. If cross-linking is
problematic then don't worry about it.
Thanks,
David
> Thanks,
> /Jesper
>
>> On 11 Apr 2017, at 23:34, David Holmes <david.holmes at oracle.com> wrote:
>>
>> On 12/04/2017 3:08 AM, jesper.wilhelmsson at oracle.com wrote:
>>> Hi,
>>>
>>> The link from the JavaDoc for VMOption to the JVM guide does not provide any additional information in the given context and should be removed.
>>
>> I agree that link serves no purpose. What we could have is a link to something that tells you what VM options exist! For 9 that would be the "java command" doc page.
>>
>> Thanks,
>> David
>>
>>> Bug: https://bugs.openjdk.java.net/browse/JDK-8178447
>>> Webrev: http://cr.openjdk.java.net/~jwilhelm/8178447/webrev.00/
>>>
>>> Thanks,
>>> /Jesper
>>>
>
More information about the jdk9-dev
mailing list