RFR: JDK-8220379: Fix doclint handling of headings

Jan Lahoda jan.lahoda at oracle.com
Wed Mar 13 20:15:29 UTC 2019


Looks OK to me.

A small nit, in test/langtools/tools/doclint/AccessibilityTest.java, 
there is (in the new state) method "missing_h5", this should presumably 
be "missing_h4". (No need for re-review and no big deal.)

Jan

On 11.3.2019 22:12, Jonathan Gibbons wrote:
>
>
> On 03/11/2019 02:11 PM, Jonathan Gibbons wrote:
>> Please review a moderately simple fix to improve doclint's checking of
>> headings in doc comments.
>>
>> Build folk: by default, the improved checking causes build issues
>> until the doc comments in some modules can be updated. To workaround
>> that, the doclint options in the build have been modified. It is
>> assumed we will re-enable the checks as the issues in each affected
>> module get addressed.
>>
>> javadoc/doclint folk: the new guidelines of using h2 or h4 as the base
>> heading as appropriate are now hard-coded into doclint. In addition,
>> the error messages have been improved, and a new check added, for
>> using a heading that is too low for the context. Internally, some
>> names have been improved to reflect the current terminology.  Tests
>> have been updated as appropriate.
>>
>> -- Jon
>>
>
> Doh!
>
> JBS: https://bugs.openjdk.java.net/browse/JDK-8220379
> Webrev: http://cr.openjdk.java.net/~jjg/8220379/webrev.00


More information about the build-dev mailing list