hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Comment cleanup for bug #1512374

Browse Source 
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@4650 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Brian Remedios
2006-10-14 16:26:23 +00:00
parent e31e3387e5
commit 6433ace8b7
4 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pmd/rulesets/javabeans.xml
View File

@ -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">
<description>
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.

6
pmd/rulesets/logging-java.xml
View File

@ -7,11 +7,11 @@
xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
<description>
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.
</description>
<rule name="MoreThanOneLogger"
message="Class contains more than one Logger"
message="Class contains more than one logger."
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/logging-java.html#MoreThanOneLogger">
<description>
@ -82,7 +82,7 @@ first -->
message="There is log block not surrounded by if"
class="net.sourceforge.pmd.rules.XPathRule">
<description>
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.
</description>
<properties>
<property name="xpath">

8
pmd/rulesets/migrating.xml
View File

@ -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">
<description>
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.
</description>
<properties>
<property name="xpath">
@ -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">
<description>Finds all places 'enum' is used as an identifier is used</description>
<description>Finds all places 'enum' is used as an identifier is used.</description>
<properties>
<property name="xpath">
<value>
@ -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">
<description>Finds all places 'assert' is used as an identifier is used</description>
<description>Finds all places 'assert' is used as an identifier is used.</description>
<properties>
<property name="xpath">
<value>
@ -152,7 +152,7 @@ public class Foo implements Enumeration {
</rule>
<rule name="IntegerInstantiation"
message="Avoid instantiating Integer objects. Call Integer.valueOf() instead"
message="Avoid instantiating Integer objects. Call Integer.valueOf() instead."
class="net.sourceforge.pmd.rules.XPathRule">
<description>In JDK 1.5, calling new Integer() causes memory allocation. Integer.valueOf() is more memory friendly.</description>
<properties>

8
pmd/rulesets/naming.xml
View File

@ -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">
<description>
Detects when a field, local or parameter has a short name.
Detects when a field, local, or parameter has a very short name.
</description>
<properties>
<property name="xpath" pluginname="true">
@ -111,8 +111,8 @@ public class ShortMethod {
externalInfoUrl="http://pmd.sourceforge.net/rules/naming.html#VariableNamingConventions">
<description>
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.
</description>
<priority>1</priority>
<properties>
@ -362,7 +362,7 @@ public class Foo {
externalInfoUrl="http://pmd.sourceforge.net/rules/naming.html#AvoidFieldNameMatchingTypeName">
<description>
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.
</description>
<priority>3</priority>
<example>