hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Update documentation

Browse Source 
TRAVIS_JOB_NUMBER=2991.1
TRAVIS_COMMIT_RANGE=544c81927435...f6dd18204463
This commit is contained in:
Travis CI (pmd-bot)
2018-11-01 22:48:31 +00:00
parent f6dd182044
commit 117e9a4277
3 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/pages/pmd/rules/ecmascript/bestpractices.md
View File

@ -70,7 +70,7 @@ function bar() {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|rhinoLanguageVersion|VERSION_DEFAULT|Specifies the Rhino Language Version to use for parsing. Defaults to Rhino default.|no|
|rhinoLanguageVersion|VERSION\_DEFAULT|Specifies the Rhino Language Version to use for parsing. Defaults to Rhino default.|no|
|recordingLocalJsDocComments|true|Specifies that JsDoc comments are produced in the AST.|no|
|recordingComments|true|Specifies that comments are produced in the AST.|no|

50
docs/pages/pmd/rules/java/codestyle.md
View File

@ -407,12 +407,12 @@ public class Éléphant {}
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|classPattern|[A-Z][a-zA-Z0-9]*|Regex which applies to concrete class names|no|
|abstractClassPattern|[A-Z][a-zA-Z0-9]*|Regex which applies to abstract class names|no|
|interfacePattern|[A-Z][a-zA-Z0-9]*|Regex which applies to interface names|no|
|enumPattern|[A-Z][a-zA-Z0-9]*|Regex which applies to enum names|no|
|annotationPattern|[A-Z][a-zA-Z0-9]*|Regex which applies to annotation names|no|
|utilityClassPattern|[A-Z][a-zA-Z0-9]+(Utils?\|Helper)|Regex which applies to utility class names|no|
|classPattern|\[A-Z\]\[a-zA-Z0-9\]\*|Regex which applies to concrete class names|no|
|abstractClassPattern|\[A-Z\]\[a-zA-Z0-9\]\*|Regex which applies to abstract class names|no|
|interfacePattern|\[A-Z\]\[a-zA-Z0-9\]\*|Regex which applies to interface names|no|
|enumPattern|\[A-Z\]\[a-zA-Z0-9\]\*|Regex which applies to enum names|no|
|annotationPattern|\[A-Z\]\[a-zA-Z0-9\]\*|Regex which applies to annotation names|no|
|utilityClassPattern|\[A-Z\]\[a-zA-Z0-9\]+(Utils?\|Helper)|Regex which applies to utility class names|no|
**Use this rule by referencing it:**
``` xml
@ -462,7 +462,7 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|regex|\/\*\s+(default\|package)\s+\*\/|Regular expression|no|
|regex|\\/\\\*\\s+(default\|package)\\s+\\\*\\/|Regular expression|no|
|ignoredAnnotations|com.google.common.annotations.VisibleForTesting \| android.support.annotation.VisibleForTesting|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
@ -801,12 +801,12 @@ class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|publicConstantPattern|[A-Z][A-Z_0-9]*|Regex which applies to public constant names|no|
|constantPattern|[A-Z][A-Z_0-9]*|Regex which applies to non-public static final field names|no|
|enumConstantPattern|[A-Z][A-Z_0-9]*|Regex which applies to enum constant names|no|
|finalFieldPattern|[a-z][a-zA-Z0-9]*|Regex which applies to final field names|no|
|staticFieldPattern|[a-z][a-zA-Z0-9]*|Regex which applies to static field names|no|
|defaultFieldPattern|[a-z][a-zA-Z0-9]*|Regex which applies to field names|no|
|publicConstantPattern|\[A-Z\]\[A-Z\_0-9\]\*|Regex which applies to public constant names|no|
|constantPattern|\[A-Z\]\[A-Z\_0-9\]\*|Regex which applies to non-public static final field names|no|
|enumConstantPattern|\[A-Z\]\[A-Z\_0-9\]\*|Regex which applies to enum constant names|no|
|finalFieldPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to final field names|no|
|staticFieldPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to static field names|no|
|defaultFieldPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to field names|no|
|exclusions|serialVersionUID|Names of fields to whitelist.|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
@ -918,10 +918,10 @@ class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|methodParameterPattern|[a-z][a-zA-Z0-9]*|Regex which applies to formal parameter names|no|
|finalMethodParameterPattern|[a-z][a-zA-Z0-9]*|Regex which applies to final formal parameter names|no|
|lambdaParameterPattern|[a-z][a-zA-Z0-9]*|Regex which applies to inferred-type lambda parameter names|no|
|explicitLambdaParameterPattern|[a-z][a-zA-Z0-9]*|Regex which applies to explicitly-typed lambda parameter names|no|
|methodParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to formal parameter names|no|
|finalMethodParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to final formal parameter names|no|
|lambdaParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to inferred-type lambda parameter names|no|
|explicitLambdaParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to explicitly-typed lambda parameter names|no|
**Use this rule by referencing it:**
``` xml
@ -1297,9 +1297,9 @@ class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|localVarPattern|[a-z][a-zA-Z0-9]*|Regex which applies to non-final local variable names|no|
|finalVarPattern|[a-z][a-zA-Z0-9]*|Regex which applies to final local variable names|no|
|catchParameterPattern|[a-z][a-zA-Z0-9]*|Regex which applies to exception block parameter names|no|
|localVarPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to non-final local variable names|no|
|finalVarPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to final local variable names|no|
|catchParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to exception block parameter names|no|
**Use this rule by referencing it:**
``` xml
@ -1438,11 +1438,11 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|checkNativeMethods|true|<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> Check native methods|no|
|methodPattern|[a-z][a-zA-Z0-9]*|Regex which applies to instance method names|no|
|staticPattern|[a-z][a-zA-Z0-9]*|Regex which applies to static method names|no|
|nativePattern|[a-z][a-zA-Z0-9]*|Regex which applies to native method names|no|
|junit3TestPattern|test[A-Z0-9][a-zA-Z0-9]*|Regex which applies to JUnit 3 test method names|no|
|junit4TestPattern|[a-z][a-zA-Z0-9]*|Regex which applies to JUnit 4 test method names|no|
|methodPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to instance method names|no|
|staticPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to static method names|no|
|nativePattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to native method names|no|
|junit3TestPattern|test\[A-Z0-9\]\[a-zA-Z0-9\]\*|Regex which applies to JUnit 3 test method names|no|
|junit4TestPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to JUnit 4 test method names|no|
**Use this rule by referencing it:**
``` xml

4
docs/pages/pmd/rules/plsql/codestyle.md
View File

@ -141,8 +141,8 @@ END;
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|allowSimpleLoops|false|Ignore simple loops, that are not nested|no|
|cursorPattern|[a-zA-Z_0-9]{5,}|The pattern used for the curosr loop variable|no|
|indexPattern|[a-zA-Z_0-9]{5,}|The pattern used for the index loop variable|no|
|cursorPattern|\[a-zA-Z\_0-9\]{5,}|The pattern used for the curosr loop variable|no|
|indexPattern|\[a-zA-Z\_0-9\]{5,}|The pattern used for the index loop variable|no|
**Use this rule by referencing it:**
``` xml