Uploaded image for project: 'Maven Help Plugin'
  1. Maven Help Plugin
  2. MPH-31

medium mode should include plugin descriptions

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Major
    • Resolution: Won't Fix
    • None
    • None
    • describe
    • None

    Description

      Run "mvn help:describe -Dplugin=compiler -Dmojo=compile". You'll get this:

      [INFO] Mojo: 'compiler:compile'
      ===============================================
      Goal: 'compile'
      Description:
      Compiles application sources
      ===============================================

      Try again with "mvn help:describe -Dplugin=compiler -Dmojo=compile -Dmedium". You'll get the exact same information. Try again with "-Dfull". You'll get a highly verbose description of every parameter, including their type, required, readonly, and description.

      -Dmedium should include an "in-between" amount of information. I might suggest that it include all parameters by name and the description, but not type/required/readonly. (Perhaps omit readonly parameters from -Dmedium view?) We might also consider using only the first sentence of the description, just like Javadoc.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              dfabulich Daniel Fabulich
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: