maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Scholte (JIRA)" <>
Subject [jira] [Commented] (MPLUGIN-247) Allow getting mojo/parameter description/since/deprecated from annotations
Date Sun, 03 Dec 2017 13:26:00 GMT


Robert Scholte commented on MPLUGIN-247:

Maybe [this link|]
gives you an idea. And to be honest, descriptions can get very long. Is an annotation the
only solution?

> Allow getting mojo/parameter description/since/deprecated from annotations
> --------------------------------------------------------------------------
>                 Key: MPLUGIN-247
>                 URL:
>             Project: Maven Plugin Tools
>          Issue Type: Improvement
>          Components: maven-plugin-annotations
>    Affects Versions: 3.2
>            Reporter: Alex Hvostov
>            Priority: Minor
>         Attachments: extra-annotations.diff
> The attached patch adds annotations {{@Description}}, {{@Since}}, and {{@DeprecatedBecause}},
which can be used instead of Javadoc comments for describing a Mojo and its parameters.
> My use-case for this feature is writing Maven plugins in Scala. This language supports
annotations, but a Java parser will obviously not be able to extract description/since/deprecated
information from Scala source files. (There is another {{plugin-tools}} implementation specifically
for writing Scala plugins, which has its own set of annotations, but it is buggy, incomplete,
and not under active development.)

This message was sent by Atlassian JIRA

View raw message