From 8a36e00031b70d7f7e56f6a63c8a7e9779821053 Mon Sep 17 00:00:00 2001 From: Bas Leijdekkers Date: Thu, 28 Mar 2013 13:14:15 +0100 Subject: [PATCH] improve wording of several inspection descriptions --- .../AnnotationNamingConvention.html | 2 +- .../AnonymousClassComplexity.html | 2 +- .../AnonymousClassMethodCount.html | 5 ++--- .../src/inspectionDescriptions/ClassComplexity.html | 8 ++++---- .../src/inspectionDescriptions/ClassCoupling.html | 5 ++--- .../ClassInheritanceDepth.html | 4 ++-- .../ClassNamingConvention.html | 2 +- .../inspectionDescriptions/ClassNestingDepth.html | 2 +- .../ClassWithoutNoArgConstructor.html | 2 +- .../ConstantNamingConvention.html | 7 ++++--- .../inspectionDescriptions/ConstructorCount.html | 2 +- .../CyclomaticComplexity.html | 2 +- .../EnumSwitchStatementWhichMissesCases.html | 3 +-- .../EnumeratedClassNamingConvention.html | 2 +- .../EnumeratedConstantNamingConvention.html | 2 +- .../src/inspectionDescriptions/FieldCount.html | 7 ++++--- .../IfStatementWithTooManyBranches.html | 2 +- .../InstanceMethodNamingConvention.html | 2 +- .../InstanceVariableNamingConvention.html | 2 +- .../InterfaceNamingConvention.html | 2 +- .../JUnitAbstractTestClassNamingConvention.html | 2 +- .../JUnitTestClassNamingConvention.html | 2 +- .../LocalVariableNamingConvention.html | 2 +- .../src/inspectionDescriptions/MethodCount.html | 6 ++---- .../src/inspectionDescriptions/MethodCoupling.html | 2 +- .../MultipleReturnPointsPerMethod.html | 13 ++++++++----- .../MultiplyOrDivideByPowerOfTwo.html | 4 ++-- .../inspectionDescriptions/NegatedConditional.html | 3 +-- .../src/inspectionDescriptions/NegatedIfElse.html | 3 +-- .../src/inspectionDescriptions/NestingDepth.html | 2 +- .../NonCommentSourceStatements.html | 2 +- .../OverlyComplexArithmeticExpression.html | 2 +- .../PackageNamingConvention.html | 2 +- .../ParameterNamingConvention.html | 2 +- .../ParametersPerConstructor.html | 2 +- .../inspectionDescriptions/ParametersPerMethod.html | 2 +- .../ReplaceAssignmentWithOperatorAssignment.html | 2 +- .../StaticMethodNamingConvention.html | 4 ++-- .../StaticVariableNamingConvention.html | 2 +- .../inspectionDescriptions/StringConstructor.html | 2 +- .../StringReplaceableByStringBuffer.html | 2 +- .../SwitchStatementWithTooFewBranches.html | 2 +- .../SwitchStatementWithTooManyBranches.html | 2 +- .../ThrownExceptionsPerMethod.html | 2 +- .../TryFinallyCanBeTryWithResources.html | 2 +- .../TryWithIdenticalCatches.html | 2 +- .../TypeParameterNamingConvention.html | 2 +- 47 files changed, 69 insertions(+), 71 deletions(-) diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/AnnotationNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/AnnotationNamingConvention.html index 5868ee95bce2..db2187b5aaa0 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/AnnotationNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/AnnotationNamingConvention.html @@ -4,7 +4,7 @@ Reports annotation classes whose names are either too short, too long, or do not the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/AnonymousClassComplexity.html b/plugins/InspectionGadgets/src/inspectionDescriptions/AnonymousClassComplexity.html index ff78e208becc..ba9645bfc1ff 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/AnonymousClassComplexity.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/AnonymousClassComplexity.html @@ -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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/AnonymousClassMethodCount.html b/plugins/InspectionGadgets/src/inspectionDescriptions/AnonymousClassMethodCount.html index 6ba388da5fb1..562dcd0e56de 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/AnonymousClassMethodCount.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/AnonymousClassMethodCount.html @@ -1,12 +1,11 @@ -Reports anonymous inner class with too many methods. +Reports anonymous inner class 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.

-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 class is allowed to have.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassComplexity.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassComplexity.html index 5545631e12d8..e57f1a74bfb3 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassComplexity.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassComplexity.html @@ -1,12 +1,12 @@ -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 class is the sum of the cyclomatic complexities of all the methods +and initializers the class declares. Inherited methods and initializers are not counted toward the total complexity.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassCoupling.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassCoupling.html index 9a4dea6c0f21..0c5c3d5a1026 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassCoupling.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassCoupling.html @@ -2,11 +2,10 @@ 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 java.or javax. packages), are not -counted for purposes of this inspection. +(those in the java.or javax. packages), are not counted.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassInheritanceDepth.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassInheritanceDepth.html index 01b74552b231..037a60410018 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassInheritanceDepth.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassInheritanceDepth.html @@ -2,10 +2,10 @@ 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).

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassNamingConvention.html index 106143e562bb..fb9919e329bd 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassNamingConvention.html @@ -4,7 +4,7 @@ Reports classes whose names are either too short, too long, or do not follow the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassNestingDepth.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassNestingDepth.html index 5d19449ca9f3..bd8b314e0587 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassNestingDepth.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassNestingDepth.html @@ -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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassWithoutNoArgConstructor.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassWithoutNoArgConstructor.html index a6c1e99852a7..3b1d5e0dbfae 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassWithoutNoArgConstructor.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassWithoutNoArgConstructor.html @@ -5,7 +5,7 @@ Such constructors are necessary in some contexts if a class is to be created ref

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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ConstantNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ConstantNamingConvention.html index 99c3c6b6201a..9bc0bdb2368a 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ConstantNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ConstantNamingConvention.html @@ -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 static final.

-Use the fields provided below to specify minimum length, maximum length and regular expression expected for constant names -(Regular expressions are in standard java.util.regex 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 java.util.regex format). +

+Use the checkbox below to specify that only immutable static final fields should be checked by this inspection.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ConstructorCount.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ConstructorCount.html index f6e8bb81050e..f5175b6ee095 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ConstructorCount.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ConstructorCount.html @@ -5,7 +5,7 @@ too many constructors are prone to initialization errors, and may often be bette multiple subclasses.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/CyclomaticComplexity.html b/plugins/InspectionGadgets/src/inspectionDescriptions/CyclomaticComplexity.html index 96acc30811f5..9b486425fa77 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/CyclomaticComplexity.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/CyclomaticComplexity.html @@ -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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/EnumSwitchStatementWhichMissesCases.html b/plugins/InspectionGadgets/src/inspectionDescriptions/EnumSwitchStatementWhichMissesCases.html index 827ef4f29c54..feeb593c8a5d 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/EnumSwitchStatementWhichMissesCases.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/EnumSwitchStatementWhichMissesCases.html @@ -4,8 +4,7 @@ Reports switch statements over enumerated types which do not include all of the enumerated type's elements as cases.

-Use the check box below to let this inspection ignore switch -statements which include a default branch. +Use the checkbox below to ignore switch statements which have a default branch.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/EnumeratedClassNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/EnumeratedClassNamingConvention.html index cd55dc8db061..9f2382f5dbe6 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/EnumeratedClassNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/EnumeratedClassNamingConvention.html @@ -4,7 +4,7 @@ Reports enumerated classes whose names are either too short, too long, or do not the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/EnumeratedConstantNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/EnumeratedConstantNamingConvention.html index de47a9ed2ec9..c67aa6c5e14b 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/EnumeratedConstantNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/EnumeratedConstantNamingConvention.html @@ -4,7 +4,7 @@ Reports enumerated constants whose names are either too short, too long, or do n the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/FieldCount.html b/plugins/InspectionGadgets/src/inspectionDescriptions/FieldCount.html index 1053fda73f13..a6cb3d42f151 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/FieldCount.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/FieldCount.html @@ -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.

-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 static final 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. +

+Use the first checkbox below to indicate whether constant fields count toward this number. +

Per default this inspection only counts immutable static final objects as constant. Use the second checkbox below to count any static final field as constant.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/IfStatementWithTooManyBranches.html b/plugins/InspectionGadgets/src/inspectionDescriptions/IfStatementWithTooManyBranches.html index ba3b4cd5bf61..6ccaf0ffb7fb 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/IfStatementWithTooManyBranches.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/IfStatementWithTooManyBranches.html @@ -5,7 +5,7 @@ Such statements may be confusing, and are often the sign of inadequate levels of abstraction.

-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 if statement is allowed to have.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/InstanceMethodNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/InstanceMethodNamingConvention.html index 6b5506a05232..2d43e9b5f64d 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/InstanceMethodNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/InstanceMethodNamingConvention.html @@ -5,7 +5,7 @@ the specified regular expression pattern. Instance methods that override library methods are ignored by this inspection.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/InstanceVariableNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/InstanceVariableNamingConvention.html index 4f0efb6c957f..4a9c36f0490f 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/InstanceVariableNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/InstanceVariableNamingConvention.html @@ -4,7 +4,7 @@ Reports instance variables whose names are either too short, too long, or do not the specified regular expression pattern.

-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 java.util.regex format.)

diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/InterfaceNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/InterfaceNamingConvention.html index bd8d7e5ba8b5..8183383249e2 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/InterfaceNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/InterfaceNamingConvention.html @@ -4,7 +4,7 @@ Reports interfaces whose names are either too short, too long, or do not follow the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/JUnitAbstractTestClassNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/JUnitAbstractTestClassNamingConvention.html index 6e9ed206f39e..8492d81e4a92 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/JUnitAbstractTestClassNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/JUnitAbstractTestClassNamingConvention.html @@ -6,7 +6,7 @@ standard that abstract JUnit test classes follow a specific pattern, usually req with "TestCase".

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/JUnitTestClassNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/JUnitTestClassNamingConvention.html index 797ef090f0a5..431e0acf2563 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/JUnitTestClassNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/JUnitTestClassNamingConvention.html @@ -6,7 +6,7 @@ standard that concrete JUnit test classes follow a specific pattern, usually req with "Test".

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/LocalVariableNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/LocalVariableNamingConvention.html index 449e387b2645..35fa839696c1 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/LocalVariableNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/LocalVariableNamingConvention.html @@ -4,7 +4,7 @@ Reports local variables whose names are either too short, too long, or do not fo the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/MethodCount.html b/plugins/InspectionGadgets/src/inspectionDescriptions/MethodCount.html index 471915e3dc85..28724c52181d 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/MethodCount.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/MethodCount.html @@ -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.

-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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/MethodCoupling.html b/plugins/InspectionGadgets/src/inspectionDescriptions/MethodCoupling.html index 121e7f960f29..4baba21ee9e1 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/MethodCoupling.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/MethodCoupling.html @@ -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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/MultipleReturnPointsPerMethod.html b/plugins/InspectionGadgets/src/inspectionDescriptions/MultipleReturnPointsPerMethod.html index ab45f6242ca0..e7396f74045c 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/MultipleReturnPointsPerMethod.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/MultipleReturnPointsPerMethod.html @@ -1,12 +1,15 @@ -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 return points. Methods with too many return points may be confusing, +and hard to refactor. A return point is either a return statement or the falling through the bottom of a +void method or constructor.

-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 -equals() methods should be ignored. +Use the field below to specify the maximum number of return points a method is allowed to have. +

+Use the first checkbox below to ignore guard clauses. +

+Use the second checkbox below to ignore return points inside equals() methods.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/MultiplyOrDivideByPowerOfTwo.html b/plugins/InspectionGadgets/src/inspectionDescriptions/MultiplyOrDivideByPowerOfTwo.html index 89179a4fb58c..c2a8578868d8 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/MultiplyOrDivideByPowerOfTwo.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/MultiplyOrDivideByPowerOfTwo.html @@ -1,10 +1,10 @@ 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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/NegatedConditional.html b/plugins/InspectionGadgets/src/inspectionDescriptions/NegatedConditional.html index 30cb00ed1326..ccd1b184ce12 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/NegatedConditional.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/NegatedConditional.html @@ -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.

-Use the check box below to have comparisons of the form != null -ignored by this inspection +Use the checkbox below to ignore comparisons of the form != null.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/NegatedIfElse.html b/plugins/InspectionGadgets/src/inspectionDescriptions/NegatedIfElse.html index 5029f07dcc69..63a12c216851 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/NegatedIfElse.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/NegatedIfElse.html @@ -6,8 +6,7 @@ Flipping the order of the if and else branches will usually increase the clarity of such statements.

-Use the check box below to have comparisons of the form != null -ignored by this inspection +Use the checkbox below to ignore comparisons of the form != null.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/NestingDepth.html b/plugins/InspectionGadgets/src/inspectionDescriptions/NestingDepth.html index fa5fd1b7e41c..f658efd3a684 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/NestingDepth.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/NestingDepth.html @@ -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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/NonCommentSourceStatements.html b/plugins/InspectionGadgets/src/inspectionDescriptions/NonCommentSourceStatements.html index 5599d4592282..f1b6865cccd5 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/NonCommentSourceStatements.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/NonCommentSourceStatements.html @@ -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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/OverlyComplexArithmeticExpression.html b/plugins/InspectionGadgets/src/inspectionDescriptions/OverlyComplexArithmeticExpression.html index b6d845c2f6a4..26c746a06c07 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/OverlyComplexArithmeticExpression.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/OverlyComplexArithmeticExpression.html @@ -4,7 +4,7 @@ Reports arithmetic expressions with too many terms. Such expressions may be confusing and bug-prone.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/PackageNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/PackageNamingConvention.html index 9eddb8328048..55fce2a987a0 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/PackageNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/PackageNamingConvention.html @@ -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.

-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 java.util.regex format).

New in 11, Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ParameterNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ParameterNamingConvention.html index ddd783ced5c6..9557e336ad5c 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ParameterNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ParameterNamingConvention.html @@ -4,7 +4,7 @@ Reports method parameters whose names are either too short, too long, or do not the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ParametersPerConstructor.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ParametersPerConstructor.html index 226c8ea0b002..97c9c4001e52 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ParametersPerConstructor.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ParametersPerConstructor.html @@ -4,7 +4,7 @@ Reports constructors with too many parameters. Constructors with too many parameters can be a good sign that refactoring is necessary.

-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.

Use the combobox below to specify if the inspection should ignore private, package local & private or protected, package local and private constructors diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ParametersPerMethod.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ParametersPerMethod.html index 67d3f8d3eb7b..6d6075e05e03 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ParametersPerMethod.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ParametersPerMethod.html @@ -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.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ReplaceAssignmentWithOperatorAssignment.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ReplaceAssignmentWithOperatorAssignment.html index 1e2f9dea8373..0404e0fb7cfa 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ReplaceAssignmentWithOperatorAssignment.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ReplaceAssignmentWithOperatorAssignment.html @@ -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.

-Use the check box below to ignore the conditional operators && +Use the checkbox below to ignore the conditional operators && and ||. Replacing conditional operators with operator assignment modifies the semantics of the expression.

diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/StaticMethodNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/StaticMethodNamingConvention.html index 605ed476071b..be324e15ce8c 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/StaticMethodNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/StaticMethodNamingConvention.html @@ -1,10 +1,10 @@ -Reports static methods whose names are either too short, too long, or do not follow +Reports static methods whose names are either too short, too long, or do not follow the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/StaticVariableNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/StaticVariableNamingConvention.html index 27ef62898a9b..54040ee77476 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/StaticVariableNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/StaticVariableNamingConvention.html @@ -5,7 +5,7 @@ the specified regular expression pattern. Constants, i.e. variables of immutable are not checked by this inspection

-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 java.util.regex format.)

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/StringConstructor.html b/plugins/InspectionGadgets/src/inspectionDescriptions/StringConstructor.html index 3851033ebf56..a8ea2df6e63c 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/StringConstructor.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/StringConstructor.html @@ -6,7 +6,7 @@ Constructing new String objects in this way is rarely necessary, and may cause performance problems if done often enough.

-Use the check box below to ignore String +Use the checkbox below to ignore String constructor calls which have a String.substring() call as parameter. A call to substring() reuses the character array of the original string, which can cause a large diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/StringReplaceableByStringBuffer.html b/plugins/InspectionGadgets/src/inspectionDescriptions/StringReplaceableByStringBuffer.html index 45e397e37d13..65299e00bf63 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/StringReplaceableByStringBuffer.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/StringReplaceableByStringBuffer.html @@ -5,7 +5,7 @@ repeatedly appended to. Such variables may be more efficiently declared as ja or java.lang.StringBuilder.

-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.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/SwitchStatementWithTooFewBranches.html b/plugins/InspectionGadgets/src/inspectionDescriptions/SwitchStatementWithTooFewBranches.html index fcbd8e712f03..0832a5793d77 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/SwitchStatementWithTooFewBranches.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/SwitchStatementWithTooFewBranches.html @@ -4,7 +4,7 @@ Reports switch statements with too few case labels. Such statements may be more clearly expressed as if statements.

-Use the field provided below to specify the minimum number of case labels expected. +Use the field below to specify the minimum number of case labels expected.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/SwitchStatementWithTooManyBranches.html b/plugins/InspectionGadgets/src/inspectionDescriptions/SwitchStatementWithTooManyBranches.html index 0ceee7b6fd87..d1853c9b399a 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/SwitchStatementWithTooManyBranches.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/SwitchStatementWithTooManyBranches.html @@ -3,7 +3,7 @@ Reports switch statements with too many case labels.

-Use the field provided below to specify the maximum number of case labels expected. +Use the field below to specify the maximum number of case labels expected.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ThrownExceptionsPerMethod.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ThrownExceptionsPerMethod.html index 4a1d6db3543e..4c94a5df808a 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ThrownExceptionsPerMethod.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ThrownExceptionsPerMethod.html @@ -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.

-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 throws clauses a method might have.

Powered by InspectionGadgets diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/TryFinallyCanBeTryWithResources.html b/plugins/InspectionGadgets/src/inspectionDescriptions/TryFinallyCanBeTryWithResources.html index 22533392f259..28b8411a23e5 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/TryFinallyCanBeTryWithResources.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/TryFinallyCanBeTryWithResources.html @@ -1,7 +1,7 @@ Reports try finally statements which can use Java 7 -Automatic Resource Management. A quickfix is provided to convert the try finally +Automatic Resource Management. A quickfix is available to convert the try finally statement into a try with resources statement.

This inspection only reports if the project or module is configured to use a diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/TryWithIdenticalCatches.html b/plugins/InspectionGadgets/src/inspectionDescriptions/TryWithIdenticalCatches.html index 79143fd4e68f..3b10d772375b 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/TryWithIdenticalCatches.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/TryWithIdenticalCatches.html @@ -1,6 +1,6 @@ -Reports identical catch sections in try blocks under JDK 7. A quickfix is provided to collapse the sections into +Reports identical catch sections in try blocks under JDK 7. A quickfix is available to collapse the sections into a multi-catch section.

This inspection only reports if the project or module is configured to use a diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/TypeParameterNamingConvention.html b/plugins/InspectionGadgets/src/inspectionDescriptions/TypeParameterNamingConvention.html index be4665aa3ba9..c305e8a67f9f 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/TypeParameterNamingConvention.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/TypeParameterNamingConvention.html @@ -4,7 +4,7 @@ Reports type parameters whose names are either too short, too long, or do not fo the specified regular expression pattern.

-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 java.util.regex format.)

Powered by InspectionGadgets