[doc] Fixes from PR review

This commit is contained in:
Andreas Dangel
2017-08-17 19:57:58 +02:00
parent c8c4b73c80
commit b3f04079d6
4 changed files with 71 additions and 61 deletions

View File

@ -84,3 +84,7 @@ folder: pmd/devdocs
* For each rule in this set you want to test, call `addRule` method in setUp of the unit test
* This triggers the unit test to read the corresponding XML file with rule test data *(see `EmptyForeachStmtRule.xml` for example)*
* This test XML file contains sample pieces of code which should trigger a specified number of violations of this rule. The unit test will execute the rule on this piece of code, and verify that the number of violations matches
* To verify the validity of the created ruleset, create a subclass of `AbstractRuleSetFactoryTest` (*see `RuleSetFactoryTest` in pmd-vm for example)*.
This will load all rulesets and verify, that all required attributes are provided.
*Note:* You'll need to add your ruleset to `rulesets.properties`, so that it can be found.

View File

@ -10,7 +10,7 @@ folder: pmd/devdocs
# XPath Rule tutorial
{% include note.html content="For a translation to Gregorian, see [webhostinggeeks.com/science/xpath-sourceforge-ka](http://webhostinggeeks.com/science/xpath-sourceforge-ka)" %}
{% include note.html content="For a translation to Georgian, see [webhostinggeeks.com/science/xpath-sourceforge-ka](http://webhostinggeeks.com/science/xpath-sourceforge-ka)" %}
Writing PMD rules with XPath can be a bit easier than writing rules with Java code. Heres an introduction on how to do that.

View File

@ -141,6 +141,12 @@ All existing rules have been updated to reflect these changes. If you have custo
* The properties API (rule and report properties) have been revamped to be fully typesafe. This is everything
around `net.sourceforge.pmd.PropertyDescriptor`.
* The rule classes `net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestClassShouldHaveAsserts`
and `net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestShouldNotUseSeeAllDataTrue` have been
renamed to `ApexUnitTestClassShouldHaveAssertsRule` and `ApexUnitTestShouldNotUseSeeAllDataTrueRule`,
respectively. This is to comply with the naming convention, that each rule class should be suffixed with "Rule".
This change has no impact on custom rulesets, since the rule names themselves didn't change.
### External Contributions
* [#420](https://github.com/pmd/pmd/pull/420): \[java] Fix UR anomaly in assert statements - [Clément Fournier](https://github.com/oowekyala)

File diff suppressed because it is too large Load Diff