Add description to core widgets

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/AlertsWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/AlertsWidget.java
index c30344f2c5f552556a5c119a7066db9e99dc82f0..604b491b4365369db2932e0e41ad0fb5846ede72 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/AlertsWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/AlertsWidget.java
@@ -20,15 +20,16 @@
 package org.sonar.plugins.core.widgets;\r
 \r
 import org.sonar.api.web.AbstractRubyTemplate;\r
+import org.sonar.api.web.Description;\r
 import org.sonar.api.web.RubyRailsWidget;\r
 \r
+@Description("Display current alerts on the project.")\r
 public class AlertsWidget extends AbstractRubyTemplate implements RubyRailsWidget {\r
   public String getId() {\r
     return "alerts";\r
   }\r
 \r
   public String getTitle() {\r
-    // not used for the moment by widgets.\r
     return "Alerts";\r
   }\r
 \r

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CodeCoverageWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CodeCoverageWidget.java
index 6e9baa8494d885e674b58332ebf47e505ea78eeb..fc028d5b8cff83bfbf90f2f1a2800b23eadaea0f 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CodeCoverageWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CodeCoverageWidget.java
@@ -22,13 +22,13 @@ package org.sonar.plugins.core.widgets;
 import org.sonar.api.web.*;\r
 \r
 @WidgetCategory({"Tests"})\r
+@Description("Reports on units tests and code coverage by unit tests.")\r
 public class CodeCoverageWidget extends AbstractRubyTemplate implements RubyRailsWidget {\r
   public String getId() {\r
     return "code_coverage";\r
   }\r
 \r
   public String getTitle() {\r
-    // not used for the moment by widgets.\r
     return "Code coverage";\r
   }\r
 \r

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CommentsDuplicationsWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CommentsDuplicationsWidget.java
index 2d3fcaaac3d7d9db766709c66eae287727954137..6244640336674767ae7d5b0d5375f966b4670d71 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CommentsDuplicationsWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CommentsDuplicationsWidget.java
@@ -20,15 +20,16 @@
 package org.sonar.plugins.core.widgets;\r
 \r
 import org.sonar.api.web.AbstractRubyTemplate;\r
+import org.sonar.api.web.Description;\r
 import org.sonar.api.web.RubyRailsWidget;\r
 \r
+@Description("Reports on copy/paste and documentation")\r
 public class CommentsDuplicationsWidget extends AbstractRubyTemplate implements RubyRailsWidget {\r
   public String getId() {\r
     return "comments_duplications";\r
   }\r
 \r
   public String getTitle() {\r
-    // not used for the moment by widgets.\r
     return "Comments & Duplications";\r
   }\r
 \r

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CustomMeasuresWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CustomMeasuresWidget.java
index b664ae3a6f347c2337a9029c7cc52a9076221cf8..84d99a7f63c1d67bc7e223a71c39b9b2bc0a0e7b 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CustomMeasuresWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/CustomMeasuresWidget.java
@@ -20,15 +20,16 @@
 package org.sonar.plugins.core.widgets;
 
 import org.sonar.api.web.AbstractRubyTemplate;
+import org.sonar.api.web.Description;
 import org.sonar.api.web.RubyRailsWidget;
 
+@Description("Displays manual measures entered on the project.")
 public class CustomMeasuresWidget extends AbstractRubyTemplate implements RubyRailsWidget {
   public String getId() {
     return "custom_measures";
   }
 
   public String getTitle() {
-    // not used for the moment by widgets.
     return "Custom measures";
   }
 

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DefaultExtendedAnalysisWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DefaultExtendedAnalysisWidget.java
index 516b910653cc78f739f35c195ae7e7144e29b7a1..509f51c5b14fff8e91ee8a953b11ccd36813550a 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DefaultExtendedAnalysisWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DefaultExtendedAnalysisWidget.java
@@ -20,16 +20,17 @@
 package org.sonar.plugins.core.widgets;\r
 \r
 import org.sonar.api.web.AbstractRubyTemplate;\r
+import org.sonar.api.web.Description;\r
 import org.sonar.api.web.RubyRailsWidget;\r
 \r
+@Description("Reports on complexity, average complexity and complexity distribution.")\r
 public class DefaultExtendedAnalysisWidget extends AbstractRubyTemplate implements RubyRailsWidget {\r
   public String getId() {\r
     return "extended_analysis";\r
   }\r
 \r
   public String getTitle() {\r
-    // not used for the moment by widgets.\r
-    return "Extended analysis";\r
+    return "Complexity";\r
   }\r
 \r
   @Override\r

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DefaultStaticAnalysisWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DefaultStaticAnalysisWidget.java
index 9c10430c7744932b49c815f0930cc01e136156dd..69ddfc62b0ba60fc020b5a57486ae2a3babe6472 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DefaultStaticAnalysisWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DefaultStaticAnalysisWidget.java
@@ -20,16 +20,17 @@
 package org.sonar.plugins.core.widgets;\r
 \r
 import org.sonar.api.web.AbstractRubyTemplate;\r
+import org.sonar.api.web.Description;\r
 import org.sonar.api.web.RubyRailsWidget;\r
 \r
+@Description("Reports general metrics on the size of the project.")\r
 public class DefaultStaticAnalysisWidget extends AbstractRubyTemplate implements RubyRailsWidget {\r
   public String getId() {\r
     return "static_analysis";\r
   }\r
 \r
   public String getTitle() {\r
-    // not used for the moment by widgets.\r
-    return "Static analysis";\r
+    return "Size metrics";\r
   }\r
 \r
   @Override\r

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DescriptionWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DescriptionWidget.java
index 0c191d9f7512f1b015919df6e65758f201f57878..52f47b03b62b6a98bed6fb226d441a6e17f9b677 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DescriptionWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/DescriptionWidget.java
@@ -20,15 +20,16 @@
 package org.sonar.plugins.core.widgets;\r
 \r
 import org.sonar.api.web.AbstractRubyTemplate;\r
+import org.sonar.api.web.Description;\r
 import org.sonar.api.web.RubyRailsWidget;\r
 \r
+@Description("Displays general project information taken from the pom.xml")\r
 public class DescriptionWidget extends AbstractRubyTemplate implements RubyRailsWidget {\r
   public String getId() {\r
     return "description";\r
   }\r
 \r
   public String getTitle() {\r
-    // not used for the moment by widgets.\r
     return "Description";\r
   }\r
 \r

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/EventsWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/EventsWidget.java
index 547bc2f01a4a9d26db737261f412c38e9de46f55..0da901088b665665808ddc86108bc8d5499a6bbb 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/EventsWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/EventsWidget.java
@@ -20,15 +20,16 @@
 package org.sonar.plugins.core.widgets;
 
 import org.sonar.api.web.AbstractRubyTemplate;
+import org.sonar.api.web.Description;
 import org.sonar.api.web.RubyRailsWidget;
 
+@Description("Reports events on the project life cycle such as versions and alerts.")
 public class EventsWidget extends AbstractRubyTemplate implements RubyRailsWidget {
   public String getId() {
     return "events";
   }
 
   public String getTitle() {
-    // not used for the moment by widgets.
     return "Events";
   }
 

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/RulesWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/RulesWidget.java
index b43247140c8495eea1545892e2f1d92e91b57e54..d9d166aefdada24c827bcf435d638e81ac8b2300 100644 (file)
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/RulesWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/RulesWidget.java
@@ -22,14 +22,14 @@ package org.sonar.plugins.core.widgets;
 import org.sonar.api.web.*;\r
 \r
 @WidgetCategory({"Rules"})\r
+@Description("Reports violations and compliance index on coding standards.")\r
 public class RulesWidget extends AbstractRubyTemplate implements RubyRailsWidget {\r
   public String getId() {\r
     return "rules";\r
   }\r
 \r
   public String getTitle() {\r
-    // not used for the moment by widgets.\r
-    return "Rules";\r
+    return "Rules Compliance";\r
   }\r
 \r
   @Override\r

diff --git a/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/ChidamberKemererWidget.java b/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/ChidamberKemererWidget.java
index 0bbcbcec6c6cdf0ade732aac047f68217cbf64bf..90345b27db85dab7000cc3879b2f3bf3c37e9d36 100644 (file)
--- a/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/ChidamberKemererWidget.java
+++ b/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/ChidamberKemererWidget.java
@@ -19,13 +19,11 @@
  */
 package org.sonar.plugins.design.ui.widgets;
 
-import org.sonar.api.web.AbstractRubyTemplate;
-import org.sonar.api.web.RubyRailsWidget;
-import org.sonar.api.web.UserRole;
-import org.sonar.api.web.WidgetCategory;
+import org.sonar.api.web.*;
 
 @UserRole(UserRole.USER)
 @WidgetCategory({"Design"})
+@Description("Reports on LCOM4 and RFC average and distribution.")
 public final class ChidamberKemererWidget extends AbstractRubyTemplate implements RubyRailsWidget {
   public String getId() {
     return "ckjm";

diff --git a/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/FileDesignWidget.java b/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/FileDesignWidget.java
index bd6bda2aaeea13c0d939c574f3c32eb090bbbfb2..c4009c9dd7bb1825b7e5a26933ce21c5cb126eea 100644 (file)
--- a/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/FileDesignWidget.java
+++ b/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/FileDesignWidget.java
@@ -19,11 +19,11 @@
  */
 package org.sonar.plugins.design.ui.widgets;
 
-import org.sonar.api.web.AbstractRubyTemplate;
-import org.sonar.api.web.RubyRailsWidget;
-import org.sonar.api.web.UserRole;
+import org.sonar.api.web.*;
 
 @UserRole(UserRole.USER)
+@WidgetCategory({"Design"})
+@Description("Reports on files dependency cycles and tangle index.")
 public final class FileDesignWidget extends AbstractRubyTemplate implements RubyRailsWidget {
   public String getId() {
     return "file-design";

diff --git a/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/PackageDesignWidget.java b/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/PackageDesignWidget.java
index 309d95f18d08814643dad996dc9565da29f18668..be27d6a71302a2b27570cc90c6f1466730c82f32 100644 (file)
--- a/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/PackageDesignWidget.java
+++ b/plugins/sonar-design-plugin/src/main/java/org/sonar/plugins/design/ui/widgets/PackageDesignWidget.java
@@ -23,6 +23,7 @@ import org.sonar.api.web.*;
 
 @UserRole(UserRole.USER)
 @WidgetCategory({"Design"})
+@Description("Reports on package dependency cycles and tangle index.")
 public final class PackageDesignWidget extends AbstractRubyTemplate implements RubyRailsWidget {
   public String getId() {
     return "package-design";