Suggestion: javadoc 'FRAMES' link uses '#' instead of '?'

Jonathan Gibbons jonathan.gibbons at oracle.com
Thu Jul 24 00:50:12 UTC 2014


On 07/23/2014 05:28 PM, Zhong Yu wrote:
> As an example, on this page
>      http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html
> the 'FRAMES' link is
>      http://docs.oracle.com/javase/8/docs/api/index.html?java/lang/Class.html
> i.e. the `targetPage` is embedded as a query.
>
> This is a problem for web crawlers, to them
>      http://docs.oracle.com/javase/8/docs/api/index.html?java/lang/Class.html
>      http://docs.oracle.com/javase/8/docs/api/index.html?java/lang/Object.html
>      ...
> are different pages, therefore the "index.html" page will be crawled many times.
That's an issue for web crawlers; not for javadoc.

>
> I suggest that we use fragment instead of query for `targetPage`, like
>      http://docs.oracle.com/javase/8/docs/api/index.html#java/lang/Class.html
>      http://docs.oracle.com/javase/8/docs/api/index.html#java/lang/Object.html
> these two links point to the same page, and the "index.html" page will
> only be crawled once.

That is not an appropriate use of the fragment syntax.

>
> I made a private mod to javadoc as a proof of concept, for example,
> see the 'FRAME' link on this page:
>
>      http://bayou.io/release/0.9/javadoc/bayou/async/Async.html
>
> Zhong Yu
> bayou.io



More information about the javadoc-dev mailing list