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

[doc] Document the delimiter for multi valued properties

Browse Source
This commit is contained in:
Andreas Dangel
2018-04-27 21:56:45 +02:00
parent 970fdffbb9
commit 529d2da054
2 changed files with 22 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java
View File

@ -39,6 +39,7 @@ import net.sourceforge.pmd.RuleSetNotFoundException;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.rule.RuleReference;
import net.sourceforge.pmd.lang.rule.XPathRule;
import net.sourceforge.pmd.properties.MultiValuePropertyDescriptor;
import net.sourceforge.pmd.properties.PropertyDescriptor;
public class RuleDocGenerator {
@ -421,8 +422,8 @@ public class RuleDocGenerator {
if (!properties.isEmpty()) {
lines.add("**This rule has the following properties:**");
lines.add("");
lines.add("|Name|Default Value|Description|");
lines.add("|----|-------------|-----------|");
lines.add("|Name|Default Value|Description|Multivalued|");
lines.add("|----|-------------|-----------|-----------|");
for (PropertyDescriptor<?> propertyDescriptor : properties) {
String description = propertyDescriptor.description();
if (description != null && description.toLowerCase(Locale.ROOT).startsWith(DEPRECATED_RULE_PROPERTY_MARKER)) {
@ -441,9 +442,18 @@ public class RuleDocGenerator {
}
}
String multiValued = "no";
if (propertyDescriptor.isMultiValue()) {
MultiValuePropertyDescriptor<?> multiValuePropertyDescriptor =
(MultiValuePropertyDescriptor<?>) propertyDescriptor;
multiValued = "yes. Delimiter is '"
+ multiValuePropertyDescriptor.multiValueDelimiter() + "'";
}
lines.add("|" + propertyDescriptor.name()
+ "|" + defaultValue.replace("|", "\\|")
+ "|" + description
+ "|" + multiValued.replace("|", "\\|")
+ "|");
}
lines.add("");

20
pmd-doc/src/test/resources/expected/sample.md
View File

@ -60,11 +60,11 @@ public class JumbledIncrementerRule1 {
**This rule has the following properties:**
|Name|Default Value|Description|
|----|-------------|-----------|
|sampleAdditionalProperty|the value|This is a additional property for tests|
|sampleMultiStringProperty|Value1\|Value2|Test property with multiple strings|
|sampleDeprecatedProperty|test|<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> This is a sample deprecated property for tests|
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|sampleAdditionalProperty|the value|This is a additional property for tests|no|
|sampleMultiStringProperty|Value1\|Value2|Test property with multiple strings|yes. Delimiter is '\|'|
|sampleDeprecatedProperty|test|<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> This is a sample deprecated property for tests|no|
**Use this rule by referencing it:**
``` xml
@ -198,11 +198,11 @@ public class JumbledIncrementerRule1 {
**This rule has the following properties:**
|Name|Default Value|Description|
|----|-------------|-----------|
|sampleAdditionalProperty|the value|This is a additional property for tests|
|sampleMultiStringProperty|Value1\|Value2|Test property with multiple strings|
|sampleDeprecatedProperty|test|<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> This is a sample deprecated property for tests|
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|sampleAdditionalProperty|the value|This is a additional property for tests|no|
|sampleMultiStringProperty|Value1\|Value2|Test property with multiple strings|yes. Delimiter is '\|'|
|sampleDeprecatedProperty|test|<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> This is a sample deprecated property for tests|no|
**Use this rule by referencing it:**
``` xml