You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by rw...@apache.org on 2015/09/29 19:13:09 UTC
svn commit: r1705893 - in /pivot/trunk: charts/src/org/apache/pivot/charts/
wtk/src/org/apache/pivot/wtk/
Author: rwhitcomb
Date: Tue Sep 29 17:13:08 2015
New Revision: 1705893
URL: http://svn.apache.org/viewvc?rev=1705893&view=rev
Log:
PIVOT-976: Add @param descriptions to Javadoc (found missing by Java 8) in nine files.
There are still over 100 Javadoc warnings left to fix.
Modified:
pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java
pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewListener.java
pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java
Modified: pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java (original)
+++ pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewCategoryListener.java Tue Sep 29 17:13:08 2015
@@ -25,17 +25,17 @@ public interface ChartViewCategoryListen
/**
* Fired when a category is inserted into a chart view.
*
- * @param chartView
- * @param index
+ * @param chartView The chart that is changing.
+ * @param index The index of the new category that was inserted.
*/
public void categoryInserted(ChartView chartView, int index);
/**
* Fired when a category is removed from a chart view.
*
- * @param chartView
- * @param index
- * @param categories
+ * @param chartView The chart that is changing.
+ * @param index The index of the first category that was removed.
+ * @param categories The list of removed categories.
*/
public void categoriesRemoved(ChartView chartView, int index,
Sequence<ChartView.Category> categories);
@@ -43,18 +43,18 @@ public interface ChartViewCategoryListen
/**
* Fired when a chart view's category key changes.
*
- * @param chartView
- * @param index
- * @param previousKey
+ * @param chartView The chart that is changing.
+ * @param index The index of the category whose key changed.
+ * @param previousKey Previous value of the changed key.
*/
public void categoryKeyChanged(ChartView chartView, int index, String previousKey);
/**
* Fired when a chart view's category label changes.
*
- * @param chartView
- * @param index
- * @param previousLabel
+ * @param chartView The chart that is changing.
+ * @param index The index of the category whose label changed.
+ * @param previousLabel Previous value of the changed label.
*/
public void categoryLabelChanged(ChartView chartView, int index, String previousLabel);
}
Modified: pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewListener.java (original)
+++ pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewListener.java Tue Sep 29 17:13:08 2015
@@ -25,47 +25,47 @@ public interface ChartViewListener {
/**
* Fired when a chart view's data changes.
*
- * @param chartView
- * @param previousChartData
+ * @param chartView The chart that is changing.
+ * @param previousChartData Previous data for the chart.
*/
public void chartDataChanged(ChartView chartView, List<?> previousChartData);
/**
* Fired when a chart view's series name key changes.
*
- * @param chartView
- * @param previousSeriesNameKey
+ * @param chartView The chart that is changing.
+ * @param previousSeriesNameKey Previous value of the key for the series name.
*/
public void seriesNameKeyChanged(ChartView chartView, String previousSeriesNameKey);
/**
* Fired when a chart view's title changes.
*
- * @param chartView
- * @param previousTitle
+ * @param chartView The chart that changed.
+ * @param previousTitle Previous title for this chart.
*/
public void titleChanged(ChartView chartView, String previousTitle);
/**
* Fired when a chart view's horizontal axis label changes.
*
- * @param chartView
- * @param previousHorizontalAxisLabel
+ * @param chartView The chart that has changed.
+ * @param previousHorizontalAxisLabel Previous value of the horizontal axis label.
*/
public void horizontalAxisLabelChanged(ChartView chartView, String previousHorizontalAxisLabel);
/**
* Fired when a chart view's vertical axis label changes.
*
- * @param chartView
- * @param previousVerticalAxisLabel
+ * @param chartView The chart that has changed.
+ * @param previousVerticalAxisLabel Previous value of the vertical axis label.
*/
public void verticalAxisLabelChanged(ChartView chartView, String previousVerticalAxisLabel);
/**
* Fired when a chart view's "show legend" flag changes.
*
- * @param chartView
+ * @param chartView The chart that has changed.
*/
public void showLegendChanged(ChartView chartView);
}
Modified: pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java (original)
+++ pivot/trunk/charts/src/org/apache/pivot/charts/ChartViewSeriesListener.java Tue Sep 29 17:13:08 2015
@@ -23,39 +23,39 @@ public interface ChartViewSeriesListener
/**
* Fired when a series is inserted into a chart view's data set.
*
- * @param chartView
- * @param index
+ * @param chartView The chart that has changed.
+ * @param index Index of the series that was inserted.
*/
public void seriesInserted(ChartView chartView, int index);
/**
* Fired when a series is removed from a chart view's data set.
*
- * @param chartView
- * @param index
- * @param count
+ * @param chartView The chart that has changed.
+ * @param index Starting index of the removed series.
+ * @param count Number of series removed.
*/
public void seriesRemoved(ChartView chartView, int index, int count);
/**
* Fired when a chart view's series data is cleared.
*
- * @param chartView
+ * @param chartView The chart that has changed.
*/
public void seriesCleared(ChartView chartView);
/**
* Fired when a series is updated in a chart view's data set.
*
- * @param chartView
- * @param index
+ * @param chartView The chart that has changed.
+ * @param index Index of the series that was updated.
*/
public void seriesUpdated(ChartView chartView, int index);
/**
* Fired when a chart view's series data is sorted.
*
- * @param chartView
+ * @param chartView Chart that changed.
*/
public void seriesSorted(ChartView chartView);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentKeyListener.java Tue Sep 29 17:13:08 2015
@@ -44,8 +44,8 @@ public interface ComponentKeyListener {
/**
* Called when a key has been typed.
*
- * @param component
- * @param character
+ * @param component Component that has the focus, that is receiving this key.
+ * @param character The decoded character that was typed.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
* propagate.
*/
@@ -54,9 +54,9 @@ public interface ComponentKeyListener {
/**
* Called when a key has been pressed.
*
- * @param component
- * @param keyCode
- * @param keyLocation
+ * @param component Component that has the focus.
+ * @param keyCode The key code for the key that was pressed.
+ * @param keyLocation Location value for the key (left or right for shift keys, etc.).
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
* propagate.
*/
@@ -65,9 +65,9 @@ public interface ComponentKeyListener {
/**
* Called when a key has been released.
*
- * @param component
- * @param keyCode
- * @param keyLocation
+ * @param component Component that has the focus, that is receiving this key event.
+ * @param keyCode Code for the key that was released.
+ * @param keyLocation Location of the key.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
* propagate.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentListener.java Tue Sep 29 17:13:08 2015
@@ -102,26 +102,26 @@ public interface ComponentListener {
* Called when a component's parent has changed (when the component is
* either added to or removed from a container).
*
- * @param component
- * @param previousParent
+ * @param component The component whose parent changed.
+ * @param previousParent Previous parent of this component.
*/
public void parentChanged(Component component, Container previousParent);
/**
* Called when a component's size has changed.
*
- * @param component
- * @param previousWidth
- * @param previousHeight
+ * @param component Component that changed size.
+ * @param previousWidth Previous width of this component.
+ * @param previousHeight Previous height of this component.
*/
public void sizeChanged(Component component, int previousWidth, int previousHeight);
/**
* Called when a component's preferred size has changed.
*
- * @param component
- * @param previousPreferredWidth
- * @param previousPreferredHeight
+ * @param component Component that changed.
+ * @param previousPreferredWidth Previous value of the preferred width for this component.
+ * @param previousPreferredHeight Previous preferred height for this component.
*/
public void preferredSizeChanged(Component component, int previousPreferredWidth,
int previousPreferredHeight);
@@ -129,9 +129,9 @@ public interface ComponentListener {
/**
* Called when a component's preferred width limits have changed.
*
- * @param component
- * @param previousMinimumWidth
- * @param previousMaximumWidth
+ * @param component Component that changed.
+ * @param previousMinimumWidth Previously specified preferred minimum width.
+ * @param previousMaximumWidth Previous value of the preferred maximum width.
*/
public void widthLimitsChanged(Component component, int previousMinimumWidth,
int previousMaximumWidth);
@@ -139,9 +139,9 @@ public interface ComponentListener {
/**
* Called when a component's preferred height limits have changed.
*
- * @param component
- * @param previousMinimumHeight
- * @param previousMaximumHeight
+ * @param component Component that has changed.
+ * @param previousMinimumHeight Previously given minimum height value.
+ * @param previousMaximumHeight Previous maximum height value.
*/
public void heightLimitsChanged(Component component, int previousMinimumHeight,
int previousMaximumHeight);
@@ -149,72 +149,72 @@ public interface ComponentListener {
/**
* Called when a component's location has changed.
*
- * @param component
- * @param previousX
- * @param previousY
+ * @param component Component that has moved.
+ * @param previousX The previous X position of the component.
+ * @param previousY The previous Y position.
*/
public void locationChanged(Component component, int previousX, int previousY);
/**
* Called when a component's visible flag has changed.
*
- * @param component
+ * @param component Component that has changed visibility.
*/
public void visibleChanged(Component component);
/**
* Called when a component's cursor has changed.
*
- * @param component
- * @param previousCursor
+ * @param component Component whose cursor has changed.
+ * @param previousCursor Previous cursor for this component.
*/
public void cursorChanged(Component component, Cursor previousCursor);
/**
* Called when a component's tooltip text has changed.
*
- * @param component
- * @param previousTooltipText
+ * @param component Component that changed.
+ * @param previousTooltipText Previous value of this component's tooltip text.
*/
public void tooltipTextChanged(Component component, String previousTooltipText);
/**
* Called when a component's tooltip delay has changed.
*
- * @param component
- * @param previousTooltipDelay
+ * @param component The component we're dealing with.
+ * @param previousTooltipDelay The previous tooltip delay for this component.
*/
public void tooltipDelayChanged(Component component, int previousTooltipDelay);
/**
* Called when a component's drag source has changed.
*
- * @param component
- * @param previousDragSource
+ * @param component The component in question.
+ * @param previousDragSource The previous value of the {@link DragSource} for this component.
*/
public void dragSourceChanged(Component component, DragSource previousDragSource);
/**
* Called when a component's drop target has changed.
*
- * @param component
- * @param previousDropTarget
+ * @param component The component that is changing.
+ * @param previousDropTarget The previous value of the {@link DropTarget} for this component.
*/
public void dropTargetChanged(Component component, DropTarget previousDropTarget);
/**
* Called when a component's context menu handler has changed.
*
- * @param component
- * @param previousMenuHandler
+ * @param component The component that has changed.
+ * @param previousMenuHandler The previous menu handler object for this component.
*/
public void menuHandlerChanged(Component component, MenuHandler previousMenuHandler);
/**
* Called when a component's name has changed.
*
- * @param component
- * @param previousName
+ * @param component Component whose name changed.
+ * @param previousName Previous name for this component.
*/
public void nameChanged(Component component, String previousName);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseButtonListener.java Tue Sep 29 17:13:08 2015
@@ -43,10 +43,10 @@ public interface ComponentMouseButtonLis
/**
* Called when a mouse button is pressed over a component.
*
- * @param component
- * @param button
- * @param x
- * @param y
+ * @param component Component that is under the mouse pointer.
+ * @param button Which mouse button was pressed.
+ * @param x X position of the mouse.
+ * @param y Y position of the mouse.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
* propagate.
*/
@@ -55,10 +55,10 @@ public interface ComponentMouseButtonLis
/**
* Called when a mouse button is released over a component.
*
- * @param component
- * @param button
- * @param x
- * @param y
+ * @param component Component user the mouse pointer.
+ * @param button Which mouse button that was released.
+ * @param x X position of the mouse.
+ * @param y Y position of the mouse.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
* propagate.
*/
@@ -67,11 +67,11 @@ public interface ComponentMouseButtonLis
/**
* Called when a mouse button is clicked over a component.
*
- * @param component
- * @param button
- * @param x
- * @param y
- * @param count
+ * @param component Component user the mouse pointer.
+ * @param button Which mouse button was clicked.
+ * @param x X position of the mouse.
+ * @param y Y position of the mouse.
+ * @param count Number of clicks (1 = single click, 2 = double click, etc.).
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
* propagate.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseListener.java Tue Sep 29 17:13:08 2015
@@ -44,9 +44,9 @@ public interface ComponentMouseListener
/**
* Called when the mouse is moved over a component.
*
- * @param component
- * @param x
- * @param y
+ * @param component Component that is under the mouse.
+ * @param x X position of the mouse.
+ * @param y Y position of the mouse.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
* propagate.
*/
@@ -55,14 +55,14 @@ public interface ComponentMouseListener
/**
* Called when the mouse enters a component.
*
- * @param component
+ * @param component Component that is now under the mouse pointer.
*/
public void mouseOver(Component component);
/**
* Called when the mouse exits a component.
*
- * @param component
+ * @param component Component that has now lost the mouse pointer.
*/
public void mouseOut(Component component);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentMouseWheelListener.java Tue Sep 29 17:13:08 2015
@@ -23,12 +23,12 @@ public interface ComponentMouseWheelList
/**
* Called when the mouse wheel is scrolled over a component.
*
- * @param component
- * @param scrollType
- * @param scrollAmount
- * @param wheelRotation
- * @param x
- * @param y
+ * @param component Component under the mouse pointer.
+ * @param scrollType What type of scroll was requested on the mouse.
+ * @param scrollAmount Amount of scrolling.
+ * @param wheelRotation Rotation value.
+ * @param x X position of the mouse.
+ * @param y Y position of the mouse.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it to
* propagate.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java?rev=1705893&r1=1705892&r2=1705893&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentTooltipListener.java Tue Sep 29 17:13:08 2015
@@ -23,9 +23,9 @@ public interface ComponentTooltipListene
/**
* Called when a tooltip has been triggered over a component.
*
- * @param component
- * @param x
- * @param y
+ * @param component The component in question.
+ * @param x X position of the mouse.
+ * @param y Y position of the mouse.
*/
public void tooltipTriggered(Component component, int x, int y);
}