JDK-8216463 : rename "header" to "heading" in doclint
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 12
  • Priority: P4
  • Status: Resolved
  • Resolution: Duplicate
  • Submitted: 2019-01-10
  • Updated: 2019-05-22
  • Resolved: 2019-05-22
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 13
13Resolved
Related Reports
Duplicate :  
JDK-8220379 - Fix doclint handling of headings
Description
There are 3 similar terms in HTML5, with distinct usages:

Head ... the <head> element of an HTML document
Header ... a <header> element within an HTML document ... new in HTM5 ... one of the newly defined regions of a document
Heading ... this seems to be the preferred term for any of the <h1>...<h6> group of elements

The doclint code, which was written before we adopted use of HTML5, uses "header" extensively to describe the collection of HTML tags H1...H6.
For consistency and sanity, it would be good to update the code to use Heading in preference to Header.

Here is a quick grep indicating the affected locations. I assume that most could be fixed up with IDE renames.

$ grep -r -i header $(find src/jdk.compiler -name doclint) | grep -v COPYRIGHT
src/jdk.compiler/share/classes/com/sun/tools/doclint/HtmlTag.java:                case HEADER: case FOOTER: case MAIN:
src/jdk.compiler/share/classes/com/sun/tools/doclint/HtmlTag.java:    HEADER(HtmlVersion.HTML5, BlockType.BLOCK, EndKind.REQUIRED,
src/jdk.compiler/share/classes/com/sun/tools/doclint/HtmlTag.java:                case HEADER: case FOOTER: case MAIN:
src/jdk.compiler/share/classes/com/sun/tools/doclint/HtmlTag.java:            attrs(AttrKind.ALL, COLSPAN, ROWSPAN, HEADERS, VALIGN),
src/jdk.compiler/share/classes/com/sun/tools/doclint/HtmlTag.java:            attrs(AttrKind.ALL, COLSPAN, ROWSPAN, HEADERS, SCOPE, Attr.ABBR,
src/jdk.compiler/share/classes/com/sun/tools/doclint/HtmlTag.java:        HEADERS,
src/jdk.compiler/share/classes/com/sun/tools/doclint/DocLint.java:    public static final String XIMPLICIT_HEADERS = "-XimplicitHeaders:";
src/jdk.compiler/share/classes/com/sun/tools/doclint/DocLint.java:            } else if (arg.matches(XIMPLICIT_HEADERS + "[1-6]")) {
src/jdk.compiler/share/classes/com/sun/tools/doclint/DocLint.java:                env.setImplicitHeaders(Character.digit(ch, 10));
src/jdk.compiler/share/classes/com/sun/tools/doclint/resources/doclint_ja.properties:dc.tag.header.sequence.1 = \u30D8\u30C3\u30C0\u30FC\u306E\u6307\u5B9A\u9806\u5E8F\u304C\u6B63\u3057\u304F\u3042\u308A\u307E\u305B\u3093: <{0}>
src/jdk.compiler/share/classes/com/sun/tools/doclint/resources/doclint_ja.properties:dc.tag.header.sequence.2 = \u30D8\u30C3\u30C0\u30FC\u306E\u6307\u5B9A\u9806\u5E8F\u304C\u6B63\u3057\u304F\u3042\u308A\u307E\u305B\u3093: <{0}>
src/jdk.compiler/share/classes/com/sun/tools/doclint/resources/doclint.properties:dc.tag.header.sequence.1 = header used out of sequence: <{0}>
src/jdk.compiler/share/classes/com/sun/tools/doclint/resources/doclint.properties:dc.tag.header.sequence.2 = header used out of sequence: <{0}>
src/jdk.compiler/share/classes/com/sun/tools/doclint/resources/doclint_zh_CN.properties:dc.tag.header.sequence.1 = \u4F7F\u7528\u7684\u6807\u9898\u8D85\u51FA\u5E8F\u5217: <{0}>
src/jdk.compiler/share/classes/com/sun/tools/doclint/resources/doclint_zh_CN.properties:dc.tag.header.sequence.2 = \u4F7F\u7528\u7684\u6807\u9898\u8D85\u51FA\u5E8F\u5217: <{0}>
src/jdk.compiler/share/classes/com/sun/tools/doclint/Env.java:    int implicitHeaderLevel = 0;
src/jdk.compiler/share/classes/com/sun/tools/doclint/Env.java:    void setImplicitHeaders(int n) {
src/jdk.compiler/share/classes/com/sun/tools/doclint/Env.java:        implicitHeaderLevel = n;
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:    private HtmlTag currHeaderTag;
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:    private final int implicitHeaderLevel;
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:        implicitHeaderLevel = env.implicitHeaderLevel;
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:        currHeaderTag = null;
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:                // check for out of sequence headers, such as <h1>...</h1>  <h3>...</h3>
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:                    checkHeader(tree, t);
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:    private void checkHeader(StartElementTree tree, HtmlTag tag) {
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:        if (getHeaderLevel(tag) > getHeaderLevel(currHeaderTag) + 1) {
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:            if (currHeaderTag == null) {
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:                env.messages.error(ACCESSIBILITY, tree, "dc.tag.header.sequence.1", tag);
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:                env.messages.error(ACCESSIBILITY, tree, "dc.tag.header.sequence.2",
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:                    tag, currHeaderTag);
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:        currHeaderTag = tag;
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:    private int getHeaderLevel(HtmlTag tag) {
src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java:            return implicitHeaderLevel;
Comments
In src/jdk.compiler/share/classes/com/sun/tools/doclint/HtmlTag.java, HEADER present refers to HTML5 Header element. In all other remaining places, the "header" is renamed to "heading" as part of fix for JDK-8220379.
22-05-2019