From 9dd92fc237a54a1f99f89cdb168a0220307c24f8 Mon Sep 17 00:00:00 2001 From: Oliver Burn Date: Tue, 22 Jan 2002 05:39:28 +0000 Subject: [PATCH] cleaned up after a review by a colleague. --- docs/engine.html | 14 +++++++------- docs/index.html | 17 +++++------------ 2 files changed, 12 insertions(+), 19 deletions(-) diff --git a/docs/engine.html b/docs/engine.html index dcf738d2f..862d4b34d 100644 --- a/docs/engine.html +++ b/docs/engine.html @@ -40,7 +40,7 @@

What checkstyle checks

-

Unused Imports

+

Imports

Checks for import statements that are not used. It will warn about wild-card imports like import java.io.*;. It will also warn about duplicate import statements.

Removing unused import statements reduces unnecessary dependencies in a code base. This feature can be turned off.

@@ -94,16 +94,16 @@

Long Lines

-

Checks for lines that are longer that a specified length. The default is "80". This can be turned off for import statements.

+

Checks for lines that are longer than a specified length. The default is "80". This can be turned off for import statements.

Method Body Length

-

Checks for method bodies that are longer that a specified number of lines. The default is "150". +

Checks for method bodies that are longer than a specified number of lines. The default is "150".

Constructor Body Length

-

Checks for constructor bodies that are longer that a specified number of lines. The default is "150". +

Checks for constructor bodies that are longer than a specified number of lines. The default is "150".

File Length

-

Checks for files that are longer that a specified number of lines. The default is "2000". +

Checks for files that are longer than a specified number of lines. The default is "2000".

Tab characters

Checks for lines that contain tab ('\t') characters. This can be turned off.

@@ -166,14 +166,14 @@

Verifies that the format of public member names conform to a specified regular expression. The default is ^f[A-Z][a-zA-Z0-9]*$. This is useful for the fields required for Container Managed Persistence (CMP) Enterprise JavaBeans 1.1.

-

Access Permissions

+

Visibility Modifiers

Checks for data members that are not declared private. Also finds static non-final data members that are not declared as private.

Note: you can turn on allowing protected data members.

Tip

-

Container Managed Persistence EJBs require that managed fields are declared public. This will cause checkstyle to complain that the fields should be declared private. Hence checkstyle supports ignoring public that match a specified regular expression. The default is ^f[A-Z][a-zA-Z0-9]*$.

+

Container Managed Persistence EJBs require (in the EJB 1.1 specification) that managed fields are declared public. This will cause checkstyle to complain that the fields should be declared private. Hence checkstyle supports ignoring public that match a specified regular expression. The default is ^f[A-Z][a-zA-Z0-9]*$.

White space

diff --git a/docs/index.html b/docs/index.html index 3ac9c2658..6942f546b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -75,30 +75,23 @@ Sun Code Conventions. However, Checkstyle is highly configurable.

-

- My experience from using a similar proprietary tool at a previous employer - was that it increased the productivity of code reviews. This is because it - allowed the reviewers to get on with reviewing the code and not get into - "style" debates. -

-

Features

-

The things that checkstyle checks for are:

+

The things that Checkstyle can check for are: