diff --git a/docs/anttask.html b/docs/anttask.html index 11a26a56f..428735732 100644 --- a/docs/anttask.html +++ b/docs/anttask.html @@ -3,13 +3,11 @@ checkstyle ANT Task - + -

checkstyle ANT Task

+

checkstyle ANT Task

Description

This task runs checkstyle over specified Java files. The task has been tested using ANT 1.4.1. The latest version of checkstyle can be found at http://checkstyle.sourceforge.net/. @@ -32,7 +30,7 @@ This task is included in the checkstyle distribution.

Parameters

- + diff --git a/docs/cmdline.html b/docs/cmdline.html index 09ee32c83..8780ddcec 100644 --- a/docs/cmdline.html +++ b/docs/cmdline.html @@ -3,21 +3,19 @@ checkstyle Command Line - + -

checkstyle Command Line

-

Description

+

checkstyle Command Line

+

Description

This document describes how to run checkstyle using the command line tool. The latest version of checkstyle can be found at http://checkstyle.sourceforge.net. This command line tool is included in the checkstyle distribution.

-

Installation

+

Installation

The easiest way is to include checkstyle-all-1.4.jar in the classpath. This contains all the classes required to run checkstyle. Alternatively, you must include the following in the classpath:

  1. checkstyle-1.4.jar
  2. @@ -26,7 +24,7 @@ This command line tool is included in the checkstyle distribution.

-

Usage

+

Usage

The command line usage is:

   java -D<property>=<value>  \
@@ -44,7 +42,7 @@ This command line tool is included in the checkstyle distribution.

The default behaviour of checkstyle can be changed by setting system properties using the -D<property>=<value> arguments to java. The following table describes what properties can be set:

Attribute Description Required
- + @@ -142,7 +140,7 @@ This command line tool is included in the checkstyle distribution.

Older versions of the checkstyle task supported the boolean parameters checkstyle.javadoc.relax and checkstyle.javadoc.ignore. These parameters have been removed because they were conflicting with each other and the semantics of relaxJavadoc was not specified. The two parameters have been replaced by the checkstyle.javadoc.scope parameter. Instead of checkstyle.javadoc.ignore=true you can now use checkstyle.javadoc.scope=nothing. The behaviour of checkstyle.javadoc.relax=true is roughly the same as checkstyle.javadoc.scope=protected.

-

Examples

+

Examples

Run checkstyle on a file

   java  com.puppycrawl.tools.checkstyle.Main  Check.java
diff --git a/docs/engine.html b/docs/engine.html
index 4543fa400..eac946c2b 100644
--- a/docs/engine.html
+++ b/docs/engine.html
@@ -3,23 +3,16 @@
 
 
   Checkstyle Core Engine
-  
+  
 
 
 
-

Checkstyle Core Engine

+

Checkstyle Core Engine

-

Author: Oliver Burn

+

Author: Oliver Burn

Introduction

-

This document describes the core engine of Checkstyle, including what checks it performs and what can be configured. The engine can be executed via different interfaces. The standard distribution included support for: +

This document describes the core engine of Checkstyle, including what checks it performs and what can be configured. The engine can be executed via different interfaces. The standard distribution includes support for:

Property Description
- Checkstyle Home Page +

Checkstyle Home Page

diff --git a/docs/mystyle.css b/docs/mystyle.css index 8adbeee53..af894a060 100644 --- a/docs/mystyle.css +++ b/docs/mystyle.css @@ -3,6 +3,29 @@ // margin-right : 5%; //} +h1 { + font-family : monospace; + font-size : 28; + font-weight : bold; + color : #aaaaaa; + text-transform: capitalize; +} + +h2 { + text-transform: capitalize; +} + +h4.tip { + text-transform: capitalize; + text-align: center; +} + +tr.header { + background-color: Silver; + font-weight: bolder; + text-align: center; +} + p.body { margin-left : 5%; margin-right : 3%; @@ -18,3 +41,17 @@ span.code { font-family: monospace; font-weight: bold } + +span.default { + white-space: nowrap; + font-family: monospace; +} + +div.tip { + margin-left : 5%; + margin-right : 5%; + padding-left: 2%; + padding-right: 2%; + background-color: Silver; + border: ridge; +}