Skip to content

Commit

Permalink
Issue checkstyle#6: update documentation after transfer ('This rule i…
Browse files Browse the repository at this point in the history
…s deprecated ...' is removed from html files)
  • Loading branch information
romani authored and tsjensen committed Mar 21, 2019
1 parent a52a540 commit 29fc6c6
Show file tree
Hide file tree
Showing 82 changed files with 0 additions and 82 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks the style of array type definitions. Some like Java-style: public static void main(String[] args) and some like C-style: public static void main(String args[])

<p>
This rule is deprecated, use {rule:squid:S1197} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Check that method/constructor/catch/foreach parameters are final.

<p>
This rule is deprecated, use {rule:squid:S1226} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@
</p>

<p>
This rule is deprecated, use {rule:squid:S00113} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
This rule allows to find any kind of pattern inside comments like TODO, NOPMD, ..., except NOSONAR

<p>
This rule is deprecated, use {rule:squid:S1135}, {rule:squid:S1310} and {rule:squid:S1315} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,4 @@
</p>

<p>
This rule is deprecated, use {rule:squid:TrailingCommentCheck} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
This is in accordance to the Java Language Specification, <a href="http://docs.oracle.com/javase/specs/jls/se8/html/jls-3.html#jls-3.10.1">Section 3.10.1</a>.

