You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Dan Fabulich (JIRA)" <ji...@codehaus.org> on 2008/02/05 00:27:57 UTC

[jira] Created: (MPH-31) medium mode should include plugin descriptions

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

        

[jira] Updated: (MPH-31) medium mode should include plugin descriptions

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MPH-31?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Brett Porter updated MPH-31:
----------------------------

    Fix Version/s: Backlog

> 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
>             Fix For: Backlog
>
>
> 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

        

[jira] (MPH-31) medium mode should include plugin descriptions

Posted by "Robert Scholte (JIRA)" <ji...@codehaus.org>.
     [ https://jira.codehaus.org/browse/MPH-31?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Scholte updated MPH-31:
------------------------------

    Component/s: describe
    
> medium mode should include plugin descriptions
> ----------------------------------------------
>
>                 Key: MPH-31
>                 URL: https://jira.codehaus.org/browse/MPH-31
>             Project: Maven 2.x Help Plugin
>          Issue Type: Bug
>          Components: describe
>            Reporter: Dan Fabulich
>             Fix For: Backlog
>
>
> 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, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira