Fix unused parameters in javadoc (#10055)

13 files changed, 51 insertions, 52 deletions

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);