[MPLUGIN-329] support for "description" in mojo annotations / extractors for plugin.xml

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Duplicate
• Affects Version/s: 3.5
• Component/s: maven-plugin-annotations, maven-plugin-tools-java
• Labels: easyfix features
• Environment: java 8
• Assignee: Robert Scholte
• Reporter: Andrei Pozolotin
• Created: 03/Dec/17 00:55
• Updated: 03/Dec/17 11:42
• Resolved: 03/Dec/17 11:42

Description

1) currently, plugin.xml descriptor is generated by extractors
which look basically in 2 places:
a) annotations
b) javadoc

in cases when plugin is written in "other java": scala, groovy, etc i.e. :
https://github.com/random-maven/bintray-maven-plugin
a) annotations work just fine
b) but javadoc descriptions are lost
https://random-maven.github.io/bintray-maven-plugin/deploy-mojo.html

2) this request is to add extra field description to all mojo annotations
https://github.com/apache/maven-plugin-tools/tree/master/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations

so for example:

/**

• Enable to perform deployment.
  */
  @Parameter( property = "bintray.performDeploy", defaultValue = "true" )

becomes:

@Parameter(
description = "Enable to perform deployment.",
property = "bintray.performDeploy",
defaultValue = "true"
)

it seems this feature requires minor effort, yet can result in major improvement

Issue Links

• duplicates: MPLUGIN-247 Allow getting mojo/parameter description/since/deprecated from annotations