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

Fix documentation to: 

- Include a version number in headings
- Use the ANT <filterset> to update the version number. No longer need to
  update the docs for each release.
This commit is contained in:
Oliver Burn 2002-05-14 04:33:54 +00:00
parent fca8c91804
commit dfd7310b96
4 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
build.xml
View File

@ -16,7 +16,7 @@
value="src/checkstyle/com/puppycrawl/tools/checkstyle" />
<property name="testreport.dir" value="testreports"/>
<property name="version" value="2.2" />
<property name="version" value="2.3beta" />
<path id="build.classpath">
<pathelement location="${antlr.jar}" />
@ -303,6 +303,9 @@
<include name="**/.cvsignore"/>
<include name="**/CVS"/>
</fileset>
<filterset>
<filter token="CHECKSTYLE_VERSION" value="${version}" />
</filterset>
</copy>
<!-- create the final zip & tar/gzip files -->
<zip zipfile="dist/checkstyle-${version}.zip">

10
docs/anttask.html
View File

@ -2,21 +2,21 @@
<html>
<head>
<title>checkstyle ANT Task</title>
<title>Checkstyle ANT Task - Version @CHECKSTYLE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="mystyle.css">
</head>
<body>
<h1><a name="checkstyle">checkstyle ANT Task</a></h1>
<h1><a name="checkstyle">Checkstyle ANT Task - Version @CHECKSTYLE_VERSION@</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>.
<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>.
This task is included in the checkstyle distribution.</p>
<h3>Installation</h3>
<p>The easiest way is to include <span class="default">checkstyle-all-2.2.jar</span> in the classpath. This contains all the classes required to run checkstyle. Alternatively, you must include the following in the classpath:</p>
<p>The easiest way is to include <span class="default">checkstyle-all-@CHECKSTYLE_VERSION@.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-2.2.jar</span></li>
<li><span class="default">checkstyle-@CHECKSTYLE_VERSION@.jar</span></li>
<li>ANTLR 2.7.1 classes. <span class="default">antlr.jar</span> is included in the distribution.</li>
<li>Jakarta Regexp 1.2 classes. <span class="default">jakarta-regexp-1.2.jar</span> is included in the distribution.</li>
</ol>

8
docs/cmdline.html
View File

@ -2,12 +2,12 @@
<html>
<head>
<title>checkstyle Command Line</title>
<title>Checkstyle Command Line - Version @CHECKSTYLE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="mystyle.css">
</head>
<body>
<h1><a name="checkstyle">checkstyle Command Line</a></h1>
<h1><a name="checkstyle">Checkstyle Command Line - Version @CHECKSTYLE_VERSION@</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
@ -16,9 +16,9 @@ This command line tool is included in the checkstyle distribution.</p>
<h2>Installation</h2>
<p>The easiest way is to include <span class="default">checkstyle-all-2.2.jar</span> in the classpath. This contains all the classes required to run checkstyle. Alternatively, you must include the following in the classpath:</p>
<p>The easiest way is to include <span class="default">checkstyle-all-@CHECKSTYLE_VERSION@.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-2.2.jar</span></li>
<li><span class="default">checkstyle-@CHECKSTYLE_VERSION@.jar</span></li>
<li>ANTLR 2.7.1 classes. <span class="default">antlr.jar</span> is included in the distribution.</li>
<li>Jakarta Regexp 1.2 classes. <span class="default">jakarta-regexp-1.2.jar</span> is included in the distribution.</li>
</ol>

4
docs/engine.html
View File

@ -2,12 +2,12 @@
<html>
<head>
<title>Checkstyle Core Engine</title>
<title>Checkstyle Core Engine - Version @CHECKSTYLE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="mystyle.css">
</head>
<body>
<h1>Checkstyle Core Engine</h1>
<h1>Checkstyle Core Engine - Version @CHECKSTYLE_VERSION@</h1>
<p>Author: <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a></p>