From a877b0c1f15e514b59ecd0e4f9543501a81c4c42 Mon Sep 17 00:00:00 2001 From: Elias Naur Date: Mon, 21 Jan 2008 22:20:25 +0000 Subject: [PATCH] javadoc fixes --- src/java/org/lwjgl/opengl/AWTGLCanvas.java | 9 ++++----- src/java/org/lwjgl/util/Display.java | 2 +- src/java/org/lwjgl/util/applet/AppletLoader.java | 4 +--- src/java/org/lwjgl/util/glu/GLU.java | 2 -- src/java/org/lwjgl/util/glu/Project.java | 4 ---- src/java/org/lwjgl/util/vector/Quaternion.java | 8 +++----- 6 files changed, 9 insertions(+), 20 deletions(-) diff --git a/src/java/org/lwjgl/opengl/AWTGLCanvas.java b/src/java/org/lwjgl/opengl/AWTGLCanvas.java index 3f30677f..620ea08e 100644 --- a/src/java/org/lwjgl/opengl/AWTGLCanvas.java +++ b/src/java/org/lwjgl/opengl/AWTGLCanvas.java @@ -136,8 +136,7 @@ public class AWTGLCanvas extends Canvas implements Drawable, ComponentListener, /** * Create an AWTGLCanvas with the requested PixelFormat on the default GraphicsDevice. * - * @param pixelFormat The desired pixel format. May not be null - * @param device the device to create the canvas on. + * @param pixel_format The desired pixel format. May not be null */ public AWTGLCanvas(PixelFormat pixel_format) throws LWJGLException { this(GraphicsEnvironment.getLocalGraphicsEnvironment().getDefaultScreenDevice(), pixel_format); @@ -146,8 +145,8 @@ public class AWTGLCanvas extends Canvas implements Drawable, ComponentListener, /** * Create an AWTGLCanvas with the requested PixelFormat on the default GraphicsDevice. * - * @param pixelFormat The desired pixel format. May not be null * @param device the device to create the canvas on. + * @param pixel_format The desired pixel format. May not be null */ public AWTGLCanvas(GraphicsDevice device, PixelFormat pixel_format) throws LWJGLException { this(device, pixel_format, null); @@ -157,8 +156,8 @@ public class AWTGLCanvas extends Canvas implements Drawable, ComponentListener, * Create an AWTGLCanvas with the requested PixelFormat on the specified GraphicsDevice. * * @param device the device to create the canvas on. - * @param pixelFormat The desired pixel format. May not be null - * @param shared_drawable The Drawable to share context with + * @param pixel_format The desired pixel format. May not be null + * @param drawable The Drawable to share context with */ public AWTGLCanvas(GraphicsDevice device, PixelFormat pixel_format, Drawable drawable) throws LWJGLException { super(implementation.findConfiguration(device, pixel_format)); diff --git a/src/java/org/lwjgl/util/Display.java b/src/java/org/lwjgl/util/Display.java index cedb76b5..32112cf7 100644 --- a/src/java/org/lwjgl/util/Display.java +++ b/src/java/org/lwjgl/util/Display.java @@ -127,7 +127,7 @@ public final class Display { * @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.lwjgl.DisplayMode + * @see org.lwjgl.opengl.DisplayMode */ public static DisplayMode setDisplayMode(DisplayMode[] dm, final String[] param) throws Exception { diff --git a/src/java/org/lwjgl/util/applet/AppletLoader.java b/src/java/org/lwjgl/util/applet/AppletLoader.java index b0866215..5a62ec61 100644 --- a/src/java/org/lwjgl/util/applet/AppletLoader.java +++ b/src/java/org/lwjgl/util/applet/AppletLoader.java @@ -868,7 +868,6 @@ public class AppletLoader extends Applet implements Runnable, AppletStub { * * @param ownCerts Chain of certificates to check against * @param native_certs Chain of certificates to check - * @return true if the chains match */ protected static void validateCertificateChain(Certificate[] ownCerts, Certificate[] native_certs) throws Exception { if (native_certs == null) @@ -948,7 +947,6 @@ public class AppletLoader extends Applet implements Runnable, AppletStub { * Sets the state of the loaded and prints some debug information * * @param error Error message to print - * @param state State to enter */ protected void fatalErrorOccured(String error) { fatalError = true; @@ -968,4 +966,4 @@ public class AppletLoader extends Applet implements Runnable, AppletStub { /* ignored */ } } -} \ No newline at end of file +} diff --git a/src/java/org/lwjgl/util/glu/GLU.java b/src/java/org/lwjgl/util/glu/GLU.java index d9fa582c..c24430e6 100644 --- a/src/java/org/lwjgl/util/glu/GLU.java +++ b/src/java/org/lwjgl/util/glu/GLU.java @@ -294,7 +294,6 @@ public class GLU { * @param projMatrix * @param viewport * @param win_pos - * @return */ public static boolean gluProject(float objx, float objy, float objz, FloatBuffer modelMatrix, @@ -314,7 +313,6 @@ public class GLU { * @param projMatrix * @param viewport * @param obj_pos - * @return */ public static boolean gluUnProject(float winx, float winy, float winz, FloatBuffer modelMatrix, diff --git a/src/java/org/lwjgl/util/glu/Project.java b/src/java/org/lwjgl/util/glu/Project.java index d47415b5..c60bb151 100644 --- a/src/java/org/lwjgl/util/glu/Project.java +++ b/src/java/org/lwjgl/util/glu/Project.java @@ -287,8 +287,6 @@ public class Project extends Util { * @param projMatrix * @param viewport * @param win_pos - * - * @return */ public static boolean gluProject( float objx, @@ -338,8 +336,6 @@ public class Project extends Util { * @param projMatrix * @param viewport * @param obj_pos - * - * @return */ public static boolean gluUnProject( float winx, diff --git a/src/java/org/lwjgl/util/vector/Quaternion.java b/src/java/org/lwjgl/util/vector/Quaternion.java index c38e2fde..c84f2c43 100644 --- a/src/java/org/lwjgl/util/vector/Quaternion.java +++ b/src/java/org/lwjgl/util/vector/Quaternion.java @@ -67,8 +67,6 @@ public class Quaternion extends Vector implements ReadableVector4f { /** * C'tor * - * @param x, - * y, z, w */ public Quaternion(float x, float y, float z, float w) { set(x, y, z, w); @@ -438,7 +436,7 @@ public class Quaternion extends Vector implements ReadableVector4f { * Sets the value of this quaternion using the rotational component of the * passed matrix. * - * @param m1 + * @param m * The matrix * @return this */ @@ -454,7 +452,7 @@ public class Quaternion extends Vector implements ReadableVector4f { * The source matrix * @param q * The destination quaternion, or null if a new quaternion is to be created - * @return + * @return q */ public final static Quaternion setFromMatrix(Matrix4f m, Quaternion q) { return q.setFromMat(m.m00, m.m01, m.m02, m.m10, m.m11, m.m12, m.m20, @@ -480,7 +478,7 @@ public class Quaternion extends Vector implements ReadableVector4f { * The source matrix * @param q * The destination quaternion, or null if a new quaternion is to be created - * @return + * @return q */ public static final Quaternion setFromMatrix(Matrix3f m, Quaternion q) { return q.setFromMat(m.m00, m.m01, m.m02, m.m10, m.m11, m.m12, m.m20,