Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

PR: MNG-952 

Submitted by: Allan Ramirez
Reviewed by:  Brett Porter
documentation for the checkstyle plugin


git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@291481 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Brett Leslie Porter 2005-09-25 22:47:08 +00:00
parent 77f8246cf8
commit c864bf664c
3 changed files with 134 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
maven-plugins/maven-checkstyle-plugin/src/site/apt/howto.apt Normal file
View File

@ -0,0 +1,33 @@
------
Maven 2 Checkstyle Plugin
------
Maven 2 Checkstyle Plugin
Checkstyle plugin generates report regarding the code style of the developer.
*How to Generate Checkstyle Report
In your project pom.xml, add the checkstyle plugin in <reporting> section.
-------------------
<project>
...
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>2.0-alpha-3-SNAPSHOT</version>
</plugin>
</plugins>
</reporting>
...
</project>
-------------------
Execute the site plugin to generate the report distribution.
-------------------
m2 site:site
-------------------

80
maven-plugins/maven-checkstyle-plugin/src/site/resources/checkstyle.html Normal file
View File

File diff suppressed because one or more lines are too long

21
maven-plugins/maven-checkstyle-plugin/src/site/site.xml Normal file
View File

@ -0,0 +1,21 @@
<project name="Maven Checkstyle plugin">
<bannerLeft>
<name>Maven Checkstyle plugin</name>
<src>http://maven.apache.org/images/apache-maven-project.png</src>
<href>http://maven.apache.org/</href>
</bannerLeft>
<bannerRight>
<src>http://maven.apache.org/images/maven-small.gif</src>
</bannerRight>
<body>
<links>
<item name="Maven 2" href="http://maven.apache.org/maven2/"/>
</links>
<menu name="Checkstyle Quickstart">
<item name="Overview" href="howto.html"/>
<item name="Sample Checkstyle Report" href="checkstyle.html"/>
</menu>
${reports}
</body>
</project>