javadoc fixes

This commit is contained in:
Brian Matzon 2004-05-14 17:20:17 +00:00
parent 0786d857f8
commit 3e4eac8e66
10 changed files with 30 additions and 18 deletions

View File

@ -213,7 +213,7 @@ public class Controller {
* *
* @param button The index of the button you wish to test (0..buttonCount-1) * @param button The index of the button you wish to test (0..buttonCount-1)
* @return true if the specified button is down * @return true if the specified button is down
* @see #buttonCount * @see #getButtonCount()
*/ */
public static boolean isButtonDown(int button) { public static boolean isButtonDown(int button) {
if (!created) if (!created)

View File

@ -447,8 +447,8 @@ public final class Color implements ReadableColor, Serializable, WritableColor {
* RGB to HSB conversion, pinched from java.awt.Color. * RGB to HSB conversion, pinched from java.awt.Color.
* The HSB value is returned in dest[] if dest[] is supplied. * The HSB value is returned in dest[] if dest[] is supplied.
* Values range from 0..1 * Values range from 0..1
* @param dest[] Destination floats, or null * @param dest Destination floats, or null
* @return dest[], or a new float[] * @return dest, or a new float array
*/ */
public float[] toHSB(float dest[]) { public float[] toHSB(float dest[]) {
int r = getRed(); int r = getRed();

View File

@ -122,14 +122,12 @@ public final class Display {
* and an array with the order in which you would like them sorted in descending order. * 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, * 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. * 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 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 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
* @return the chosen display mode * @return the chosen display mode
* @throws NoSuchFieldException if one of the params is not a field in DisplayMode * @throws NoSuchFieldException if one of the params is not a field in DisplayMode
* @throws Exception if no display mode could be set * @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 { public static DisplayMode setDisplayMode(DisplayMode[] dm, final String[] param) throws Exception {

View File

@ -87,7 +87,8 @@ public final class Point implements ReadablePoint, WritablePoint, Serializable {
/** /**
* Translate a point. * 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) { public void translate(int dx, int dy) {
this.x += dx; this.x += dx;

View File

@ -145,7 +145,8 @@ public final class Rectangle implements ReadableRectangle, WritableRectangle, Se
/** /**
* Translate the rectangle by an amount. * 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) { public void translate(int x, int y) {
this.x += x; this.x += x;
@ -187,7 +188,8 @@ public final class Rectangle implements ReadableRectangle, WritableRectangle, Se
* Checks whether or not this <code>Rectangle</code> contains the * Checks whether or not this <code>Rectangle</code> contains the
* point at the specified location * point at the specified location
* (<i>x</i>,&nbsp;<i>y</i>). * (<i>x</i>,&nbsp;<i>y</i>).
* @param X,&nbsp;Y the specified coordinates * @param X the specified x coordinate
* @param Y the specified y coordinate
* @return <code>true</code> if the point * @return <code>true</code> if the point
* (<i>x</i>,&nbsp;<i>y</i>) is inside this * (<i>x</i>,&nbsp;<i>y</i>) is inside this
* <code>Rectangle</code>; * <code>Rectangle</code>;
@ -229,7 +231,8 @@ public final class Rectangle implements ReadableRectangle, WritableRectangle, Se
* the <code>Rectangle</code> * the <code>Rectangle</code>
* at the specified location (<i>X</i>,&nbsp;<i>Y</i>) with the * at the specified location (<i>X</i>,&nbsp;<i>Y</i>) with the
* specified dimensions (<i>W</i>,&nbsp;<i>H</i>). * specified dimensions (<i>W</i>,&nbsp;<i>H</i>).
* @param X,&nbsp;Y the specified coordinates * @param X the specified x coordinate
* @param Y the specified y coordinate
* @param W the width of the <code>Rectangle</code> * @param W the width of the <code>Rectangle</code>
* @param H the height of the <code>Rectangle</code> * @param H the height of the <code>Rectangle</code>
* @return <code>true</code> if the <code>Rectangle</code> specified by * @return <code>true</code> if the <code>Rectangle</code> specified by
@ -393,7 +396,8 @@ public final class Rectangle implements ReadableRectangle, WritableRectangle, Se
* falls on the right or bottom edge of the enlarged * falls on the right or bottom edge of the enlarged
* <code>Rectangle</code>, <code>contains</code> returns * <code>Rectangle</code>, <code>contains</code> returns
* <code>false</code> for that point. * <code>false</code> for that point.
* @param newx,&nbsp;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) { public void add(int newx, int newy) {
int x1 = Math.min(x, newx); int x1 = Math.min(x, newx);

View File

@ -97,7 +97,7 @@ public class Timer {
/** /**
* Reset the timer. Equivalent to set(0.0f); * Reset the timer. Equivalent to set(0.0f);
* @see #set() * @see #set(float)
*/ */
public void reset() { public void reset() {
set(0.0f); set(0.0f);

View File

@ -41,7 +41,10 @@ public interface WritableRectangle extends WritablePoint, WritableDimension {
/** /**
* Sets the bounds of the rectangle * 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); public void setBounds(int x, int y, int width, int height);

View File

@ -54,7 +54,8 @@ public interface WritableVector2f {
/** /**
* Set the X,Y values * Set the X,Y values
* @param x, y * @param x
* @param y
*/ */
public void set(float x, float y); public void set(float x, float y);

View File

@ -48,7 +48,9 @@ public interface WritableVector3f extends WritableVector2f {
/** /**
* Set the X,Y,Z values * 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); public void set(float x, float y, float z);

View File

@ -48,7 +48,10 @@ public interface WritableVector4f extends WritableVector3f {
/** /**
* Set the X,Y,Z,W values * 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); public void set(float x, float y, float z, float w);