diff options
author | Leif Åstrand <leif@vaadin.com> | 2013-06-05 15:15:53 +0300 |
---|---|---|
committer | Vaadin Code Review <review@vaadin.com> | 2013-06-05 12:18:23 +0000 |
commit | a9ff7993c2f0e3f3412ef68a236aa2eb02385c64 (patch) | |
tree | 9741381f4f2b8f260796c1bfcaa57d2c22cdcf33 | |
parent | b0574f7b33c4d3d437c8c11cd53389e5522f6999 (diff) | |
download | vaadin-framework-a9ff7993c2f0e3f3412ef68a236aa2eb02385c64.tar.gz vaadin-framework-a9ff7993c2f0e3f3412ef68a236aa2eb02385c64.zip |
Don't use the broken {@value Type#CONSTANT} pattern in javadocs
Change-Id: I78f0f6532242bd5d7aa406fe61ccf15d9585fde9
-rw-r--r-- | client/src/com/vaadin/client/ApplicationConfiguration.java | 10 | ||||
-rw-r--r-- | server/src/com/vaadin/server/Constants.java | 1 | ||||
-rw-r--r-- | server/src/com/vaadin/server/VaadinService.java | 3 | ||||
-rw-r--r-- | server/src/com/vaadin/server/VaadinSession.java | 1 | ||||
-rw-r--r-- | server/src/com/vaadin/ui/UI.java | 2 | ||||
-rw-r--r-- | shared/src/com/vaadin/shared/ApplicationConstants.java | 1 |
6 files changed, 9 insertions, 9 deletions
diff --git a/client/src/com/vaadin/client/ApplicationConfiguration.java b/client/src/com/vaadin/client/ApplicationConfiguration.java index 9152e5ab23..a1f2e4f30e 100644 --- a/client/src/com/vaadin/client/ApplicationConfiguration.java +++ b/client/src/com/vaadin/client/ApplicationConfiguration.java @@ -232,9 +232,8 @@ public class ApplicationConfiguration implements EntryPoint { /** * Checks whether path info in requests to the server-side service should be - * in a request parameter (named - * {@value ApplicationConstants#V_RESOURCE_PATH}) or appended to the end of - * the service URL. + * in a request parameter (named <code>v-resourcePath</code>) or appended to + * the end of the service URL. * * @see #getServiceUrl() * @@ -253,9 +252,8 @@ public class ApplicationConfiguration implements EntryPoint { /** * Gets the URL to the server-side VaadinService. If * {@link #useServiceUrlPathParam()} return <code>true</code>, the requested - * path info should be in the {@value ApplicationConstants#V_RESOURCE_PATH} - * query parameter; else the path info should be appended to the end of the - * URL. + * path info should be in the <code>v-resourcePath</code> query parameter; + * else the path info should be appended to the end of the URL. * * @see #useServiceUrlPathParam() * 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 - * <code>true</code>. + * <code>disable-xsrf-protection</code> to <code>true</code>. * * @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 <code>UI</code> init parameter from web.xml. * </p> * <p> * After a UI has been created by the application, it is initialized using diff --git a/shared/src/com/vaadin/shared/ApplicationConstants.java b/shared/src/com/vaadin/shared/ApplicationConstants.java index e51139dac7..15b81cd9a4 100644 --- a/shared/src/com/vaadin/shared/ApplicationConstants.java +++ b/shared/src/com/vaadin/shared/ApplicationConstants.java @@ -48,6 +48,7 @@ public class ApplicationConstants implements Serializable { public static final String SERVICE_URL_PATH_AS_PARAMETER = "usePathParameter"; + // Javadocs in ApplicationConfiguration should be updated if this is changed public static final String V_RESOURCE_PATH = "v-resourcePath"; @Deprecated |