From 6433ace8b7c41c2eab11c93710a49c493dcb3e8f Mon Sep 17 00:00:00 2001 From: Brian Remedios Date: Sat, 14 Oct 2006 16:26:23 +0000 Subject: [PATCH] Comment cleanup for bug #1512374 git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@4650 51baf565-9d33-0410-a72c-fc3788e3496d --- pmd/rulesets/javabeans.xml | 4 ++-- pmd/rulesets/logging-java.xml | 6 +++--- pmd/rulesets/migrating.xml | 8 ++++---- pmd/rulesets/naming.xml | 8 ++++---- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/pmd/rulesets/javabeans.xml b/pmd/rulesets/javabeans.xml index f1792b044a..3b6de11e7a 100644 --- a/pmd/rulesets/javabeans.xml +++ b/pmd/rulesets/javabeans.xml @@ -16,9 +16,9 @@ The JavaBeans Ruleset catches instances of bean rules not being followed. class="net.sourceforge.pmd.rules.BeanMembersShouldSerializeRule" externalInfoUrl="http://pmd.sourceforge.net/rules/javabeans.html#BeanMembersShouldSerialize"> -If a class is a bean, or is referenced by a bean, directly or indirectly +If a class is a bean, or is referenced by a bean directly or indirectly it needs to be serializable. Member variables need to be marked as transient, -marked as static, or have accessor methods in the class. Marking variables +static, or have accessor methods in the class. Marking variables as transient is the safest and easiest modification. Accessor methods should follow the Java naming conventions, i.e.if you have a variable foo, you should provide getFoo and setFoo methods. diff --git a/pmd/rulesets/logging-java.xml b/pmd/rulesets/logging-java.xml index 9dcd52edda..11b40213e0 100644 --- a/pmd/rulesets/logging-java.xml +++ b/pmd/rulesets/logging-java.xml @@ -7,11 +7,11 @@ xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"> -The Java Logging ruleset contains a collection of rules that find questionable usages of the Logger. +The Java Logging ruleset contains a collection of rules that find questionable usages of the logger. @@ -82,7 +82,7 @@ first --> message="There is log block not surrounded by if" class="net.sourceforge.pmd.rules.XPathRule"> - When many log statements are used, it is conveninent to surround them with an if. + When many log statements are used, it is conveninent to surround them with an if statement. diff --git a/pmd/rulesets/migrating.xml b/pmd/rulesets/migrating.xml index 21f03c7b7b..1b1efdb8f3 100644 --- a/pmd/rulesets/migrating.xml +++ b/pmd/rulesets/migrating.xml @@ -16,7 +16,7 @@ Contains rules about migrating from one JDK version to another. Don't use these class="net.sourceforge.pmd.rules.XPathRule" externalInfoUrl="http://pmd.sourceforge.net/rules/migrating.html#ReplaceVectorWithList"> - Consider replacing this Vector with the newer java.util.List + Consider replacing Vector usages with the newer java.util.ArrayList if expensive threadsafe operation is not required. @@ -103,7 +103,7 @@ public class Foo implements Enumeration { message="Avoid using enum as an identifier; it's a reserved word in JDK 1.5" class="net.sourceforge.pmd.rules.XPathRule" externalInfoUrl="http://pmd.sourceforge.net/rules/migrating.html#AvoidEnumAsIdentifier"> - Finds all places 'enum' is used as an identifier is used + Finds all places 'enum' is used as an identifier is used. @@ -129,7 +129,7 @@ public class Foo implements Enumeration { message="Avoid using assert as an identifier; it's a reserved word in JDK 1.4" class="net.sourceforge.pmd.rules.XPathRule" externalInfoUrl="http://pmd.sourceforge.net/rules/migrating.html#AvoidAssertAsIdentifier"> - Finds all places 'assert' is used as an identifier is used + Finds all places 'assert' is used as an identifier is used. @@ -152,7 +152,7 @@ public class Foo implements Enumeration { In JDK 1.5, calling new Integer() causes memory allocation. Integer.valueOf() is more memory friendly. diff --git a/pmd/rulesets/naming.xml b/pmd/rulesets/naming.xml index e26fc7fc77..4de04a30af 100644 --- a/pmd/rulesets/naming.xml +++ b/pmd/rulesets/naming.xml @@ -15,7 +15,7 @@ The Naming Ruleset contains a collection of rules about names - too long, too sh class="net.sourceforge.pmd.rules.XPathRule" externalInfoUrl="http://pmd.sourceforge.net/rules/naming.html#ShortVariable"> -Detects when a field, local or parameter has a short name. +Detects when a field, local, or parameter has a very short name. @@ -111,8 +111,8 @@ public class ShortMethod { externalInfoUrl="http://pmd.sourceforge.net/rules/naming.html#VariableNamingConventions"> A variable naming conventions rule - customize this to your liking. Currently, it - checks that final variables should be all caps and non-final variables - should not include underscores. + checks for final variables that should be fully capitalized and non-final variables + that should not include underscores. 1 @@ -362,7 +362,7 @@ public class Foo { externalInfoUrl="http://pmd.sourceforge.net/rules/naming.html#AvoidFieldNameMatchingTypeName"> It is somewhat confusing to have a field name matching the declaring class name. -This proabably means that type and or field names could be more precise. +This probably means that type and or field names could be more precise. 3