From 06e8e32d23068625d363ceac981a9196f95d6262 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Fri, 11 Aug 2017 21:52:18 +0200 Subject: [PATCH] [doc] update generated documentation --- docs/pages/pmd/rules/java.md | 6 +++--- docs/pages/pmd/rules/java/basic.md | 14 +++++++------- docs/pages/pmd/rules/java/codesize.md | 6 ++++++ 3 files changed, 16 insertions(+), 10 deletions(-) diff --git a/docs/pages/pmd/rules/java.md b/docs/pages/pmd/rules/java.md index aa6b07fb8a..125a9ed55f 100644 --- a/docs/pages/pmd/rules/java.md +++ b/docs/pages/pmd/rules/java.md @@ -76,17 +76,17 @@ List of rulesets and rules contained in each ruleset. * [ProperCloneImplementation](pmd_rules_java_clone.html#propercloneimplementation): Object clone() should be implemented with super.clone(). ## Code Size -* [CyclomaticComplexity](pmd_rules_java_codesize.html#cyclomaticcomplexity): Complexity directly affects maintenance costs is determined by the number of decision points in a... +* [CyclomaticComplexity](pmd_rules_java_codesize.html#cyclomaticcomplexity): Deprecated Complexity directly affects maintenance costs is determined by the number of decision points in a... * [ExcessiveClassLength](pmd_rules_java_codesize.html#excessiveclasslength): Excessive class file lengths are usually indications that the class may be burdened with excessiv... * [ExcessiveMethodLength](pmd_rules_java_codesize.html#excessivemethodlength): When methods are excessively long this usually indicates that the method is doing more than itsna... * [ExcessiveParameterList](pmd_rules_java_codesize.html#excessiveparameterlist): Methods with numerous parameters are a challenge to maintain, especially if most of them share th... * [ExcessivePublicCount](pmd_rules_java_codesize.html#excessivepubliccount): Classes with large numbers of public methods and attributes require disproportionate testing effo... -* [ModifiedCyclomaticComplexity](pmd_rules_java_codesize.html#modifiedcyclomaticcomplexity): Complexity directly affects maintenance costs is determined by the number of decision points in a... +* [ModifiedCyclomaticComplexity](pmd_rules_java_codesize.html#modifiedcyclomaticcomplexity): Deprecated Complexity directly affects maintenance costs is determined by the number of decision points in a... * [NcssConstructorCount](pmd_rules_java_codesize.html#ncssconstructorcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l... * [NcssMethodCount](pmd_rules_java_codesize.html#ncssmethodcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l... * [NcssTypeCount](pmd_rules_java_codesize.html#ncsstypecount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l... * [NPathComplexity](pmd_rules_java_codesize.html#npathcomplexity): The NPath complexity of a method is the number of acyclic execution paths through that method.A t... -* [StdCyclomaticComplexity](pmd_rules_java_codesize.html#stdcyclomaticcomplexity): Complexity directly affects maintenance costs is determined by the number of decision points in a... +* [StdCyclomaticComplexity](pmd_rules_java_codesize.html#stdcyclomaticcomplexity): Deprecated Complexity directly affects maintenance costs is determined by the number of decision points in a... * [TooManyFields](pmd_rules_java_codesize.html#toomanyfields): Classes that have too many fields can become unwieldy and could be redesigned to have fewer field... * [TooManyMethods](pmd_rules_java_codesize.html#toomanymethods): A class with too many methods is probably a good suspect for refactoring, in order to reduce its ... diff --git a/docs/pages/pmd/rules/java/basic.md b/docs/pages/pmd/rules/java/basic.md index 50f170b6f0..f93c391216 100644 --- a/docs/pages/pmd/rules/java/basic.md +++ b/docs/pages/pmd/rules/java/basic.md @@ -449,13 +449,13 @@ Avoid jumbled loop incrementers - its usually a mistake, and is confusing even i ``` public class JumbledIncrementerRule1 { - public void foo() { - for (int i = 0; i < 10; i++) { // only references 'i' - for (int k = 0; k < 20; i++) { // references both 'i' and 'k' - System.out.println("Hello"); - } - } - } + public void foo() { + for (int i = 0; i < 10; i++) { // only references 'i' + for (int k = 0; k < 20; i++) { // references both 'i' and 'k' + System.out.println("Hello"); + } + } + } } ``` diff --git a/docs/pages/pmd/rules/java/codesize.md b/docs/pages/pmd/rules/java/codesize.md index 774419302d..e338ab110a 100644 --- a/docs/pages/pmd/rules/java/codesize.md +++ b/docs/pages/pmd/rules/java/codesize.md @@ -8,6 +8,8 @@ editmepath: ../pmd-java/src/main/resources/rulesets/java/codesize.xml --- ## CyclomaticComplexity +Deprecated + **Since:** 1.03 **Priority:** Medium (3) @@ -204,6 +206,8 @@ public class Foo { ## ModifiedCyclomaticComplexity +Deprecated + **Since:** 5.1.2 **Priority:** Medium (3) @@ -421,6 +425,8 @@ void bar() { // this is something more complex than it needs to be, ## StdCyclomaticComplexity +Deprecated + **Since:** 5.1.2 **Priority:** Medium (3)