RFR (XS) 8219691: method summary table head should be enclosed in <thead>

Jonathan Gibbons jonathan.gibbons at oracle.com
Thu Mar 7 01:31:55 UTC 2019


Hi Derek,

Thanks for taking a look at this.

The code itself looks reasonable, but I see you didn't provide anything 
in the way of a test.  There's two ways to look at that ..  either your 
change will break some existing tests, which will need to be fixed up, 
or it will not break any existing tests, indicating there is a lack of 
test coverage in this area, and so a test would be worth while. Either 
way, we should make sure there is test coverage for this change.

Writing javadoc tests is pretty easy these days, using the 
"JavadocTester" framework.  Typically these days, for a case like this, 
I would expect to see a test generate a class with a few methods, 
perhaps using Toolbox.writeJavaFiles, then run it through javadoc, using 
JavadocTester.javadoc, and then call checkOutput to verify that the 
expected output has been generated.

-- Jon



On 03/06/2019 03:37 PM, Derek Thomson wrote:
> Hi all,
>
> I saw this bug and thought I could take a stab at it. Could someone 
> review my change please?
>
> Webrev: http://cr.openjdk.java.net/~jcbeyler/8219691/webrev.00/ 
> <http://cr.openjdk.java.net/%7Ejcbeyler/8219691/webrev.00/>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8219691
>
> Thanks,
> Derek.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20190306/00cb17c0/attachment.html>


More information about the javadoc-dev mailing list