]> source.dussan.org Git - sonarqube.git/commitdiff
Fix some javadoc
authorSimon Brandhof <simon.brandhof@sonarsource.com>
Fri, 3 Oct 2014 15:54:24 +0000 (17:54 +0200)
committerSimon Brandhof <simon.brandhof@sonarsource.com>
Fri, 3 Oct 2014 15:54:24 +0000 (17:54 +0200)
16 files changed:
server/sonar-ws-client/src/main/java/org/sonar/wsclient/connectors/HttpClient4Connector.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/measure/Metric.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/measure/MetricFinder.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/SensorContext.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/duplication/DuplicationBuilder.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/duplication/DuplicationGroup.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/duplication/DuplicationTokenBuilder.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/highlighting/HighlightingBuilder.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/highlighting/TypeOfText.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/symbol/Symbol.java
sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/symbol/SymbolTableBuilder.java
sonar-plugin-api/src/main/java/org/sonar/api/measures/MetricFinder.java
sonar-plugin-api/src/main/java/org/sonar/api/source/Highlightable.java
sonar-plugin-api/src/main/java/org/sonar/api/source/Symbol.java
sonar-plugin-api/src/main/java/org/sonar/api/source/Symbolizable.java
sonar-plugin-api/src/main/java/org/sonar/api/web/NavigationSection.java

