aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api/src
diff options
context:
space:
mode:
authorSimon Brandhof <simon.brandhof@gmail.com>2012-01-05 14:52:45 +0100
committerSimon Brandhof <simon.brandhof@gmail.com>2012-01-05 14:52:45 +0100
commit20b04ec76cd7f45a446095d0873338be4e4bb87e (patch)
treecc206d54af7b1f729312d08cafdb4506575bf138 /sonar-plugin-api/src
parent4951f7ee5360ffa11c2f02deaa593d74c8e9bc67 (diff)
downloadsonarqube-20b04ec76cd7f45a446095d0873338be4e4bb87e.tar.gz
sonarqube-20b04ec76cd7f45a446095d0873338be4e4bb87e.zip
SONAR-3147 Web service to list available widgets
Diffstat (limited to 'sonar-plugin-api/src')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java2
1 files changed, 2 insertions, 0 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java b/sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java
index ca0602a6f92..df2a2104806 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/web/Dashboard.java
@@ -54,6 +54,8 @@ public final class Dashboard {
/**
* Add a widget with the given parameters, and return the newly created {@link Widget} object if one wants to add parameters to it.
*
+ * <p>The widget ids are listed by the web service /api/widgets</p>
+ *
* @param widgetId id of an existing widget
* @param columnId column starts with 1. The widget is ignored if the column id does not match the layout.
*/