From 3e4eac8e6625a984b9a3122a04c4421d3cd3d96f Mon Sep 17 00:00:00 2001 From: Brian Matzon Date: Fri, 14 May 2004 17:20:17 +0000 Subject: [PATCH] javadoc fixes --- src/java/org/lwjgl/input/Controller.java | 2 +- src/java/org/lwjgl/util/Color.java | 4 ++-- src/java/org/lwjgl/util/Display.java | 8 +++----- src/java/org/lwjgl/util/Point.java | 3 ++- src/java/org/lwjgl/util/Rectangle.java | 12 ++++++++---- src/java/org/lwjgl/util/Timer.java | 2 +- src/java/org/lwjgl/util/WritableRectangle.java | 5 ++++- src/java/org/lwjgl/util/vector/WritableVector2f.java | 3 ++- src/java/org/lwjgl/util/vector/WritableVector3f.java | 4 +++- src/java/org/lwjgl/util/vector/WritableVector4f.java | 5 ++++- 10 files changed, 30 insertions(+), 18 deletions(-) diff --git a/src/java/org/lwjgl/input/Controller.java b/src/java/org/lwjgl/input/Controller.java index 55462303..f133cc66 100644 --- a/src/java/org/lwjgl/input/Controller.java +++ b/src/java/org/lwjgl/input/Controller.java @@ -213,7 +213,7 @@ public class Controller { * * @param button The index of the button you wish to test (0..buttonCount-1) * @return true if the specified button is down - * @see #buttonCount + * @see #getButtonCount() */ public static boolean isButtonDown(int button) { if (!created) diff --git a/src/java/org/lwjgl/util/Color.java b/src/java/org/lwjgl/util/Color.java index 4343757c..839264a2 100644 --- a/src/java/org/lwjgl/util/Color.java +++ b/src/java/org/lwjgl/util/Color.java @@ -447,8 +447,8 @@ public final class Color implements ReadableColor, Serializable, WritableColor { * RGB to HSB conversion, pinched from java.awt.Color. * The HSB value is returned in dest[] if dest[] is supplied. * Values range from 0..1 - * @param dest[] Destination floats, or null - * @return dest[], or a new float[] + * @param dest Destination floats, or null + * @return dest, or a new float array */ public float[] toHSB(float dest[]) { int r = getRed(); diff --git a/src/java/org/lwjgl/util/Display.java b/src/java/org/lwjgl/util/Display.java index c1b6c82d..2356e62e 100644 --- a/src/java/org/lwjgl/util/Display.java +++ b/src/java/org/lwjgl/util/Display.java @@ -122,14 +122,12 @@ public final class Display { * and an array with the order in which you would like them sorted in descending order. * This method attempts to create the topmost display mode; if that fails, it will try the next one, * and so on, until there are no modes left. If no mode is set at the end, an exception is thrown. - * @param dm[] a list of display modes to choose from - * @param param[] the names of the DisplayMode fields in the order in which you would like them sorted. - * @param fullscreen whether to go fullscreen - * @param title The app title + * @param dm a list of display modes to choose from + * @param param the names of the DisplayMode fields in the order in which you would like them sorted. * @return the chosen display mode * @throws NoSuchFieldException if one of the params is not a field in DisplayMode * @throws Exception if no display mode could be set - * @see org.lwjgj.DisplayMode + * @see org.lwjgl.DisplayMode */ public static DisplayMode setDisplayMode(DisplayMode[] dm, final String[] param) throws Exception { diff --git a/src/java/org/lwjgl/util/Point.java b/src/java/org/lwjgl/util/Point.java index ad6537a2..af305359 100644 --- a/src/java/org/lwjgl/util/Point.java +++ b/src/java/org/lwjgl/util/Point.java @@ -87,7 +87,8 @@ public final class Point implements ReadablePoint, WritablePoint, Serializable { /** * Translate a point. - * @param x, y The translation to apply + * @param dx The translation to apply + * @param dy The translation to apply */ public void translate(int dx, int dy) { this.x += dx; diff --git a/src/java/org/lwjgl/util/Rectangle.java b/src/java/org/lwjgl/util/Rectangle.java index d4c9f485..fcd817bc 100644 --- a/src/java/org/lwjgl/util/Rectangle.java +++ b/src/java/org/lwjgl/util/Rectangle.java @@ -145,7 +145,8 @@ public final class Rectangle implements ReadableRectangle, WritableRectangle, Se /** * Translate the rectangle by an amount. - * @param x, y The translation amount + * @param x The translation amount on the x axis + * @param y The translation amount on the y axis */ public void translate(int x, int y) { this.x += x; @@ -187,7 +188,8 @@ public final class Rectangle implements ReadableRectangle, WritableRectangle, Se * Checks whether or not this Rectangle contains the * point at the specified location * (x, y). - * @param X, Y the specified coordinates + * @param X the specified x coordinate + * @param Y the specified y coordinate * @return true if the point * (x, y) is inside this * Rectangle; @@ -229,7 +231,8 @@ public final class Rectangle implements ReadableRectangle, WritableRectangle, Se * the Rectangle * at the specified location (X, Y) with the * specified dimensions (W, H). - * @param X, Y the specified coordinates + * @param X the specified x coordinate + * @param Y the specified y coordinate * @param W the width of the Rectangle * @param H the height of the Rectangle * @return true if the Rectangle specified by @@ -393,7 +396,8 @@ public final class Rectangle implements ReadableRectangle, WritableRectangle, Se * falls on the right or bottom edge of the enlarged * Rectangle, contains returns * false for that point. - * @param newx, newy the coordinates of the new point + * @param newx the x coordinates of the new point + * @param newy the y coordinates of the new point */ public void add(int newx, int newy) { int x1 = Math.min(x, newx); diff --git a/src/java/org/lwjgl/util/Timer.java b/src/java/org/lwjgl/util/Timer.java index 4b1b8622..75ea82fd 100644 --- a/src/java/org/lwjgl/util/Timer.java +++ b/src/java/org/lwjgl/util/Timer.java @@ -97,7 +97,7 @@ public class Timer { /** * Reset the timer. Equivalent to set(0.0f); - * @see #set() + * @see #set(float) */ public void reset() { set(0.0f); diff --git a/src/java/org/lwjgl/util/WritableRectangle.java b/src/java/org/lwjgl/util/WritableRectangle.java index 7bb17ad8..071a7628 100644 --- a/src/java/org/lwjgl/util/WritableRectangle.java +++ b/src/java/org/lwjgl/util/WritableRectangle.java @@ -41,7 +41,10 @@ public interface WritableRectangle extends WritablePoint, WritableDimension { /** * Sets the bounds of the rectangle - * @param x, y, width, height + * @param x Position of rectangle on x axis + * @param y Position of rectangle on y axis + * @param width Width of rectangle + * @param height Height of rectangle */ public void setBounds(int x, int y, int width, int height); diff --git a/src/java/org/lwjgl/util/vector/WritableVector2f.java b/src/java/org/lwjgl/util/vector/WritableVector2f.java index deee4eb2..3b0b75cb 100644 --- a/src/java/org/lwjgl/util/vector/WritableVector2f.java +++ b/src/java/org/lwjgl/util/vector/WritableVector2f.java @@ -54,7 +54,8 @@ public interface WritableVector2f { /** * Set the X,Y values - * @param x, y + * @param x + * @param y */ public void set(float x, float y); diff --git a/src/java/org/lwjgl/util/vector/WritableVector3f.java b/src/java/org/lwjgl/util/vector/WritableVector3f.java index a233946a..1599c83b 100644 --- a/src/java/org/lwjgl/util/vector/WritableVector3f.java +++ b/src/java/org/lwjgl/util/vector/WritableVector3f.java @@ -48,7 +48,9 @@ public interface WritableVector3f extends WritableVector2f { /** * Set the X,Y,Z values - * @param x, y, z + * @param x + * @param y + * @param z */ public void set(float x, float y, float z); diff --git a/src/java/org/lwjgl/util/vector/WritableVector4f.java b/src/java/org/lwjgl/util/vector/WritableVector4f.java index 2e954ab8..645c4051 100644 --- a/src/java/org/lwjgl/util/vector/WritableVector4f.java +++ b/src/java/org/lwjgl/util/vector/WritableVector4f.java @@ -48,7 +48,10 @@ public interface WritableVector4f extends WritableVector3f { /** * Set the X,Y,Z,W values - * @param x, y, z, w + * @param x + * @param y + * @param z + * @param w */ public void set(float x, float y, float z, float w);