/**
* @since 2.11
- * @see org.sonar.api.config.PropertyDef.Builder#category(String)
+ * @see org.sonar.api.config.PropertyDefinition#category()
*/
String category() default "";
/**
* 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)
/**
* 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.
* 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
*/
/**
* @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);
* <p>
* Here is the format (since Sonar 2.12):
* <pre>
- * {@code<duplications>
+ * <duplications>
* <!-- Multiple groups: -->
* <g>
* <!-- Multiple blocks: -->
* ...
* </g>
* ...
- * </duplications>}
+ * </duplications>
* </pre>
* </p>
*/
* 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
}
/**
- * @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
}
/**
- * @return
* @deprecated since 3.3. Always return true.
*/
@Deprecated
}
/**
- * @return
* @deprecated since 3.3. Always return true.
*/
@Deprecated
}
/**
- * @return
* @deprecated since 3.3.
*/
@Deprecated
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
* <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
/**
* Tells if the query should return only switched-off violations.
- *
- * @return
*/
public boolean isSwitchedOff() {
return switchMode == SwitchMode.OFF;
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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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);
* <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");
import com.google.common.base.Preconditions;
/**
- * Definition of a {@see Filter} column.
+ * Definition of a {@link Filter} column.
*
* @since 3.1
*/
/**
* 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>
* 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
projects / sonarqube.git / commitdiff