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

[doc] Fix how moved and deprecated rules are linked

Browse Source 
Text should be the old name, the link should point to the new name/rule
This commit is contained in:
Andreas Dangel
2017-11-24 09:28:05 +01:00
parent 70fc3d75bb
commit 3132080b83
3 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -262,8 +262,8 @@ public class RuleDocGenerator {
.replace("${language.tersename}", languageTersename)
.replace("${ruleset.name}", RuleSetUtils.getRuleSetFilename(ref.getRuleSetReference().getRuleSetFileName()));
rules.append("[").append(ref.getRule().getName()).append("](");
rules.append(otherLink).append("#").append(ref.getName().toLowerCase(Locale.ROOT)).append(")");
rules.append("[").append(ref.getName()).append("](");
rules.append(otherLink).append("#").append(ref.getRule().getName().toLowerCase(Locale.ROOT)).append(")");
} else {
rules.append(rule.getName());
}

2
pmd-doc/src/test/resources/expected/java.md
View File

@ -29,5 +29,5 @@ folder: pmd/rules
It contains the following rules:
[JumbledIncrementer](pmd_rules_java_sample.html#jumbledincrementer), [OverrideBothEqualsAndHashcode](pmd_rules_java_sample.html#overridebothequalsandhashcode)
[JumbledIncrementer](pmd_rules_java_sample.html#jumbledincrementer), [OldNameOfJumbledIncrementer](pmd_rules_java_sample.html#jumbledincrementer), [OverrideBothEqualsAndHashcode](pmd_rules_java_sample.html#overridebothequalsandhashcode)

3
pmd-doc/src/test/resources/rulesets/ruledoctest/sample-deprecated.xml
View File

@ -11,4 +11,7 @@ Sample ruleset which only contains deprecated rule references.
<rule ref="rulesets/ruledoctest/sample.xml/OverrideBothEqualsAndHashcode" deprecated="true" />
<rule ref="rulesets/ruledoctest/sample.xml/JumbledIncrementer" deprecated="true" />
<!-- both moved and renamed: -->
<rule ref="rulesets/ruledoctest/sample.xml/JumbledIncrementer" name="OldNameOfJumbledIncrementer" deprecated="true" />
</ruleset>