Martin,
Finding and fixing broken links continues to be a priority for us as well.
Regrettably, there is a lot of technical debt in this area, and
sometimes the noise of the "minor" errors drown out the signal of the
more significant errors.
-- Jon
On 10/01/2018 03:40 PM, Martin Buchholz wrote:
I am a lot happier after discovering Priya's fix in progress!
(but after all these years my top priority for java documentation
remains ensuring that the process makes broken links impossible, like
a compile-time error in the java source)
On Mon, Oct 1, 2018 at 3:06 PM, Michel Trudeau
<michel.trud...@oracle.com <mailto:michel.trud...@oracle.com>> wrote:
This appear to be a dup of [1], we will verify and make sure it is
before closing the issue as such. Also, we will evaluate the
backport.
-Michel
[1] https://bugs.openjdk.java.net/browse/JDK-8205593
<https://bugs.openjdk.java.net/browse/JDK-8205593>
On Sep 30, 2018, at 9:56 PM, Martin Buchholz <marti...@google.com
<mailto:marti...@google.com>> wrote:
I found
https://bugs.openjdk.java.net/browse/JDK-8211194
<https://bugs.openjdk.java.net/browse/JDK-8211194>
javadoc -link doesn't take module path into consideration
and raised the priority of that bug.
On Wed, Sep 26, 2018 at 6:47 PM, Martin Buchholz
<marti...@google.com <mailto:marti...@google.com>> wrote:
I was trying to migrate to using the shiny
https://docs.oracle.com/en/java/javase/11/
<https://docs.oracle.com/en/java/javase/11/>
for all my documentation needs and ran into some troubles:
Every year I complain about no one checking for dead links in
the docs.
Running a dead-link checker before a major release should be
easy-peasy.
E.g. in
https://docs.oracle.com/en/java/javase/11/docs/specs/jdwp/jdwp-protocol.html
<https://docs.oracle.com/en/java/javase/11/docs/specs/jdwp/jdwp-protocol.html>
I see a link to
https://docs.oracle.com/en/java/javase/11/api/java/lang/ThreadGroup.html
<https://docs.oracle.com/en/java/javase/11/api/java/lang/ThreadGroup.html>
but that's a 404 ... because ... there's now a new level in
the api
docs hierarchy
The actual link is
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ThreadGroup.html
<https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ThreadGroup.html>
so this URL is broken in two different ways.
Including module names in the api docs hierarchy makes some
sense, but
then how to reconcile with the javadoc flags -Xdocrootparent and
-link, which can only take a single URL?
The link
https://docs.oracle.com/javase/11/docs/api/java/util/ArrayList.html
<https://docs.oracle.com/javase/11/docs/api/java/util/ArrayList.html>
shouldn't be a 404
I'm finding it hard to generate private javadoc with external
links to
java 11 javadoc on docs.oracle.com <http://docs.oracle.com/>
I'm surprised that visiting
https://docs.oracle.com/javase/11/docs
<https://docs.oracle.com/javase/11/docs>
redirects to the top-level doc page
https://docs.oracle.com/en/java/javase/11/
<https://docs.oracle.com/en/java/javase/11/>
but
https://docs.oracle.com/en/java/javase/11/docs
<https://docs.oracle.com/en/java/javase/11/docs>
redirects to the API
https://docs.oracle.com/en/java/javase/11/docs/api/index.html
<https://docs.oracle.com/en/java/javase/11/docs/api/index.html>
even though specs are stored under
https://docs.oracle.com/en/java/javase/11/docs/specs/
<https://docs.oracle.com/en/java/javase/11/docs/specs/>
e.g.
https://docs.oracle.com/en/java/javase/11/docs/specs/jvmti.html
<https://docs.oracle.com/en/java/javase/11/docs/specs/jvmti.html>
but visiting
https://docs.oracle.com/en/java/javase/11/docs/specs/
<https://docs.oracle.com/en/java/javase/11/docs/specs/>
also gives an unexpected 404
I was surprised to not be able to find the JDWP spec by clicking
around from https://docs.oracle.com/en/java/javase/11/
<https://docs.oracle.com/en/java/javase/11/>
but the search box on that page worked!
