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

(doc) Update generated rule documentation

Browse Source
This commit is contained in:
Andreas Dangel
2019-05-24 19:37:06 +02:00
parent 912d358c05
commit fa91d47f7b
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -900,7 +900,7 @@ class Foo {
|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 '\|'.|
|exclusions|serialVersionUID \| serialPersistentFields|Names of fields to whitelist.|yes. Delimiter is '\|'.|
**Use this rule with the default properties by just referencing it:**
``` xml
@@ -917,7 +917,7 @@ class Foo {
<property name="finalFieldPattern" value="[a-z][a-zA-Z0-9]*" />
<property name="staticFieldPattern" value="[a-z][a-zA-Z0-9]*" />
<property name="defaultFieldPattern" value="[a-z][a-zA-Z0-9]*" />
<property name="exclusions" value="serialVersionUID" />
<property name="exclusions" value="serialVersionUID|serialPersistentFields" />
</properties>
</rule>
```

2
docs/pages/pmd/rules/java/documentation.md
View File

@@ -79,6 +79,7 @@ Denotes whether comments are required (or unwanted) for specific language elemen
|protectedMethodCommentRequirement|Required|Protected method constructor comments. Possible values: \[Required, Ignored, Unwanted\]|no|
|enumCommentRequirement|Required|Enum comments. Possible values: \[Required, Ignored, Unwanted\]|no|
|serialVersionUIDCommentRequired|Ignored|Serial version UID comments. Possible values: \[Required, Ignored, Unwanted\]|no|
|serialPersistentFieldsCommentRequired|Ignored|Serial persistent fields comments. Possible values: \[Required, Ignored, Unwanted\]|no|
**Use this rule with the default properties by just referencing it:**
``` xml
@@ -97,6 +98,7 @@ Denotes whether comments are required (or unwanted) for specific language elemen
<property name="protectedMethodCommentRequirement" value="Required" />
<property name="enumCommentRequirement" value="Required" />
<property name="serialVersionUIDCommentRequired" value="Ignored" />
<property name="serialPersistentFieldsCommentRequired" value="Ignored" />
</properties>
</rule>
```