DOCCK = Maven Document Check

As seen on the page: "This plugin checks that a project complies with
the Plugin Documentation Standard."

Link to Plugin Doc Standard:
http://maven.apache.org/guides/development/guide-plugin-documentation.html

Link to DOCCK FAQ:
http://maven.apache.org/plugins/maven-docck-plugin/faq.html

Where did the standard came from?
The plugin documentation standard was created to address the frequent
complaint of lack of documentation, specifically on the maven plugins.
The standard was based on suggestions made on the maven dev mailing
list with some refinements. It is a community consensus of what basic
documentation a maven plugin should have.

[top]

--------------------------------------------------------------------------------

Why do we need a documentation standard?
The standard is not a set of rules but a guide to help plugin
developers document their plugins better, for the benefit of the users
of the plugin. The standard also reminds the plugin developers of the
important details that needs to be documented, to help speed up the
adoption of the plugin.


Wayne

On 10/25/06, Mick Knutson <[EMAIL PROTECTED]> wrote:
Is there a better description of this plugin? Sorry, but I am not quite sure
what this plugin will do for me. Can someone shed some more light?


On 10/24/06, Wim Deblauwe <[EMAIL PROTECTED]> wrote:
>
> It is very nice to see this after there has been much discussion about the
> quality of the documentation. It shows that the Maven team is really
> concerned with this.
>
> keep up the good work!
>
> regards,
>
> Wim
>
> 2006/10/25, Dennis Lundberg <[EMAIL PROTECTED]>:
> >
> > The Maven team is pleased to announce the release of the Maven DOCCK
> > Plugin, version 1.0-beta-1
> >
> > http://maven.apache.org/plugins/maven-docck-plugin/
> >
> > You can run mvn -U to get the latest version of the plugin, or specify
> > the version in your project's plugin configuration:
> >
> > <plugin>
> >   <groupId>org.apache.maven.plugins</groupId>
> >   <artifactId>maven-docck-plugin</artifactId>
> >   <version>1.0-beta-1</version>
> > </plugin>
> >
> > This is the first release of this plugin.
> >
> > Enjoy,
> >
> > -The Maven team
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: [EMAIL PROTECTED]
> > For additional commands, e-mail: [EMAIL PROTECTED]
> >
> >
>
>


--

Thanks

DJ MICK
http://www.djmick.com
http://www.myspace.com/mickknutson



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to