From 92d37dd95ea6cf84fc347dbd079c795bf6047b98 Mon Sep 17 00:00:00 2001
From: Oleg Sukhodolsky
Date: Tue, 26 Aug 2003 16:21:11 +0000
Subject: [PATCH] Applying patch 783672 (Package names.xml documentation).
---
docs/config.html | 32 +++++++++++++++++++++++++-------
1 file changed, 25 insertions(+), 7 deletions(-)
diff --git a/docs/config.html b/docs/config.html
index f49882970..5ff2712d1 100644
--- a/docs/config.html
+++ b/docs/config.html
@@ -152,8 +152,10 @@
<module name="AvoidStarImport"/>
Checkstyle applies packages
- com.puppycrawl.tools.checkstyle and
- com.puppycrawl.tools.checkstyle.checks by default. You can specify other
+ com.puppycrawl.tools.checkstyle,
+ com.puppycrawl.tools.checkstyle.filters, and
+ com.puppycrawl.tools.checkstyle.checks and its sub-packages (only
+ those included in the Checkstyle distribution). You can specify other
packages in a package names XML document
when you invoke Checkstyle at the command line,
and when you run a Checkstyle task in ant.
@@ -620,16 +622,19 @@
of a module element, and automatically appends pre-specified
package prefixes to that name in its search for a loadable class.
By default, Checkstyle applies packages
- com.puppycrawl.tools.checkstyle and
- com.puppycrawl.tools.checkstyle.checks. To specify other packages to apply,
+ com.puppycrawl.tools.checkstyle,
+ com.puppycrawl.tools.checkstyle.filters, and
+ com.puppycrawl.tools.checkstyle.checks as well as any sub-packages of
+ com.puppycrawl.tools.checkstyle.checks that are
+ distributed with Checkstyle. To specify other packages to apply,
create a package names XML document in a file, and provide that file as a
command line option or as a
attribute of an ant Checkstyle task.
This is useful for integrating other modules in your configuration.
- A package names XML document specifies a list of package names. Here is the root of the
- default Checkstyle package names XML document for packages
+ A package names XML document specifies a list of package names. Here is a
+ sample package names XML document for packages
com.puppycrawl.tools.checkstyle and
com.puppycrawl.tools.checkstyle.checks:
@@ -661,7 +666,20 @@
<checkstyle-packages>
<package name="com.mycompany.checks">
<package name="com.puppycrawl.tools.checkstyle">
- <package name="checks"/>
+ <package name="checks">
+ <package name="blocks"/>
+ <package name="coding"/>
+ <package name="design"/>
+ <package name="imports"/>
+ <package name="indentation"/>
+ <package name="j2ee"/>
+ <package name="javadoc"/>
+ <package name="metrics"/>
+ <package name="naming"/>
+ <package name="sizes"/>
+ <package name="whitespace"/>
+ </package>
+ <package name="filters"/>
</package>
</checkstyle-packages>