[MPLUGIN-62] Exclude read-only components from plugin goal documentation

• Type: Bug
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Fix Version/s: 2.4
• Component/s: maven-plugin-tools-java
• Environment: Maven 2.0.7
• Flags: Patch
• Assignee: Siveton Vincent
• Reporter: Benjamin Bentmann
• Created: 08/Nov/07 12:15
• Updated: 05/Apr/15 14:54
• Resolved: 17/Nov/07 07:36

Description

Currently, a mojo field declared like

/**
 * @component
 * @readonly
 */
private MavenProjectHelper projectHelper;

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.

Issue Links

• is related to: MPLUGIN-57 Mojo fields @component and no @parameter annotations are still considered parameters and can't be distinguished when it became a Parameter Object