2002-07-08 15:43:20 +00:00
|
|
|
<html><head>
|
2002-07-08 17:24:35 +00:00
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
|
|
|
<title>
|
2002-07-22 19:57:18 +00:00
|
|
|
PMD-JEdit Plug-in Users' Guide
|
2002-07-08 17:24:35 +00:00
|
|
|
</title>
|
|
|
|
|
<body>
|
2002-07-22 19:57:18 +00:00
|
|
|
<h1>PMD-JEdit Plug-in Users' Guide</h1>
|
2002-07-08 17:38:49 +00:00
|
|
|
<hr>
|
2002-07-22 19:57:18 +00:00
|
|
|
<p>PMD is a Java source code analyzer - it finds unused variables, questionable design decisions, empty catch blocks, and so forth.
|
|
|
|
|
You can read much more about PMD here - http://pmd.sf.net/.</p>
|
2002-07-08 17:24:35 +00:00
|
|
|
<h3>Installation</h3>
|
|
|
|
|
<ul>
|
2002-07-22 19:57:18 +00:00
|
|
|
<li>Uninstall any old PMD-JEdit plugins
|
2002-07-24 21:41:07 +00:00
|
|
|
<li>Unzip the PMD-JEdit-bin-0.6.zip file into your JEdit directory; it'll put a couple of jar files into your jars directory.
|
2002-07-22 19:57:18 +00:00
|
|
|
<li>Restart JEdit and you'll be ready to go.
|
2002-07-08 17:24:35 +00:00
|
|
|
</ul>
|
2002-07-22 19:57:18 +00:00
|
|
|
<h3>Integration</h3>
|
2002-07-25 04:22:41 +00:00
|
|
|
<p>There's a new 'PMD' menu item in the Plugins menu. This has several submenu options</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>"Check current file" checks your currently displayed Java code</li>
|
|
|
|
|
<li>"Check all files in current directory" does just that</li>
|
|
|
|
|
<li>"Check directory recursively" does just that, too! </li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>"Current directory" means "the directory which is displayed in the file system browser. So, for
|
|
|
|
|
example, if you wanted to run PMD on your whole source tree, and your top level
|
|
|
|
|
source directory is named "src", you would 1) double-click on the "src" directory and
|
|
|
|
|
then 2) select the "PMD->Check directory recursively" menu option.</p>
|
|
|
|
|
<p>All those options put any errors into the ErrorList so you can jump around your project fixing stuff.
|
2002-07-22 19:57:18 +00:00
|
|
|
<p>There's also a new section in the Global Options configuration panel that lets you pick rule sets.</p>
|
|
|
|
|
<h3>License</h3>
|
|
|
|
|
<p>The PMD-JEdit plugin is free software released under the Apache license.</p>
|
2002-07-08 17:38:49 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
