Maven 2.x Help Plugin

medium mode should include plugin descriptions

Details

  • Type: Bug Bug
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: Backlog
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    0

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.

Activity

There are no comments yet on this issue.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated: