improve wording of several inspection descriptions

2026-09-27 10:03:11 +07:00 · 2013-03-28 13:14:15 +01:00
parent a7d889eb3b
commit 8a36e00031
47 changed files with 69 additions and 71 deletions
@@ -4,7 +4,7 @@ Reports annotation classes whose names are either too short, too long, or do not
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for annotation names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for annotation names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -7,7 +7,7 @@ toward the total complexity. Anonymous classes with more than very low complexit
 difficult to understand, and should probably be promoted to become named inner classes.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable complexity a class might have.
+Use the field below to specify the maximum complexity a class is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -1,12 +1,11 @@
 <html>
 <body>
-Reports anonymous inner class with too many methods.
+Reports anonymous inner <b>class</b> with too many methods.
 Anonymous classes with more than a very low number of methods may be
 difficult to understand, and should probably be promoted to become named inner classes.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable number of methods
-an anonymous inner class might have.
+Use the field below to specify the maximum number of methods an anonymous inner <b>class</b> is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -1,12 +1,12 @@
 <html>
 <body>
-Reports class with too high of a total complexity. The
-total complexity of a class is the sum of the cyclomatic complexities of all the methods
-and initializers the class declares. Inherited methods and initializers are not counted
+Reports classes with too high of a total complexity. The
+total complexity of a <b>class</b> is the sum of the cyclomatic complexities of all the methods
+and initializers the <b>class</b> declares. Inherited methods and initializers are not counted
 toward the total complexity.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable complexity a class might have.
+Use the field below to specify the maximum complexity a class is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -2,11 +2,10 @@
 <body>
 Reports classes which are highly coupled, i.e. that reference too many other classes.
 Classes with too high a coupling can be very fragile, and should probably be broken up. References to system classes
-(those in the <b>java.</b>or <b>javax.</b> packages), are not
-counted for purposes of this inspection.
+(those in the <b>java.</b>or <b>javax.</b> packages), are not counted.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable coupling a class might have.
+Use the field below to specify the maximum coupling a class is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -2,10 +2,10 @@
 <body>
 Reports class too deep in the inheritance hierarchy. Classes too deeply inherited
 may be confusing, and are a good sign that refactoring may be necessary. This inspection counts all superclasses
-from a library as a single superclass (libraries are considered unmodifyable).
+from a library as a single superclass (libraries are considered unmodifiable).
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable inheritance depth a class might have.
+Use the field below to specify the maximum inheritance depth a class is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -4,7 +4,7 @@ Reports classes whose names are either too short, too long, or do not follow
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for class names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for class names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -4,7 +4,7 @@ Reports inner classes too deeply nested. Nesting inner classes inside
 inner classes is almost certain to be confusing, and is a good sign that refactoring may be necessary.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable nesting depth a class might have.
+Use the field below to specify the maximum nesting depth a class is allowed have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -5,7 +5,7 @@ Such constructors are necessary in some contexts if a class is to be created ref
 <!-- tooltip end -->
 <p>
 Use the checkbox below to indicate that this inspection should ignore classes which
-contain no explicit constructors, and thus are provided a default no-argument constructor
+contain no explicit constructors. These classes are provided a default no-argument constructor
 by the compiler.
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -4,9 +4,10 @@ Reports any constants whose names are either too short, too long, or do not foll
 the specified regular expression pattern. Constants are fields declared <b>static final</b>.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for constant names
-(Regular expressions are in standard <b>java.util.regex</b> format). Use the
-checkbox below to specify that only immutable static final fields should be checked by this inspection.
+Use the fields below to specify minimum length, maximum length and regular expression expected for constant names
+(Regular expressions are in standard <b>java.util.regex</b> format).
+<p>
+Use the checkbox below to specify that only immutable static final fields should be checked by this inspection.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -5,7 +5,7 @@ too many constructors are prone to initialization errors, and may often be bette
 multiple subclasses.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable number of constructors a class might have.
+Use the field below to specify the maximum number of constructors a class is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -5,7 +5,7 @@ complexity is basically a measurement of the number of branching points in a met
 a cyclomatic complexity may be confusing and difficult to test.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable cyclomatic complexity a method might have.
+Use the field below to specify the maximum cyclomatic complexity a method is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -4,8 +4,7 @@ Reports <b>switch</b> statements
 over enumerated types which do not include all of the enumerated type's elements as cases.
 <!-- tooltip end -->
 <p>
-Use the check box below to let this inspection ignore <b>switch</b>
-statements which include a <b>default</b> branch.
+Use the checkbox below to ignore <b>switch</b> statements which have a <b>default</b> branch.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -4,7 +4,7 @@ Reports enumerated classes whose names are either too short, too long, or do not
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for enumerated class names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for enumerated class names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -4,7 +4,7 @@ Reports enumerated constants whose names are either too short, too long, or do n
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for enumerated constant names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for enumerated constant names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -5,9 +5,10 @@ a large number of fields are often trying to 'do too much', and may need to be
 refactored into multiple smaller classes.
 <!-- tooltip end -->
 <p>
