You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Shane StClair (JIRA)" <ji...@codehaus.org> on 2013/11/22 23:18:45 UTC
[jira] (MPLUGIN-254) @parameter javadoc annotation and @Parameter
Java annotation should be allowed on setters
[ https://jira.codehaus.org/browse/MPLUGIN-254?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Shane StClair updated MPLUGIN-254:
----------------------------------
Component/s: maven-plugin-annotations
Description:
maven-plugin-tools-javadc currently complains if the @parameter is used on a setter method rather than a field with this warning:
warning - Tag @parameter cannot be used in method documentation. It can only be used in the following types of documentation: field.
Likewise, the @Parameter Java annotation can't be placed on setter methods, since it is limited to @Target( { ElementType.FIELD } ).
However, @parameter/@Parameter should be legal to use on both fields and setter methods, as referenced here:
http://books.sonatype.com/mvnref-book/reference/writing-plugins-sect-mojo-params.html#writing-plugins-sect-param-annot
"Marks a private field (or a setter method) as a parameter."
maven-plugin-tools-javadoc and maven-plugin-annotations should be updated to allow the usage of @parameter/@Parameter on setter methods.
was:
maven-plugin-tools-javadc currently complains if @parameter is used on a setter method rather than a field with this warning:
warning - Tag @parameter cannot be used in method documentation. It can only be used in the following types of documentation: field.
However, @parameter is legal to use on both fields and setter methods, as referenced here:
http://books.sonatype.com/mvnref-book/reference/writing-plugins-sect-mojo-params.html#writing-plugins-sect-param-annot
"Marks a private field (or a setter method) as a parameter."
maven-plugin-tools-javadoc should be updated to allow the usage of @parameter on setters.
Summary: @parameter javadoc annotation and @Parameter Java annotation should be allowed on setters (was: @parameter annotation should be allowed on setters)
> @parameter javadoc annotation and @Parameter Java annotation should be allowed on setters
> -----------------------------------------------------------------------------------------
>
> Key: MPLUGIN-254
> URL: https://jira.codehaus.org/browse/MPLUGIN-254
> Project: Maven Plugin Tools
> Issue Type: Bug
> Components: maven-plugin-annotations, maven-plugin-tools-javadoc
> Affects Versions: 3.2
> Reporter: Shane StClair
> Priority: Minor
>
> maven-plugin-tools-javadc currently complains if the @parameter is used on a setter method rather than a field with this warning:
> warning - Tag @parameter cannot be used in method documentation. It can only be used in the following types of documentation: field.
> Likewise, the @Parameter Java annotation can't be placed on setter methods, since it is limited to @Target( { ElementType.FIELD } ).
> However, @parameter/@Parameter should be legal to use on both fields and setter methods, as referenced here:
> http://books.sonatype.com/mvnref-book/reference/writing-plugins-sect-mojo-params.html#writing-plugins-sect-param-annot
> "Marks a private field (or a setter method) as a parameter."
> maven-plugin-tools-javadoc and maven-plugin-annotations should be updated to allow the usage of @parameter/@Parameter on setter methods.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira