From 9abf1eeab7196c0ac75a23101c262bfa404d1c84 Mon Sep 17 00:00:00 2001 From: caalador Date: Thu, 26 Jan 2017 09:43:41 +0200 Subject: Fix some faulty javaDoc names --- server/src/main/java/com/vaadin/data/provider/Sort.java | 8 ++------ server/src/main/java/com/vaadin/server/Responsive.java | 4 ++-- server/src/main/java/com/vaadin/server/ServerRpcManager.java | 2 -- server/src/main/java/com/vaadin/server/VaadinPortlet.java | 4 ++-- server/src/main/java/com/vaadin/server/VaadinService.java | 4 ++-- server/src/main/java/com/vaadin/server/VaadinServlet.java | 3 --- .../main/java/com/vaadin/server/communication/PushHandler.java | 2 +- .../java/com/vaadin/server/communication/ServerRpcHandler.java | 2 +- .../main/java/com/vaadin/server/communication/UidlWriter.java | 2 -- server/src/main/java/com/vaadin/ui/Component.java | 9 ++++----- .../main/java/com/vaadin/ui/ReconnectDialogConfiguration.java | 2 +- server/src/main/java/com/vaadin/ui/TwinColSelect.java | 2 +- server/src/main/java/com/vaadin/ui/Upload.java | 8 +++----- server/src/main/java/com/vaadin/ui/Window.java | 2 +- .../com/vaadin/ui/components/grid/SingleSelectionModelImpl.java | 2 +- .../java/com/vaadin/ui/declarative/DesignAttributeHandler.java | 2 +- 16 files changed, 22 insertions(+), 36 deletions(-) (limited to 'server/src/main/java') diff --git a/server/src/main/java/com/vaadin/data/provider/Sort.java b/server/src/main/java/com/vaadin/data/provider/Sort.java index 0655c7d0e4..040d7ba376 100644 --- a/server/src/main/java/com/vaadin/data/provider/Sort.java +++ b/server/src/main/java/com/vaadin/data/provider/Sort.java @@ -37,8 +37,8 @@ public abstract class Sort implements Serializable { * * * @see Sort - * @see Sort#asc(Object) - * @see Sort#desc(Object) + * @see Sort#asc(String) + * @see Sort#desc(String) * @see #build() */ public static class SortBuilder implements Serializable { @@ -104,8 +104,6 @@ public abstract class Sort implements Serializable { * * @param by * the object to sort by - * @param - * sort order data type * * @return the sort builder */ @@ -119,8 +117,6 @@ public abstract class Sort implements Serializable { * * @param by * the object to sort by - * @param - * sort order data type * * @return the sort builder */ diff --git a/server/src/main/java/com/vaadin/server/Responsive.java b/server/src/main/java/com/vaadin/server/Responsive.java index 5d0bbfb2ab..f60d020250 100644 --- a/server/src/main/java/com/vaadin/server/Responsive.java +++ b/server/src/main/java/com/vaadin/server/Responsive.java @@ -148,8 +148,8 @@ public class Responsive extends AbstractExtension { * Enable responsive width and height range styling for the target component * or UI instance. * - * @param target - * The component which should be able to respond to width and/or + * @param components + * The components which should be able to respond to width and/or * height changes. */ public static void makeResponsive(Component... components) { diff --git a/server/src/main/java/com/vaadin/server/ServerRpcManager.java b/server/src/main/java/com/vaadin/server/ServerRpcManager.java index e9f8d9543e..bb534efee7 100644 --- a/server/src/main/java/com/vaadin/server/ServerRpcManager.java +++ b/server/src/main/java/com/vaadin/server/ServerRpcManager.java @@ -88,8 +88,6 @@ public class ServerRpcManager implements Serializable { /** * Create a RPC manager for an RPC target. * - * @param target - * RPC call target (normally a {@link Connector}) * @param implementation * RPC interface implementation for the target * @param rpcInterface diff --git a/server/src/main/java/com/vaadin/server/VaadinPortlet.java b/server/src/main/java/com/vaadin/server/VaadinPortlet.java index c3daf2c617..441580df84 100644 --- a/server/src/main/java/com/vaadin/server/VaadinPortlet.java +++ b/server/src/main/java/com/vaadin/server/VaadinPortlet.java @@ -644,8 +644,8 @@ public class VaadinPortlet extends GenericPortlet /** * Gets the currently used Vaadin portlet. The current portlet is * automatically defined when processing requests related to the service - * (see {@link ThreadLocal}) and in {@link VaadinSession#access(Command)} - * and {@link UI#access(Command)}. In other cases, (e.g. from background + * (see {@link ThreadLocal}) and in {@link VaadinSession#access(Runnable)} + * and {@link UI#access(Runnable)}. In other cases, (e.g. from background * threads, the current service is not automatically defined. * * The current portlet is derived from the current service using diff --git a/server/src/main/java/com/vaadin/server/VaadinService.java b/server/src/main/java/com/vaadin/server/VaadinService.java index 6ae9df2408..3050e41f0e 100644 --- a/server/src/main/java/com/vaadin/server/VaadinService.java +++ b/server/src/main/java/com/vaadin/server/VaadinService.java @@ -923,8 +923,8 @@ public abstract class VaadinService implements Serializable { /** * Gets the currently used Vaadin service. The current service is * automatically defined when processing requests related to the service - * (see {@link ThreadLocal}) and in {@link VaadinSession#access(Command)} - * and {@link UI#access(Command)}. In other cases, (e.g. from background + * (see {@link ThreadLocal}) and in {@link VaadinSession#access(Runnable)} + * and {@link UI#access(Runnable)}. In other cases, (e.g. from background * threads, the current service is not automatically defined. * * @return the current Vaadin service instance if available, otherwise diff --git a/server/src/main/java/com/vaadin/server/VaadinServlet.java b/server/src/main/java/com/vaadin/server/VaadinServlet.java index fae7b160c3..a03979216b 100644 --- a/server/src/main/java/com/vaadin/server/VaadinServlet.java +++ b/server/src/main/java/com/vaadin/server/VaadinServlet.java @@ -495,9 +495,6 @@ public class VaadinServlet extends HttpServlet implements Constants { * Check that cookie support is enabled in the browser. Only checks UIDL * requests. * - * @param requestType - * Type of the request as returned by - * {@link #getRequestType(HttpServletRequest)} * @param request * The request from the browser * @param response diff --git a/server/src/main/java/com/vaadin/server/communication/PushHandler.java b/server/src/main/java/com/vaadin/server/communication/PushHandler.java index 5a81b8020c..07b606c6e9 100644 --- a/server/src/main/java/com/vaadin/server/communication/PushHandler.java +++ b/server/src/main/java/com/vaadin/server/communication/PushHandler.java @@ -498,7 +498,7 @@ public class PushHandler { * aware of a reconnect taking place. * * @since 7.6 - * @param suspendTimeout + * @param longPollingSuspendTimeout * the timeout to use for suspended AtmosphereResources */ public void setLongPollingSuspendTimeout(int longPollingSuspendTimeout) { diff --git a/server/src/main/java/com/vaadin/server/communication/ServerRpcHandler.java b/server/src/main/java/com/vaadin/server/communication/ServerRpcHandler.java index 134fd569ff..755a9bb94a 100644 --- a/server/src/main/java/com/vaadin/server/communication/ServerRpcHandler.java +++ b/server/src/main/java/com/vaadin/server/communication/ServerRpcHandler.java @@ -457,7 +457,7 @@ public class ServerRpcHandler implements Serializable { * the UI containing the connector * @param connector * the connector the RPC is targeted to - * @param invocation + * @param legacyInvocation * information about the rpc to invoke */ protected void handleInvocation(UI ui, ClientConnector connector, diff --git a/server/src/main/java/com/vaadin/server/communication/UidlWriter.java b/server/src/main/java/com/vaadin/server/communication/UidlWriter.java index 4f94f4780b..28f4cda09a 100644 --- a/server/src/main/java/com/vaadin/server/communication/UidlWriter.java +++ b/server/src/main/java/com/vaadin/server/communication/UidlWriter.java @@ -63,8 +63,6 @@ public class UidlWriter implements Serializable { * The {@link UI} whose changes to write * @param writer * The writer to use - * @param analyzeLayouts - * Whether detected layout problems should be logged. * @param async * True if this message is sent by the server asynchronously, * false if it is a response to a client message. diff --git a/server/src/main/java/com/vaadin/ui/Component.java b/server/src/main/java/com/vaadin/ui/Component.java index 09c5f2cc99..1215d848aa 100644 --- a/server/src/main/java/com/vaadin/ui/Component.java +++ b/server/src/main/java/com/vaadin/ui/Component.java @@ -513,10 +513,9 @@ public interface Component extends ClientConnector, Sizeable, Serializable { *

* Reimplementing the {@code attach()} method is useful for tasks that need * to get a reference to the parent, window, or application object with the - * {@link #getParent()}, {@link #getUI()}, and {@link #getSession()} - * methods. A component does not yet know these objects in the constructor, - * so in such case, the methods will return {@code null}. For example, the - * following is invalid: + * {@link #getParent()} and {@link #getUI()} methods. A component does not + * yet know these objects in the constructor, so in such case, the methods + * will return {@code null}. For example, the following is invalid: *

* * 
@@ -537,7 +536,7 @@ public interface Component extends ClientConnector, Sizeable, Serializable {
      * component from a container triggers calling the {@link #detach()} method.
      * If the parent of an added component is already connected to the
      * application, the {@code attach()} is called immediately from
-     * {@link #setParent(Component)}.
+     * {@link #setParent(HasComponents)}.
      * 

      *
      * 
diff --git a/server/src/main/java/com/vaadin/ui/ReconnectDialogConfiguration.java b/server/src/main/java/com/vaadin/ui/ReconnectDialogConfiguration.java
index 8a36de3510..f24045e1a6 100644
--- a/server/src/main/java/com/vaadin/ui/ReconnectDialogConfiguration.java
+++ b/server/src/main/java/com/vaadin/ui/ReconnectDialogConfiguration.java
@@ -54,7 +54,7 @@ public interface ReconnectDialogConfiguration extends Serializable {
      * Sets the text to show in the reconnect dialog after giving up trying to
      * reconnect ({@link #getReconnectAttempts()} reached)
      *
-     * @param dialogText
+     * @param dialogTextGaveUp
      *            the text to show in the reconnect dialog after giving up
      */
     public void setDialogTextGaveUp(String dialogTextGaveUp);
diff --git a/server/src/main/java/com/vaadin/ui/TwinColSelect.java b/server/src/main/java/com/vaadin/ui/TwinColSelect.java
index 2a8c91f9a7..1b84e32fe0 100644
--- a/server/src/main/java/com/vaadin/ui/TwinColSelect.java
+++ b/server/src/main/java/com/vaadin/ui/TwinColSelect.java
@@ -92,7 +92,7 @@ public class TwinColSelect extends AbstractMultiSelect
      * the selects.
      * 

      * If a height if set (using {@link #setHeight(String)} or
-     * {@link #setHeight(float, int)}) it overrides the number of rows. Leave
+     * {@link #setHeight(float, Unit)}) it overrides the number of rows. Leave
      * the height undefined to use this method.
      *
      * @param rows
diff --git a/server/src/main/java/com/vaadin/ui/Upload.java b/server/src/main/java/com/vaadin/ui/Upload.java
index d67fa07641..d725d157a6 100644
--- a/server/src/main/java/com/vaadin/ui/Upload.java
+++ b/server/src/main/java/com/vaadin/ui/Upload.java
@@ -141,7 +141,7 @@ public class Upload extends AbstractComponent
     /**
      * Invoked when the value of a variable has changed.
      *
-     * @see com.vaadin.ui.AbstractComponent#changeVariables(java.lang.Object,
+     * @see com.vaadin.ui.LegacyComponent#changeVariables(java.lang.Object,
      *      java.util.Map)
      */
     @Override
@@ -344,7 +344,7 @@ public class Upload extends AbstractComponent
          * @param filename
          * @param MIMEType
          * @param length
-         * @param exception
+         * @param reason
          */
         public FailedEvent(Upload source, String filename, String MIMEType,
                 long length, Exception reason) {
@@ -358,7 +358,6 @@ public class Upload extends AbstractComponent
          * @param filename
          * @param MIMEType
          * @param length
-         * @param exception
          */
         public FailedEvent(Upload source, String filename, String MIMEType,
                 long length) {
@@ -456,7 +455,7 @@ public class Upload extends AbstractComponent
          * @param source
          * @param filename
          * @param MIMEType
-         * @param length
+         * @param contentLength
          */
         public StartedEvent(Upload source, String filename, String MIMEType,
                 long contentLength) {
@@ -775,7 +774,6 @@ public class Upload extends AbstractComponent
      *
      * @param filename
      * @param MIMEType
-     * @param length
      */
     protected void fireStarted(String filename, String MIMEType) {
         fireEvent(new Upload.StartedEvent(this, filename, MIMEType,
diff --git a/server/src/main/java/com/vaadin/ui/Window.java b/server/src/main/java/com/vaadin/ui/Window.java
index b0c2b7e19e..7b57927d94 100644
--- a/server/src/main/java/com/vaadin/ui/Window.java
+++ b/server/src/main/java/com/vaadin/ui/Window.java
@@ -1282,7 +1282,7 @@ public class Window extends Panel
      * This postfix is read to assistive device users after the window caption,
      * but not visible on the page.
      *
-     * @param prefix
+     * @param assistivePostfix
      *            String that is placed after the window caption
      */
     public void setAssistivePostfix(String assistivePostfix) {
diff --git a/server/src/main/java/com/vaadin/ui/components/grid/SingleSelectionModelImpl.java b/server/src/main/java/com/vaadin/ui/components/grid/SingleSelectionModelImpl.java
index cd985f473a..12f3ee4de4 100644
--- a/server/src/main/java/com/vaadin/ui/components/grid/SingleSelectionModelImpl.java
+++ b/server/src/main/java/com/vaadin/ui/components/grid/SingleSelectionModelImpl.java
@@ -146,7 +146,7 @@ public class SingleSelectionModelImpl extends AbstractSelectionModel
 
     /**
      * Sets the selection based on a client request. Does nothing if the select
-     * component is {@linkplain Component#isReadOnly()} or if the selection
+     * component is {@linkplain SingleSelect#isReadOnly()} or if the selection
      * would not change. Otherwise updates the selection and fires a selection
      * change event with {@code isUserOriginated == true}.
      *
diff --git a/server/src/main/java/com/vaadin/ui/declarative/DesignAttributeHandler.java b/server/src/main/java/com/vaadin/ui/declarative/DesignAttributeHandler.java
index 42ffe303ef..8207ce7af6 100644
--- a/server/src/main/java/com/vaadin/ui/declarative/DesignAttributeHandler.java
+++ b/server/src/main/java/com/vaadin/ui/declarative/DesignAttributeHandler.java
@@ -316,7 +316,7 @@ public class DesignAttributeHandler implements Serializable {
      * return value would be primary-style-name
      *
      * @param propertyName
-     *            the property name returned by {@link IntroSpector}
+     *            the property name returned by {@link Introspector}
      * @return the design attribute name corresponding the given method name
      */
     private static String toAttributeName(String propertyName) {
-- 
cgit v1.2.3