maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Matt Benson (JIRA)" <j...@codehaus.org>
Subject [jira] (JXR-96) [PATCH] JXR Comment handling has several shortcomings
Date Sat, 03 Mar 2012 00:29:02 GMT

    [ https://jira.codehaus.org/browse/JXR-96?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=293258#comment-293258
] 

Matt Benson commented on JXR-96:
--------------------------------

The third issue above, after accounting for wiki markup, is:

* does not handle /\*\*/ construct properly:  recognized as javadoc but not terminated, while
it is better interpreted as /\*\[empty\]\*/.
                
> [PATCH] JXR Comment handling has several shortcomings
> -----------------------------------------------------
>
>                 Key: JXR-96
>                 URL: https://jira.codehaus.org/browse/JXR-96
>             Project: Maven JXR
>          Issue Type: Bug
>    Affects Versions: 2.3, 2.4
>            Reporter: Matt Benson
>         Attachments: JXR-96.patch.txt
>
>
> I have identified the following issues:
>  * a // comment does not properly mask a subsequent /* on the same line.
>  * explicitly tries not to terminate comments if */ is embedded in a string, but compilers
don't behave this way.
>  * does not handle /**/ construct properly: recognized as javadoc but not terminated,
while it is better interpreted as /*[empty]*/.
> I have addressed these issues + JXR-58 by reworking the comment handling code.  Formerly
the filters were applied { multiline, inline }; my version of the code uses { ongoing-multiline,
inline, begin-multiline } specifically to address the first of the issues noted above.  I
was unable to find any exhaustive tests for this code; please guide me if there is any further
testing I can provide.  I have collapsed the duplicate code in these regions as much as possible,
and since this project is on maven-parent v21 I believe I was justified in replacing the StringBuffers
in affected areas with StringBuilders (obviously the whole file might benefit minutely from
this treatment).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message