diff --git a/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java b/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java index b3a54e706b..5eb70b5fa6 100644 --- a/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java +++ b/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java @@ -286,6 +286,12 @@ public class RuleDocGenerator { lines.add("**Priority:** " + rule.getPriority() + " (" + rule.getPriority().getPriority() + ")"); lines.add(""); + if (rule.getMinimumLanguageVersion() != null) { + lines.add("**Minimum Language Version:** " + + rule.getLanguage().getName() + " " + rule.getMinimumLanguageVersion().getVersion()); + lines.add(""); + } + lines.add(StringUtils.stripToEmpty(rule.getDescription())); lines.add(""); diff --git a/pmd-doc/src/test/resources/expected/sample.md b/pmd-doc/src/test/resources/expected/sample.md index 2ff1e05272..89496308fa 100644 --- a/pmd-doc/src/test/resources/expected/sample.md +++ b/pmd-doc/src/test/resources/expected/sample.md @@ -51,6 +51,12 @@ public class JumbledIncrementerRule1 { } ``` +**This rule has the following properties:** + +|Name|Default Value|Description| +|----|-------------|-----------| +|sampleAdditionalProperty|the value|This is a additional property for tests| + ## MovedRule Deprecated @@ -92,6 +98,8 @@ public class JumbledIncrementerRule1 { **Priority:** Medium (3) +**Minimum Language Version:** Java 1.5 + Override both public boolean Object.equals(Object other), and public int Object.hashCode(), or override neither. Even if you are inheriting a hashCode() from a parent class, consider implementing hashCode and explicitly delegating to your superclass. **This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.basic.OverrideBothEqualsAndHashcodeRule](https://github.com/pmd/pmd/blob/master/net/sourceforge/pmd/lang/java/rule/basic/OverrideBothEqualsAndHashcodeRule.java) @@ -155,3 +163,9 @@ public class JumbledIncrementerRule1 { } } ``` + +**This rule has the following properties:** + +|Name|Default Value|Description| +|----|-------------|-----------| +|sampleAdditionalProperty|the value|This is a additional property for tests| diff --git a/pmd-doc/src/test/resources/rulesets/ruledoctest/sample.xml b/pmd-doc/src/test/resources/rulesets/ruledoctest/sample.xml index f6148216ed..b0139a9851 100644 --- a/pmd-doc/src/test/resources/rulesets/ruledoctest/sample.xml +++ b/pmd-doc/src/test/resources/rulesets/ruledoctest/sample.xml @@ -13,7 +13,8 @@ Sample ruleset to test rule doc generation. since="0.4" message="Ensure you override both equals() and hashCode()" class="net.sourceforge.pmd.lang.java.rule.basic.OverrideBothEqualsAndHashcodeRule" - externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_sample.html#overridebothequalsandhashcode"> + externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_sample.html#overridebothequalsandhashcode" + minimumLanguageVersion="1.5"> Override both public boolean Object.equals(Object other), and public int Object.hashCode(), or override neither. Even if you are inheriting a hashCode() from a parent class, consider implementing hashCode and explicitly delegating to your superclass. @@ -67,6 +68,7 @@ Avoid jumbled loop incrementers - its usually a mistake, and is confusing even i ]]> +