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

Start on Configuration documentation.

This commit is contained in:
Rick Giles 2002-12-15 15:59:26 +00:00
parent 469acd6705
commit 04483a77e8
2 changed files with 100 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

126
docs/config.html
View File

@ -1,36 +1,108 @@
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Checkstyle Configuration Properties - Version @CHECKSTYLE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="mystyle.css">
<title>Checkstyle Configuration</title>
<link rel="stylesheet" type="text/css" href="mystyle.css"/>
</head>
<body>
<h1>Checkstyle Configuration Properties - Version @CHECKSTYLE_VERSION@</h1>
<!-- The header -->
<table border="0" width="100%" summary="header layout">
<tr>
<td><h1>Checkstyle Configuration</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 class="menu" valign="top">
<ul>
<li>
<a href="#Overview">Overview</a>
</li>
<li>
<a href="#Properties">Properties</a>
</li>
<li>
<a href="#Modules">Modules</a>
</li>
<li>
<a href="#TreeWalker">TreeWalker Checks</a>
</li>
<li>
<a href="#Tokens">Tokens</a>
</li>
</ul>
</td>
<!--Content-->
<td class="content" valign="top" align="left">
<p>Checkstyle is configured through a properties file. NEED TO ADD A SAMPLE PROPERTIES FILE BUT I CAN ONLY DO SO MUCH DOCUMENTATION IN ONE SITTING!!!</p>
<a name="Overview"></a> <h2>Overview</h2>
<p class="body">
Opt-in policy. XML config file & module hierarchy. How config names are resolved. Properties.
</p>
<a name="Properties"></a> <h2>Properties</h2>
<p class="body">
Contexts. Property Expansion.
</p>
<a name="Modules"></a> <h2>Modules</h2>
<p class="body">
PackageHtmlCheck, TranlationCheck, TreeWalker. TreeWalker checks. Repeated modules with different properties.
</p>
<a name="TreeWalker"></a> <h2>TreeWalker Checks</h2>
<p class="body">
Lead-in paragraph.
</p>
<p class="body">
Configuration of the checks are specified in the following pages:
</p>
<p>The properties for configuring the reporting mechanisms are defined in
<a href="config_reporting.html">Reporting Configuration</a>.</li>
<ul class="body">
<li>
<a href="config_javadoc.html">Checks For Javadoc Comments</a>
</li>
<li>
<a href="config_naming.html">Checks For Naming Conventions</a>
</li>
<li>
<a href="config_header.html">Checks For Headers</a>
</li>
<li>
<a href="config_import.html">Checks For Imports</a>
</li>
<li>
<a href="config_sizes.html">Checks For Size Violations</a>
</li>
<li>
<a href="config_whitespace.html">Checks For Whitespace</a>
</li>
<li>
<a href="config_modifiers.html">Checks For Modifiers</a>
</li>
<li>
<a href="config_blocks.html">Checks For Blocks</a>
</li>
<li>
<a href="config_misc.html">Miscellaneous Checks</a>
</li>
</ul>
<a name="Tokens"></a> <h2>Tokens</h2>
<p class="body">
What is a token? Default tokens. Acceptable tokens.
</p>
</td>
</tr>
</table>
<p>The properties for configuring the checks are specified in the
following pages:</p>
<ul>
<li><a href="config_javadoc.html">Checks For Javadoc Comments</a></li>
<li><a href="config_naming.html">Checks For Naming Conventions</a></li>
<li><a href="config_header.html">Checks For Headers</a></li>
<li><a href="config_import.html">Checks For Imports</a></li>
<li><a href="config_sizes.html">Checks For Size Violations</a></li>
<li><a href="config_whitespace.html">Checks For Whitespace</a></li>
<li><a href="config_modifiers.html">Checks For Modifiers</a></li>
<li><a href="config_blocks.html">Checks For Blocks</a></li>
<li><a href="config_misc.html">Miscellaneous Checks</a></li>
</ul>
<hr>
<p align="center">Copyright &copy; 2002 Oliver Burn. All rights Reserved.</p>
<hr />
<p>
Copyright &copy; 2002 Oliver Burn. All rights Reserved.
</p>
</body>
</html>
</html>

18
docs/mystyle.css
View File

@ -34,23 +34,7 @@ td.content {
width: 100%;
}
p.body {
margin-left : 5%;
margin-right : 3%;
}
pre.body {
margin-left : 5%;
margin-right : 3%;
}
table.body {
margin-left : 5%;
margin-right : 3%;
}
li.body {
*.body {
margin-left : 5%;
margin-right : 3%;
}