-Use the controls below to specify the maximum acceptable number of fields a class might have, and
-to indicate whether constant fields count toward this number. Per default this inspection only counts
-immutable <b>static final</b> objects as constant. Use the checkbox below to
+Use the field below to specify the maximum number of fields a class is allowed to have.
+<p>
+Use the first checkbox below to indicate whether constant fields count toward this number.
+<p>Per default this inspection only counts immutable <b>static final</b> objects as constant. Use the second checkbox below to
 count any <b>static final</b> field as constant.
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -5,7 +5,7 @@ Such statements may be confusing, and are often the sign of inadequate levels of
 abstraction.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum number of branches expected.
+Use the field below to specify the maximum number of branches an <b>if</b> statement is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -5,7 +5,7 @@ the specified regular expression pattern. Instance methods that override library
 methods are ignored by this inspection.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for instance method names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for instance method names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -4,7 +4,7 @@ Reports instance variables whose names are either too short, too long, or do not
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for
+Use the fields below to specify minimum length, maximum length and regular expression expected for
 instance variable names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
@@ -4,7 +4,7 @@ Reports interfaces whose names are either too short, too long, or do not follow
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for interface names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for interface names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -6,7 +6,7 @@ standard that abstract JUnit test classes follow a specific pattern, usually req
 with "TestCase".
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for class names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for class names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -6,7 +6,7 @@ standard that concrete JUnit test classes follow a specific pattern, usually req
 with "Test".
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for class names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for class names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -4,7 +4,7 @@ Reports local variables whose names are either too short, too long, or do not fo
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for local variables names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for local variables names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -5,11 +5,9 @@ a large number of methods are often trying to 'do too much', and may need to be
 refactored into multiple smaller classes.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable number of methods
-a class might have.
+Use the field below to specify the maximum number of methods a class is allowed to have.
 <p>
-Use the checkbox below to specify if simple getters and setters should be ignored
-in the method count.
+Use the checkbox below to specify that simple getters and setters should be ignored in the method count.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -6,7 +6,7 @@ Methods with too high a coupling can be very fragile, and should probably be bro
 counted for purposes of this inspection.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable coupling a method might have.
+Use the field below to specify the maximum coupling a method is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -1,12 +1,15 @@
 <html>
 <body>
-Reports methods with too many return points. Methods
-with too many return points may be confusing, and hard to refactor.
+Reports methods with too many <b>return</b> points. Methods with too many <b>return</b> points may be confusing,
+and hard to refactor. A <b>return</b> point is either a <b>return</b> statement or the falling through the bottom of a
+<b>void</b> method or constructor.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable number of return points a method might have.
-Use the check boxes below to specify if guard clause and/or return points inside 
-<b>equals()</b> methods should be ignored.
+Use the field below to specify the maximum number of <b>return</b> points a method is allowed to have.
+<p>
+Use the first checkbox below to ignore guard clauses.
+<p>
+Use the second checkbox below to ignore <b>return</b> points inside <b>equals()</b> methods.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -1,10 +1,10 @@
 <html>
 <body>
 Reports multiplication of an integer value by a constant power of 2. These
-expressions may be replaced by right or left shift operations, to some possible performance improvement.
+expressions may be replaced by right or left shift operations, for a possible performance improvement.
 <!-- tooltip end -->
 <p>
-Use the check box below to enable the inspection for divisions by a power of two also. Note that replacing
+Use the checkbox below to enable the inspection for divisions by a power of two. Note that replacing
 a power of two division by a shift does not work for negative numbers.
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -4,8 +4,7 @@ Reports conditional expressions whose conditions are negated.
 Flipping the order of the conditional expression branches will usually increase the clarity of such statements.
 <!-- tooltip end -->
 <p>
-Use the check box below to have comparisons of the form <b>!= null</b>
-ignored by this inspection
+Use the checkbox below to ignore comparisons of the form <b>!= null</b>.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -6,8 +6,7 @@ Flipping the order of the <b>if</b> and <b>else</b>
 branches will usually increase the clarity of such statements.
 <!-- tooltip end -->
 <p>
-Use the check box below to have comparisons of the form <b>!= null</b>
-ignored by this inspection
+Use the checkbox below to ignore comparisons of the form <b>!= null</b>.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -4,7 +4,7 @@ Reports methods whose bodies are too deeply nested. Methods with too much statem
 nesting may be confusing, and are a good sign that refactoring may be necessary.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable nesting depth a method might have.
+Use the field below to specify the maximum nesting depth a method is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -4,7 +4,7 @@ Reports methods that are too long. Methods that are too long
 may be confusing, and are a good sign that refactoring is necessary.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable number of non-comment source statements a method might have.
+Use the field below to specify the maximum number of non-comment source statements a method is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -4,7 +4,7 @@ Reports arithmetic expressions with too many terms. Such
 expressions may be confusing and bug-prone.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum number of terms allowed in an arithmetic expression.
+Use the field below to specify the maximum number of terms allowed in an arithmetic expression.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -4,7 +4,7 @@ This global inspection reports packages whose names are either too short, too lo
 the specified regular expression pattern. Since this inspection requires global code analysis, it is only available in batch inspection mode.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for method parameter names
