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

Add comments and update release notes

Browse Source
This commit is contained in:
Clément Fournier 2019-12-05 15:23:07 +01:00
parent bb7478cd0a
commit eb6ceef085
11 changed files with 38 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/pages/release_notes.md
View File

@ -18,6 +18,12 @@ This is a {{ site.pmd.release_type }} release.
### API Changes
#### Deprecated APIs
* Implementations of {% jdoc core::lang.rule.RuleViolationFactory %} in each language module, eg {% jdoc java::lang.java.rule.JavaRuleViolationFactory %}.
### External Contributions
{% endtocmaker %}

4
pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolationFactory.java
View File

@ -10,7 +10,11 @@ import net.sourceforge.pmd.RuleViolation;
import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class ApexRuleViolationFactory extends AbstractRuleViolationFactory {

5
pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/RuleViolationFactory.java
View File

@ -6,11 +6,16 @@ package net.sourceforge.pmd.lang.rule;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.lang.LanguageVersionHandler;
import net.sourceforge.pmd.lang.ast.Node;
/**
* This class handles of producing a Language specific RuleViolation and adding
* to a Report.
*
* <p>Since PMD 6.21.0, implementations of this interface are considered internal
* API and hence deprecated. Clients should exclusively use this interface and obtain
* instances through {@link LanguageVersionHandler#getRuleViolationFactory()}.
*/
public interface RuleViolationFactory {
/**

3
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/JavaRuleViolationFactory.java
View File

@ -13,6 +13,9 @@ import net.sourceforge.pmd.lang.java.ast.JavaNode;
import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class JavaRuleViolationFactory extends AbstractRuleViolationFactory {

4
pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/rule/EcmascriptRuleViolationFactory.java
View File

@ -12,7 +12,11 @@ import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.ecmascript.ast.EcmascriptNode;
import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class EcmascriptRuleViolationFactory extends AbstractRuleViolationFactory {

3
pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/rule/JspRuleViolationFactory.java
View File

@ -14,6 +14,9 @@ import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class JspRuleViolationFactory extends AbstractRuleViolationFactory {

3
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/PLSQLRuleViolationFactory.java
View File

@ -13,6 +13,9 @@ import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class PLSQLRuleViolationFactory extends AbstractRuleViolationFactory {

2
pmd-scala/src/main/java/net/sourceforge/pmd/lang/scala/rule/ScalaRuleViolationFactory.java
View File

@ -14,7 +14,7 @@ import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
/**
* A RuleViolationFactory for Scala.
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi

3
pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/rule/VfRuleViolationFactory.java
View File

@ -14,6 +14,9 @@ import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
import net.sourceforge.pmd.lang.vf.ast.VfNode;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class VfRuleViolationFactory extends AbstractRuleViolationFactory {

3
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/VmRuleViolationFactory.java
View File

@ -14,6 +14,9 @@ import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
import net.sourceforge.pmd.lang.vm.ast.AbstractVmNode;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class VmRuleViolationFactory extends AbstractRuleViolationFactory {

3
pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/rule/XmlRuleViolationFactory.java
View File

@ -14,6 +14,9 @@ import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
import net.sourceforge.pmd.lang.xml.ast.XmlNode;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class XmlRuleViolationFactory extends AbstractRuleViolationFactory {