530c640d4f
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112724 13f79535-47bb-0310-9956-ffa450edef68
43 lines
1.3 KiB
XML
43 lines
1.3 KiB
XML
<?xml version="1.0"?>
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Maven Checkstyle Plug-in Goals</title>
|
|
<author email="dion@multitask.com.au">dIon Gillard</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Goals">
|
|
<table>
|
|
<tr><th>Goal</th><th>Description</th></tr>
|
|
<tr>
|
|
<td>checkstyle</td>
|
|
<td>
|
|
This is the default goal of the plugin and simply has a pre-requisite
|
|
of the <code>checkstyle:check-license-file</code> goal.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>checkstyle:generate-report</td>
|
|
<td>
|
|
Generates an xml report from the source code showing how well the
|
|
code conforms to the <a href="http://checkstyle.sourceforge.net">Checkstyle</a>
|
|
definitions defined by the project.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>checkstyle:check-license-file</td>
|
|
<td>
|
|
Checks the existence of the LICENSE.txt file that checkstyle uses
|
|
for ensuring the top of a source file has a valid license block.
|
|
<p>
|
|
If the license file exists, the <code>checkstyle:generate-report</code>
|
|
goal is attained.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document>
|