[Java-game-lib-cvs] SF.net SVN: java-game-lib: [2956] trunk/LWJGL/src/java/org/lwjgl

[<eli...@us...>]

Revision: 2956
          http://java-game-lib.svn.sourceforge.net/java-game-lib/?rev=2956&view=rev
Author:   elias_naur
Date:     2008-01-21 14:20:25 -0800 (Mon, 21 Jan 2008)

Log Message:
-----------
javadoc fixes

Modified Paths:
--------------
    trunk/LWJGL/src/java/org/lwjgl/opengl/AWTGLCanvas.java
    trunk/LWJGL/src/java/org/lwjgl/util/Display.java
    trunk/LWJGL/src/java/org/lwjgl/util/applet/AppletLoader.java
    trunk/LWJGL/src/java/org/lwjgl/util/glu/GLU.java
    trunk/LWJGL/src/java/org/lwjgl/util/glu/Project.java
    trunk/LWJGL/src/java/org/lwjgl/util/vector/Quaternion.java

Modified: trunk/LWJGL/src/java/org/lwjgl/opengl/AWTGLCanvas.java
===================================================================
--- trunk/LWJGL/src/java/org/lwjgl/opengl/AWTGLCanvas.java	2008-01-21 22:19:25 UTC (rev 2955)
+++ trunk/LWJGL/src/java/org/lwjgl/opengl/AWTGLCanvas.java	2008-01-21 22:20:25 UTC (rev 2956)
@@ -136,8 +136,7 @@
 	/**
 	 * 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 @@
 	/**
 	 * 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 @@
 	 * 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));

Modified: trunk/LWJGL/src/java/org/lwjgl/util/Display.java
===================================================================
--- trunk/LWJGL/src/java/org/lwjgl/util/Display.java	2008-01-21 22:19:25 UTC (rev 2955)
+++ trunk/LWJGL/src/java/org/lwjgl/util/Display.java	2008-01-21 22:20:25 UTC (rev 2956)
@@ -127,7 +127,7 @@
 	 * @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 {
 		

Modified: trunk/LWJGL/src/java/org/lwjgl/util/applet/AppletLoader.java
===================================================================
--- trunk/LWJGL/src/java/org/lwjgl/util/applet/AppletLoader.java	2008-01-21 22:19:25 UTC (rev 2955)
+++ trunk/LWJGL/src/java/org/lwjgl/util/applet/AppletLoader.java	2008-01-21 22:20:25 UTC (rev 2956)
@@ -868,7 +868,6 @@
 	 * 
 	 * @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 @@
 	 * 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 @@
 			/* ignored */
 		}
 	}
-}
\ No newline at end of file
+}

Modified: trunk/LWJGL/src/java/org/lwjgl/util/glu/GLU.java
===================================================================
--- trunk/LWJGL/src/java/org/lwjgl/util/glu/GLU.java	2008-01-21 22:19:25 UTC (rev 2955)
+++ trunk/LWJGL/src/java/org/lwjgl/util/glu/GLU.java	2008-01-21 22:20:25 UTC (rev 2956)
@@ -294,7 +294,6 @@
 	 * @param projMatrix
 	 * @param viewport
 	 * @param win_pos
-	 * @return
 	 */
 	public static boolean gluProject(float objx, float objy, float objz,
 			FloatBuffer modelMatrix,
@@ -314,7 +313,6 @@
 	 * @param projMatrix
 	 * @param viewport
 	 * @param obj_pos
-	 * @return
 	 */
 	public static boolean gluUnProject(float winx, float winy, float winz,
 			FloatBuffer modelMatrix,

Modified: trunk/LWJGL/src/java/org/lwjgl/util/glu/Project.java
===================================================================
--- trunk/LWJGL/src/java/org/lwjgl/util/glu/Project.java	2008-01-21 22:19:25 UTC (rev 2955)
+++ trunk/LWJGL/src/java/org/lwjgl/util/glu/Project.java	2008-01-21 22:20:25 UTC (rev 2956)
@@ -287,8 +287,6 @@
 	 * @param projMatrix
 	 * @param viewport
 	 * @param win_pos
-	 * 
-	 * @return
 	 */
 	public static boolean gluProject(
 		float objx,
@@ -338,8 +336,6 @@
 	 * @param projMatrix
 	 * @param viewport
 	 * @param obj_pos
-	 * 
-	 * @return
 	 */
 	public static boolean gluUnProject(
 		float winx,

Modified: trunk/LWJGL/src/java/org/lwjgl/util/vector/Quaternion.java
===================================================================
--- trunk/LWJGL/src/java/org/lwjgl/util/vector/Quaternion.java	2008-01-21 22:19:25 UTC (rev 2955)
+++ trunk/LWJGL/src/java/org/lwjgl/util/vector/Quaternion.java	2008-01-21 22:20:25 UTC (rev 2956)
@@ -67,8 +67,6 @@
 	/**
 	 * 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 @@
 	 * 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 @@
 	 *            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 @@
 	 *            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,


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.