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

use consistent style in all documentation files

This commit is contained in:
Lars Kühne 2002-01-21 18:51:25 +00:00
parent d0dd35e29d
commit 3cb5c532cf
5 changed files with 52 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/anttask.html
View File

@ -3,13 +3,11 @@
<html>
<head>
<title>checkstyle ANT Task</title>
<style>
span.default {white-space: nowrap;font-family: monospace;font-size: x-small;}
</style>
<link rel="stylesheet" type="text/css" href="mystyle.css">
</head>
<body>
<h2><a name="checkstyle">checkstyle ANT Task</a></h2>
<h1><a name="checkstyle">checkstyle ANT Task</a></h1>
<h3>Description</h3>
<p>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 <a href="http://checkstyle.sourceforge.net/">http://checkstyle.sourceforge.net/</a>.
@ -32,7 +30,7 @@ This task is included in the checkstyle distribution.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<tr class="header">
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td valign="top"><b>Required</b></td>

16
docs/cmdline.html
View File

@ -3,21 +3,19 @@
<html>
<head>
<title>checkstyle Command Line</title>
<style>
span.default {white-space: nowrap;font-family: monospace;font-size: x-small;}
</style>
<link rel="stylesheet" type="text/css" href="mystyle.css">
</head>
<body>
<h2><a name="checkstyle">checkstyle Command Line</a></h2>
<h3>Description</h3>
<h1><a name="checkstyle">checkstyle Command Line</a></h1>
<h2>Description</h2>
<p>This document describes how to run checkstyle using the command line tool. The latest version of checkstyle can be found at
<a href="http://checkstyle.sourceforge.net">http://checkstyle.sourceforge.net</a>.
This command line tool is included in the checkstyle distribution.</p>
<h3>Installation</h3>
<h2>Installation</h2>
<p>The easiest way is to include <span class="default">checkstyle-all-1.4.jar</span> in the classpath. This contains all the classes required to run checkstyle. Alternatively, you must include the following in the classpath:</p>
<ol>
<li><span class="default">checkstyle-1.4.jar</span></li>
@ -26,7 +24,7 @@ This command line tool is included in the checkstyle distribution.</p>
</ol>
<h3>Usage</h3>
<h2>Usage</h2>
<p>The command line usage is:</p>
<pre>
java -D&lt;property&gt;=&lt;value&gt; \
@ -44,7 +42,7 @@ This command line tool is included in the checkstyle distribution.</p>
<p>The default behaviour of checkstyle can be changed by setting system properties using the <code>-D&lt;property&gt;=&lt;value&gt;</code> arguments to java. The following table describes what properties can be set:</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<tr class="header">
<td valign="top"><b>Property</b></td>
<td valign="top"><b>Description</b></td>
</tr>
@ -142,7 +140,7 @@ This command line tool is included in the checkstyle distribution.</p>
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.
</p>
<h3>Examples</h3>
<h2>Examples</h2>
<p><b>Run checkstyle on a file</b></p>
<pre>
java com.puppycrawl.tools.checkstyle.Main Check.java

15
docs/engine.html
View File

@ -3,23 +3,16 @@
<html>
<head>
<title>Checkstyle Core Engine</title>
<style type="text/css">
h2 {padding-left: 1%; border: dotted; text-transform: capitalize;}
h4.tip {text-transform: capitalize; text-align: center;}
tr.header {background-color: Silver; font-weight: bolder; text-align: center;}
span.code {white-space: nowrap; font-family: monospace; font-size: x-small;}
span.default {white-space: nowrap;font-family: monospace;font-size: x-small;}
div.tip {margin-left : 5%;margin-right : 5%;padding-left: 2%; padding-right: 2%; background-color: Silver; border: ridge;}
</style>
<link rel="stylesheet" type="text/css" href="mystyle.css">
</head>
<body>
<h1 align="center">Checkstyle Core Engine</h1>
<h1>Checkstyle Core Engine</h1>
<p align="center">Author: <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a></p>
<p>Author: <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a></p>
<h2>Introduction</h2>
<p>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 <a href="site.html#related">interfaces</a>. The standard distribution included support for:
<p>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 <a href="index.html#related">interfaces</a>. The standard distribution includes support for:
<ul>
<li><a href="http://jakarta.apache.org/ant/">ANT Task</a> - see <a href="anttask.html">anttask.html</a> for more information.</li>

2
docs/index.html
View File

@ -11,7 +11,7 @@
<table border="0" width="100%">
<tr>
<td>
<font style="font-family: Courier New; font-size=36; font-weight:bold; color:#aaaaaa">Checkstyle Home Page</font>
<h1>Checkstyle Home Page</h1>
</td>
<td align="right">
<img src="logo.png">

37
docs/mystyle.css
View File

@ -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;
}