maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dan Fabulich (JIRA)" <j...@codehaus.org>
Subject [jira] Created: (MPH-31) medium mode should include plugin descriptions
Date Mon, 04 Feb 2008 23:27:57 GMT
medium mode should include plugin descriptions
----------------------------------------------

                 Key: MPH-31
                 URL: http://jira.codehaus.org/browse/MPH-31
             Project: Maven 2.x Help Plugin
          Issue Type: Bug
            Reporter: Dan Fabulich


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.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message