[MPLUGIN-254] @parameter javadoc annotation and @Parameter Java annotation should be allowed on setters

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Auto Closed
• Affects Version/s: 3.2
• Component/s: maven-plugin-annotations, maven-plugin-tools-javadoc
• Assignee: Unassigned
• Reporter: Shane StClair
• Created: 22/Nov/13 14:31
• Updated: 16/Mar/18 22:40
• Resolved: 16/Mar/18 22:40

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.