fix: javadoc

This commit is contained in:
Brian Matzon 2003-05-03 21:20:23 +00:00
parent f75a3197e6
commit 702d541fc6
6 changed files with 37 additions and 32 deletions

View File

@ -130,7 +130,8 @@ public final class Display {
* Set the current display mode. The underlying OS may not use an exact match for
* the specified display mode. After successfully calling setDisplayMode() you will
* still need to query the display's characteristics using getDisplayMode().
* @param newMode The new display mode to set
*
* @param mode The new display mode to set
* @throws Exception if the display mode could not be set
*/
public static native void setDisplayMode(DisplayMode mode) throws Exception;
@ -207,9 +208,9 @@ public final class Display {
*
* If gamma is not supported by the underlying hardware then false is returned.
*
* @param red[] An array of ints to store red gamma in. Must be 256 in length.
* @param green[] An array of ints to store green gamma in. Must be 256 in length.
* @param blue[] An array of ints to store blue gamma in. Must be 256 in length.
* @param red An array of ints to store red gamma in. Must be 256 in length.
* @param green An array of ints to store green gamma in. Must be 256 in length.
* @param blue An array of ints to store blue gamma in. Must be 256 in length.
* @return true if it succeeds, false if it fails
*/
public static native boolean getGammaRamp(int[] red, int[] green, int[] blue);
@ -223,9 +224,9 @@ public final class Display {
*
* When LWJGL exits, any gamma changes are automatically undone.
*
* @param red[] An array of ints to store red gamma in. Must be 256 in length.
* @param green[] An array of ints to store green gamma in. Must be 256 in length.
* @param blue[] An array of ints to store blue gamma in. Must be 256 in length.
* @param red An array of ints to store red gamma in. Must be 256 in length.
* @param green An array of ints to store green gamma in. Must be 256 in length.
* @param blue An array of ints to store blue gamma in. Must be 256 in length.
*
* @return true if it succeeds, false if it fails
*/

View File

@ -71,11 +71,15 @@ public abstract class Window {
*
* Only one Window can be created() at a time; to create another Window you must
* first destroy() the first window.
*
* The dimensions may be ignored if the window cannot be made non-
* fullscreen. The position may be ignored in either case.
*
* @param title The window's title
* @param x, y, width, height The position and dimensions of the client area of
* the window. The dimensions may be ignored if the window cannot be made non-
* fullscreen. The position may be ignored in either case.
* @param x Position on x axis of top left corner of window.
* @param y Position on y axis of top left corner of window.
* @param width Width of window
* @param height Height of window
* @throws RuntimeException if you attempt to create more than one window at the same time
*/
protected Window(String title, int x, int y, int width, int height) {

View File

@ -81,7 +81,6 @@ public class CoreAL extends BaseAL implements BaseALConstants {
/**
* Returns a boolean OpenAL state.
*
* @param parameter state to be queried
* @return boolean state described by pname will be returned.
*/
public native boolean getBoolean(int pname);
@ -89,7 +88,6 @@ public class CoreAL extends BaseAL implements BaseALConstants {
/**
* Returns an int OpenAL state.
*
* @param parameter state to be queried
* @return int state described by pname will be returned.
*/
public native int getInteger(int pname);
@ -97,7 +95,6 @@ public class CoreAL extends BaseAL implements BaseALConstants {
/**
* Returns a float OpenAL state.
*
* @param parameter state to be queried
* @return float state described by pname will be returned.
*/
public native float getFloat(int pname);
@ -105,7 +102,6 @@ public class CoreAL extends BaseAL implements BaseALConstants {
/**
* Returns a double OpenAL state.
*
* @param parameter state to be queried
* @return double state described by pname will be returned.
*/
public native double getDouble(int pname);
@ -113,7 +109,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
/**
* Returns a boolean OpenAL state.
*
* @param parameter state to be queried
* @param pname state to be queried
* @param data address of ByteBuffer to place the booleans in
*/
public native void getBooleanv(int pname, int data);
@ -121,7 +117,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
/**
* Returns an integer OpenAL state.
*
* @param parameter state to be queried
* @param pname state to be queried
* @param data address of ByteBuffer to place the integers in
*/
public native void getIntegerv(int pname, int data);
@ -129,7 +125,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
/**
* Returns a floating point OpenAL state.
*
* @param parameter state to be queried
* @param pname state to be queried
* @param data address of ByteBuffer to place the floats in
*/
public native void getFloatv(int pname, int data);
@ -137,7 +133,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
/**
* Returns a double OpenAL state.
*
* @param parameter state to be queried
* @param pname state to be queried
* @param data address of ByteBuffer to place the floats in
*/
public native void getDoublev(int pname, int data);
@ -177,7 +173,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
* Sets an integer property of the listener
*
* @param pname name of the attribute to be set
* @param integer value to set the attribute to
* @param value value to set the attribute to
*/
public native void listeneri(int pname, int value);
@ -340,7 +336,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
* Plays a set of sources.
*
* @param n number of sources to play
* @param source array of sources to play
* @param sources array of sources to play
*/
public native void sourcePlayv(int n, int sources);
@ -348,7 +344,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
* Pauses a set of sources.
*
* @param n number of sources to pause
* @param source array of sources to pause
* @param sources array of sources to pause
*/
public native void sourcePausev(int n, int sources);
@ -356,7 +352,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
* Stops a set of sources.
*
* @param n number of sources to stop
* @param source array of sources to stop
* @param sources array of sources to stop
*/
public native void sourceStopv(int n, int sources);
@ -364,7 +360,7 @@ public class CoreAL extends BaseAL implements BaseALConstants {
* Rewinds a set of sources.
*
* @param n number of sources to rewind
* @param source array of sources to rewind
* @param sources array of sources to rewind
*/
public native void sourceRewindv(int n, int sources);

View File

@ -190,8 +190,6 @@ public class EAXBufferProperties {
/**
* Creates a new instance of EAXBufferProperties
*
* @param eaxBufferProperties address of EAXBUFFERPROPERTIES
*/
public EAXBufferProperties() {
eaxBufferProperties = ByteBuffer.allocateDirect(EAXBUFFERPROPERTIES_SIZE);
@ -228,7 +226,7 @@ public class EAXBufferProperties {
/**
* Sets the direct path level at high frequencies
*
* @param direct direct path level at high frequencies to set to
* @param directHF direct path level at high frequencies to set to
*/
public void setDirectHF(int directHF) {
eaxBufferProperties.putInt(directHF_offset, directHF);
@ -264,7 +262,7 @@ public class EAXBufferProperties {
/**
* Sets the room effect level at high frequencies
*
* @param room room effect level at high frequencies to set to
* @param roomHF room effect level at high frequencies to set to
*/
public void setRoomHF(int roomHF) {
eaxBufferProperties.putInt(roomHF_offset, roomHF);

View File

@ -244,7 +244,7 @@ public class EAXListenerProperties {
/**
* Sets the room effect level at high frequencies
*
* @param room room effect level at high frequencies to set to
* @param roomHF room effect level at high frequencies to set to
*/
public void setRoomHF(int roomHF) {
eaxListenerProperties.putInt(roomHF_offset, roomHF);

View File

@ -88,9 +88,12 @@ public class BaseGL extends Window {
* support windowed mode, then the width and height must match the current
* display resolution, or an Exception will be thrown. Otherwise a fullscreen
* window will be created.
*
* @param title The title of the window
* @param x, y The position of the window. May be ignored.
* @param width, height The size of the window's client area
* @param x The position of the window on the x axis. May be ignored.
* @param y The position of the window on the y axis. May be ignored.
* @param width The width of the window's client area
* @param height The height of the window's client area
* @param bpp Require colour bits
* @param alpha Required alpha bits
* @param depth Required depth bits
@ -113,9 +116,12 @@ public class BaseGL extends Window {
* Construct a fullscreen instance of GL. If the underlying OS does not
* support fullscreen mode, then a window will be created instead. If this
* fails too then an Exception will be thrown.
*
* @param title The title of the window
* @param x, y The position of the window. May be ignored.
* @param width, height The size of the window's client area
* @param bpp Minimum bits per pixel
* @param alpha Minimum bits per pixel in alpha buffer
* @param depth Minimum bits per pixel in depth buffer
* @param stencil Minimum bits per pixel in stencil buffer
*/
public BaseGL(String title, int bpp, int alpha, int depth, int stencil) {
super(title, 0, 0, Display.getWidth(), Display.getHeight());