[jira] Commented: (MNG-1200) I wish the documentation for the plugin goals (specifically the descriptions) were completed and included examples

["Dave Sag (JIRA)" <ji...@codehaus.org>]

    [ http://jira.codehaus.org/browse/MNG-1200?page=comments#action_48610 ] 

Dave Sag commented on MNG-1200:
-------------------------------

I would like to see usage examples for each plugin too.  sometimes the docs that are there are very opaque.



> I wish the documentation for the plugin goals (specifically the descriptions) were completed and included examples
> ------------------------------------------------------------------------------------------------------------------
>
>          Key: MNG-1200
>          URL: http://jira.codehaus.org/browse/MNG-1200
>      Project: Maven 2
>         Type: Wish
>   Components: maven-war-plugin, maven-verifier-plugin, maven-surefire-plugin, maven-sources-plugin, maven-site-plugin, maven-resources-plugin, maven-reports, maven-release-plugin, maven-rar-plugin, maven-project-info-reports-plugin, maven-projecthelp-plugin, maven-project, maven-pmd-plugin, maven-plugin-tools, maven-plugins, maven-plugin-plugin, maven-plugin-descriptor, maven-plugin-api, maven-monitor, maven-model, maven-javadoc-plugin, maven-jar-plugin, maven-install-plugin, maven-idea-plugin, maven-embedder, maven-ejb-plugin, maven-eclipse-plugin, maven-ear-plugin, maven-deploy-plugin, maven-core, maven-compiler-plugin, maven-clover-plugin, maven-clean-plugin, maven-checkstyle-plugin, maven-assembly-plugin, maven-artifact-ant, maven-artifact, maven-archiver, maven-archetype-plugin, maven-antrun-plugin, maven-ant-plugin, maven-antlr-plugin
>     Reporter: Brian Bonner
>     Assignee: Stephane Nicoll

>
>
> Many of the plugins don't include a detailed description.  They include "description", or "no description".   The plugins 
> Several of the plugins (assembly, checkstyle) do a great job of describing the fields (although I used them all yet).  But some still have "no description" or don't include examples  (i.e. siteRenderer)  Even a reference with a link to a page where more info can be obtained would be helpful.
> I'm taking the perspect of the new user to maven.  Having a description of what the plugin goal is will really help adoption.
> btw, I'm creating this because I ran into a problem with the changes plugin and it turns out that updateReleaseInfo on the install plugin seemed to fix the problem I was having, but after looking at the install goal docs, I have no idea what the updateReleaseInfo property does, except: No Description.
> Thanks.

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org