diff options
author | Ahmed Ashour <asashour@yahoo.com> | 2017-09-21 15:01:30 +0200 |
---|---|---|
committer | Henri Sara <henri.sara@gmail.com> | 2017-09-21 16:01:30 +0300 |
commit | 132d9fa60e1d5530c01e1954905ef5d0f9643060 (patch) | |
tree | 1254865f246b5350115234a792402e51eaec58f7 /client | |
parent | 11ddb11cbc72b0ee233e503058d4e104030e4aa3 (diff) | |
download | vaadin-framework-132d9fa60e1d5530c01e1954905ef5d0f9643060.tar.gz vaadin-framework-132d9fa60e1d5530c01e1954905ef5d0f9643060.zip |
Fix unused parameters in javadoc (#10055)
Diffstat (limited to 'client')
29 files changed, 62 insertions, 69 deletions
diff --git a/client/src/main/java/com/vaadin/client/AnimationUtil.java b/client/src/main/java/com/vaadin/client/AnimationUtil.java index e2cf9e690a..d6807f6803 100644 --- a/client/src/main/java/com/vaadin/client/AnimationUtil.java +++ b/client/src/main/java/com/vaadin/client/AnimationUtil.java @@ -88,7 +88,7 @@ public class AnimationUtil { /** * Removes the given animation listener. * - * @param element + * @param elem * the element which has the listener * @param animationEndListener * the listener to remove diff --git a/client/src/main/java/com/vaadin/client/ApplicationConnection.java b/client/src/main/java/com/vaadin/client/ApplicationConnection.java index 58d5259f1b..8da676668b 100644 --- a/client/src/main/java/com/vaadin/client/ApplicationConnection.java +++ b/client/src/main/java/com/vaadin/client/ApplicationConnection.java @@ -1226,8 +1226,8 @@ public class ApplicationConnection implements HasHandlers { * Use to notify that the given component's caption has changed; layouts may * have to be recalculated. * - * @param component - * the Paintable whose caption has changed + * @param widget + * The Widget whose caption has changed * @deprecated As of 7.0.2, has not had any effect for a long time */ @Deprecated diff --git a/client/src/main/java/com/vaadin/client/ConnectorMap.java b/client/src/main/java/com/vaadin/client/ConnectorMap.java index fbd5b40e3f..a2fc8cc81e 100644 --- a/client/src/main/java/com/vaadin/client/ConnectorMap.java +++ b/client/src/main/java/com/vaadin/client/ConnectorMap.java @@ -38,7 +38,7 @@ public class ConnectorMap { /** * Returns a {@link ServerConnector} by its id * - * @param id + * @param connectorId * The connector id * @return A connector or null if a connector with the given id has not been * registered @@ -284,8 +284,8 @@ public class ConnectorMap { * @return true if the widget is the root widget of a * {@link ComponentConnector}, false otherwise */ - public boolean isConnector(Widget w) { - return getConnectorId(w.getElement()) != null; + public boolean isConnector(Widget widget) { + return getConnectorId(widget.getElement()) != null; } private static Logger getLogger() { diff --git a/client/src/main/java/com/vaadin/client/DateTimeService.java b/client/src/main/java/com/vaadin/client/DateTimeService.java index 88cc0923e6..2e9627a5a5 100644 --- a/client/src/main/java/com/vaadin/client/DateTimeService.java +++ b/client/src/main/java/com/vaadin/client/DateTimeService.java @@ -302,8 +302,6 @@ public class DateTimeService { * The date to convert * @param formatStr * The format string that might contain MMM or MMMM - * @param dateTimeService - * Reference to the Vaadin DateTimeService * @return */ public String formatDate(Date date, String formatStr) { diff --git a/client/src/main/java/com/vaadin/client/VTooltip.java b/client/src/main/java/com/vaadin/client/VTooltip.java index 0804e67666..74da680c66 100644 --- a/client/src/main/java/com/vaadin/client/VTooltip.java +++ b/client/src/main/java/com/vaadin/client/VTooltip.java @@ -123,8 +123,6 @@ public class VTooltip extends VOverlay { /** * Initialize the tooltip overlay for assistive devices. * - * @param info - * with the content of the tooltip * @since 7.2.4 */ public void initializeAssistiveTooltips() { diff --git a/client/src/main/java/com/vaadin/client/communication/ConnectionStateHandler.java b/client/src/main/java/com/vaadin/client/communication/ConnectionStateHandler.java index dc1c1bf913..03ab23d43e 100644 --- a/client/src/main/java/com/vaadin/client/communication/ConnectionStateHandler.java +++ b/client/src/main/java/com/vaadin/client/communication/ConnectionStateHandler.java @@ -77,7 +77,7 @@ public interface ConnectionStateHandler { * * @param pushConnection * The push connection which was closed - * @param response + * @param responseObject * An object containing response data */ void pushClosed(PushConnection pushConnection, @@ -153,8 +153,8 @@ public interface ConnectionStateHandler { * Called when invalid content (not JSON) was returned from the server as * the result of an XmlHttpRequest request * - * @param communicationProblemEvent - * An event containing what was being sent to the server and what + * @param xhrConnectionError + * The error containing what was being sent to the server and what * was returned */ void xhrInvalidContent(XhrConnectionError xhrConnectionError); @@ -163,8 +163,8 @@ public interface ConnectionStateHandler { * Called when invalid status code (not 200) was returned by the server as * the result of an XmlHttpRequest. * - * @param communicationProblemEvent - * An event containing what was being sent to the server and what + * @param xhrConnectionError + * The error containing what was being sent to the server and what * was returned */ void xhrInvalidStatusCode(XhrConnectionError xhrConnectionError); @@ -187,9 +187,10 @@ public interface ConnectionStateHandler { * Called when invalid content (not JSON) was pushed from the server through * the push connection * - * @param communicationProblemEvent - * An event containing what was being sent to the server and what - * was returned + * @param pushConnection + * The push connection used + * @param message + * The message which was sent to the server */ void pushInvalidContent(PushConnection pushConnection, String message); diff --git a/client/src/main/java/com/vaadin/client/communication/Heartbeat.java b/client/src/main/java/com/vaadin/client/communication/Heartbeat.java index 856b021d7a..7690209157 100644 --- a/client/src/main/java/com/vaadin/client/communication/Heartbeat.java +++ b/client/src/main/java/com/vaadin/client/communication/Heartbeat.java @@ -55,7 +55,7 @@ public class Heartbeat { /** * Initializes the heartbeat for the given application connection * - * @param connection + * @param applicationConnection * the connection */ public void init(ApplicationConnection applicationConnection) { diff --git a/client/src/main/java/com/vaadin/client/communication/MessageHandler.java b/client/src/main/java/com/vaadin/client/communication/MessageHandler.java index 90e822649b..6840d92063 100644 --- a/client/src/main/java/com/vaadin/client/communication/MessageHandler.java +++ b/client/src/main/java/com/vaadin/client/communication/MessageHandler.java @@ -229,7 +229,7 @@ public class MessageHandler { * Handles a received UIDL JSON text, parsing it, and passing it on to the * appropriate handlers, while logging timing information. * - * @param jsonText + * @param json * The JSON to handle */ public void handleMessage(final ValueMap json) { diff --git a/client/src/main/java/com/vaadin/client/communication/MessageSender.java b/client/src/main/java/com/vaadin/client/communication/MessageSender.java index 13553deddb..762e5e2e6b 100644 --- a/client/src/main/java/com/vaadin/client/communication/MessageSender.java +++ b/client/src/main/java/com/vaadin/client/communication/MessageSender.java @@ -140,8 +140,8 @@ public class MessageSender { * * @param reqInvocations * Data containing RPC invocations and all related information. - * @param extraParams - * Parameters that are added to the payload + * @param extraJson + * The JsonObject whose parameters are added to the payload */ protected void send(final JsonArray reqInvocations, final JsonObject extraJson) { @@ -173,8 +173,6 @@ public class MessageSender { * Sends an asynchronous or synchronous UIDL request to the server using the * given URI. * - * @param uri - * The URI to use for the request. May includes GET parameters * @param payload * The contents of the request to send */ @@ -367,7 +365,7 @@ public class MessageSender { /** * Used internally to update what the server expects * - * @param clientToServerMessageId + * @param nextExpectedId * the new client id to set * @param force * true if the id must be updated, false otherwise diff --git a/client/src/main/java/com/vaadin/client/debug/internal/LogSection.java b/client/src/main/java/com/vaadin/client/debug/internal/LogSection.java index 1840aa6e1a..a31cc12067 100644 --- a/client/src/main/java/com/vaadin/client/debug/internal/LogSection.java +++ b/client/src/main/java/com/vaadin/client/debug/internal/LogSection.java @@ -244,13 +244,13 @@ public class LogSection implements Section { /** * Sets the log row limit. * - * @param limit + * @param limit The limit */ public void setLimit(int limit) { this.limit = limit; applyLimit(); - // TODO shoud be persisted + // TODO should be persisted } /** diff --git a/client/src/main/java/com/vaadin/client/renderers/NumberRenderer.java b/client/src/main/java/com/vaadin/client/renderers/NumberRenderer.java index 5b4fea1988..1ef19c30f0 100644 --- a/client/src/main/java/com/vaadin/client/renderers/NumberRenderer.java +++ b/client/src/main/java/com/vaadin/client/renderers/NumberRenderer.java @@ -25,8 +25,6 @@ import com.vaadin.client.widget.grid.RendererCellReference; * * @since 7.4 * @author Vaadin Ltd - * @param <T> - * The number type to render. */ public class NumberRenderer implements Renderer<Number> { diff --git a/client/src/main/java/com/vaadin/client/ui/FocusUtil.java b/client/src/main/java/com/vaadin/client/ui/FocusUtil.java index 49cd9284c1..4914af6022 100644 --- a/client/src/main/java/com/vaadin/client/ui/FocusUtil.java +++ b/client/src/main/java/com/vaadin/client/ui/FocusUtil.java @@ -49,7 +49,7 @@ public class FocusUtil { * * @param focusable * the widget to focus/unfocus - * @param focused + * @param focus * whether this widget should take focus or release it */ public static void setFocus(Widget focusable, boolean focus) { diff --git a/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java b/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java index f0a23b5f43..8fce2651ab 100644 --- a/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java +++ b/client/src/main/java/com/vaadin/client/ui/VAbstractCalendarPanel.java @@ -2020,7 +2020,7 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>> * and it depends on the current resolution, what is considered inside the * range. * - * @param startDate + * @param newRangeStart * - the allowed range's start date */ public void setRangeStart(Date newRangeStart) { @@ -2039,7 +2039,7 @@ public abstract class VAbstractCalendarPanel<R extends Enum<R>> * Sets the end range for this component. The end range is inclusive, and it * depends on the current resolution, what is considered inside the range. * - * @param endDate + * @param newRangeEnd * - the allowed range's end date */ public void setRangeEnd(Date newRangeEnd) { diff --git a/client/src/main/java/com/vaadin/client/ui/VContextMenu.java b/client/src/main/java/com/vaadin/client/ui/VContextMenu.java index 09e1f5be8c..af5d5ddb4c 100644 --- a/client/src/main/java/com/vaadin/client/ui/VContextMenu.java +++ b/client/src/main/java/com/vaadin/client/ui/VContextMenu.java @@ -76,9 +76,6 @@ public class VContextMenu extends VOverlay implements SubPartAware { /** * This method should be used only by Client object as only one per client * should exists. Request an instance via client.getContextMenu(); - * - * @param cli - * to be set as an owner of menu */ public VContextMenu() { super(true, false); diff --git a/client/src/main/java/com/vaadin/client/ui/VCustomLayout.java b/client/src/main/java/com/vaadin/client/ui/VCustomLayout.java index e978a08119..22fd53d0a1 100644 --- a/client/src/main/java/com/vaadin/client/ui/VCustomLayout.java +++ b/client/src/main/java/com/vaadin/client/ui/VCustomLayout.java @@ -411,7 +411,7 @@ public class VCustomLayout extends ComplexPanel { /** * In custom layout one may want to run layout functions made with * JavaScript. This function tests if one exists (with name "iLayoutJS" in - * layouts first DOM node) and runs et. Return value is used to determine if + * layouts first DOM node) and runs it. Return value is used to determine if * children needs to be notified of size changes. * <p> * Note! When implementing a JS layout function you most likely want to call @@ -421,7 +421,7 @@ public class VCustomLayout extends ComplexPanel { * <p> * For internal use only. May be removed or replaced in the future. * - * @param el + * @param el The first element of the layout * @return true if layout function exists and was run successfully, else * false. */ diff --git a/client/src/main/java/com/vaadin/client/ui/VMenuBar.java b/client/src/main/java/com/vaadin/client/ui/VMenuBar.java index 6527ac8c93..0687ff472e 100644 --- a/client/src/main/java/com/vaadin/client/ui/VMenuBar.java +++ b/client/src/main/java/com/vaadin/client/ui/VMenuBar.java @@ -1332,8 +1332,12 @@ public class VMenuBar extends SimpleFocusablePanel /** * Handles the keyboard events handled by the MenuBar * - * @param event - * The keyboard event received + * @param keycode + * The key code received + * @param ctrl + * Whether {@code CTRL} was pressed + * @param shift + * Whether {@code SHIFT} was pressed * @return true iff the navigation event was handled */ public boolean handleNavigation(int keycode, boolean ctrl, boolean shift) { diff --git a/client/src/main/java/com/vaadin/client/ui/VSlider.java b/client/src/main/java/com/vaadin/client/ui/VSlider.java index b84f9da926..86feb560b8 100644 --- a/client/src/main/java/com/vaadin/client/ui/VSlider.java +++ b/client/src/main/java/com/vaadin/client/ui/VSlider.java @@ -462,8 +462,12 @@ public class VSlider extends SimpleFocusablePanel /** * Handles the keyboard events handled by the Slider * - * @param event - * The keyboard event received + * @param keycode + * The key code received + * @param ctrl + * Whether {@code CTRL} was pressed + * @param shift + * Whether {@code SHIFT} was pressed * @return true iff the navigation event was handled */ public boolean handleNavigation(int keycode, boolean ctrl, boolean shift) { diff --git a/client/src/main/java/com/vaadin/client/ui/VTabsheet.java b/client/src/main/java/com/vaadin/client/ui/VTabsheet.java index 97add9a0f9..52b48899dd 100644 --- a/client/src/main/java/com/vaadin/client/ui/VTabsheet.java +++ b/client/src/main/java/com/vaadin/client/ui/VTabsheet.java @@ -809,8 +809,8 @@ public class VTabsheet extends VTabsheetBase /** * Load the content of a tab of the provided index. * - * @param index - * of the tab to load + * @param tabIndex + * The index of the tab to load * * @return true if the specified sheet gets loaded, otherwise false. */ diff --git a/client/src/main/java/com/vaadin/client/ui/VTabsheetBase.java b/client/src/main/java/com/vaadin/client/ui/VTabsheetBase.java index d52362afcc..2da458c7e9 100644 --- a/client/src/main/java/com/vaadin/client/ui/VTabsheetBase.java +++ b/client/src/main/java/com/vaadin/client/ui/VTabsheetBase.java @@ -177,9 +177,9 @@ public abstract class VTabsheetBase extends ComplexPanel implements HasEnabled { * The default is false, i.e. render tab captions as plain text * * @since 7.4 - * @param captionAsHtml - * true if the captions are rendered as HTML, false if rendered - * as plain text + * @param tabCaptionsAsHtml + * {@code true} if the captions are rendered as HTML, + * {@code false} if rendered as plain text */ public void setTabCaptionsAsHtml(boolean tabCaptionsAsHtml) { this.tabCaptionsAsHtml = tabCaptionsAsHtml; diff --git a/client/src/main/java/com/vaadin/client/ui/VUI.java b/client/src/main/java/com/vaadin/client/ui/VUI.java index a372b746b0..71f3daeaf0 100644 --- a/client/src/main/java/com/vaadin/client/ui/VUI.java +++ b/client/src/main/java/com/vaadin/client/ui/VUI.java @@ -421,8 +421,6 @@ public class VUI extends SimplePanel implements ResizeHandler, * * Current use case is to restore the focus when a Window is closed. Does * currently handle only a single value. Needs to be extended for #12158 - * - * @return the lastFocusElementBeforeDialogOpened */ public void focusStoredElement() { if (storedFocus != null) { diff --git a/client/src/main/java/com/vaadin/client/ui/aria/AriaHelper.java b/client/src/main/java/com/vaadin/client/ui/aria/AriaHelper.java index f04b14173b..127dae5895 100644 --- a/client/src/main/java/com/vaadin/client/ui/aria/AriaHelper.java +++ b/client/src/main/java/com/vaadin/client/ui/aria/AriaHelper.java @@ -35,7 +35,7 @@ public class AriaHelper { * * @param widget * Widget, that should be bound to the caption - * @param captionElements + * @param captionElement * Element with of caption to bind */ public static void bindCaption(Widget widget, Element captionElement) { @@ -175,9 +175,9 @@ public class AriaHelper { * * @param element * Element to move out of sight - * @param boolean - * assistiveOnly true when element should only be visible for - * assistive devices, false to make the element visible for all + * @param assistiveOnly + * {@code true} when element should only be visible for + * assistive devices, {@code false} to make the element visible for all */ public static void setVisibleForAssistiveDevicesOnly(Element element, boolean assistiveOnly) { diff --git a/client/src/main/java/com/vaadin/client/ui/dd/VDropHandler.java b/client/src/main/java/com/vaadin/client/ui/dd/VDropHandler.java index d402467489..9d4a120660 100644 --- a/client/src/main/java/com/vaadin/client/ui/dd/VDropHandler.java +++ b/client/src/main/java/com/vaadin/client/ui/dd/VDropHandler.java @@ -55,8 +55,8 @@ public interface VDropHandler { * drop was performed on this Paintable. * * - * @param dragEvent - * DragEvent which contains the transferable and other + * @param drag + * VDragEvent which contains the transferable and other * information for the operation * * @return true if the Tranferrable of this drag event needs to be sent to diff --git a/client/src/main/java/com/vaadin/client/ui/orderedlayout/VAbstractOrderedLayout.java b/client/src/main/java/com/vaadin/client/ui/orderedlayout/VAbstractOrderedLayout.java index d226e0b5dc..868b01a1f3 100644 --- a/client/src/main/java/com/vaadin/client/ui/orderedlayout/VAbstractOrderedLayout.java +++ b/client/src/main/java/com/vaadin/client/ui/orderedlayout/VAbstractOrderedLayout.java @@ -226,7 +226,7 @@ public class VAbstractOrderedLayout extends FlowPanel { * method must be called. * * @since 7.6 - * @param Slot + * @param slot * to remove */ protected void removeSlot(Slot slot) { diff --git a/client/src/main/java/com/vaadin/client/widget/escalator/ColumnConfiguration.java b/client/src/main/java/com/vaadin/client/widget/escalator/ColumnConfiguration.java index 91e9f8d556..2aad0d4fbe 100644 --- a/client/src/main/java/com/vaadin/client/widget/escalator/ColumnConfiguration.java +++ b/client/src/main/java/com/vaadin/client/widget/escalator/ColumnConfiguration.java @@ -172,16 +172,16 @@ public interface ColumnConfiguration { throws IllegalArgumentException; /** - * Refreshes a range of rows in the current row containers in each Escalator + * Refreshes a range of columns in the current row containers in each Escalator * section. * <p> * The data for the refreshed columns is queried from the current cell * renderer. * * @param index - * the index of the first row that will be updated - * @param numberOfRows - * the number of rows to update, starting from the index + * the index of the first column that will be updated + * @param numberOfColumns + * the number of columns to update, starting from the index * @throws IndexOutOfBoundsException * if any integer number in the range * <code>[index..(index+numberOfColumns)]</code> is not an diff --git a/client/src/main/java/com/vaadin/client/widget/escalator/EscalatorUpdater.java b/client/src/main/java/com/vaadin/client/widget/escalator/EscalatorUpdater.java index aee38b4ce4..b07594946f 100644 --- a/client/src/main/java/com/vaadin/client/widget/escalator/EscalatorUpdater.java +++ b/client/src/main/java/com/vaadin/client/widget/escalator/EscalatorUpdater.java @@ -132,7 +132,7 @@ public interface EscalatorUpdater { * Information about the row from which the cells will be * removed. <em>Note:</em> You should not store nor reuse this * reference. - * @param cellsToAttach + * @param cellsToDetach * A collection of cells that are about to be detached. * <em>Note:</em> You should neither store nor reuse the * reference to the iterable, nor to the individual cells. @@ -146,7 +146,7 @@ public interface EscalatorUpdater { * @param row * Information about the row from which the cells were removed. * <em>Note:</em> You should not store nor reuse this reference. - * @param attachedCells + * @param detachedCells * A collection of cells that were detached. <em>Note:</em> You * should neither store nor reuse the reference to the iterable, * nor to the individual cells. diff --git a/client/src/main/java/com/vaadin/client/widget/grid/DataAvailableHandler.java b/client/src/main/java/com/vaadin/client/widget/grid/DataAvailableHandler.java index b4d8f4feaf..7ebc527ef6 100644 --- a/client/src/main/java/com/vaadin/client/widget/grid/DataAvailableHandler.java +++ b/client/src/main/java/com/vaadin/client/widget/grid/DataAvailableHandler.java @@ -28,10 +28,8 @@ public interface DataAvailableHandler extends EventHandler { /** * Called when DataSource has data available. Supplied with row range. * - * @param availableRows - * Range of rows available in the DataSource - * @return true if the command was successfully completed, false to call - * again the next time new data is available + * @param event + * The triggered event */ public void onDataAvailable(DataAvailableEvent event); } diff --git a/client/src/main/java/com/vaadin/client/widget/grid/RowReference.java b/client/src/main/java/com/vaadin/client/widget/grid/RowReference.java index cb6b622b96..712a961461 100644 --- a/client/src/main/java/com/vaadin/client/widget/grid/RowReference.java +++ b/client/src/main/java/com/vaadin/client/widget/grid/RowReference.java @@ -56,7 +56,7 @@ public class RowReference<T> { * the index of the row * @param row * the row object - * @param elemenet + * @param element * the element of the row */ public void set(int rowIndex, T row, TableRowElement element) { diff --git a/client/src/main/java/com/vaadin/client/widget/grid/sort/SortEvent.java b/client/src/main/java/com/vaadin/client/widget/grid/sort/SortEvent.java index 660b635eb6..d75557835d 100644 --- a/client/src/main/java/com/vaadin/client/widget/grid/sort/SortEvent.java +++ b/client/src/main/java/com/vaadin/client/widget/grid/sort/SortEvent.java @@ -43,8 +43,8 @@ public class SortEvent<T> extends GwtEvent<SortHandler<?>> { * a grid reference * @param order * an array dictating the desired sort order of the data source - * @param originator - * a value indicating where this event originated from + * @param userOriginated + * where this event originated from the user or not */ public SortEvent(Grid<T> grid, List<SortOrder> order, boolean userOriginated) { diff --git a/client/src/main/java/com/vaadin/client/widgets/Escalator.java b/client/src/main/java/com/vaadin/client/widgets/Escalator.java index 092253bbc5..fa1145d9cf 100644 --- a/client/src/main/java/com/vaadin/client/widgets/Escalator.java +++ b/client/src/main/java/com/vaadin/client/widgets/Escalator.java @@ -1381,7 +1381,6 @@ public class Escalator extends Widget * the DOM index to add rows into * @param numberOfRows * the number of rows to insert - * @return a list of the added row elements */ protected abstract void paintInsertRows(final int visualIndex, final int numberOfRows); |