RFR 9: 8180082 : Broken javadoc links

[Roger Riggs]

Hi,

Thanks for the review and suggestions.
{@link ...} will work those links;  some hrefs will remain in cases 
where the link is to an "id" of some
element that is not a method or field name.

Webrev updated in place:
     http://cr.openjdk.java.net/~rriggs/webrev-broken-links-8180082/

Thanks, Roger

On 5/11/2017 5:24 AM, Daniel Fuchs wrote:
> Hi Roger,
>
> I'm surprised to see we have <a href=""...> style links in .java
> files to link to package summary and java APIs for classes and
> methods, when {@link } should work...
>
> For instance in this file:
> http://cr.openjdk.java.net/~rriggs/webrev-broken-links-8180082/src/jdk.management/share/classes/com/sun/management/package-info.java.frames.html 
>
>
> Does:
>
>   29  * <a 
> href="{@docRoot}/../../../../api/java/lang/management/package-summary.html">
>
> actualy works?? Looks like it has too many ../.. to me...
>
> I suspect (hope?) it could be advantageously replaced by {@link 
> java.lang.management}.
>
>
> Similarly:
>
>   36  * <a 
> href="{@docRoot}/java/lang/management/ManagementFactory.html#getPlatformMBeanServer()">
>   37  * java.lang.management.ManagementFactory.getPlatformMBeanServer</a>
>
> could probably be {@link 
> java.lang.management.ManagementFactory#getPlatformMBeanServer()}
>
>
> This also reminds me that as part of the technical debt we might also
> think about replacing package.html files by their more modern
> package-info.java counterpart - but that's probably for another day...
>
>
> cheers,
>
> -- daniel
>
>
>
> On 10/05/2017 19:22, Roger Riggs wrote:
>> Please review corrections to broken javadoc links:
>>  - links to the serialization spec now in ./specs/serialization
>>  - links in java.lang to java/util/Spliterator
>>  - link in ModuleLayer to Classloader
>>  - Links using ../../../.. do not work well when they show up in some
>> indexes; they should use @docRoot
>>
>> webrev:
>> http://cr.openjdk.java.net/~rriggs/webrev-broken-links-8180082/
>>
>> Issue:
>>   https://bugs.openjdk.java.net/browse/JDK-8180082
>>
>> Thanks, Roger
>>
>