Uploaded image for project: 'Maven Plugin Tools'
  1. Maven Plugin Tools
  2. MPLUGIN-247

Allow getting mojo/parameter description/since/deprecated from annotations

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Won't Fix
    • 3.2
    • None
    • maven-plugin-annotations
    • None
    • Patch

    Description

      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.)

      Attachments

        1. extra-annotations.diff
          17 kB
          Alex Hvostov

        Issue Links

          is duplicated by

          Bug - A problem which impairs or prevents the functions of the product. MPLUGIN-329 support for "description" in mojo annotations / extractors for plugin.xml

          • Major - Major loss of function.
          • Closed
          is part of

          New Feature - A new feature of the product, which has yet to be developed. MPLUGIN-189 add java 5 annotations support to mark Mojo sources

          • Major - Major loss of function.
          • Closed
          is superceded by

          New Feature - A new feature of the product, which has yet to be developed. MPLUGIN-426 Description annotation for Mojo and Parameters

          • Major - Major loss of function.
          • Open

          Activity

            People

              rfscholte Robert Scholte
              argv Alex Hvostov
              Votes:
              2 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: