diff --git a/docs/config_usage.html b/docs/config_usage.html new file mode 100644 index 000000000..a0f5bb2a5 --- /dev/null +++ b/docs/config_usage.html @@ -0,0 +1,311 @@ + + + +
+Checks for usage |
+ ![]() |
+
+
|
+
+
+
+ OneMethodPrivateFieldDescription+ ++ Checks that a private field is used in more than one method, constructor, or initializer. + ++ Rationale: a private field used in only one method, constructor, or + initializer should be replaced by a local variable. + +Properties+
Examples++ To configure the check: + ++<module name="OneMethodPrivateField"/> ++ + To configure the check to ignore fields whose name ends in Temp: + ++<module name="OneMethodPrivateField"> + <property name="ignoreFormat" value="Temp$"/> +</module> ++ Package++ com.puppycrawl.tools.checkstyle.checks.usage + + +Parent Module++ TreeWalker + + + +UnusedLocalVariableDescription+ ++ Checks that a local variable is used after its declaration. + + +Properties+
Examples++ To configure the check: + ++<module name="UnusedLocalVariable"/> ++ + To configure the check to ignore variables whose name ends in Temp: + ++<module name="UnusedLocalVariable"> + <property name="ignoreFormat" value="Temp$"/> +</module> ++ Package++ com.puppycrawl.tools.checkstyle.checks.usage + + +Parent Module++ TreeWalker + + + +UnusedParameterDescription+ ++ Checks that a parameter is used. + + +Properties+
Examples++ To configure the check: + ++<module name="UnusedParameter"/> ++ + To configure the check to ignore parameters whose name ends in Temp: + ++<module name="UnusedParameter"> + <property name="ignoreFormat" value="Temp$"/> +</module> ++ + To configure the check to report unused catch parameters: + ++<module name="UnusedParameter"> + <property name="ignoreCatch" value="false"/> +</module> ++ Package++ com.puppycrawl.tools.checkstyle.checks.usage + + +Parent Module++ TreeWalker + + +UnusedPrivateFieldDescription+ ++ Checks that a private field is used. + + +Properties+
Examples++ To configure the check: + ++<module name="UnusedPrivateField"/> ++ + To configure the check to ignore fields whose name ends in Temp: + ++<module name="UnusedPrivateField"> + <property name="ignoreFormat" value="Temp$"/> +</module> ++ Package++ com.puppycrawl.tools.checkstyle.checks.usage + + +Parent Module++ TreeWalker + + + +UnusedPrivateMethodDescription+ ++ Checks that a private method is used. + + +Properties+
Examples++ To configure the check: + ++<module name="UnusedPrivateMethod"/> ++ + To configure the check to ignore methods whose name ends in Temp: + ++<module name="UnusedPrivateMethod"> + <property name="ignoreFormat" value="Temp$"/> +</module> ++ Package++ com.puppycrawl.tools.checkstyle.checks.usage + + +Parent Module++ TreeWalker + + + |
+
+Copyright © 2002-2003 Oliver Burn. All rights Reserved. +
+ + + diff --git a/docs/index.html b/docs/index.html index 35bd0bce7..e2d38ebe5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -129,6 +129,7 @@