checkstyle/docs/config_reporting.html

58 lines
2.2 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>Reporting Configuration</title>
<link rel="stylesheet" type="text/css" href="mystyle.css" />
</head>
<body>
<h1>Reporting Configuration</h1>
<h2>Caching Support</h2>
<p>The property <span class="code">checkstyle.cache.file</span> specifies the
name of a file that can be used to cache details of files that pass
Checkstyle. This can <i>significantly</i> increase the speed of checkstyle on
successive runs. The property type is
<a href="property_types.html#string">string</a> and defaults to an empty string
(which means do not cache).</p>
<h2>Localisation Support</h2>
<p>Checkstyle supports a mechanism for localising the output messages. If your
language is not supported, please consider translating the messages in the
<span class="default">messages.properties</span> file. Please let us know if
you translate the file.</p>
<p>The property <span class="code">checkstyle.locale.language</span> specifies
the language to use in localising the output messages. The property type is
<a href="property_types.html#string">string</a> and defaults to the default
system locale language.</p>
<p>The property <span class="code">checkstyle.locale.country</span> specifies
the country to use in localising the output messages. The property type is
<a href="property_types.html#string">string</a> and defaults to the default
system locale country.</p>
<h2>Base directory support</h2>
<p>The property <span class="code">checkstyle.basedir</span> specifies a base
directory which files are then reported relative to. For example, if a base
directory is specified as <span class="code">c:\projects\checkstyle</span>,
then an error in the file <span
class="code">c:\projects\checkstyle\src\dir\subdir\File.java</span> will be
reported as <span class="code">src\dir\subdir\File.java</span>. The property
type is <a href="property_types.html#string">string</a> and defaults to an
empty string.</p>
<hr/>
<p class="copyright">Copyright &copy; 2002-2004 Oliver Burn. All rights Reserved.</p>
</body>
</html>