[MJAVADOC-662] Generated javadoc for static final fields should be HTML escaped

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.3.0
• Component/s: fix
• Assignee: Robert Scholte
• Reporter: Jin Xu
• Created: 26/Aug/20 14:36
• Updated: 26/Apr/21 06:44
• Resolved: 24/Apr/21 12:18

Description

https://github.com/apache/maven-javadoc-plugin/pull/59

    protected static final int MultiTime = 1 << 4;

will become

    /** Constant <code>MultiTime=1 << 4</code> */
    protected static final int MultiTime = 1 << 4;

after calling fix operation.

And notice that the << in the doc is NOT allowed by html, thus will fail the javadoc jar generation.
should use &lt&lt instead.

The expected correct result should be:

    /** Constant <code>MultiTime=1 &lt;&lt; 4</code> */
    protected static final int MultiTime = 1 << 4;

I think I can fix it, but I'm too tired today, tomorrow I will see if I can get some time for the fix.
update: fix done at https://github.com/apache/maven-javadoc-plugin/pull/59

Issue Links

• links to: GitHub Pull Request #59