You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Robert Scholte (Jira)" <ji...@apache.org> on 2021/04/20 21:54:00 UTC

[jira] [Closed] (MPLUGIN-247) Allow getting mojo/parameter description/since/deprecated from annotations

     [ https://issues.apache.org/jira/browse/MPLUGIN-247?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Scholte closed MPLUGIN-247.
----------------------------------
      Assignee: Robert Scholte
    Resolution: Won't Fix

Introducing annotations where one would normally write javadoc doesn't make sense to me.
So I'm closing this as won't fix, it might be superseded if someone writes a javadoc parser for Scala (like QDox is being used for parsing the Java sourcefiles)

> Allow getting mojo/parameter description/since/deprecated from annotations
> --------------------------------------------------------------------------
>
>                 Key: MPLUGIN-247
>                 URL: https://issues.apache.org/jira/browse/MPLUGIN-247
>             Project: Maven Plugin Tools
>          Issue Type: Improvement
>          Components: maven-plugin-annotations
>    Affects Versions: 3.2
>            Reporter: Alex Hvostov
>            Assignee: Robert Scholte
>            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
(v8.3.4#803005)