[jira] [Updated] (MJAVADOC-662) The fix operation wrongly generate illegal javadoc for static final fields.

[Jin Xu (Jira)]

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

Jin Xu updated MJAVADOC-662:
----------------------------
    Description: 
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

  was:
{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.


> The fix operation wrongly generate illegal javadoc for static final fields.
> ---------------------------------------------------------------------------
>
>                 Key: MJAVADOC-662
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-662
>             Project: Maven Javadoc Plugin
>          Issue Type: Bug
>          Components: fix
>            Reporter: Jin Xu
>            Priority: Major
>
> 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)