2006-01-24 00:21:22 +00:00

59 lines
2.1 KiB
XML

<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Maven CheckStyle Plug-in</title>
<author email="jason@zenplex.com">Jason van Zyl</author>
<author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
<section name="Maven CheckStyle Plugin">
<p>
This plugin generates a nicely formatted
<a href="http://checkstyle.sourceforge.net">Checkstyle</a> report so
code violations can be easily found and corrected.
</p>
</section>
<section name="Using the dashboard report">
<p>
To use older versions of the dashboard plugin (&lt; 1.9) report with later versions of this one (&gt; 2.5)
you need to change these properties:
</p>
<source>
# Properties for the Checkstyle files aggregator
maven.dashboard.aggregator.csfiles.artifact = ${maven.build.dir}/checkstyle/checkstyle-raw-report.xml
# Properties for the Checkstyle error/warning aggregator (all errors/warnings)
maven.dashboard.aggregator.csall.artifact = ${maven.build.dir}/checkstyle/checkstyle-raw-report.xml
# Properties for the Checkstyle error aggregator (only errors)
maven.dashboard.aggregator.cserrors.artifact = ${maven.build.dir}/checkstyle/checkstyle-raw-report.xml
# Properties for the Checkstyle warning aggregator (only warnings)
maven.dashboard.aggregator.cswarnings.artifact = ${maven.build.dir}/checkstyle/checkstyle-raw-report.xml
</source>
</section>
</body>
</document>