checkstyle/docs/releasenotes.html

152 lines
7.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<title>Checkstyle Release Notes</title>
<link rel="stylesheet" type="text/css" href="mystyle.css">
</head>
<body>
<!-- The header -->
<table border="0" width="100%" summary="header layout">
<tr>
<td>
<h1>Checkstyle Release Notes</h1>
</td>
<td align="right">
<img src="logo.png" alt="Checkstyle Logo">
</td>
</tr>
</table>
<!-- content -->
<table border="0" width="100%" cellpadding="5" summary="body layout">
<tr>
<!--Left menu-->
<td valign="top" align="left" nowrap="true" bgcolor="#EEEEEE">
<p>Checkstyle 2</p>
<ul>
<li><a href="#release2_3">Release 2.3</a></li>
<li><a href="#release2_2">Release 2.2</a></li>
<li><a href="#release2_1">Release 2.1</a></li>
<li><a href="#release2_0">Release 2.0</a></li>
</ul>
</td>
<!--Content-->
<td width="100%" valign="top" align="left">
<a name="release2_3"></a>
<h2>Release 2.3</h2>
<p class="body">
New features:
<ul>
<li class="body">Support checking to determine if an unused <span class="code">@throws</span> exception is a subclass of <span class="code">java.lang.RuntimeException</span> (request 540382).</li>
<li class="body">Detect instantiations of classes that should not be instantiated (e.g. java.lang.Boolean) (request 550205).</li>
<li class="body">Added ability to specify the base directory for reporting file names (request 571161).</li>
<li class="body">Check for line wrapping on operators (request 553160).</li>
<li class="body">Detect empty <span class="code">try</span> blocks.</li>
<li class="body">Detect empty <span class="code">catch</span> blocks (request 516255).</li>
<li class="body">Detect empty <span class="code">finally</span> blocks.</li>
<li class="body">Detect to-do comments (request 504275).</li>
<li class="body">Detect use of lowercase l ("ell") in long integer literals.</li>
<li class="body">Include column number in the XML output (request 555262).</li>
<li class="body">Added ability to specify a properties file on the command line (request 557544).</li>
<li class="body">Check for whitespace around "{" and "}" (request 557544).</li>
<li class="body">Fix Javadoc errors under JDK 1.4 (request 568553).</li>
<li class="body">Detect redundant <span class="code">abstract</span> modifier in interfaces (request 573485).</li>
</ul>
</p>
<p class="body">
Resolved bugs:
<ul>
<li class="body">Better error reporting for missing properties files (bug 576165).</li>
<li class="body">Ant task now logs style violations as errors (bug 561616).</li>
</ul>
</p>
<p class="body">
API changes (only relevant for IDE plugin authors):
<ul>
<li class="body">The get/setOutputStream methods have been removed from the AuditListener interface. The XMLLogger and DefaultLogger implementations now expect OutputStreams to be provided as a constructor argument.</li>
<li class="body">The DefaultLogger now differentiates between info messages ("started checking file ...", etc.) and error messages (style errors found by checkstyle).</li>
</ul>
</p>
<a name="release2_2"></a>
<h2>Release 2.2</h2>
<p class="body">
Resolved bugs:
<ul>
<li class="body">The cache was not invalidated upon parameter change (Bug 522282).</li>
<li class="body">Tabs were not counted correctly in line length checks (Bug 524671).</li>
<li class="body">Problem when a Checker could not be created (Bug 528358).</li>
<li class="body">The documentation of the command line property names did not list the property checkstyle.allow.tabs (Bug 529975).</li>
<li class="body">The default regular expression for constant names allowed consecutive '_' characters to occur (Bug 540358).</li>
<li class="body">Checkstyle reported unused @throws tag for multiple declarations of the same Exception. According to the <a href="http://developer.java.sun.com/developer/bugParade/bugs/4525364.html">Java BugParade</a> this is incorrect, multiple @throws tags for the same exception are OK (Bug 540384).</li>
</ul>
</p>
<p class="body">
New features:
<ul>
<!--(Feature request 498879)-->
<li class="body">added check for whitespace around '()'</li>
<!--(Feature request 500122)-->
<li class="body">added support for JDK 1.4 assert statements</li>
<!--(Feature request 515787)-->
<li class="body">added column number to error messages for better Emacs integration</li>
<!--(Feature request 524650)-->
<li class="body">added possibility to disable line-length checking by means of regular expressions</li>
<!--(Feature request 531229)-->
<li class="body">added possibility to disallow import of package hierarchies, e.g. sun.*</li>
<!--(Feature request 534038)-->
<li class="body">added failureProperty to ANT task</li>
<!--(Feature request 537107)-->
<li class="body">added check for 'public' modifier in interface method declarations, following the recommendation in chapter 9.4 of the Java Language Specification</li>
<!--(Feature request 545128)-->
<li class="body">added -r "dir" option to the commandline frontend, checkstyle will find all Java files contained in the specified directory</li>
<!--(Patch 531230 + enhancements)-->
<li class="body">incorporated patch from Warner Onstine to configure the ANT task by means of a property file</li>
<li class="body">added 'contrib' directory, contains XSL stylesheets for formating checkstyle's XML output (contributions by Ingmar Stein, Stephane Bailliez, Scott McCrory and Gray Herter)</li>
</ul>
</p>
<a name="release2_1"></a>
<h2>Release 2.1</h2>
<p class="body">
New features:
<ul>
<li class="body">added check for package.html</li>
<li class="body">added flag allowPackage which acts similar as allowProtected</li>
<li class="body">added support for ignoring multiple lines in the file header</li>
<li class="body">added support for specifying the file header by means of regular expressions</li>
<li class="body">added whitespace checks around '.', e.g. System . out . println()</li>
<li class="body">added check for names of methods and local variables</li>
<li class="body">check the order of modifiers (public, static, etc.) against the recommendation in the Java Language specification</li>
<li class="body">added checks for curly braces placement</li>
<li class="body">incorporated patch from Andrew Lang for more robust Javadoc parsing</li>
</ul>
</p>
<a name="release2_0"></a>
<h2>Release 2.0</h2>
<p class="body">
Changes:
<ul>
<li class="body">Now released under the GNU Lesser General Public License (LGPL).</li>
<li class="body">Fix bug #508010, documentation and code are inconsistent.</li>
<li class="body">Changes to make it build "out of the box".</li>
</ul>
</p>
</td>
</tr>
</table>
<hr>
</body> </html>