+Use the fields below to specify minimum length, maximum length and regular expression expected for method parameter names
 (Regular expressions are in standard <b>java.util.regex</b> format).
 <p>
 <small>New in 11, Powered by InspectionGadgets</small>
@@ -4,7 +4,7 @@ Reports method parameters whose names are either too short, too long, or do not
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for method parameter names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for method parameter names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -4,7 +4,7 @@ Reports constructors with too many parameters. Constructors
 with too many parameters can be a good sign that refactoring is necessary.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable number of parameters a constructor might have.
+Use the field below to specify the maximum number of parameters a constructor is allowed to have.
 <p>
 Use the combobox below to specify if the inspection should ignore private, package local & private or protected, package local and
 private constructors
@@ -5,7 +5,7 @@ can be a good sign that refactoring is necessary. Methods whose signatures are i
 library classes are ignored by this inspection.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable number of parameters a method might have.
+Use the field below to specify the maximum number of parameters a method is allowed to have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -4,7 +4,7 @@ Reports assignment operations which can be replaced by operator-assignment. Code
 using operator assignment may be clearer, and theoretically more performant.
 <!-- tooltip end -->
 <p>
-Use the check box below to ignore the conditional operators <b>&amp;&amp;</b>
+Use the checkbox below to ignore the conditional operators <b>&amp;&amp;</b>
 and <b>||</b>. Replacing conditional operators with operator
 assignment modifies the semantics of the expression.
 <p>
@@ -1,10 +1,10 @@
 <html>
 <body>
-Reports static methods whose names are either too short, too long, or do not follow
+Reports <b>static</b> methods whose names are either too short, too long, or do not follow
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for static method names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for static method names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -5,7 +5,7 @@ the specified regular expression pattern. Constants, i.e. variables of immutable
 are not checked by this inspection
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for static variable names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for static variable names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -6,7 +6,7 @@ Constructing new <b>String</b> objects in this way
 is rarely necessary, and may cause performance problems if done often enough.
 <!-- tooltip end -->
 <p>
-Use the check box below to ignore <b>String</b>
+Use the checkbox below to ignore <b>String</b>
 constructor calls which have a <b>String.substring()</b>
 call as parameter. A call to <b>substring()</b>
 reuses the character array of the original string, which can cause a large
@@ -5,7 +5,7 @@ repeatedly appended to. Such variables may be more efficiently declared as <b>ja
 or <b>java.lang.StringBuilder</b>.
 <!-- tooltip end -->
 <p>
-Use the check box below to specify that this inspection should only warn when the variable is appended
+Use the checkbox below to specify that this inspection should only warn when the variable is appended
 to in a loop.
 <p>
 <small>Powered by InspectionGadgets</small>
@@ -4,7 +4,7 @@ Reports <b>switch</b> statements with too few <b>case</b> labels.
 Such statements may be more clearly expressed as <b>if</b> statements.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the minimum number of <b>case</b> labels expected.
+Use the field below to specify the minimum number of <b>case</b> labels expected.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -3,7 +3,7 @@
 Reports <b>switch</b> statements with too many <b>case</b> labels.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum number of <b>case</b> labels expected.
+Use the field below to specify the maximum number of <b>case</b> labels expected.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -5,7 +5,7 @@ different types of exceptions. Methods with too many exceptions declared
 are a good sign that your error handling code is getting overly complex.
 <!-- tooltip end -->
 <p>
-Use the field provided below to specify the maximum acceptable number of throw clauses a method might have.
+Use the field below to specify the maximum number of <b>throws</b> clauses a method might have.
 <p>
 <small>Powered by InspectionGadgets</small>
 </body>
@@ -1,7 +1,7 @@
 <html>
 <body>
 Reports <b>try finally</b> statements which can use Java 7
-Automatic Resource Management. A quickfix is provided to convert the <b>try finally</b>
+Automatic Resource Management. A quickfix is available to convert the <b>try finally</b>
 statement into a <b>try</b> with resources statement.
 <p>
 This inspection only reports if the project or module is configured to use a
@@ -1,6 +1,6 @@
 <html>
 <body>
-Reports identical <b>catch</b> sections in <b>try</b> blocks under JDK 7. A quickfix is provided to collapse the sections into
+Reports identical <b>catch</b> sections in <b>try</b> blocks under JDK 7. A quickfix is available to collapse the sections into
 a multi-catch section.
 <p>
 This inspection only reports if the project or module is configured to use a
@@ -4,7 +4,7 @@ Reports type parameters whose names are either too short, too long, or do not fo
 the specified regular expression pattern.
 <!-- tooltip end -->
 <p>
-Use the fields provided below to specify minimum length, maximum length and regular expression expected for type parameter names.
+Use the fields below to specify minimum length, maximum length and regular expression expected for type parameter names.
 (Regular expressions are in standard <b>java.util.regex</b> format.)
 <p>
 <small>Powered by InspectionGadgets</small>