From 3f5dfa959b7c8c98af244472ab1e2024d5c94351 Mon Sep 17 00:00:00 2001
From: Simon Brandhof <simon.brandhof@gmail.com>
Date: Thu, 6 Jun 2013 23:02:32 +0200
Subject: [PATCH] Fix javadoc

---
 .../src/main/java/org/sonar/api/Property.java        |  2 +-
 .../org/sonar/api/batch/InstantiationStrategy.java   |  2 +-
 .../main/java/org/sonar/api/batch/SensorContext.java |  1 -
 .../main/java/org/sonar/api/batch/SonarIndex.java    |  1 -
 .../sonar/api/batch/bootstrap/ProjectDefinition.java |  2 +-
 .../java/org/sonar/api/measures/CoreMetrics.java     |  4 ++--
 .../src/main/java/org/sonar/api/measures/Metric.java |  7 +++++--
 .../src/main/java/org/sonar/api/profiles/Alert.java  |  1 -
 .../java/org/sonar/api/profiles/RulesProfile.java    |  3 ---
 .../java/org/sonar/api/resources/ProjectUtils.java   |  2 +-
 .../java/org/sonar/api/resources/ResourceType.java   |  1 -
 .../org/sonar/api/violations/ViolationQuery.java     |  2 --
 .../src/main/java/org/sonar/api/web/Criterion.java   | 12 ++++++------
 .../src/main/java/org/sonar/api/web/Filter.java      |  8 ++++----
 .../main/java/org/sonar/api/web/FilterColumn.java    |  4 ++--
 .../src/main/java/org/sonar/api/web/WidgetScope.java |  2 +-
 16 files changed, 24 insertions(+), 30 deletions(-)

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/Property.java b/sonar-plugin-api/src/main/java/org/sonar/api/Property.java
index 665b90685be..99531ed1354 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/Property.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/Property.java
@@ -64,7 +64,7 @@ public @interface Property {
 
   /**
    * @since 2.11
-   * @see org.sonar.api.config.PropertyDef.Builder#category(String)
+   * @see org.sonar.api.config.PropertyDefinition#category()
    */
   String category() default "";
 
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/InstantiationStrategy.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/InstantiationStrategy.java
index 52384aa3084..3dacc2fd6d3 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/InstantiationStrategy.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/InstantiationStrategy.java
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
 
 /**
  * Define instantiation strategy of batch extensions. If an extension is not annotated, then default value
- * is {@link org.sonar.api.batch.InstantiationStrategy#PROJECT}.
+ * is {@link org.sonar.api.batch.InstantiationStrategy#PER_PROJECT}.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
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 71d0658c1c4..3e459fce6ad 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
@@ -188,7 +188,6 @@ public interface SensorContext {
   /**
    * Save the source code of a file. The file must be have been indexed before.
    *
-   * @return false if the resource is excluded or not indexed
    * @throws org.sonar.api.resources.DuplicatedSourceException
    *          if the source has already been set on this resource
    * @since 1.10. Returns a boolean since 2.6.
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java
index bd2e50c564b..b1c3e8e79e4 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java
@@ -92,7 +92,6 @@ public abstract class SonarIndex implements DirectedGraphAccessor<Resource, Depe
    * Save the source code of a file. The file must be have been indexed before.
    * Note: the source stream is not closed.
    *
-   * @return false if the resource is excluded or not indexed
    * @throws org.sonar.api.resources.DuplicatedSourceException
    *          if the source has already been set on this resource
    */
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java
index e7b71317672..9adcaf049f7 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java
@@ -304,7 +304,7 @@ public class ProjectDefinition {
   /**
    * @param path path to directory with compiled source. In case of Java this is directory with class files.
    *             It can be absolute or relative to project directory.
-   * @TODO currently Sonar supports only one such directory due to dependency on MavenProject
+   *             TODO currently Sonar supports only one such directory due to dependency on MavenProject
    */
   public ProjectDefinition addBinaryDir(String path) {
     appendProperty(BINARIES_PROPERTY, path);
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/measures/CoreMetrics.java b/sonar-plugin-api/src/main/java/org/sonar/api/measures/CoreMetrics.java
index aa1c7683c67..68967655016 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/measures/CoreMetrics.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/measures/CoreMetrics.java
@@ -1302,7 +1302,7 @@ public final class CoreMetrics {
    * <p>
    * Here is the format (since Sonar 2.12):
    * <pre>
-   *   {@code<duplications>
+   *   <duplications>
    *     <!-- Multiple groups: -->
    *     <g>
    *       <!-- Multiple blocks: -->
@@ -1310,7 +1310,7 @@ public final class CoreMetrics {
    *       ...
    *     </g>
    *     ...
-   *   </duplications>}
+   *   </duplications>
    * </pre>
    * </p>
    */
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java b/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java
index 00e28dd643e..440d816b15c 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java
@@ -704,8 +704,11 @@ public class Metric implements ServerExtension, BatchExtension {
      * When a formula is set, sensors/decorators just need to store measures at a specific level and let Sonar run the formula to store
      * measures on the remaining levels.
      *
-     * @see {@link SumChildDistributionFormula}, {@link SumChildValuesFormula}, {@link AverageComplexityFormula}, {@link MeanAggregationFormula},
-     * {@link WeightedMeanAggregationFormula}
+     * @see SumChildDistributionFormula
+     * @see SumChildValuesFormula
+     * @see MeanAggregationFormula
+     * @see WeightedMeanAggregationFormula
+     * @see AverageComplexityFormula
      *
      * @param f the formula
      * @return the builder
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/profiles/Alert.java b/sonar-plugin-api/src/main/java/org/sonar/api/profiles/Alert.java
index 789aa429b11..8b377186b4e 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/profiles/Alert.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/profiles/Alert.java
@@ -231,7 +231,6 @@ public class Alert extends BaseIdentifiable implements Cloneable {
   }
 
   /**
-   * @see org.sonar.plugins.core.sensors.CheckAlertThresholds#getAlertLabel(Alert alert, Metric.Level level)
    * @deprecated since 3.4 because it does not manage alerts with variation
    */
   @Deprecated
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/profiles/RulesProfile.java b/sonar-plugin-api/src/main/java/org/sonar/api/profiles/RulesProfile.java
index c3bdf4bae09..08fae8fbca5 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/profiles/RulesProfile.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/profiles/RulesProfile.java
@@ -228,7 +228,6 @@ public class RulesProfile implements Cloneable {
   }
 
   /**
-   * @return
    * @deprecated since 3.3. Always return true.
    */
   @Deprecated
@@ -237,7 +236,6 @@ public class RulesProfile implements Cloneable {
   }
 
   /**
-   * @return
    * @deprecated since 3.3. Always return true.
    */
   @Deprecated
@@ -246,7 +244,6 @@ public class RulesProfile implements Cloneable {
   }
 
   /**
-   * @return
    * @deprecated since 3.3.
    */
   @Deprecated
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/resources/ProjectUtils.java b/sonar-plugin-api/src/main/java/org/sonar/api/resources/ProjectUtils.java
index 34ce5a1f0b2..fc75e6bab18 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/resources/ProjectUtils.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/resources/ProjectUtils.java
@@ -26,7 +26,7 @@ import java.util.Collection;
 import java.util.List;
 
 /**
- * @TODO Actually this class incorrectly named, because provides information not about project, but about Java project.
+ * TODO Actually this class incorrectly named, because provides information not about project, but about Java project.
  *       And seems that only core plugins use this class.
  * 
  * @since 1.10
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/resources/ResourceType.java b/sonar-plugin-api/src/main/java/org/sonar/api/resources/ResourceType.java
index e80e3f05406..d5aa6d2e402 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/resources/ResourceType.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/resources/ResourceType.java
@@ -49,7 +49,6 @@ import java.util.Map;
  * <li>"configurable" (since 3.6) : if true, the settings page can be displayed on the resource</li>
  * </ul>
  *
- * @see DefaultResourceTypes in Sonar Core Plugin to see the default resource types
  * @since 2.14
  */
 @Beta
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/violations/ViolationQuery.java b/sonar-plugin-api/src/main/java/org/sonar/api/violations/ViolationQuery.java
index 470e3929648..8b169aaaf23 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/violations/ViolationQuery.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/violations/ViolationQuery.java
@@ -66,8 +66,6 @@ public final class ViolationQuery {
 
   /**
    * Tells if the query should return only switched-off violations.
-   * 
-   * @return
    */
   public boolean isSwitchedOff() {
     return switchMode == SwitchMode.OFF;
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/Criterion.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/Criterion.java
index e266e48807c..a1e8cba29fa 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/web/Criterion.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/Criterion.java
@@ -27,7 +27,7 @@ import com.google.common.collect.ImmutableSortedSet;
 import java.util.Set;
 
 /**
- * Definition of a criterion to be used to narrow down a {@see Filter}.
+ * Definition of a criterion to be used to narrow down a {@link Filter}.
  *
  * @since 3.1
  */
@@ -60,7 +60,7 @@ public final class Criterion {
   /**
    * Creates a new {@link Criterion} with a numerical value.
    *
-   * <p>Valid values for the {@code operator} are {@value #EQ}, {@value #GT}, {@value #GTE}, {@value #LT} and {@value #LTE}</p>
+   * <p>Valid values for the {@code operator} are {@code #EQ}, {@code #GT}, {@code #GTE}, {@code #LT} and {@code #LTE}</p>
    *
    * @throws IllegalArgumentException if {@code operator} is not valid
    */
@@ -71,7 +71,7 @@ public final class Criterion {
   /**
    * Creates a new {@link Criterion} with a text value.
    *
-   * <p>Valid values for the {@code operator} are {@value #EQ}, {@value #GT}, {@value #GTE}, {@value #LT} and {@value #LTE}</p>
+   * <p>Valid values for the {@code operator} are {@code #EQ}, {@code #GT}, {@code #GTE}, {@code #LT} and {@code #LTE}</p>
    *
    * @throws IllegalArgumentException if {@code operator} is not valid
    */
@@ -82,7 +82,7 @@ public final class Criterion {
   /**
    * Creates a new {@link Criterion} on a metric, with a numerical value.
    *
-   * <p>Valid values for the {@code operator} are {@value #EQ}, {@value #GT}, {@value #GTE}, {@value #LT} and {@value #LTE}</p>
+   * <p>Valid values for the {@code operator} are {@code #EQ}, {@code #GT}, {@code #GTE}, {@code #LT} and {@code #LTE}</p>
    *
    * @throws IllegalArgumentException if {@code operator} is not valid
    */
@@ -93,7 +93,7 @@ public final class Criterion {
   /**
    * Creates a new {@link Criterion} on a metric, with a text value.
    *
-   * <p>Valid values for the {@code operator} are {@value #EQ}, {@value #GT}, {@value #GTE}, {@value #LT} and {@value #LTE}</p>
+   * <p>Valid values for the {@code operator} are {@code #EQ}, {@code #GT}, {@code #GTE}, {@code #LT} and {@code #LTE}</p>
    *
    * @throws IllegalArgumentException if {@code operator} is not valid
    */
@@ -129,7 +129,7 @@ public final class Criterion {
   /**
    * Get the the criterion's operator.
    *
-   * <p>Valid values for the {@code operator} are {@value #EQ}, {@value #GT}, {@value #GTE}, {@value #LT} and {@value #LTE}</p>
+   * <p>Valid values for the {@code operator} are {@code #EQ}, {@code #GT}, {@code #GTE}, {@code #LT} and {@code #LTE}</p>
    *
    * @return the operator
    */
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/Filter.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/Filter.java
index cc293f09c58..e7a5ffb6d2f 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/web/Filter.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/Filter.java
@@ -113,7 +113,7 @@ public final class Filter {
   /**
    * Get the type of display used by this {@link Filter}.
    * 
-   * <p>Can be either {@value #LIST} or {@value #TREEMAP}</p>
+   * <p>Can be either {@code #LIST} or {@code #TREEMAP}</p>
    * 
    * @return the display type
    */
@@ -124,10 +124,10 @@ public final class Filter {
   /**
    * Set the type of display used by this {@link Filter}.
    * 
-   * <p>Can be either {@value #LIST} or {@value #TREEMAP}</p>
+   * <p>Can be either {@code #LIST} or {@code #TREEMAP}</p>
    * 
    * @return this filter
-   * @throws IllegalArgumentException if {@code displayAs) is not {@value #LIST} or {@value #TREEMAP}
+   * @throws IllegalArgumentException if {@code displayAs} is not {@code #LIST} or {@code #TREEMAP}
    */
   public Filter setDisplayAs(String displayAs) {
     Preconditions.checkArgument(LIST.equals(displayAs) || TREEMAP.equals(displayAs), "Default display should be either %s or %s, not %s", LIST, TREEMAP, displayAs);
@@ -152,7 +152,7 @@ public final class Filter {
    * <p>The page size should be between <code>20</code> and <code>200</code> (included)</p>
    * 
    * @return the display type
-   * @throws IllegalArgumentException if {@code pageSize) is not lower than {@code 20} or greater than {@code 200}
+   * @throws IllegalArgumentException if {@code pageSize} is not lower than {@code 20} or greater than {@code 200}
    */
   public Filter setPageSize(int pageSize) {
     Preconditions.checkArgument((pageSize >= 20) && (pageSize <= 200), "page size should be between 20 and 200");
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/FilterColumn.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/FilterColumn.java
index 46b425fa813..bf7f23bd3a0 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/web/FilterColumn.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/FilterColumn.java
@@ -26,7 +26,7 @@ import java.util.Set;
 import com.google.common.base.Preconditions;
 
 /**
- * Definition of a {@see Filter} column.
+ * Definition of a {@link Filter} column.
  *
  * @since 3.1
  */
@@ -52,7 +52,7 @@ public final class FilterColumn {
   /**
    * Creates a new {@link FilterColumn}.
    *
-   * <p>Valid values for the {@code sortDirection} are {@value #ASC}, {@value #DESC}</p>
+   * <p>Valid values for the {@code sortDirection} are {@code #ASC}, {@code #DESC}</p>
    *
    * <p>When the @{see Filter} is persisted, a validation is made on the {@code family} and the {@code key}.
    * They should point to a valid column description.</p>
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetScope.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetScope.java
index 7bfc05b1710..4539143a656 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetScope.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/WidgetScope.java
@@ -25,7 +25,7 @@ import java.lang.annotation.*;
  * Depending on its scope, a widget can be available for project dashboards <code>(value = "PROJECT")</code>,
  * global dashboards <code>(value = "GLOBAL")</code> or both <code>(value = {"PROJECT", "GLOBAL"})</code>.
  * 
- * <p>Before version 3.1 all widget had a scope <code>"PROJECT"</code>. If a widget is not annotated with {@WidgetScope},
+ * <p>Before version 3.1 all widget had a scope <code>"PROJECT"</code>. If a widget is not annotated with @WidgetScope,
  * then is is assumed project scoped.</p>
  *
  * @since 3.1
-- 
2.39.5