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

Hannes Wallnöfer hannesw at openjdk.java.net
Mon Sep 27 12:37:17 UTC 2021


On Fri, 24 Sep 2021 11:12:24 GMT, Masanori Yano <myano at openjdk.org> wrote:

>> 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.
>
> @hns As you commented, I changed to add test codes in test/langtools/jdk/javadoc/doclet/testHrefInDocComment,
> and not to introduce a new test. I modified the test to use www.example.com instead of www.domain.com.

@masyano thanks, this helps to not inflate the size of our test suite more than necessary. 

What is missing from the updated test is something like the `checkHtml` method in your original test that verifies the correct links in the generated files. Also, the copyright date in the `TestHrefInDocComment.java` should be updated to 2021.

> @hns As you commented, I changed to add test codes in test/langtools/jdk/javadoc/doclet/testHrefInDocComment,
> and not to introduce a new test. I modified the test to use [www.example.com](http://www.example.com) instead of [www.domain.com](http://www.domain.com).

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

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


More information about the javadoc-dev mailing list