From 08088b8cd0eb6a680c820e2a2194ca0dca8e3339 Mon Sep 17 00:00:00 2001 From: gaudol Date: Thu, 4 Nov 2010 17:40:14 +0000 Subject: [PATCH] Add description to core widgets --- .../java/org/sonar/plugins/core/widgets/AlertsWidget.java | 3 ++- .../org/sonar/plugins/core/widgets/CodeCoverageWidget.java | 2 +- .../plugins/core/widgets/CommentsDuplicationsWidget.java | 3 ++- .../sonar/plugins/core/widgets/CustomMeasuresWidget.java | 3 ++- .../plugins/core/widgets/DefaultExtendedAnalysisWidget.java | 5 +++-- .../plugins/core/widgets/DefaultStaticAnalysisWidget.java | 5 +++-- .../org/sonar/plugins/core/widgets/DescriptionWidget.java | 3 ++- .../java/org/sonar/plugins/core/widgets/EventsWidget.java | 3 ++- .../java/org/sonar/plugins/core/widgets/RulesWidget.java | 4 ++-- .../plugins/design/ui/widgets/ChidamberKemererWidget.java | 6 ++---- .../sonar/plugins/design/ui/widgets/FileDesignWidget.java | 6 +++--- .../plugins/design/ui/widgets/PackageDesignWidget.java | 1 + 12 files changed, 25 insertions(+), 19 deletions(-) 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 c30344f2c5f..604b491b436 100644 --- 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; import org.sonar.api.web.AbstractRubyTemplate; +import org.sonar.api.web.Description; import org.sonar.api.web.RubyRailsWidget; +@Description("Display current alerts on the project.") public class AlertsWidget extends AbstractRubyTemplate implements RubyRailsWidget { public String getId() { return "alerts"; } public String getTitle() { - // not used for the moment by widgets. return "Alerts"; } 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 6e9baa8494d..fc028d5b8cf 100644 --- 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.*; @WidgetCategory({"Tests"}) +@Description("Reports on units tests and code coverage by unit tests.") public class CodeCoverageWidget extends AbstractRubyTemplate implements RubyRailsWidget { public String getId() { return "code_coverage"; } public String getTitle() { - // not used for the moment by widgets. return "Code coverage"; } 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 2d3fcaaac3d..62446403366 100644 --- 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; import org.sonar.api.web.AbstractRubyTemplate; +import org.sonar.api.web.Description; import org.sonar.api.web.RubyRailsWidget; +@Description("Reports on copy/paste and documentation") public class CommentsDuplicationsWidget extends AbstractRubyTemplate implements RubyRailsWidget { public String getId() { return "comments_duplications"; } public String getTitle() { - // not used for the moment by widgets. return "Comments & Duplications"; } 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 b664ae3a6f3..84d99a7f63c 100644 --- 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 516b910653c..509f51c5b14 100644 --- 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; import org.sonar.api.web.AbstractRubyTemplate; +import org.sonar.api.web.Description; import org.sonar.api.web.RubyRailsWidget; +@Description("Reports on complexity, average complexity and complexity distribution.") public class DefaultExtendedAnalysisWidget extends AbstractRubyTemplate implements RubyRailsWidget { public String getId() { return "extended_analysis"; } public String getTitle() { - // not used for the moment by widgets. - return "Extended analysis"; + return "Complexity"; } @Override 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 9c10430c774..69ddfc62b0b 100644 --- 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; import org.sonar.api.web.AbstractRubyTemplate; +import org.sonar.api.web.Description; import org.sonar.api.web.RubyRailsWidget; +@Description("Reports general metrics on the size of the project.") public class DefaultStaticAnalysisWidget extends AbstractRubyTemplate implements RubyRailsWidget { public String getId() { return "static_analysis"; } public String getTitle() { - // not used for the moment by widgets. - return "Static analysis"; + return "Size metrics"; } @Override 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 0c191d9f751..52f47b03b62 100644 --- 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; import org.sonar.api.web.AbstractRubyTemplate; +import org.sonar.api.web.Description; import org.sonar.api.web.RubyRailsWidget; +@Description("Displays general project information taken from the pom.xml") public class DescriptionWidget extends AbstractRubyTemplate implements RubyRailsWidget { public String getId() { return "description"; } public String getTitle() { - // not used for the moment by widgets. return "Description"; } 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 547bc2f01a4..0da901088b6 100644 --- 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 b43247140c8..d9d166aefda 100644 --- 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.*; @WidgetCategory({"Rules"}) +@Description("Reports violations and compliance index on coding standards.") public class RulesWidget extends AbstractRubyTemplate implements RubyRailsWidget { public String getId() { return "rules"; } public String getTitle() { - // not used for the moment by widgets. - return "Rules"; + return "Rules Compliance"; } @Override 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 0bbcbcec6c6..90345b27db8 100644 --- 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 bd6bda2aaee..c4009c9dd7b 100644 --- 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 309d95f18d0..be27d6a7130 100644 --- 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"; -- 2.39.5