SONAR-4915 add javadoc to RulesDefinition#setEffortToFixDescription(String)

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/server/rule/RulesDefinition.java b/sonar-plugin-api/src/main/java/org/sonar/api/server/rule/RulesDefinition.java
index c7bd5ce3c99145825a312d25ee0e5762e1fb8f0d..d2470d6eabf47c8862b589871d11bb5403644142 100644 (file)
--- a/sonar-plugin-api/src/main/java/org/sonar/api/server/rule/RulesDefinition.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/server/rule/RulesDefinition.java
@@ -614,6 +614,15 @@ public interface RulesDefinition extends ServerExtension {
       return this;
     }
 
+    /**
+     * For rules that use "Linear"/"Linear with offset" remediation functions, the meaning
+     * of the function parameter (= "effort to fix") must be set. This description
+     * explains what 1 point of "effort to fix" represents for the rule.
+     * <p/>
+     * Example : : for the "Insufficient branch coverage", this description for the
+     * remediation function coefficient/offset would be something like
+     * "Effort to test one uncovered branch".
+     */
     public NewRule setEffortToFixDescription(@Nullable String s) {
       this.effortToFixDescription = s;
       return this;