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 9a2e66551b..bde314c9cc 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 @@ -239,15 +239,16 @@ public class RuleDocGenerator { for (Map.Entry> entry : rulesets.entrySet()) { String languageTersename = entry.getKey().getTerseName(); for (RuleSet ruleset : entry.getValue()) { + String rulesetFilename = getRuleSetFilename(ruleset); String filename = RULESET_INDEX_FILENAME_PATTERN .replace("${language.tersename}", languageTersename) - .replace("${ruleset.name}", getRuleSetFilename(ruleset)); + .replace("${ruleset.name}", rulesetFilename); Path path = getAbsoluteOutputPath(filename); String permalink = RULESET_INDEX_PERMALINK_PATTERN .replace("${language.tersename}", languageTersename) - .replace("${ruleset.name}", getRuleSetFilename(ruleset)); + .replace("${ruleset.name}", rulesetFilename); List lines = new LinkedList<>(); lines.add("---"); @@ -350,6 +351,12 @@ public class RuleDocGenerator { } lines.add(""); } + + lines.add("**Use this rule by referencing it:**"); + lines.add("``` xml"); + lines.add(""); + lines.add("```"); + lines.add(""); } writer.write(path, lines); diff --git a/pmd-doc/src/test/resources/expected/sample.md b/pmd-doc/src/test/resources/expected/sample.md index 66f2db4ada..c1119aab3e 100644 --- a/pmd-doc/src/test/resources/expected/sample.md +++ b/pmd-doc/src/test/resources/expected/sample.md @@ -21,6 +21,11 @@ Just some description of a deprecated rule. //ForStatement ``` +**Use this rule by referencing it:** +``` xml + +``` + ## JumbledIncrementer **Since:** PMD 1.0 @@ -58,6 +63,11 @@ public class JumbledIncrementerRule1 { |----|-------------|-----------| |sampleAdditionalProperty|the value|This is a additional property for tests| +**Use this rule by referencing it:** +``` xml + +``` + ## MovedRule Deprecated @@ -93,6 +103,11 @@ public class JumbledIncrementerRule1 { } ``` +**Use this rule by referencing it:** +``` xml + +``` + ## OverrideBothEqualsAndHashcode **Since:** PMD 0.4 @@ -132,6 +147,11 @@ public class Foo { // perfect, both methods provided } ``` +**Use this rule by referencing it:** +``` xml + +``` + ## RenamedRule Deprecated @@ -172,3 +192,8 @@ public class JumbledIncrementerRule1 { |Name|Default Value|Description| |----|-------------|-----------| |sampleAdditionalProperty|the value|This is a additional property for tests| + +**Use this rule by referencing it:** +``` xml + +```