phoedos/pmd
1
1 Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
TRAVIS_JOB_NUMBER=3167.1
TRAVIS_COMMIT_RANGE=0799482f85e1...f41df324804f
This commit is contained in:
Travis CI (pmd-bot) committed 2018-12-05 19:42:29 +00:00
1 parent f41df32480
commit 159095292c
8 files changed
+39 -39
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/pages/pmd/rules/apex/codestyle.md
+10 -10
View File
@@ -265,20 +265,20 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|parameterSuffix||Method parameter variable suffixes|yes. Delimiter is ','.|
|parameterPrefix||Method parameter variable prefixes|yes. Delimiter is ','.|
|localSuffix||Local variable suffixes|yes. Delimiter is ','.|
|localPrefix||Local variable prefixes|yes. Delimiter is ','.|
|memberSuffix||Member variable suffixes|yes. Delimiter is ','.|
|memberPrefix||Member variable prefixes|yes. Delimiter is ','.|
|staticSuffix||Static variable suffixes|yes. Delimiter is ','.|
|staticPrefix||Static variable prefixes|yes. Delimiter is ','.|
|checkParameters|true|Check constructor and method parameter variables|no|
|checkLocals|true|Check local variables|no|
|cc\_categories|Style|Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|Code Climate Block Highlighting|no|
|checkMembers|true|Check member variables|no|
|checkLocals|true|Check local variables|no|
|checkParameters|true|Check constructor and method parameter variables|no|
|staticPrefix||Static variable prefixes|yes. Delimiter is ','.|
|staticSuffix||Static variable suffixes|yes. Delimiter is ','.|
|memberPrefix||Member variable prefixes|yes. Delimiter is ','.|
|memberSuffix||Member variable suffixes|yes. Delimiter is ','.|
|localPrefix||Local variable prefixes|yes. Delimiter is ','.|
|localSuffix||Local variable suffixes|yes. Delimiter is ','.|
|parameterPrefix||Method parameter variable prefixes|yes. Delimiter is ','.|
|parameterSuffix||Method parameter variable suffixes|yes. Delimiter is ','.|
**Use this rule by referencing it:**
``` xml
docs/pages/pmd/rules/apex/design.md
+2 -2
View File
@@ -437,12 +437,12 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|showMethodsComplexity|true|Add method average violations to the report|no|
|showClassesComplexity|true|Add class average violations to the report|no|
|cc\_categories|Style|Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|Code Climate Block Highlighting|no|
|reportLevel|10|Cyclomatic Complexity reporting threshold|no|
|showClassesComplexity|true|Add class average violations to the report|no|
|showMethodsComplexity|true|Add method average violations to the report|no|
**Use this rule by referencing it:**
``` xml
docs/pages/pmd/rules/java/bestpractices.md
+1 -1
View File
@@ -436,8 +436,8 @@ otherwise skip the associate String creation and manipulation.
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|guardsMethods|isTraceEnabled , isDebugEnabled , isInfoEnabled , isWarnEnabled , isErrorEnabled , isLoggable|method use to guard the log statement|yes. Delimiter is ','.|
|logLevels|trace , debug , info , warn , error , log , finest , finer , fine , info , warning , severe|LogLevels to guard|yes. Delimiter is ','.|
|guardsMethods|isTraceEnabled , isDebugEnabled , isInfoEnabled , isWarnEnabled , isErrorEnabled , isLoggable|Method use to guard the log statement|yes. Delimiter is ','.|
**Use this rule by referencing it:**
``` xml
docs/pages/pmd/rules/java/codestyle.md
+13 -13
View File
@@ -753,9 +753,9 @@ public class HelloWorldBean {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|ignoreInterfaceDeclarations|false|Ignore Interface Declarations that precede fields.|no|
|ignoreAnonymousClassDeclarations|true|Ignore Field Declarations, that are initialized with anonymous class declarations|no|
|ignoreEnumDeclarations|true|Ignore Enum Declarations that precede fields.|no|
|ignoreAnonymousClassDeclarations|true|Ignore Field Declarations, that are initialized with anonymous class declarations|no|
|ignoreInterfaceDeclarations|false|Ignore Interface Declarations that precede fields.|no|
**Use this rule by referencing it:**
``` xml
@@ -1145,16 +1145,16 @@ public class LinguisticNaming {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|booleanFieldPrefixes|is \| has \| can \| have \| will \| should|The prefixes of fields and variables that indicate boolean.|yes. Delimiter is '\|'.|
|checkVariables|true|Check local variable names and types for inconsistent naming.|no|
|checkFields|true|Check field names and types for inconsistent naming.|no|
|transformMethodNames|to \| as|The prefixes and infixes that indicate a transform method.|yes. Delimiter is '\|'.|
|booleanMethodPrefixes|is \| has \| can \| have \| will \| should|The prefixes of methods that return boolean.|yes. Delimiter is '\|'.|
|checkBooleanMethod|true|Check method names and types for inconsistent naming.|no|
|checkGetters|true|Check return type of getters.|no|
|checkSetters|true|Check return type of setters.|no|
|checkPrefixedTransformMethods|true|Check return type of methods whose names start with the configured prefix (see transformMethodNames property).|no|
|checkTransformMethods|false|Check return type of methods which contain the configured infix in their name (see transformMethodNames property).|no|
|checkSetters|true|Check return type of setters.|no|
|checkGetters|true|Check return type of getters.|no|
|checkBooleanMethod|true|Check method names and types for inconsistent naming.|no|
|booleanMethodPrefixes|is \| has \| can \| have \| will \| should|The prefixes of methods that return boolean.|yes. Delimiter is '\|'.|
|transformMethodNames|to \| as|The prefixes and infixes that indicate a transform method.|yes. Delimiter is '\|'.|
|checkFields|true|Check field names and types for inconsistent naming.|no|
|checkVariables|true|Check local variable names and types for inconsistent naming.|no|
|booleanFieldPrefixes|is \| has \| can \| have \| will \| should|The prefixes of fields and variables that indicate boolean.|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
``` xml
@@ -2295,11 +2295,11 @@ public class Foo {
|memberSuffix||Member variable suffixes|yes. Delimiter is ','.|
|memberPrefix||Member variable prefixes|yes. Delimiter is ','.|
|staticSuffix||Static variable suffixes|yes. Delimiter is ','.|
|staticPrefix||Static variable prefixes|yes. Delimiter is ','.|
|checkMembers|true|Check member variables|no|
|checkLocals|true|Check local variables|no|
|checkParameters|true|Check constructor and method parameter variables|no|
|checkNativeMethodParameters|true|Check method parameter of native methods|no|
|staticPrefix||Static variable prefixes|yes. Delimiter is ','.|
|checkLocals|true|Check local variables|no|
|checkMembers|true|Check member variables|no|
**Use this rule by referencing it:**
``` xml
docs/pages/pmd/rules/java/design.md
+3 -3
View File
@@ -965,8 +965,8 @@ public class Bar {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|classes||Allowed classes|yes. Delimiter is ','.|
|packages||Restricted packages|yes. Delimiter is ','.|
|classes||Allowed classes|yes. Delimiter is ','.|
**Use this rule by referencing it:**
``` xml
@@ -1577,9 +1577,9 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|disallowNotAssignment|false|Disallow violations where the first usage is not an assignment|no|
|checkInnerClasses|false|Check inner classes|no|
|ignoredAnnotations|lombok.Setter \| lombok.Getter \| lombok.Builder \| lombok.Data \| lombok.RequiredArgsConstructor \| lombok.AllArgsConstructor \| lombok.Value \| lombok.NoArgsConstructor|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
|checkInnerClasses|false|Check inner classes|no|
|disallowNotAssignment|false|Disallow violations where the first usage is not an assignment|no|
**Use this rule by referencing it:**
``` xml
docs/pages/pmd/rules/java/documentation.md
+1 -1
View File
@@ -29,8 +29,8 @@ A rule for the politically correct... we don't want to offend anyone.
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|disallowedTerms|idiot \| jerk|Illegal terms or phrases|yes. Delimiter is '\|'.|
|caseSensitive|false|Case sensitive|no|
|disallowedTerms|idiot \| jerk|Illegal terms or phrases|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
``` xml
docs/pages/pmd/rules/java/errorprone.md
+8 -8
View File
@@ -34,10 +34,10 @@ public void bar() {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|allowIncrementDecrement|false|Allow increment or decrement operators within the conditional expression of an if, for, or while statement|no|
|allowWhile|false|Allow assignment within the conditional expression of a while statement|no|
|allowFor|false|Allow assignment within the conditional expression of a for statement|no|
|allowIf|false|Allow assignment within the conditional expression of an if statement|no|
|allowFor|false|Allow assignment within the conditional expression of a for statement|no|
|allowWhile|false|Allow assignment within the conditional expression of a while statement|no|
|allowIncrementDecrement|false|Allow increment or decrement operators within the conditional expression of an if, for, or while statement|no|
**Use this rule by referencing it:**
``` xml
@@ -382,12 +382,12 @@ private void buz(String x) {}
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|exceptionfile||File containing strings to skip (one string per line), only used if ignore list is not set. File must be UTF-8 encoded.|no|
|exceptionfile||<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> (Use 'exceptionList' property) File containing strings to skip (one string per line), only used if ignore list is not set. File must be UTF-8 encoded.|no|
|separator|,|Ignore list separator|no|
|exceptionList||Strings to ignore|no|
|skipAnnotations|false|Skip literals within annotations|no|
|maxDuplicateLiterals|4|Max duplicate literals|no|
|minimumLength|3|Minimum string length to check|no|
|skipAnnotations|false|Skip literals within annotations|no|
|exceptionList||List of literals to ignore. A literal is ignored if its image can be found in this list. Components of this list should not be surrounded by double quotes.|no|
**Use this rule by referencing it:**
``` xml
@@ -1124,9 +1124,9 @@ public class Bar {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|closeAsDefaultTarget|true|Consider 'close' as a target by default|no|
|types|java.sql.Connection , java.sql.Statement , java.sql.ResultSet|Affected types|yes. Delimiter is ','.|
|closeTargets||Methods which may close this resource|yes. Delimiter is ','.|
|types|java.sql.Connection , java.sql.Statement , java.sql.ResultSet|Affected types|yes. Delimiter is ','.|
|closeAsDefaultTarget|true|Consider 'close' as a target by default|no|
**Use this rule by referencing it:**
``` xml
docs/pages/pmd/rules/java/multithreading.md
+1 -1
View File
@@ -265,8 +265,8 @@ public static Foo getFoo() {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|checkNonStaticFields|false|Check for non-static fields. Do not set this to true and checkNonStaticMethods to false.|no|
|checkNonStaticMethods|true|Check for non-static methods. Do not set this to false and checkNonStaticFields to true.|no|
|checkNonStaticFields|false|Check for non-static fields. Do not set this to true and checkNonStaticMethods to false.|no|
**Use this rule by referencing it:**
``` xml