index 8fa546978d9bfe8abcd31571922d94b3330a5258..8d3c5e8a1d81e67efd40ed08e437ba9271ab7792 100644 (file)
@@ -203,6 +203,7 @@ public class HttpClient4Connector extends Connector {
 
     static final String ATTRIBUTE = "preemptive-auth";
 
+    @Override
     public void process(
       final HttpRequest request,
       final HttpContext context) throws HttpException {
index e5e4f98953be75b9ce03eedabc842cb191728b8a..95e3828abb9ef8ce8c07effd7b016130e7976e3f 100644 (file)
@@ -24,7 +24,7 @@ import com.google.common.annotations.Beta;
 import java.io.Serializable;
 
 /**
- * Metric definition.
+ * Experimental - do not use
  * @since 4.4
  */
 @Beta
index 4f91ea5aae422f182717e895e416079545cdf2ac..79967526386973af38560b757bf311e47c8e8cb9 100644 (file)
@@ -19,6 +19,7 @@
  */
 package org.sonar.api.batch.measure;
 
+import com.google.common.annotations.Beta;
 import org.sonar.api.BatchComponent;
 
 import javax.annotation.CheckForNull;
@@ -27,8 +28,10 @@ import java.util.Collection;
 import java.util.List;
 
 /**
+ * Experimental - do not use
  * @since 4.5
  */
+@Beta
 public interface MetricFinder extends BatchComponent {
 
   @CheckForNull
index 7465126c3e1c02339626683bebc60d792ae05671..0e877c8bfc7633b55aca395fdf83518c86836fb8 100644 (file)
@@ -41,6 +41,7 @@ import java.io.Serializable;
 import java.util.List;
 
 /**
+ * Experimental - do not use
  * @since 4.4
  */
 @Beta
index aa27ff41b284a74407ccc61314fd288ae1f80766..691fff2dc456e29cabdc2a05dd7485afe3e49817 100644 (file)
  */
 package org.sonar.api.batch.sensor.duplication;
 
+import com.google.common.annotations.Beta;
 import org.sonar.api.batch.fs.InputFile;
 
 import java.util.List;
 
 /**
+ * Experimental, do not use.
+ * <p/>
  * This builder is used to declare duplications on files of the project.
  * Usage:
  * <code><pre>
@@ -38,6 +41,7 @@ import java.util.List;
  * </pre></code>
  * @since 4.5
  */
+@Beta
 public interface DuplicationBuilder {
 
   /**
index 5d3d833a906517602a6b93f98f88ac33c79817e7..82f866deea58bfe59c16a7f28c9cf102d1e01081 100644 (file)
@@ -19,6 +19,7 @@
  */
 package org.sonar.api.batch.sensor.duplication;
 
+import com.google.common.annotations.Beta;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
 import org.apache.commons.lang.builder.ToStringBuilder;
@@ -29,12 +30,15 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
+ * Experimental, do not use.
+ * <p/>
  * A {@link DuplicationGroup} is a list of duplicated {@link Block}s. One block
  * is considered as the original code and all others are duplicates.
  * Use {@link SensorContext#duplicationBuilder(org.sonar.api.batch.fs.InputFile)} and
  * {@link SensorContext#saveDuplications(org.sonar.api.batch.fs.InputFile, List)}.
  * @since 4.5
  */
+@Beta
 public class DuplicationGroup {
 
   public static class Block {
index 6dfd437c5527454d45e349847288bd8b6025570f..d43c5d216fda557e1d40505ec004193820614c1c 100644 (file)
 package org.sonar.api.batch.sensor.duplication;
 
 
+import com.google.common.annotations.Beta;
+
 /**
+ * Experimental, do not use.
+ * <p/>
  * This builder is used to define token on files. Tokens are later used to compute duplication.
  * Tokens should be declared in sequential order.
  * Example:
@@ -35,6 +39,7 @@ package org.sonar.api.batch.sensor.duplication;
  * </pre></code>
  * @since 4.5
  */
+@Beta
 public interface DuplicationTokenBuilder {
 
   /**
index d969ba49a03ab6223cb7097212f3aa68e2925136..aef7d5393a71d52f1cdac3caa32605a58bfd990a 100644 (file)
  */
 package org.sonar.api.batch.sensor.highlighting;
 
+import com.google.common.annotations.Beta;
+
 /**
+ * Experimental, do not use.
+ * <p/>
  * This builder is used to define syntax highlighting (aka code coloration) on files.
  * @since 4.5
  */
+@Beta
 public interface HighlightingBuilder {
 
   /**
index ae42794405298894b12bf5bae94f5bba614f3ea1..16064019c91e834c81c17066979b98bb887adfb7 100644 (file)
  */
 package org.sonar.api.batch.sensor.highlighting;
 
+import com.google.common.annotations.Beta;
+
 /**
- * Possible types for highlighting code.
- * See sonar-colorizer.css
+ * Experimental, do not use.
+ * <p/>
+ * Possible types for highlighting code. See sonar-colorizer.css
  * @since 4.5
  */
+@Beta
 public enum TypeOfText {
   ANNOTATION("a"),
   CONSTANT("c"),
index 9e1e3e8259e88903aaec210cd2feda73eb5d16f3..72f0bf92980d54c2c91a4987e028b7fa04faa21c 100644 (file)
 
 package org.sonar.api.batch.sensor.symbol;
 
+import com.google.common.annotations.Beta;
+
 /**
- * Represent a symbol in a source file.
+ * Represent a symbol in a source file. Experimental, do not use
  * @since 4.5
  */
+@Beta
 public interface Symbol {
 
   int getDeclarationStartOffset();
index 3be82175d4217ec4a8904ed28dde9df4bda612ce..e9ebd8c72fc0196f0bf7c75d33aba31d7bf2e495 100644 (file)
  */
 package org.sonar.api.batch.sensor.symbol;
 
+import com.google.common.annotations.Beta;
+
 /**
+ * Experimental, do not use.
+ * <p/>
  * Use this builder to create symbol references. For now only references
  * in the same file are supported.
  * @since 4.5
  */
+@Beta
 public interface SymbolTableBuilder {
 
   /**
index 5d9aefd60136a9194debaafe653a8945ec503f1b..c6f68aaedce932651085d0e8987671e78b20c777 100644 (file)
@@ -29,9 +29,7 @@ import java.util.List;
 
 /**
  * @since 2.5
- * @deprecated since 4.5 use {@link org.sonar.api.batch.measure.MetricFinder} on batch side
  */
-@Deprecated
 public interface MetricFinder extends TaskComponent, ServerComponent {
 
   @CheckForNull
index 6d5bd6bd14df8a39571e84bd9f11d343bb2cb535..0ab229be03c6e77512b7f75583eebd1f677ce532 100644 (file)
  */
 package org.sonar.api.source;
 
-import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.api.component.Perspective;
 
 /**
  * @since 3.6
- * @deprecated since 4.5 use {@link SensorContext#highlightingBuilder(org.sonar.api.batch.fs.InputFile)}
  */
-@Deprecated
 public interface Highlightable extends Perspective {
 
   interface HighlightingBuilder {
index 31702ecb065cdd5818e97df47f8e408f552677c7..9aa8ae26900c6703f14dd3d72859341c92df4f38 100644 (file)
 
 package org.sonar.api.source;
 
-/**
- * @deprecated since 4.5 replaced by {@link org.sonar.api.batch.sensor.symbol.Symbol}
- */
-@Deprecated
 public interface Symbol extends org.sonar.api.batch.sensor.symbol.Symbol {
 
   @Override
index 0b7f765cfe7678ff080fa8f0abd3abd36bef6065..3a49ada34df770e5b5adb15a9af12c8f0938e763 100644 (file)
  */
 package org.sonar.api.source;
 
-import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.api.component.Perspective;
 
 import java.util.List;
 
 /**
  * @since 3.6
- * @deprecated since 4.5 use {@link SensorContext#symbolTableBuilder(org.sonar.api.batch.fs.InputFile)}
  */
-@Deprecated
 public interface Symbolizable extends Perspective {
 
   interface SymbolTableBuilder {
index 9786e2fb6f5d5755276b5509d517b173033cf931..19b43b0bc40f0b36d5a0375678a9bcf38a3758ea 100644 (file)
@@ -37,7 +37,7 @@ public @interface NavigationSection {
   String RESOURCE = "resource";
 
   /**
-   * @deprecated since 4.5, as it costs too much to maintain and update.
+   * @deprecated in 4.5, as it costs too much to maintain and update.
    * @see <a href="https://jira.codehaus.org/browse/SONAR-5321">SONAR-5321</a>
    */
   @Deprecated