From 37afdd63bb98921c8aa91d5aa749fcfebb93a1b2 Mon Sep 17 00:00:00 2001
From: Artur Signell <artur@vaadin.com>
Date: Mon, 22 Apr 2013 14:31:02 +0300
Subject: Documented that push and pull settings is only for the app developer
 (#11666)

Change-Id: I6128abbfc6227ee4d86dd65b8073c5ccdea542f0
---
 server/src/com/vaadin/ui/UI.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'server')

diff --git a/server/src/com/vaadin/ui/UI.java b/server/src/com/vaadin/ui/UI.java
index e1646a5ac5..5bef772c95 100644
--- a/server/src/com/vaadin/ui/UI.java
+++ b/server/src/com/vaadin/ui/UI.java
@@ -1212,6 +1212,11 @@ public abstract class UI extends AbstractSingleComponentContainer implements
      * Note that it is possible to enable push and polling at the same time but
      * it should not be done to avoid excessive server traffic.
      * </p>
+     * <p>
+     * Add-on developers should note that this method is only meant for the
+     * application developer. An add-on should not set the poll interval
+     * directly, rather instruct the user to set it.
+     * </p>
      * 
      * @param intervalInMillis
      *            The interval (in ms) with which the UI should poll the server
@@ -1244,6 +1249,11 @@ public abstract class UI extends AbstractSingleComponentContainer implements
     /**
      * Sets the mode of bidirectional ("push") communication that should be used
      * in this UI.
+     * <p>
+     * Add-on developers should note that this method is only meant for the
+     * application developer. An add-on should not set the push mode directly,
+     * rather instruct the user to set it.
+     * </p>
      * 
      * @param pushMode
      *            The push mode to use.
-- 
cgit v1.2.3