diff options
55 files changed, 132 insertions, 149 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); diff --git a/compatibility-client/src/main/java/com/vaadin/v7/client/renderers/NumberRenderer.java b/compatibility-client/src/main/java/com/vaadin/v7/client/renderers/NumberRenderer.java index fb7762d39c..fb8033d1c7 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/renderers/NumberRenderer.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/client/renderers/NumberRenderer.java @@ -25,8 +25,6 @@ import com.vaadin.v7.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/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VCalendar.java b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VCalendar.java index 864b48595d..8f62fc7525 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VCalendar.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VCalendar.java @@ -1108,17 +1108,17 @@ public class VCalendar extends Composite implements VHasDropHandler { } /** - * Get the number when a week ends + * Get the number when a week ends. */ public int getLastDayNumber() { return lastDay; } /** - * Set the number when a week starts + * Set the first hour of the day. * - * @param dayNumber - * The number of the day + * @param hour + * The first hour of the day */ public void setFirstHourOfTheDay(int hour) { assert (hour >= 0 && hour <= 23); @@ -1126,17 +1126,19 @@ public class VCalendar extends Composite implements VHasDropHandler { } /** - * Get the number when a week starts + * Get the first hour of the day. + * + * @return The first hour of the day */ public int getFirstHourOfTheDay() { return firstHour; } /** - * Set the number when a week ends + * Set the last hour of the day. * - * @param dayNumber - * The number of the day + * @param hour + * The last hour of the day */ public void setLastHourOfTheDay(int hour) { assert (hour >= 0 && hour <= 23); @@ -1144,7 +1146,9 @@ public class VCalendar extends Composite implements VHasDropHandler { } /** - * Get the number when a week ends + * Get the last hour of the day. + * + * @return The last hour of the day */ public int getLastHourOfTheDay() { return lastHour; @@ -1589,9 +1593,9 @@ public class VCalendar extends Composite implements VHasDropHandler { * <p> * The default is false, i.e. to render that caption as plain text. * - * @param captionAsHtml - * true if the captions are rendered as HTML, false if rendered - * as plain text + * @param eventCaptionAsHtml + * {@code true} if the captions are rendered as HTML, + * {@code false} if rendered as plain text */ public void setEventCaptionAsHtml(boolean eventCaptionAsHtml) { this.eventCaptionAsHtml = eventCaptionAsHtml; diff --git a/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VCalendarPanel.java b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VCalendarPanel.java index afc0a7340e..21229dcb84 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VCalendarPanel.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VCalendarPanel.java @@ -2216,7 +2216,7 @@ public class VCalendarPanel extends FocusableFlexTable implements * 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) { @@ -2235,7 +2235,7 @@ public class VCalendarPanel extends FocusableFlexTable implements * 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/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VScrollTable.java b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VScrollTable.java index cf8d53d42a..55923f2eab 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VScrollTable.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VScrollTable.java @@ -5350,8 +5350,8 @@ public class VScrollTable extends FlowPanel * To get this work properly crossplatform, we will also set the width * of td. * - * @param colIndex - * @param w + * @param colIndex The column Index + * @param w The content width */ public void setColWidth(int colIndex, int w) { for (Widget row : renderedRows) { @@ -7725,8 +7725,12 @@ public class VScrollTable extends FlowPanel /** * Handles the keyboard events handled by the table * - * @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 */ protected boolean handleNavigation(int keycode, boolean ctrl, diff --git a/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VSlider.java b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VSlider.java index 88457a76d9..085b1e276a 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VSlider.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/VSlider.java @@ -468,8 +468,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/compatibility-client/src/main/java/com/vaadin/v7/client/ui/calendar/schedule/WeekGridMinuteTimeRange.java b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/calendar/schedule/WeekGridMinuteTimeRange.java index ac413917d5..ad7345e405 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/ui/calendar/schedule/WeekGridMinuteTimeRange.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/client/ui/calendar/schedule/WeekGridMinuteTimeRange.java @@ -34,9 +34,6 @@ public class WeekGridMinuteTimeRange { * Start time of the range * @param end * End time of the range - * @param clearSeconds - * Boolean Indicates, if seconds should be dropped from the range - * start and end */ public WeekGridMinuteTimeRange(Date start, Date end) { this.start = new Date(start.getTime()); diff --git a/compatibility-client/src/main/java/com/vaadin/v7/client/widget/escalator/ColumnConfiguration.java b/compatibility-client/src/main/java/com/vaadin/v7/client/widget/escalator/ColumnConfiguration.java index 221ae96206..ed4ffa1dff 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/widget/escalator/ColumnConfiguration.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/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 columns 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/compatibility-client/src/main/java/com/vaadin/v7/client/widget/escalator/EscalatorUpdater.java b/compatibility-client/src/main/java/com/vaadin/v7/client/widget/escalator/EscalatorUpdater.java index 4319d98c50..bb4fc9ca1e 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/widget/escalator/EscalatorUpdater.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/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/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/DataAvailableHandler.java b/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/DataAvailableHandler.java index ee8bdbdd79..717b809fb3 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/DataAvailableHandler.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/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/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/RowReference.java b/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/RowReference.java index 7df5e5843f..7a122f1018 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/RowReference.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/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/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/sort/SortEvent.java b/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/sort/SortEvent.java index 297e898c08..2b07c6ac16 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/widget/grid/sort/SortEvent.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/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/compatibility-client/src/main/java/com/vaadin/v7/client/widgets/Escalator.java b/compatibility-client/src/main/java/com/vaadin/v7/client/widgets/Escalator.java index 8b71ccc52a..8cf57b54a4 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/widgets/Escalator.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/client/widgets/Escalator.java @@ -1366,7 +1366,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); diff --git a/compatibility-client/src/main/java/com/vaadin/v7/client/widgets/Grid.java b/compatibility-client/src/main/java/com/vaadin/v7/client/widgets/Grid.java index eb88bb895f..469ecb5bba 100644 --- a/compatibility-client/src/main/java/com/vaadin/v7/client/widgets/Grid.java +++ b/compatibility-client/src/main/java/com/vaadin/v7/client/widgets/Grid.java @@ -5299,11 +5299,6 @@ public class Grid<T> extends ResizeComposite implements HasSelectionHandlers<T>, * * @param pixels * the maximum width - * @param immediately - * <code>true</code> if the widths should be executed - * immediately (ignoring lazy loading completely), or - * <code>false</code> if the command should be run after a - * while (duplicate non-immediately invocations are ignored). * @return this column */ public Column<C, T> setMaximumWidth(double pixels) { @@ -5345,7 +5340,7 @@ public class Grid<T> extends ResizeComposite implements HasSelectionHandlers<T>, * returns. This is done to reduce overhead of unintentionally always * recalculate all columns, when modifying several columns at once. * - * @param expandRatio + * @param ratio * the expand ratio of this column. {@code 0} to not have it * expand at all. A negative number to clear the expand * value. @@ -6703,8 +6698,8 @@ public class Grid<T> extends ResizeComposite implements HasSelectionHandlers<T>, /** * Removes the row at the given position from the header section. * - * @param index - * the position of the row + * @param rowIndex + * the index of the row * * @throws IllegalArgumentException * if no row exists at given index @@ -6852,7 +6847,7 @@ public class Grid<T> extends ResizeComposite implements HasSelectionHandlers<T>, /** * Removes the row at the given position from the footer section. * - * @param index + * @param rowIndex * the position of the row * * @throws IllegalArgumentException @@ -8723,7 +8718,7 @@ public class Grid<T> extends ResizeComposite implements HasSelectionHandlers<T>, * Sets the handler responsible for binding data and editor widgets to the * editor. * - * @param rowHandler + * @param handler * the new editor handler * * @throws IllegalStateException @@ -9210,9 +9205,9 @@ public class Grid<T> extends ResizeComposite implements HasSelectionHandlers<T>, * Sets the buffered editor mode. * * @since 7.6 - * @param editorUnbuffered - * <code>true</code> to enable buffered editor, - * <code>false</code> to disable it + * @param editorBuffered + * {@code true} to enable buffered editor, + * {@code false} to disable it */ public void setEditorBuffered(boolean editorBuffered) { editor.setBuffered(editorBuffered); diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/IndexedContainer.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/IndexedContainer.java index fce2c1753d..5371584a31 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/IndexedContainer.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/IndexedContainer.java @@ -146,7 +146,7 @@ public class IndexedContainer /** * Gets the type of a Property stored in the list. * - * @param id + * @param propertyId * the ID of the Property. * @return Type of the requested Property */ diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToCollectionConverter.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToCollectionConverter.java index 8b65f7fc44..ed65e621ec 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToCollectionConverter.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/converter/StringToCollectionConverter.java @@ -97,7 +97,7 @@ public class StringToCollectionConverter * * @param tokenConverter * converter for token - * @param tokenType + * @param tokenClass * expected token model type * @param delimiter * delimiter in presentation string @@ -117,7 +117,7 @@ public class StringToCollectionConverter * * @param tokenConverter * converter for token - * @param tokenType + * @param tokenClass * expected token model type * @param delimiter * delimiter in presentation string diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/FreeformQueryDelegate.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/FreeformQueryDelegate.java index 360a0ae89a..e74e6abe1d 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/FreeformQueryDelegate.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/FreeformQueryDelegate.java @@ -35,8 +35,8 @@ public interface FreeformQueryDelegate extends Serializable { * * @param offset * the first record (row) to fetch. - * @param pagelength - * the number of records (rows) to fetch. 0 means all records + * @param limit + * the limit of records (rows) to fetch. 0 means all records * starting from offset. * @deprecated As of 6.7. Implement {@link FreeformStatementDelegate} * instead of {@link FreeformQueryDelegate} diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/FreeformStatementDelegate.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/FreeformStatementDelegate.java index 3266a135e8..c3a8c60dbb 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/FreeformStatementDelegate.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/FreeformStatementDelegate.java @@ -39,8 +39,8 @@ public interface FreeformStatementDelegate extends FreeformQueryDelegate { * * @param offset * the first record (row) to fetch. - * @param pagelength - * the number of records (rows) to fetch. 0 means all records + * @param limit + * the limit of records (rows) to fetch. 0 means all records * starting from offset. */ public StatementHelper getQueryStatement(int offset, int limit) diff --git a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/QueryDelegate.java b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/QueryDelegate.java index e9e0d066f9..45206701a0 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/QueryDelegate.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/data/util/sqlcontainer/query/QueryDelegate.java @@ -94,9 +94,8 @@ public interface QueryDelegate extends Serializable { * decides how to identify whether to store a new row or update an existing * one. * - * @param columnToValueMap - * A map containing the values for all columns to be stored or - * updated. + * @param row + * The row to be stored or updated. * @return the number of affected rows in the database table * @throws UnsupportedOperationException * if the implementation is read only. diff --git a/compatibility-server/src/main/java/com/vaadin/v7/server/communication/data/RpcDataProviderExtension.java b/compatibility-server/src/main/java/com/vaadin/v7/server/communication/data/RpcDataProviderExtension.java index 4fed8fd605..85d3014b0b 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/server/communication/data/RpcDataProviderExtension.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/server/communication/data/RpcDataProviderExtension.java @@ -416,8 +416,6 @@ public class RpcDataProviderExtension extends AbstractExtension { * * @param component * the remote data grid component to extend - * @param columnKeys - * the key mapper for columns */ public void extend(Grid component) { super.extend(component); diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractSelect.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractSelect.java index 70fabdc9b3..eddd57888b 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractSelect.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractSelect.java @@ -718,7 +718,7 @@ public abstract class AbstractSelect extends AbstractField<Object> implements * </p> * * @since 7.5.7 - * @param newValue + * @param newFieldValue * the New selected item or collection of selected items. * @param repaintIsNotNeeded * True if caller is sure that repaint is not needed. diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java index b37c9c7e2b..a763eccba2 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/Calendar.java @@ -1932,9 +1932,9 @@ public class Calendar extends AbstractLegacyComponent * <p> * The default is false, i.e. to render that caption as plain text. * - * @param captionAsHtml - * true if the captions are rendered as HTML, false if rendered - * as plain text + * @param eventCaptionAsHtml + * {@code true} if the captions are rendered as HTML, + * {@code false} if rendered as plain text */ public void setEventCaptionAsHtml(boolean eventCaptionAsHtml) { getState().eventCaptionAsHtml = eventCaptionAsHtml; diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/CheckBox.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/CheckBox.java index 7366266787..10703d5bd2 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/CheckBox.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/CheckBox.java @@ -109,9 +109,10 @@ public class CheckBox extends AbstractField<Boolean> { /** * Creates a new checkbox that is connected to a boolean property. * - * @param state - * the Initial state of the switch-button. + * @param caption + * the Initial caption of the checkbox. * @param dataSource + * the data source */ public CheckBox(String caption, Property<?> dataSource) { this(caption); diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/TwinColSelect.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/TwinColSelect.java index c90cddb595..652f081492 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/TwinColSelect.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/TwinColSelect.java @@ -173,7 +173,7 @@ public class TwinColSelect extends AbstractSelect { /** * Sets the text shown above the right column. * - * @param caption + * @param rightColumnCaption * The text to show */ public void setRightColumnCaption(String rightColumnCaption) { @@ -193,7 +193,7 @@ public class TwinColSelect extends AbstractSelect { /** * Sets the text shown above the left column. * - * @param caption + * @param leftColumnCaption * The text to show */ public void setLeftColumnCaption(String leftColumnCaption) { diff --git a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerSelect.java b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerSelect.java index 79dfdf3b49..57d5a6735f 100644 --- a/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerSelect.java +++ b/compatibility-server/src/main/java/com/vaadin/v7/ui/components/colorpicker/ColorPickerSelect.java @@ -65,11 +65,6 @@ public class ColorPickerSelect extends CustomComponent /** * Instantiates a new color picker select. - * - * @param rows - * the rows - * @param columns - * the columns */ public ColorPickerSelect() { diff --git a/server/src/main/java/com/vaadin/ui/UI.java b/server/src/main/java/com/vaadin/ui/UI.java index 19e0420fd7..e17c7fec38 100644 --- a/server/src/main/java/com/vaadin/ui/UI.java +++ b/server/src/main/java/com/vaadin/ui/UI.java @@ -1779,7 +1779,7 @@ public abstract class UI extends AbstractSingleComponentContainer * * Used internally for communication tracking. * - * @param lastProcessedServerMessageId + * @param lastProcessedClientToServerId * the id of the last processed server message * @since 7.6 */ diff --git a/server/src/main/java/com/vaadin/ui/renderers/LocalDateTimeRenderer.java b/server/src/main/java/com/vaadin/ui/renderers/LocalDateTimeRenderer.java index ea475ebf09..b6d772fe7e 100644 --- a/server/src/main/java/com/vaadin/ui/renderers/LocalDateTimeRenderer.java +++ b/server/src/main/java/com/vaadin/ui/renderers/LocalDateTimeRenderer.java @@ -129,8 +129,6 @@ public class LocalDateTimeRenderer * the format pattern to format the date with, not {@code null} * @param locale * the locale to use, not {@code null} - * @param nullRepresentation - * the textual representation of the {@code null} value * * @throws IllegalArgumentException * if format pattern is null |