You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Robert Scholte (Jira)" <ji...@apache.org> on 2021/04/24 12:19:00 UTC

[jira] [Closed] (MJAVADOC-662) Generated javadoc for static final fields should be HTML escaped

     [ https://issues.apache.org/jira/browse/MJAVADOC-662?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Scholte closed MJAVADOC-662.
-----------------------------------
      Assignee: Robert Scholte
    Resolution: Fixed

Fixed in [e7a3fe0ed8d7be61de9cc458751b5a24f640fba8|https://gitbox.apache.org/repos/asf?p=maven-javadoc-plugin.git;a=commit;h=e7a3fe0ed8d7be61de9cc458751b5a24f640fba8]

> Generated javadoc for static final fields should be HTML escaped
> ----------------------------------------------------------------
>
>                 Key: MJAVADOC-662
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-662
>             Project: Maven Javadoc Plugin
>          Issue Type: Bug
>          Components: fix
>            Reporter: Jin Xu
>            Assignee: Robert Scholte
>            Priority: Major
>             Fix For: 3.2.1
>
>
> https://github.com/apache/maven-javadoc-plugin/pull/59
> {code:java}
>     protected static final int MultiTime = 1 << 4;
> {code}
> will become 
> {code:java}
>     /** Constant <code>MultiTime=1 << 4</code> */
>     protected static final int MultiTime = 1 << 4;
> {code}
> 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:
> {code:java}
>     /** Constant <code>MultiTime=1 &lt;&lt; 4</code> */
>     protected static final int MultiTime = 1 << 4;
> {code}
> -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



--
This message was sent by Atlassian Jira
(v8.3.4#803005)