From: Simon Brandhof <simon.brandhof@sonarsource.com>
Date: Fri, 3 Oct 2014 14:43:20 +0000 (+0200)
Subject: Fix some javadoc
X-Git-Tag: 4.5.1-RC1~111
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=ebce7079f522bb5d509cb46577b0b0813b788cd5;p=sonarqube.git

Fix some javadoc
---

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/DecoratorContext.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/DecoratorContext.java
index 5d13d0ac7da..be4b1e0cd70 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/DecoratorContext.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/DecoratorContext.java
@@ -108,14 +108,18 @@ public interface DecoratorContext {
    * @param violationQuery
    *          the request parameters specified as a {@link ViolationQuery}
    * @return the list of violations that match those parameters
+   * @deprecated in 3.6, replaced by {@link org.sonar.api.issue.Issuable}
    */
+  @Deprecated
   List<Violation> getViolations(ViolationQuery violationQuery);
 
   /**
    * Returns all the active (= non switched-off) violations found on the current resource.
    * 
    * @return the list of violations
+   * @deprecated in 3.6, replaced by {@link org.sonar.api.issue.Issuable}
    */
+  @Deprecated
   List<Violation> getViolations();
 
   /**
@@ -123,12 +127,16 @@ public interface DecoratorContext {
    * 
    * @since 2.5
    * @param force allows to force creation of violation even if it was suppressed by {@link org.sonar.api.rules.ViolationFilter}
+   * @deprecated in 3.6, replaced by {@link org.sonar.api.issue.Issuable}
    */
+  @Deprecated
   DecoratorContext saveViolation(Violation violation, boolean force);
 
   /**
    * Save a coding rule violation. The decorator which calls this method must be depended upon BatchBarriers.END_OF_VIOLATIONS_GENERATION.
+   * @deprecated in 3.6, replaced by {@link org.sonar.api.issue.Issuable}
    */
+  @Deprecated
   DecoratorContext saveViolation(Violation violation);
 
   // EVENTS
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/Sensor.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/Sensor.java
index 7a82bc24015..fc055e6da5c 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/Sensor.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/Sensor.java
@@ -40,9 +40,7 @@ import org.sonar.api.resources.Project;
  * </p>
  *
  * @since 1.10
- * @deprecated since 4.5 use {@link org.sonar.api.batch.sensor.Sensor}
  */
-@Deprecated
 public interface Sensor extends BatchExtension, CheckProject {
 
   /**
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/SensorContext.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/SensorContext.java
index adf80cf8cf8..c76eaf47138 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/SensorContext.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/SensorContext.java
@@ -19,6 +19,7 @@
  */
 package org.sonar.api.batch;
 
+import com.google.common.annotations.Beta;
 import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.design.Dependency;
 import org.sonar.api.measures.Measure;
@@ -38,9 +39,7 @@ import java.util.Set;
 
 /**
  * @since 1.10
- * @deprecated since 4.5
  */
-@Deprecated
 public interface SensorContext {
 
   /**
@@ -170,17 +169,23 @@ public interface SensorContext {
    *
    * @param force allows to force creation of violation even if it was supressed by {@link org.sonar.api.rules.ViolationFilter}
    * @since 2.5
+   * @deprecated in 3.6, replaced by {@link org.sonar.api.issue.Issuable}
    */
+  @Deprecated
   void saveViolation(Violation violation, boolean force);
 
   /**
    * Save a coding rule violation.
+   * @deprecated in 3.6, replaced by {@link org.sonar.api.issue.Issuable}
    */
+  @Deprecated
   void saveViolation(Violation violation);
 
   /**
    * Saves a list of violations.
+   * @deprecated in 3.6, replaced by {@link org.sonar.api.issue.Issuable}
    */
+  @Deprecated
   void saveViolations(Collection<Violation> violations);
 
   // ----------- DEPENDENCIES BETWEEN RESOURCES --------------
@@ -247,14 +252,16 @@ public interface SensorContext {
   void deleteEvent(Event event);
 
   /**
-   * Experimental
+   * Experimental - do not use
    * @since 4.2
    */
+  @Beta
   Measure saveMeasure(InputFile inputFile, Metric metric, Double value);
 
   /**
-   * Experimental
+   * Experimental - do not use
    * @since 4.2
    */
+  @Beta
   Measure saveMeasure(InputFile inputFile, Measure measure);
 }
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/maven/DependsUponMavenPlugin.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/maven/DependsUponMavenPlugin.java
index 87b75459373..0e590c84593 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/maven/DependsUponMavenPlugin.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/maven/DependsUponMavenPlugin.java
@@ -33,9 +33,7 @@ import org.sonar.api.resources.Project;
  * </p>
  * 
  * @since 1.10
- * @deprecated since 4.5 we don't want any dependency on Maven anymore
  */
-@Deprecated
 @SupportedEnvironment("maven")
 public interface DependsUponMavenPlugin extends BatchExtension {
 
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/rule/ActiveRules.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/rule/ActiveRules.java
index 20a2fb19a4e..e717c35d83a 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/rule/ActiveRules.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/rule/ActiveRules.java
@@ -57,9 +57,7 @@ public interface ActiveRules extends BatchComponent {
 
   /**
    * The active rules for a given language, like <code>java</code>
-   * @deprecated since 4.5 Not sure rules will continue to be linked to a language
    */
-  @Deprecated
   Collection<ActiveRule> findByLanguage(String language);
 
   /**