From a9ff7993c2f0e3f3412ef68a236aa2eb02385c64 Mon Sep 17 00:00:00 2001 From: Leif Åstrand Date: Wed, 5 Jun 2013 15:15:53 +0300 Subject: Don't use the broken {@value Type#CONSTANT} pattern in javadocs Change-Id: I78f0f6532242bd5d7aa406fe61ccf15d9585fde9 --- server/src/com/vaadin/server/Constants.java | 1 + server/src/com/vaadin/server/VaadinService.java | 3 +-- server/src/com/vaadin/server/VaadinSession.java | 1 + server/src/com/vaadin/ui/UI.java | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) (limited to 'server') diff --git a/server/src/com/vaadin/server/Constants.java b/server/src/com/vaadin/server/Constants.java index 2c041e3cf8..7d3201efdf 100644 --- a/server/src/com/vaadin/server/Constants.java +++ b/server/src/com/vaadin/server/Constants.java @@ -116,6 +116,7 @@ public interface Constants { static final String URL_PARAMETER_THEME = "theme"; static final String SERVLET_PARAMETER_PRODUCTION_MODE = "productionMode"; + // Javadocs for VaadinService should be updated if this value is changed static final String SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION = "disable-xsrf-protection"; static final String SERVLET_PARAMETER_RESOURCE_CACHE_TIME = "resourceCacheTime"; static final String SERVLET_PARAMETER_HEARTBEAT_INTERVAL = "heartbeatInterval"; diff --git a/server/src/com/vaadin/server/VaadinService.java b/server/src/com/vaadin/server/VaadinService.java index a040c72175..18dc468cb0 100644 --- a/server/src/com/vaadin/server/VaadinService.java +++ b/server/src/com/vaadin/server/VaadinService.java @@ -1584,8 +1584,7 @@ public abstract class VaadinService implements Serializable { * This protection is enabled by default, but it might need to be disabled * to allow a certain type of testing. For these cases, the check can be * disabled by setting the init parameter - * {@value Constants#SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION} to - * true. + * disable-xsrf-protection to true. * * @see DeploymentConfiguration#isXsrfProtectionEnabled() * diff --git a/server/src/com/vaadin/server/VaadinSession.java b/server/src/com/vaadin/server/VaadinSession.java index e0a5b51baa..82f245594f 100644 --- a/server/src/com/vaadin/server/VaadinSession.java +++ b/server/src/com/vaadin/server/VaadinSession.java @@ -133,6 +133,7 @@ public class VaadinSession implements HttpSessionBindingListener, Serializable { * The name of the parameter that is by default used in e.g. web.xml to * define the name of the default {@link UI} class. */ + // javadoc in UI should be updated if this value is changed public static final String UI_PARAMETER = "UI"; private static final Method BOOTSTRAP_FRAGMENT_METHOD = ReflectTools diff --git a/server/src/com/vaadin/ui/UI.java b/server/src/com/vaadin/ui/UI.java index 6159298a69..fa38666dc2 100644 --- a/server/src/com/vaadin/ui/UI.java +++ b/server/src/com/vaadin/ui/UI.java @@ -74,7 +74,7 @@ import com.vaadin.util.CurrentInstance; * browser window which points to e.g. {@link VaadinServlet}, all * {@link UIProvider}s registered to the current {@link VaadinSession} are * queried for the UI class that should be used. The selection is by defaylt - * based on the {@value VaadinSession#UI_PARAMETER} parameter from web.xml. + * based on the UI init parameter from web.xml. *

*

* After a UI has been created by the application, it is initialized using -- cgit v1.2.3