PIVOT-976: More Javadoc fixes for the warnings from Java 8.
Continuing on down the list, now into the directories past "wtk", namely
"content", "effects", and "media". All these were @param tags that had
no description, although I did reformat one Enum list for clarity also.
git-svn-id: https://svn.apache.org/repos/asf/pivot/trunk@1742028 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/wtk/src/org/apache/pivot/wtk/content/NumericSpinnerData.java b/wtk/src/org/apache/pivot/wtk/content/NumericSpinnerData.java
index 78a4ac2..28e9465 100644
--- a/wtk/src/org/apache/pivot/wtk/content/NumericSpinnerData.java
+++ b/wtk/src/org/apache/pivot/wtk/content/NumericSpinnerData.java
@@ -89,6 +89,9 @@
/**
* Creates a new <tt>NumericSpinnerData</tt> with the specified bounded
* range and an increment of one.
+ *
+ * @param lowerBound The lower bound for the data.
+ * @param upperBound The upper bound for the data.
*/
public NumericSpinnerData(int lowerBound, int upperBound) {
this(lowerBound, upperBound, 1);
@@ -97,6 +100,10 @@
/**
* Creates a new <tt>NumericSpinnerData</tt> with the specified bounded
* range and increment.
+ *
+ * @param lowerBound The lower bound for the data.
+ * @param upperBound The upper bound for the data.
+ * @param increment The increment between values.
*/
public NumericSpinnerData(int lowerBound, int upperBound, int increment) {
if (lowerBound >= upperBound) {
diff --git a/wtk/src/org/apache/pivot/wtk/effects/Decorator.java b/wtk/src/org/apache/pivot/wtk/effects/Decorator.java
index c75b160..92164a9 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/Decorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/Decorator.java
@@ -50,8 +50,8 @@
* {@link Component#paint(Graphics2D)}; decorators are called in descending
* order.
*
- * @param component
- * @param graphics
+ * @param component The component the decorator is attached to.
+ * @param graphics The graphics context to draw into.
* @return The graphics context that should be used by the component or prior
* decorators.
*/
@@ -68,7 +68,7 @@
/**
* Returns the bounding area of the decorator.
*
- * @param component
+ * @param component The component that the decorator is attached to.
* @return The decorator's bounds, relative to the component's origin.
*/
public Bounds getBounds(Component component);
@@ -77,6 +77,7 @@
* Returns the transformation the decorator applies to the component's
* coordinate space.
*
+ * @param component The component the decorator is attached to.
* @return The decorator's transform.
*/
public AffineTransform getTransform(Component component);
diff --git a/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java b/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java
index 86d36ba..aba16a0 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/RotationDecorator.java
@@ -45,7 +45,7 @@
}
/**
- * Gets the rotation angle, in radians.
+ * @return The rotation angle, in radians.
*/
public double getTheta() {
return theta;
@@ -53,6 +53,8 @@
/**
* Sets the rotation angle, in radians.
+ *
+ * @param theta The rotation angle, in radians.
*/
public void setTheta(double theta) {
this.theta = theta;
diff --git a/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java b/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java
index cd3bacf..c612af0 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java
@@ -66,7 +66,7 @@
}
/**
- * Returns the opacity of the decorator, in [0,1].
+ * @return The opacity of the decorator, in [0,1].
*/
public float getOpacity() {
return opacity;
@@ -95,14 +95,16 @@
}
/**
- * Returns the color of the decorator
+ * @return The color of the decorator.
*/
public Color getColor() {
return color;
}
/**
- * Sets the color of the decorator
+ * Sets the color of the decorator.
+ *
+ * @param color The new color for the decorator.
*/
public void setColor(Color color) {
if (color == null) {
@@ -113,7 +115,7 @@
}
/**
- * Sets the color of the decorator
+ * Sets the color of the decorator.
*
* @param color Any of the {@linkplain GraphicsUtilities#decodeColor color
* values recognized by Pivot}.
diff --git a/wtk/src/org/apache/pivot/wtk/effects/Transition.java b/wtk/src/org/apache/pivot/wtk/effects/Transition.java
index 8c2dd78..6a3c783 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/Transition.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/Transition.java
@@ -173,7 +173,7 @@
* updates.
*
* @return The transition interval in milliseconds,
- * or a default minimum value if transitions has been disabled.
+ * or a default minimum value if transitions have been disabled.
*/
public int getInterval() {
int interval;
@@ -206,7 +206,7 @@
/**
* Returns the elapsed time since the transition started.
*
- * @return Returns the amount of time that has passed since the transition
+ * @return The amount of time that has passed since the transition
* was started. If the transition is reversed, this value reflects the
* amount of time remaining.
*/
@@ -337,7 +337,7 @@
/**
* Sets the transition's reversed flag.
*
- * @param reversed
+ * @param reversed Whether the transition should be reversed.
*/
public void setReversed(boolean reversed) {
this.reversed = reversed;
diff --git a/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java b/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java
index a1c7d30..36f0b5e 100644
--- a/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java
+++ b/wtk/src/org/apache/pivot/wtk/effects/TransitionListener.java
@@ -23,7 +23,7 @@
/**
* Called when a transition has completed.
*
- * @param transition
+ * @param transition The transition that has finished.
*/
public void transitionCompleted(Transition transition);
}
diff --git a/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java b/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java
index 6ba68b0..a9bcfaf 100644
--- a/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java
+++ b/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java
@@ -35,8 +35,11 @@
* Supported image formats.
*/
public enum Format {
- PNG("png", "image/png"), JPEG("jpeg", "image/jpeg"), BMP("bmp", "image/bmp"), WBMP("wbmp",
- "image/vnd.wap.wbmp"), GIF("gif", "image/gif");
+ PNG ("png", "image/png"),
+ JPEG("jpeg", "image/jpeg"),
+ BMP ("bmp", "image/bmp"),
+ WBMP("wbmp", "image/vnd.wap.wbmp"),
+ GIF ("gif", "image/gif");
private String name;
private String mimeType;
@@ -66,7 +69,7 @@
}
/**
- * Gets the image format that this serializer is using for output.
+ * @return The image format that this serializer is using for output.
*/
public Format getOutputFormat() {
return outputFormat;
@@ -74,6 +77,8 @@
/**
* Sets the image format that this serializer should use for output.
+ *
+ * @param outputFormat The new format to use for output.
*/
public void setOutputFormat(Format outputFormat) {
if (outputFormat == null) {
@@ -86,6 +91,7 @@
/**
* Reads a serialized image from an input stream.
*
+ * @param inputStream The stream to read the image from.
* @return A <tt>BufferedImage</tt> object
*/
@Override
@@ -101,6 +107,9 @@
/**
* Writes a buffered image to an output stream.
+ *
+ * @param bufferedImage The image to write out to the stream.
+ * @param outputStream The stream to write the image out to.
*/
@Override
public void writeObject(BufferedImage bufferedImage, OutputStream outputStream)
diff --git a/wtk/src/org/apache/pivot/wtk/media/ImageListener.java b/wtk/src/org/apache/pivot/wtk/media/ImageListener.java
index f638e4d..61e8686 100644
--- a/wtk/src/org/apache/pivot/wtk/media/ImageListener.java
+++ b/wtk/src/org/apache/pivot/wtk/media/ImageListener.java
@@ -23,28 +23,28 @@
/**
* Called when an image's size has changed.
*
- * @param image
- * @param previousWidth
- * @param previousHeight
+ * @param image The image whose size has changed.
+ * @param previousWidth The previous width of the image.
+ * @param previousHeight The previous height of the image.
*/
public void sizeChanged(Image image, int previousWidth, int previousHeight);
/**
* Called when an image's baseline has changed.
*
- * @param image
- * @param previousBaseline
+ * @param image The image that has changed.
+ * @param previousBaseline The previous baseline value of the image.
*/
public void baselineChanged(Image image, int previousBaseline);
/**
* Called when a region within an image needs to be repainted.
*
- * @param image
- * @param x
- * @param y
- * @param width
- * @param height
+ * @param image The image that needs repainting.
+ * @param x The upper left X-coordinate for the repaint.
+ * @param y The upper left Y-coordinate for the repaint.
+ * @param width The width of the image to repaint.
+ * @param height The height of the area to repaint.
*/
public void regionUpdated(Image image, int x, int y, int width, int height);
}
diff --git a/wtk/src/org/apache/pivot/wtk/media/MovieListener.java b/wtk/src/org/apache/pivot/wtk/media/MovieListener.java
index c5dea27..62be670 100644
--- a/wtk/src/org/apache/pivot/wtk/media/MovieListener.java
+++ b/wtk/src/org/apache/pivot/wtk/media/MovieListener.java
@@ -63,32 +63,32 @@
/**
* Called when a movie's size has changed.
*
- * @param movie
- * @param previousWidth
- * @param previousHeight
+ * @param movie The movie that has been resized.
+ * @param previousWidth The previous width of this movie.
+ * @param previousHeight The previous value of the height before resizing.
*/
public void sizeChanged(Movie movie, int previousWidth, int previousHeight);
/**
* Called when a movie's baseline has changed.
*
- * @param movie
- * @param previousBaseline
+ * @param movie The movie that has changed.
+ * @param previousBaseline The previous baseline value of the movie.
*/
public void baselineChanged(Movie movie, int previousBaseline);
/**
* Called when the movie's current frame changed.
*
- * @param movie
- * @param previousFrame
+ * @param movie The movie that has changed.
+ * @param previousFrame The previous frame index of the movie.
*/
public void currentFrameChanged(Movie movie, int previousFrame);
/**
* Called when the movie's looping property changed.
*
- * @param movie
+ * @param movie The source of this event.
*/
public void loopingChanged(Movie movie);
@@ -97,7 +97,7 @@
* starting can be obtained via <tt>getCurrentFrame()</tt> (it is not
* guaranteed to be positioned before the first frame when it is started).
*
- * @param movie
+ * @param movie The movie that has just started to play.
*/
public void movieStarted(Movie movie);
@@ -106,18 +106,18 @@
* can be obtained via <tt>getCurrentFrame()</tt> (it is not guaranteed to
* have completed the last frame when it is stopped).
*
- * @param movie
+ * @param movie The movie that has just stopped playing.
*/
public void movieStopped(Movie movie);
/**
* Called when a region within a movie needs to be repainted.
*
- * @param movie
- * @param x
- * @param y
- * @param width
- * @param height
+ * @param movie The movie that needs repainting.
+ * @param x The upper left X-position of the region to repaint.
+ * @param y The upper left Y-position for the repaint.
+ * @param width The width of the image to repaint.
+ * @param height The height to repaint.
*/
public void regionUpdated(Movie movie, int x, int y, int width, int height);
}
