[
https://issues.apache.org/jira/browse/MPLUGIN-329?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Andrei Pozolotin updated MPLUGIN-329:
-------------------------------------
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
was:
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
> support for "description" in mojo annotations / extractors for plugin.xml
> -------------------------------------------------------------------------
>
> Key: MPLUGIN-329
> URL: https://issues.apache.org/jira/browse/MPLUGIN-329
> Project: Maven Plugin Tools
> Issue Type: Bug
> Components: maven-plugin-annotations, maven-plugin-tools-java
> Affects Versions: 3.5
> Environment: java 8
> Reporter: Andrei Pozolotin
> Labels: easyfix, features
>
> 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
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