<p>
This rule is deprecated, use {rule:squid:LowerCaseLongSuffixCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Verifies that both the java.lang.Deprecated annotation is present and the @deprecated Javadoc tag is present when either is present.

<p>
This rule is deprecated, use {rule:squid:MissingDeprecatedCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Finds nested blocks.

<p>
This rule is deprecated, use {rule:squid:S1199} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@
Checks for empty blocks.
</p>

<p>This rule is deprecated, use {rule:squid:S00108} instead.</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for the placement of left curly braces for code blocks. The policy to verify is specified using property option. Policies <code>eol</code> and <code>nlow</code> take into account property maxLineLength.

<p>
This rule is deprecated, use {rule:squid:LeftCurlyBraceStartLineCheck} and {rule:squid:LeftCurlyBraceEndLineCheck} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@
</p>

<p>
This rule is deprecated, use {rule:squid:S00121} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks the placement of right curly braces.

<p>
This rule is deprecated, use {rule:squid:RightCurlyBraceStartLineCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<p>Detects inline conditionals.</p>

<p>
This rule is deprecated, use {rule:squid:S1774} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that if a class defines a covariant method equals, then it defines method equals(java.lang.Object).

<p>
This rule is deprecated, use {rule:squid:S1201} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that the parts of a class or interface declaration appear in the order suggested by the Code Convention for the Java Programming Language : <ul><li>Class (static) variables. First the public class variables, then the protected, then package level (no access modifier), and then the private.</li><li>Instance variables. First the public class variables, then the protected, then package level (no access modifier), and then the private.</li><li>Constructors</li><li>Methods</li></ul>

<p>
This rule is deprecated, use {rule:squid:S1213} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Check that the default is after all the cases in a switch statement.

<p>
This rule is deprecated, use {rule:squid:SwitchLastCaseIsDefaultCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Detects empty statements (standalone ';').

<p>
This rule is deprecated, use {rule:squid:EmptyStatementUsageCheck} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,4 @@
<p>Since, it is difficult to determine what kind of Object is being concatenated all ident concatenation is considered unsafe.</p>

<p>
This rule is deprecated, use {rule:squid:S1132} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that classes that override equals() also override hashCode().

<p>
This rule is deprecated, use {rule:squid:S1206} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks if any class or object member explicitly initialized to default for its type value (null for object references, zero for numeric types and char and false for boolean).

<p>
This rule is deprecated, use {rule:squid:S3052} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for fall through in switch statements Finds locations where a case contains Java code - but lacks a break, return, throw or continue statement.

<p>
This rule is deprecated, use {rule:squid:S128} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that a local variable or a parameter does not shadow a field that is defined in the same class.

<p>
This rule is deprecated, use {rule:squid:HiddenFieldCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Throwing java.lang.Error or java.lang.RuntimeException is almost never acceptable.

<p>
This rule is deprecated, use {rule:squid:S00112} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2);.

<p>
This rule is deprecated, use {rule:squid:AssignmentInSubExpressionCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for magic numbers.

<p>
This rule is deprecated, use {rule:squid:S109} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that switch statement has default clause.

<p>
This rule is deprecated, use {rule:squid:SwitchLastCaseIsDefaultCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Check for ensuring that for loop control variables are not modified inside the for block.

<p>
This rule is deprecated, use {rule:squid:ForLoopCounterChangedCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for multiple occurrences of the same string literal within a single file. Code duplication makes maintenance more difficult, so it can be better to replace the multiple occurrences with a constant.

<p>
This rule is deprecated, use {rule:squid:S1192} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that each variable declaration is in its own statement and on its own line.

<p>
This rule is deprecated, use {rule:squid:S1659} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Restricts nested for blocks to a specified depth.

<p>
This rule is deprecated, use {rule:squid:S134} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Restricts nested if-else blocks to a specified depth (default = 1).

<p>
This rule is deprecated, use {rule:squid:S134} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Restricts nested try-catch-finally blocks to a specified depth (default = 1).

<p>
This rule is deprecated, use {rule:squid:S1141} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<p>Verifies there are no finalize() methods defined in a class.</p>

<p>
This rule is deprecated, use {rule:squid:ObjectFinalizeOverridenCheck} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@
</p>

<p>
This rule is deprecated, use {rule:squid:S00122} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Ensures there is a package declaration.

<p>
This rule is deprecated, use {rule:squid:S1220} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Disallow assignment of parameters.

<p>
This rule is deprecated, use {rule:squid:S1226} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Restricts return statements to a specified count (default = 2).

<p>
This rule is deprecated, use {rule:squid:S1142} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for overly complicated boolean expressions.

<p>
This rule is deprecated, use {rule:squid:S1125} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for overly complicated boolean return statements.

<p>
This rule is deprecated, use {rule:squid:S1126} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that string literals are not used with == or !=.

<p>
This rule is deprecated, use {rule:squid:StringEqualityComparisonCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that an overriding clone() method invokes super.clone().

<p>
This rule is deprecated, use {rule:squid:S1182} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that an overriding finalize() method invokes super.finalize().

<p>
This rule is deprecated, use {rule:squid:ObjectFinalizeOverridenCallsSuperFinalizeCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks if unnecessary parentheses are used in a statement or expression.

<p>
This rule is deprecated, use {rule:squid:UselessParenthesesCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that class which has only private constructors is declared as final.

<p>
This rule is deprecated, use {rule:squid:S2974} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Make sure that utility classes (classes that contain only static methods) do not have a public constructor.

<p>
This rule is deprecated, use {rule:squid:S1118} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types. According to Bloch, an interface should describe a type. It is therefore inappropriate to define an interface that does not contain any methods but only constants. The Standard class javax.swing.SwingConstants is an example of a class that would be flagged by this check. The check can be configured to also disallow marker interfaces like java.io.Serializable, that do not contain methods or constants at all.

<p>
This rule is deprecated, use {rule:squid:S1214} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Ensures that exceptions (defined as any class name conforming to some regular expression) are immutable.

<p>
This rule is deprecated, use {rule:squid:S1165} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Restricts throws statements to a specified count (default = 1).

<p>
This rule is deprecated, use {rule:squid:S1160} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks visibility of class members. Only static final members may be public; other class members must be private unless property protectedAllowed or packageAllowed is set.

<p>
This rule is deprecated, use {rule:squid:ClassVariableVisibilityCheck} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,4 @@
<p>Note: ignoreLines property has been removed from this check to simplify it. To make some line optional use "^.*$" regexp for this line. </p>

<p>
This rule is deprecated, use {rule:squid:S1451} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Check that finds import statements that use the * notation.

<p>
This rule is deprecated, use {rule:squid:S2208} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for imports from a set of illegal packages, like sun.*

<p>
This rule is deprecated, use {rule:squid:S1191} or {rule:squid:ArchitecturalConstraint} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,4 @@
"http://www.puppycrawl.com/dtds/import_control_1_1.dtd"&gt;</pre>

<p>
This rule is deprecated, use {rule:squid:ArchitecturalConstraint} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@
<li>The class imported is from the same package.</li></ul>

<p>
This rule is deprecated, use {rule:squid:UselessImportCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks for unused import statements.

<p>
This rule is deprecated, use {rule:squid:UselessImportCheck} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks correct indentation of Java Code.

<p>
This rule is deprecated, use {rule:squid:IndentationCheck} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,4 @@
Static methods at all visibilities, private non-static methods and constructors are not inheritable.

<p>
This rule is deprecated, use {rule:squid:UndocumentedApi} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<p>Checks that each Java package has a Javadoc file used for commenting. By default it only allows a package-info.java file, but can be configured to allow a package.html file. An error will be reported if both files exist as this is not allowed by the Javadoc tool.</p>

<p>
This rule is deprecated, use {rule:squid:S1228} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@
<br><br>Error messages about type parameters for which no param tags are present can be suppressed by defining property allowMissingParamTags.

<p>
This rule is deprecated, use {rule:squid:UndocumentedApi} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that a variable has Javadoc comment.

<p>
This rule is deprecated, use {rule:squid:UndocumentedApi} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Restricts nested boolean operators (&&, || and ^) to a specified depth (default = 3).

<p>
This rule is deprecated, use {rule:squid:S1067} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
The number of other classes a given class relies on.

<p>
This rule is deprecated, use {rule:squid:S1200} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@
</p>

<p>
This rule is deprecated, use {rule:squid:MethodCyclomaticComplexity} instead.
</p>
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Checks that the order of modifiers conforms to the suggestions in the <a href="http://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html">Java Language specification, sections 8.1.1, 8.3.1 and 8.4.3</a>. The correct order is : public, protected, private, abstract, static, final, transient, volatile, synchronized, native, strictfp.

<p>
This rule is deprecated, use {rule:squid:ModifiersOrderCheck} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@
</p>

<p>
This rule is deprecated, use {rule:squid:S00118} instead.
</p>
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@
</pre>

<p>
This rule is deprecated, use {rule:squid:S00119} instead.
</p>
Loading

0 comments on commit 29fc6c6

Please sign in to comment.