checkstyle/docs/config.html

108 lines
2.9 KiB
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</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 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">
<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>
<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>
<hr />
<p>
Copyright &copy; 2002 Oliver Burn. All rights Reserved.
</p>
</body>
</html>