TouchInstinct
/
checkstyle
311
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor fixes

This commit is contained in:
Oliver Burn 2003-01-10 06:52:11 +00:00
parent 66ddfb7a2d
commit 82470fc576
1 changed files with 17 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/index.html
View File

@ -120,50 +120,43 @@
<a name="upgrading"></a>
<h2>Upgrading to release 3.0</h2>
<p class="body">As of release 3.0 Checkstyle has changed it's
configuration system, the configuration file is now an XML file
that configures a tree of check modules. The Checkstyle 2
configuration files (based on properties) are not supported in
Checkstyle 3. Please consult the <a
href="config.html">documentation</a> to learn about the new
configuration file format.
<p class="body">
As of release 3.0 Checkstyle has changed it's configuration
system. The configuration file is now an XML file that configures a
tree of check modules. The Checkstyle 2 configuration files (based on
properties) are not supported in Checkstyle 3. Please consult the <a
href="config.html">documentation</a> to learn about the new
configuration file format.
</p>
<a name="related"></a>
<h2>Related Tools</h2>
<p class="body">
Checkstyle is most useful if you integrate it in your build process or your development environment. The distribution includes:
Checkstyle is most useful if you integrate it in your build process or
your development environment. The distribution includes:
</p>
<ul>
<li class="body">An <a href="http://jakarta.apache.org/ant/index.html">Ant</a> task.</li>
<li class="body">A command line tool.</li>
</ul>
<ul>
<li class="body">An <a href="http://jakarta.apache.org/ant/index.html">Ant</a> task.</li>
<li class="body">A command line tool.</li>
</ul>
<p class="body">
Additionally:
Additionally plug-ins are written by third-parties. Currently they are
typically based on the Checkstyle 2.4 release. The known plug-ins are:
</p>
<ul>
<ul>
<li class="body">David Schneider has written a plug-in to integrate Checkstyle with <a href="http://www.eclipse.org">Eclipse/WSAD</a>. It is available from <a href="http://www.atlas-sw.com">http://www.atlas-sw.com</a>.</li>
<li class="body">Mark Lussier has written a plug-in to integrate Checkstyle with <a href="http://www.intellij.com/idea/">IntelliJ IDEA</a>. It is available from <a href="http://www.intellij.org/twiki/bin/view/Main/JetStylePlugin">http://www.intellij.org/twiki/bin/view/Main/JetStylePlugin</a>.</li>
<li class="body">The <a href="http://jakarta.apache.org/turbine/maven">Maven</a> project management system provides support for Checkstyle. Configuration documentation is available from <a href="http://jakarta.apache.org/turbine/maven/ref/properties.html#Checkstyle Settings">here</a> and an example report <a href="http://jakarta.apache.org/turbine/maven/checkstyle-report.html">here</a>.</li>
<li class="body">Xandy Johnson has written a file-type plug-in to integrate Checkstyle with the <a href="http://www.vim.org">Vim editor</a>. It is available from <a href="http://vim.sourceforge.net/script.php?script_id=448">here</a>.</li>
<li class="body">Todd Papaioannou has written <a href="http://plugins.jedit.org/plugins/CheckStylePlugin">CheckStylePlugin</a> to integrate Checkstyle with the very cool <a href="http://www.jedit.org/">jEdit</a> editor.</li>
<li class="body">Paul Goulbourn has written <a href="http://nbcheckstyle.sourceforge.net">nbCheckStyle</a>, a module to integrate Checkstyle with <a href="http://www.netbeans.org">NetBeans</a>.</li>
<li class="body">The <a href="http://www.krysalis.org/centipede/">Krysalis Centipede</a> build system provides a plug-in for Checkstyle. Documentation is available from <a href="http://www.krysalis.org/centipede/centipede/">http://www.krysalis.org/centipede/centipede/</a>.</li>
<li class="body">Angus Chan has written <a href="http://jbcheckstyle.sourceforge.net">jbCheckStyle</a>, an Open Tool for JBuilder.</li>
<li class="body">Markus Mohnen has written a nice interface to Checkstyle for the <a href="http://jde.sunsite.dk">Emacs JDE</a>. It is now part of the standard JDE distribution.</li>
</ul>
<p class="body">