javadoc fixes

This commit is contained in:
Brian Matzon 2002-12-21 12:07:15 +00:00
parent 158bbaf47a
commit b97b37507b
15 changed files with 47 additions and 48 deletions

View File

@ -43,9 +43,10 @@ import org.lwjgl.Sys;
*
* No buffering is available.
*
* Currently n (native limits, currently 128 - might change) buttons, the x, y, z axis is supported along with a POV (or HAT), where the z axis
* represents a throttle. In the future the joystick may support more buttons and
* axises and other features. but this is a platform issue.
* Currently n (native limits, currently 128 - might change) buttons, the x, y,
* z axis is supported along with a POV (or HAT) and a slider, where the z axis
* represents a throttle. In the future the joystick may support more buttons
* and axises and other features. but this is a platform issue.
*
* The joystick implementation currently only supports the first attached joystick.
*
@ -65,16 +66,19 @@ public class Joystick {
private static boolean[] buttons;
/** X position, range -1000 to 1000 */
public static int x = -1;
public static int x = 0;
/** Y position, range -1000 to 1000 */
public static int y = -1;
public static int y = 0;
/** Z position, range -1000 to 1000 */
public static int z = -1;
public static int z = 0;
/** Position of Point of View from -1 to 27000 (360 degrees) */
public static int pov;
/** Slider position, range -1000 to 1000 */
public static int slider = 0;
/** Constant specifying centered POV */
public static final int POV_CENTER = -1;
@ -93,8 +97,11 @@ public class Joystick {
/* Joystick capabilities */
public static int buttonCount = -1;
public static boolean hasXAxis = false;
public static boolean hasYAxis = false;
public static boolean hasZAxis = false;
public static boolean hasPOV = false;
public static boolean hasSlider = false;
/**
* Joystick cannot be constructed.
@ -148,9 +155,9 @@ public class Joystick {
/**
* See if a particular mouse button is down.
*
* @param button The index of the button you wish to test (0..getNumButtons())
* @param button The index of the button you wish to test (0..buttonCount)
* @return true if the specified button is down
* @see #getNumButtons()
* @see #buttonCount
*/
public static boolean isButtonDown(int button) {
assert created : "The joystick has not been created.";

View File

@ -29,7 +29,7 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.lwjgl.openal.eax;
package org.lwjgl.openal.eax;
/**
* $Id$
@ -43,28 +43,28 @@
* @author Brian Matzon <brian@matzon.dk>
* @version $Revision$
*/
public abstract class BaseEAX {
public abstract class BaseEAX {
/** Has the EAX object been created? */
protected static boolean created;
protected static boolean created;
static {
initialize();
}
/**
}
/**
* Override to provide any initialization code after creation.
*/
protected void init() {
}
/**
* Static initialization
*/
private static void initialize() {
System.loadLibrary(org.lwjgl.Sys.getLibraryName());
}
}
/**
* Loads the EAX functions
*
@ -73,44 +73,41 @@ public abstract class BaseEAX {
public void create() throws Exception {
if (created) {
return;
}
}
if (!nCreate()) {
throw new Exception("EAX instance could not be created.");
}
}
created = true;
init();
init();
}
/**
* Native method to create EAX instance
*
* @return true if the EAX extensions could be found
*/
protected native boolean nCreate();
/**
* "Destroy" the EAX object
*/
public void destroy() {
if (!created) {
return;
}
created = false;
nDestroy();
}
created = false;
nDestroy();
}
/**
* Finalizer, marked final. To perform specialized cleanup override the
* cleanup() method.
*
* @see #cleanup()
* Finalizer, marked final.
*/
public void finalize() throws Throwable {
super.finalize();
destroy();
}
}
/**
* Native method the destroy the EAX
*/

View File

@ -151,7 +151,7 @@ public class GLU implements GLUConstants {
* functions. A return value of zero means that there is not enough memory to
* allocate the object
*
* @returns adress to a new quadrics object
* @return adress to a new quadrics object
*/
public native int newQuadric();

View File

@ -35,7 +35,7 @@
/**
* EXT_bgra_constants
*
* @author: cas
* @author cas
*/
public interface EXTBgra {
/*

View File

@ -35,7 +35,6 @@ package org.lwjgl.opengl.ext;
/**
* Insert the type's description here.
* Creation date: (29/06/2000 00:45:10)
* @author:
*/
public interface EXTBlendColor {
public static final int CONSTANT_COLOR_EXT = 0x8001;

View File

@ -34,7 +34,7 @@ package org.lwjgl.opengl.ext;
/**
* EXT_blend_minmax constants
* @author: cas
* @author cas
*/
public interface EXTBlendMinmax {
public static final int FUNC_ADD_EXT = 0x8006;

View File

@ -34,7 +34,7 @@ package org.lwjgl.opengl.ext;
/**
* EXT_blend_subtract constants
* @author: cas
* @author cas
*/
public interface EXTBlendSubtract {
public static final int FUNC_SUBTRACT_EXT = 0x800A;

View File

@ -34,7 +34,7 @@ package org.lwjgl.opengl.ext;
/**
* EXT_light_max_exponent constants
* @author: cas
* @author cas
*/
public interface EXTLightMaxExponent {
public static final int MAX_SHININESS_EXT = 0x8504;

View File

@ -35,7 +35,6 @@ package org.lwjgl.opengl.ext;
/**
* Insert the type's description here.
* Creation date: (07/11/99 19:16:17)
* @author:
*/
public interface EXTPackedPixels {
public static final int UNSIGNED_BYTE_3_3_2_EXT = 0x8032;

View File

@ -35,7 +35,7 @@ package org.lwjgl.opengl.ext;
/**
* EXT_rescale_normal
* @author: cas
* @author cas
*/
public interface EXTRescaleNormal {
public static final int RESCALE_NORMAL_EXT = 0x803A;

View File

@ -35,7 +35,7 @@ package org.lwjgl.opengl.ext;
/**
* EXT_separate_specular_color constants.
* @author: cas
* @author cas
*/
public interface EXTSeparateSpecularColor {
public static final int SINGLE_COLOR_EXT = 0x81F9;

View File

@ -35,7 +35,6 @@ package org.lwjgl.opengl.ext;
/**
* Insert the type's description here.
* Creation date: (07/11/99 19:15:54)
* @author:
*/
public interface EXTSharedTexturePalette {
public static final int SHARED_TEXTURE_PALETTE_EXT = 0x81FB;

View File

@ -35,7 +35,6 @@ package org.lwjgl.opengl.ext;
/**
* Insert the type's description here.
* Creation date: (22/02/00 01:26:05)
* @author:
*/
public interface EXTTextureEnvCombine {
public static final int COMBINE_EXT = 0x8570;

View File

@ -35,7 +35,7 @@ package org.lwjgl.opengl.ext;
/**
* EXT_texture_env_dot3 constants.
* @author: cas
* @author cas
*/
public interface EXTTextureEnvDot3 {
public static final int DOT3_RGB_EXT = 0x8740;

View File

@ -34,7 +34,6 @@ package org.lwjgl.opengl.ext;
/**
* Insert the type's description here.
* Creation date: (07/11/99 18:58:04)
* @author:
*/
public interface EXTVertexArray {
public static final int VERTEX_ARRAY_EXT = 0x8074;