]> source.dussan.org Git - vaadin-framework.git/commitdiff
Don't use the broken {@value Type#CONSTANT} pattern in javadocs
authorLeif Åstrand <leif@vaadin.com>
Wed, 5 Jun 2013 12:15:53 +0000 (15:15 +0300)
committerVaadin Code Review <review@vaadin.com>
Wed, 5 Jun 2013 12:18:23 +0000 (12:18 +0000)
Change-Id: I78f0f6532242bd5d7aa406fe61ccf15d9585fde9

client/src/com/vaadin/client/ApplicationConfiguration.java
server/src/com/vaadin/server/Constants.java
server/src/com/vaadin/server/VaadinService.java
server/src/com/vaadin/server/VaadinSession.java
server/src/com/vaadin/ui/UI.java
shared/src/com/vaadin/shared/ApplicationConstants.java

index 9152e5ab239532e2b2f7c9ea9814116621216911..a1f2e4f30e0259761d72aa19b08593d4c8408e7b 100644 (file)
@@ -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()
      * 
index 2c041e3cf8ed3a7dafc58ac5373aa49c2a378d67..7d3201efdfacf24c8904c05b6a67c2c4099272d5 100644 (file)
@@ -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";
index a040c72175730015f5086e5c87b24aabce39a781..18dc468cb0282acd6cd375de29f0b28636672a3d 100644 (file)
@@ -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()
      * 
index e0a5b51baa9c0ad9c87906e5e97a9fd7b19b5282..82f245594f9a0fec9cf1d529f31c31af329a9acb 100644 (file)
@@ -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
index 6159298a69da113dccdfe9aab8541ae72ea5b208..fa38666dc2982bf0bd0b96c55887ae719cbb5ee1 100644 (file)
@@ -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
index e51139dac72db129a2d6b12451902d59b1565548..15b81cd9a47b1b25e256ec60738b5ed8c87b5ca9 100644 (file)
@@ -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