You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Lars van der Vliet (JIRA)" <ji...@codehaus.org> on 2012/09/14 20:14:21 UTC
[jira] (MJAVADOC-351) Javadoc:fix fixTags parameter doesn't support
'return' value
Lars van der Vliet created MJAVADOC-351:
-------------------------------------------
Summary: Javadoc:fix fixTags parameter doesn't support 'return' value
Key: MJAVADOC-351
URL: https://jira.codehaus.org/browse/MJAVADOC-351
Project: Maven 2.x Javadoc Plugin
Issue Type: Bug
Affects Versions: 2.8.1, 2.8, 2.7
Reporter: Lars van der Vliet
Attachments: fixTags.patch
Javadoc:fix fixTags parameter doesn't support 'return' value
According to the docs (http://maven.apache.org/plugins/maven-javadoc-plugin/fix-mojo.html#fixTags) the fixTags parameter should be able to handle the following values:
# all (fix all Javadoc tags)
# author (fix only @author tag)
# version (fix only @version tag)
# since (fix only @since tag)
# param (fix only @param tag)
# return (fix only @return tag)
# throws (fix only @throws tag)
# link (fix only @link tag)
When Calling javadoc:fix version 2.8 or 2.7 with -DfixTags=return gives the following error:
{code}
Unrecognized 'return' for fixTags parameter. Ignored it!
{code}
Using 2.6 this works just fine. When looking at the following diff:
{code}
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java 2011/04/25 13:38:09 1096478
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java 2011/04/30 18:59:02 1098139
@@ -491,10 +491,8 @@
for ( int j = 0; j < split.length; j++ )
{
String s = split[j].trim();
- if ( FIX_TAGS_ALL.equalsIgnoreCase( s.trim() ) || AUTHOR_TAG.equalsIgnoreCase( s.trim() )
- || VERSION_TAG.equalsIgnoreCase( s.trim() ) || SINCE_TAG.equalsIgnoreCase( s.trim() )
- || PARAM_TAG.equalsIgnoreCase( s.trim() ) || RETURN_TAG.equalsIgnoreCase( s.trim() )
- || THROWS_TAG.equalsIgnoreCase( s.trim() ) )
+ if ( JavadocUtil.equalsIgnoreCase( s, FIX_TAGS_ALL, AUTHOR_TAG, VERSION_TAG, SINCE_TAG, PARAM_TAG,
+ THROWS_TAG ) )
{
filtered.add( s );
}
{code}
the functionality seems to be broken since revision 1098139. I added a patch which restores the functionality.
--
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] (MJAVADOC-351) Javadoc:fix fixTags parameter doesn't support
'return' value
Posted by "Wouter Hermeling (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/MJAVADOC-351?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=310271#comment-310271 ]
Wouter Hermeling commented on MJAVADOC-351:
-------------------------------------------
Patch already included? Nice! Ik hope this can be included in a release quickly.
> Javadoc:fix fixTags parameter doesn't support 'return' value
> ------------------------------------------------------------
>
> Key: MJAVADOC-351
> URL: https://jira.codehaus.org/browse/MJAVADOC-351
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.7, 2.8, 2.8.1
> Reporter: Lars van der Vliet
> Attachments: fixTags.patch
>
>
> Javadoc:fix fixTags parameter doesn't support 'return' value
> According to the docs (http://maven.apache.org/plugins/maven-javadoc-plugin/fix-mojo.html#fixTags) the fixTags parameter should be able to handle the following values:
> # all (fix all Javadoc tags)
> # author (fix only @author tag)
> # version (fix only @version tag)
> # since (fix only @since tag)
> # param (fix only @param tag)
> # return (fix only @return tag)
> # throws (fix only @throws tag)
> # link (fix only @link tag)
> When Calling javadoc:fix version 2.8 or 2.7 with -DfixTags=return gives the following error:
> {code}
> Unrecognized 'return' for fixTags parameter. Ignored it!
> {code}
> Using 2.6 this works just fine. When looking at the following diff:
> {code}
> --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java 2011/04/25 13:38:09 1096478
> +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java 2011/04/30 18:59:02 1098139
> @@ -491,10 +491,8 @@
> for ( int j = 0; j < split.length; j++ )
> {
> String s = split[j].trim();
> - if ( FIX_TAGS_ALL.equalsIgnoreCase( s.trim() ) || AUTHOR_TAG.equalsIgnoreCase( s.trim() )
> - || VERSION_TAG.equalsIgnoreCase( s.trim() ) || SINCE_TAG.equalsIgnoreCase( s.trim() )
> - || PARAM_TAG.equalsIgnoreCase( s.trim() ) || RETURN_TAG.equalsIgnoreCase( s.trim() )
> - || THROWS_TAG.equalsIgnoreCase( s.trim() ) )
> + if ( JavadocUtil.equalsIgnoreCase( s, FIX_TAGS_ALL, AUTHOR_TAG, VERSION_TAG, SINCE_TAG, PARAM_TAG,
> + THROWS_TAG ) )
> {
> filtered.add( s );
> }
> {code}
> the functionality seems to be broken since revision 1098139. I added a patch which restores the functionality.
--
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