[
http://jira.codehaus.org/browse/MPLUGIN-175?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=242430#action_242430
]
Dennis Lundberg commented on MPLUGIN-175:
-----------------------------------------
The normal way to solve this is to mark the mojo parameters using the
appropriate annotations.
Here is an example of how it should be done, taken from
http://svn.apache.org/viewvc/maven/plugins/tags/maven-changes-plugin-2.3/src/main/java/org/apache/maven/plugin/announcement/AnnouncementMojo.java?revision=887770&view=markup
{noformat}
/**
* The Maven Project.
*
* @parameter expression="${project}"
* @required
* @readonly
*/
private MavenProject project;
{noformat}
The documentation for this Mojo is shown here:
http://maven.apache.org/plugins/maven-changes-plugin/announcement-generate-mojo.html
As you can see the project parameter is not in the generated documentation,
because it is marked as @readonly.
If you find project parameters in a plugin, please open a JIRA issue for that
plugin so that we can fix it for the next release of that plugin.
> Omit 'project' from documentation list of parameters
> ----------------------------------------------------
>
> Key: MPLUGIN-175
> URL: http://jira.codehaus.org/browse/MPLUGIN-175
> Project: Maven 2.x Plugin Tools
> Issue Type: Wish
> Components: Plugin Plugin
> Affects Versions: 2.6
> Reporter: Benson Margulies
>
> Just about every Maven plugin asks to have 'project' injected. The
> plugin-plugin, generating doc, includes it in the list of required
> parameters, to the eternal confusion of people learning how to configure
> plugins. I propose that it, any any other parameter which is purely a
> resource injection mechanism, be left out.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
