You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Matt Benson (JIRA)" <ji...@codehaus.org> on 2012/03/03 01:27:02 UTC
[jira] (JXR-96) [PATCH] JXR Comment handling has several
shortcomings
Matt Benson created JXR-96:
------------------------------
Summary: [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
[jira] (JXR-96) [PATCH] JXR Comment handling has several
shortcomings
Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/JXR-96?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Lukas Theussl updated JXR-96:
-----------------------------
Affects Version/s: (was: 2.4)
> [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
> Reporter: Matt Benson
> Fix For: 2.4
>
> 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
[jira] (JXR-96) [PATCH] JXR Comment handling has several
shortcomings
Posted by "Matt Benson (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/JXR-96?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Matt Benson updated JXR-96:
---------------------------
Attachment: JXR-96.patch.txt
ICLA on file w/ ASF. I grant the ASF license to use these contributions.
> [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
[jira] (JXR-96) [PATCH] JXR Comment handling has several
shortcomings
Posted by "Matt Benson (JIRA)" <ji...@codehaus.org>.
[ 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
[jira] (JXR-96) [PATCH] JXR Comment handling has several
shortcomings
Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/JXR-96?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Lukas Theussl closed JXR-96.
----------------------------
Resolution: Fixed
Fix Version/s: 2.4
Assignee: Lukas Theussl
Patch applied in [r1296948|http://svn.apache.org/viewvc?view=revision&revision=1296948]. Thanks!
> [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
> Reporter: Matt Benson
> Assignee: Lukas Theussl
> Fix For: 2.4
>
> 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