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 2018/12/02 18:34:00 UTC

[jira] [Updated] (MJAVADOC-470) fix goal corrupts file if no newline before end-comment tag

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

Robert Scholte updated MJAVADOC-470:
------------------------------------
    Description: 
If a method comment has the end-comment tag without a preceding newline, the next method processed will become corrupted. I've attached a simple java file to this case that demonstrates the problem. In short, if Method1 has a comment like:

{code}
    /**
     * This javadoc has no newline before the end-comment token
     * 
     * @throws UnsupportedEncodingException
     *             if UTF-8 is not supported     */
{code}
then Method2's javadoc will be broken.

The actual cause seems to be within the QDox library, where the library doesn't properly set the line number where the actual method begins.

  was:
If a method comment has the end-comment tag without a preceding newline, the next method processed will become corrupted. I've attached a simple java file to this case that demonstrates the problem. In short, if Method1 has a comment like:

    /**
     * This javadoc has no newline before the end-comment token
     * 
     * @throws UnsupportedEncodingException
     *             if UTF-8 is not supported     */

then Method2's javadoc will be broken.

The actual cause seems to be within the QDox library, where the library doesn't properly set the line number where the actual method begins.


> fix goal corrupts file if no newline before end-comment tag
> -----------------------------------------------------------
>
>                 Key: MJAVADOC-470
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-470
>             Project: Maven Javadoc Plugin
>          Issue Type: Bug
>          Components: javadoc
>    Affects Versions: 2.10.3
>            Reporter: Richard Sand
>            Priority: Major
>         Attachments: QDoxBug.java
>
>
> If a method comment has the end-comment tag without a preceding newline, the next method processed will become corrupted. I've attached a simple java file to this case that demonstrates the problem. In short, if Method1 has a comment like:
> {code}
>     /**
>      * This javadoc has no newline before the end-comment token
>      * 
>      * @throws UnsupportedEncodingException
>      *             if UTF-8 is not supported     */
> {code}
> then Method2's javadoc will be broken.
> The actual cause seems to be within the QDox library, where the library doesn't properly set the line number where the actual method begins.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)