aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api
diff options
context:
space:
mode:
authorTeryk Bellahsene <teryk.bellahsene@sonarsource.com>2016-11-11 17:28:23 +0100
committerTeryk Bellahsene <teryk.bellahsene@sonarsource.com>2016-11-11 17:28:23 +0100
commit95d094ea70b63f2102b253d136aeaad33bdedf92 (patch)
tree176d8251db203a09b2905ef25814a11497d87ba7 /sonar-plugin-api
parent5f19514f1f4e4e7c3ee5ff27a08c6ab1b03027ec (diff)
downloadsonarqube-95d094ea70b63f2102b253d136aeaad33bdedf92.tar.gz
sonarqube-95d094ea70b63f2102b253d136aeaad33bdedf92.zip
SONAR-8328 SONAR-4872 Deprecate and Hide metrics public_api, public_documented_api_density and public_undocumented_api
Diffstat (limited to 'sonar-plugin-api')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/measures/CoreMetrics.java18
1 files changed, 18 insertions, 0 deletions
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 b24f91024ce..72a4ec7fd02 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
@@ -233,12 +233,18 @@ public final class CoreMetrics {
.setDomain(DOMAIN_SIZE)
.create();
+ /**
+ * @deprecated since 6.2
+ * @see <a href="https://jira.sonarsource.com/browse/SONAR-8328">SONAR-8328</a>
+ */
+ @Deprecated
public static final String PUBLIC_API_KEY = "public_api";
public static final Metric<Integer> PUBLIC_API = new Metric.Builder(PUBLIC_API_KEY, "Public API", Metric.ValueType.INT)
.setDescription("Public API")
.setDirection(Metric.DIRECTION_WORST)
.setQualitative(false)
.setDomain(DOMAIN_DOCUMENTATION)
+ .setHidden(true)
.create();
/**
@@ -278,6 +284,11 @@ public final class CoreMetrics {
.setDomain(DOMAIN_DOCUMENTATION)
.create();
+ /**
+ * @deprecated since 6.2
+ * @see <a href="https://jira.sonarsource.com/browse/SONAR-8328">SONAR-8328</a>
+ */
+ @Deprecated
public static final String PUBLIC_DOCUMENTED_API_DENSITY_KEY = "public_documented_api_density";
public static final Metric<Double> PUBLIC_DOCUMENTED_API_DENSITY = new Metric.Builder(PUBLIC_DOCUMENTED_API_DENSITY_KEY, "Public Documented API (%)", Metric.ValueType.PERCENT)
.setDescription("Public documented classes and functions balanced by ncloc")
@@ -287,8 +298,14 @@ public final class CoreMetrics {
.setWorstValue(0.0)
.setBestValue(100.0)
.setOptimizedBestValue(true)
+ .setHidden(true)
.create();
+ /**
+ * @deprecated since 6.2
+ * @see <a href="https://jira.sonarsource.com/browse/SONAR-8328">SONAR-8328</a>
+ */
+ @Deprecated
public static final String PUBLIC_UNDOCUMENTED_API_KEY = "public_undocumented_api";
public static final Metric<Integer> PUBLIC_UNDOCUMENTED_API = new Metric.Builder(PUBLIC_UNDOCUMENTED_API_KEY, "Public Undocumented API", Metric.ValueType.INT)
.setDescription("Public undocumented classes, functions and variables")
@@ -298,6 +315,7 @@ public final class CoreMetrics {
.setBestValue(0.0)
.setDirection(Metric.DIRECTION_WORST)
.setOptimizedBestValue(true)
+ .setHidden(true)
.create();
/**