maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Shane StClair (JIRA)" <j...@codehaus.org>
Subject [jira] (MPLUGIN-254) @parameter annotation should be allowed on setters
Date Fri, 22 Nov 2013 20:33:45 GMT
Shane StClair created MPLUGIN-254:
-------------------------------------

             Summary: @parameter 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-tools-javadoc
    Affects Versions: 3.2
            Reporter: Shane StClair
            Priority: Minor


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.

--
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

Mime
View raw message