src/xdocs/config_reporting.xml - platform/external/checkstyle - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>

 <document xmlns="http://maven.apache.org/XDOC/2.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">

   <head>
     <title>Reporting Configuration</title>
     <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"/>
     <script type="text/javascript" src="js/anchors.js"/>
     <script type="text/javascript" src="js/google-analytics.js"/>
     <link rel="icon" href="images/favicon.png" type="image/x-icon" />
     <link rel="shortcut icon" href="images/favicon.ico" type="image/ico" />
   </head>

   <body>
     <section name="Content">
       <macro name="toc">
         <param name="fromDepth" value="1"/>
         <param name="toDepth" value="1"/>
       </macro>
     </section>

     <section name="Caching Support">
       <p>
         The property <code>checkstyle.cache.file</code>
         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 no caching is done).
       </p>
     </section>

     <section name="Localisation Support">
       <p>
         Checkstyle supports a mechanism for localising the output
         messages. If your language is not supported, please consider
         translating the messages in the <code>messages.properties</code> file. Please let us
         know if you translate the file.
       </p>

       <p>
         The property <code>checkstyle.locale.language</code> 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 <code>checkstyle.locale.country</code>
         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>
     </section>

     <section name="Base directory support">
       <p>
         The property <code>checkstyle.basedir</code>
         specifies a base directory which files are then reported
         relative to. For example, if a base directory is specified as
         <code>c:\projects\checkstyle</code>, then an error
         in the file <code>c:\projects\checkstyle\src\dir\subdir\File.java</code>
         will be reported as <code>src\dir\subdir\File.java</code>. The property type
         is <a href="property_types.html#string">string</a> and defaults
         to an empty string.
       </p>
     </section>
   </body>
 </document>
	<?xml version="1.0" encoding="UTF-8"?>

	<document xmlns="http://maven.apache.org/XDOC/2.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">

	<head>
	<title>Reporting Configuration</title>
	<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"/>
	<script type="text/javascript" src="js/anchors.js"/>
	<script type="text/javascript" src="js/google-analytics.js"/>
	<link rel="icon" href="images/favicon.png" type="image/x-icon" />
	<link rel="shortcut icon" href="images/favicon.ico" type="image/ico" />
	</head>

	<body>
	<section name="Content">
	<macro name="toc">
	<param name="fromDepth" value="1"/>
	<param name="toDepth" value="1"/>
	</macro>
	</section>

	<section name="Caching Support">
	<p>
	The property <code>checkstyle.cache.file</code>
	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 no caching is done).
	</p>
	</section>

	<section name="Localisation Support">
	<p>
	Checkstyle supports a mechanism for localising the output
	messages. If your language is not supported, please consider
	translating the messages in the <code>messages.properties</code> file. Please let us
	know if you translate the file.
	</p>

	<p>
	The property <code>checkstyle.locale.language</code> 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 <code>checkstyle.locale.country</code>
	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>
	</section>

	<section name="Base directory support">
	<p>
	The property <code>checkstyle.basedir</code>
	specifies a base directory which files are then reported
	relative to. For example, if a base directory is specified as
	<code>c:\projects\checkstyle</code>, then an error
	in the file <code>c:\projects\checkstyle\src\dir\subdir\File.java</code>
	will be reported as <code>src\dir\subdir\File.java</code>. The property type
	is <a href="property_types.html#string">string</a> and defaults
	to an empty string.
	</p>
	</section>
	</body>
	</document>