Exclude read-only components from plugin goal documentation
-----------------------------------------------------------
Key: MPLUGIN-62
URL: http://jira.codehaus.org/browse/MPLUGIN-62
Project: Maven 2.x Plugin Tools
Issue Type: Bug
Components: Java Plugins
Environment: Maven 2.0.7
Reporter: Benjamin Bentmann
Priority: Trivial
Attachments: readonly-component.patch
Currently, a mojo field declared like
{code:java}
/**
* @component
* @readonly
*/
private MavenProjectHelper projectHelper;
{code}
will make it into the site documentation for the goal (i.e. mymojo-mojo.html),
causing confusion for users of the plugin.
This problem seems to arise from
JavaMojoDescriptorExtractor.extractParameters() which does not mark @component
fields as read-only. This in turn, will make
PluginXdocGeneratorMojo.filterParameters() keep the field for documentation.
The attached patch shows two possible solutions.
--
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
