RFR: 8248001: javadoc generates invalid HTML pages whose ftp:// links are broken [v2]

Hannes Wallnöfer hannesw at openjdk.java.net
Mon Sep 13 15:29:01 UTC 2021


On Tue, 7 Sep 2021 12:27:09 GMT, Masanori Yano <myano at openjdk.org> wrote:

>> Could you please review the 8248001 bug fixes?
>> 
>> The problem is that javadoc generates invalid HTML pages whose ftp:// links are broken. The fix changes not to use protocol names directly, but to use regular expression.
>
> Masanori Yano has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains five additional commits since the last revision:
> 
>  - 8248001: javadoc generates invalid HTML pages whose ftp:// links are broken
>  - Merge branch 'master' of https://github.com/masyano/jdk into 8248001
>  - 8248001: javadoc generates invalid HTML pages whose ftp:// links are broken
>  - 8248001: javadoc generates invalid HTML pages whose ftp:// links are broken
>  - 8248001: javadoc generates invalid HTML pages whose ftp:// links are broken

Thank you for choosing the conservative approach! The fix looks good.

Using actual domain names in the test is problematic. We should use `example.com`, which has been reserved explicitly for this kind of purpose. 

Also, I'm not convinced we have to introduced a new test for this, especially with the rather generic name of "TestHtmlDocletWriter". It seems there is an existing test for the feature in `test/langtools/jdk/javadoc/doclet/testHrefInDocComment/TestHrefInDocComment.java`. Would it be possible to update/enhance the existing test? If there is a good reason to introduce a new test, it should have a more telling name.

-------------

Changes requested by hannesw (Reviewer).

PR: https://git.openjdk.java.net/jdk/pull/5198


More information about the javadoc-dev mailing list