Fixes some warnings in the Java documentation of ardor3d-core

8 files changed, 74 insertions, 34 deletions

diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/effect/EffectStep.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/effect/EffectStep.java
index 8831b6d..cdd835b 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/effect/EffectStep.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/effect/EffectStep.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -17,8 +17,9 @@ public interface EffectStep {
 
     /**
      * Apply this step.
-     * 
+     *
      * @param manager
+     *            the effect manager
      */
     public void apply(final EffectManager manager);
 
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/effect/RenderEffect.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/effect/RenderEffect.java
index 6c77243..fd75f9e 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/effect/RenderEffect.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/effect/RenderEffect.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -27,15 +27,18 @@ public abstract class RenderEffect {
 
     /**
      * Do any setup necessary for our effect prior. This should be called only once, or on changes to the effect chain.
-     * 
+     *
      * @param manager
+     *            the effect manager
      */
-    public void prepare(final EffectManager manager) {}
+    public void prepare(final EffectManager manager) {
+    }
 
     /**
      * Render this effect.
-     * 
+     *
      * @param manager
+     *            the effect manager
      */
     public void render(final EffectManager manager) {
         for (final EffectStep step : _steps) {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/FragmentProgramState.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/FragmentProgramState.java
index 90b18aa..3a3083c 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/FragmentProgramState.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/FragmentProgramState.java
@@ -41,7 +41,7 @@ public class FragmentProgramState extends RenderState {
      * programs in memory.
      *
      * @param param four-element array of floating point numbers
-     * 
+     *
      * @param paramID identity number of the parameter, ranging from 0 to 95
      */
     // TODO: Reevaluate how this is done.
@@ -86,6 +86,9 @@ public class FragmentProgramState extends RenderState {
     /**
      * Loads the fragment program into a byte array.
      *
+     * @param file
+     *            the URL of the file containing the fragment program to load
+     *
      * @see com.ardor3d.renderer.state.FragmentProgramState#load(java.net.URL)
      */
     public void load(final java.net.URL file) {
@@ -119,6 +122,9 @@ public class FragmentProgramState extends RenderState {
     /**
      * Loads the fragment program into a byte array.
      *
+     * @param programContents
+     *            the content of the fragment program to load
+     *
      * @see com.ardor3d.renderer.state.FragmentProgramState#load(java.net.URL)
      */
     public void load(final String programContents) {
@@ -159,7 +165,9 @@ public class FragmentProgramState extends RenderState {
      * Used with Serialization. Do not call this directly.
      *
      * @param s
+     *            the output stream
      * @throws IOException
+     *             if something wrong occurs while writing
      * @see java.io.Serializable
      */
     private void writeObject(final java.io.ObjectOutputStream s) throws IOException {
@@ -179,8 +187,11 @@ public class FragmentProgramState extends RenderState {
      * Used with Serialization. Do not call this directly.
      *
      * @param s
+     *            the input stream
      * @throws IOException
+     *             if something wrong occurs while reading
      * @throws ClassNotFoundException
+     *             if a class is not found
      * @see java.io.Serializable
      */
     private void readObject(final java.io.ObjectInputStream s) throws IOException, ClassNotFoundException {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderObjectsState.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderObjectsState.java
index fda1334..77a2936 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderObjectsState.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/GLSLShaderObjectsState.java
@@ -134,7 +134,7 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Gets the currently loaded vertex shader.
      *
-     * @return
+     * @return the currently loaded vertex shader
      */
     public ByteBuffer getVertexShader() {
         return _vertShader;
@@ -143,7 +143,7 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Gets the currently loaded fragment shader.
      *
-     * @return
+     * @return the currently loaded fragment shader
      */
     public ByteBuffer getFragmentShader() {
         return _fragShader;
@@ -152,7 +152,7 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Gets the currently loaded geometry shader.
      *
-     * @return
+     * @return the currently loaded geometry shader
      */
     public ByteBuffer getGeometryShader() {
         return _geomShader;
@@ -161,7 +161,7 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Gets the currently loaded tessellation control shader.
      *
-     * @return
+     * @return the currently loaded tessellation control shader
      */
     public ByteBuffer getTessellationControlShader() {
         return _tessControlShader;
@@ -170,7 +170,7 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Gets the currently loaded tessellation evaluation shader.
      *
-     * @return
+     * @return the currently loaded tessellation evaluation shader
      */
     public ByteBuffer getTessellationEvaluationShader() {
         return _tessEvalShader;
@@ -179,7 +179,7 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Gets the currently loaded compute shader.
      *
-     * @return
+     * @return the currently loaded compute shader
      */
     public ByteBuffer getComputeShader() {
         return _compShader;
@@ -538,7 +538,7 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Gets all shader uniforms variables.
      *
-     * @return
+     * @return all shader uniforms variables
      */
     public List<ShaderVariable> getShaderUniforms() {
         return _shaderUniforms;
@@ -548,7 +548,8 @@ public class GLSLShaderObjectsState extends RenderState {
      * Retrieves a shader uniform by name.
      *
      * @param uniformName
-     * @return
+     *            the name of the shader uniform
+     * @return the shader uniform
      */
     public ShaderVariable getUniformByName(final String uniformName) {
         for (final ShaderVariable shaderVar : _shaderUniforms) {
@@ -563,7 +564,7 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Gets all shader attribute variables.
      *
-     * @return
+     * @return all shader attribute variables
      */
     public List<ShaderVariable> getShaderAttributes() {
         return _shaderAttributes;
@@ -574,7 +575,7 @@ public class GLSLShaderObjectsState extends RenderState {
      *
      * @param attributeName
      *            the attribute name
-     * @return
+     * @return the shader attribute
      */
     public ShaderVariable getAttributeByName(final String attributeName) {
         for (final ShaderVariable shaderVar : _shaderAttributes) {
@@ -599,6 +600,7 @@ public class GLSLShaderObjectsState extends RenderState {
      * Logic to handle setting mesh-specific data to a shader before rendering
      *
      * @param shaderDataLogic
+     *            the mesh-specific data logic
      */
     public void setShaderDataLogic(final GLSLShaderDataLogic shaderDataLogic) {
         _shaderDataLogic = shaderDataLogic;
@@ -1266,12 +1268,14 @@ public class GLSLShaderObjectsState extends RenderState {
 
     /**
      * Creates or retrieves a uniform shadervariable.
-     *
+     * 
+     * @param <T>
+     *            the type of shader variable
      * @param name
      *            Name of the uniform shadervariable to retrieve or create
      * @param classz
      *            Class type of the shadervariable
-     * @return
+     * @return the uniform shader variable
      */
     private <T extends ShaderVariable> T getShaderUniform(final String name, final Class<T> classz) {
         final T shaderVariable = getShaderVariable(name, classz, _shaderUniforms);
@@ -1281,11 +1285,14 @@ public class GLSLShaderObjectsState extends RenderState {
     /**
      * Creates or retrieves a attribute shadervariable.
      *
+     * @param <T>
+     *            the type of shader variable
+     *
      * @param name
      *            Name of the attribute shadervariable to retrieve or create
      * @param classz
      *            Class type of the shadervariable
-     * @return
+     * @return the attribute shader variable
      */
     private <T extends ShaderVariable> T getShaderAttribute(final String name, final Class<T> classz) {
         final T shaderVariable = getShaderVariable(name, classz, _shaderAttributes);
@@ -1294,13 +1301,16 @@ public class GLSLShaderObjectsState extends RenderState {
     }
 
     /**
+     * @param <T>
+     *            the type of shader variable
+     *
      * @param name
      *            Name of the shadervariable to retrieve or create
      * @param classz
      *            Class type of the shadervariable
      * @param shaderVariableList
      *            List retrieve shadervariable from
-     * @return
+     * @return the shader variable
      */
     @SuppressWarnings("unchecked")
     private <T extends ShaderVariable> T getShaderVariable(final String name, final Class<T> classz,
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/RenderState.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/RenderState.java
index 62267b3..4afe0a5 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/RenderState.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/RenderState.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -63,7 +63,8 @@ public abstract class RenderState implements Savable {
      * <li>Material: true</li>
      * <li>Shading: true</li>
      * <li>Texture: false - because you can change a texture object directly without telling the state</li>
-     * <li>Wireframe: false - because line attributes can change when drawing regular lines, affecting wireframe lines</li>
+     * <li>Wireframe: false - because line attributes can change when drawing regular lines, affecting wireframe
+     * lines</li>
      * <li>ZBuffer: true</li>
      * <li>Cull: true</li>
      * <li>VertexShader1: true</li>
@@ -98,7 +99,8 @@ public abstract class RenderState implements Savable {
         private final EnumMap<RenderState.StateType, Stack<RenderState>> stacks = new EnumMap<>(
                 RenderState.StateType.class);
 
-        public StateStack() {}
+        public StateStack() {
+        }
 
         public final static StateStack fetchTempInstance() {
             if (Constants.useStatePools) {
@@ -150,7 +152,8 @@ public abstract class RenderState implements Savable {
     /**
      * Constructs a new RenderState. The state is enabled by default.
      */
-    public RenderState() {}
+    public RenderState() {
+    }
 
     /**
      * @return An statetype enum value for the subclass.
@@ -160,7 +163,7 @@ public abstract class RenderState implements Savable {
 
     /**
      * Returns if this render state is enabled during rendering. Disabled states are ignored.
-     * 
+     *
      * @return True if this state is enabled.
      */
     public boolean isEnabled() {
@@ -169,7 +172,7 @@ public abstract class RenderState implements Savable {
 
     /**
      * Sets if this render state is enabled during rendering. Disabled states are ignored.
-     * 
+     *
      * @param value
      *            False if the state is to be disabled, true otherwise.
      */
@@ -182,7 +185,7 @@ public abstract class RenderState implements Savable {
      * Extracts from the stack the correct renderstate that should apply to the given spatial. This is mainly used for
      * RenderStates that can be cumulitive such as TextureState or LightState. By default, the top of the static is
      * returned. This function should not be called by users directly.
-     * 
+     *
      * @param stack
      *            The stack to extract render states from.
      * @param spat
@@ -222,7 +225,7 @@ public abstract class RenderState implements Savable {
 
     /**
      * This should be called by states when it knows internal data has been altered.
-     * 
+     *
      * @param refresh
      *            true if we should apply this state even if we think it is the current state of its type in the current
      *            context.
@@ -234,6 +237,7 @@ public abstract class RenderState implements Savable {
     /**
      * @see #_quickCompare
      * @param enabled
+     *            <code>true</code> to enable the quick compares
      */
     public static void setQuickCompares(final boolean enabled) {
         _quickCompare.clear();
diff --git a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/VertexProgramState.java b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/VertexProgramState.java
index e5eafa6..fba8366 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/renderer/state/VertexProgramState.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/renderer/state/VertexProgramState.java
@@ -125,6 +125,9 @@ public class VertexProgramState extends RenderState {
     /**
      * Loads the vertex program into a byte array.
      *
+     * @param programContents
+     *            the content of the vertex program to load
+     *
      * @see com.ardor3d.renderer.state.VertexProgramState#load(java.net.URL)
      */
     public void load(final String programContents) {
@@ -170,7 +173,9 @@ public class VertexProgramState extends RenderState {
      * Used with Serialization. Do not call this directly.
      *
      * @param s
+     *            the output stream
      * @throws IOException
+     *             if something wrong occurs while writing
      * @see java.io.Serializable
      */
     private void writeObject(final java.io.ObjectOutputStream s) throws IOException {
@@ -190,8 +195,11 @@ public class VertexProgramState extends RenderState {
      * Used with Serialization. Do not call this directly.
      *
      * @param s
+     *            the input stream
      * @throws IOException
+     *             if something wrong occurs while reading
      * @throws ClassNotFoundException
+     *             if a class is not found
      * @see java.io.Serializable
      */
     private void readObject(final java.io.ObjectInputStream s) throws IOException, ClassNotFoundException {
diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/resource/ResourceSource.java b/ardor3d-core/src/main/java/com/ardor3d/util/resource/ResourceSource.java
index 895c186..0dfcb9b 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/util/resource/ResourceSource.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/util/resource/ResourceSource.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -34,7 +34,7 @@ public interface ResourceSource extends Savable {
 
     /**
      * Generate and return a new ResourceSource pointing to a named resource that is relative to this object's resource.
-     * 
+     *
      * @param name
      *            the name of the resource we want. eg. "./mypic.jpg" etc.
      * @return the relative resource, or null if none is found. Will also return null if this ResourceSource type does
@@ -45,6 +45,7 @@ public interface ResourceSource extends Savable {
     /**
      * @return an InputStream to this resource's contents.
      * @throws IOException
+     *             if something wrong occurs while reading
      */
     InputStream openStream() throws IOException;
 
diff --git a/ardor3d-core/src/main/java/com/ardor3d/util/screen/ScreenExportable.java b/ardor3d-core/src/main/java/com/ardor3d/util/screen/ScreenExportable.java
index 3125ae2..6493797 100644
--- a/ardor3d-core/src/main/java/com/ardor3d/util/screen/ScreenExportable.java
+++ b/ardor3d-core/src/main/java/com/ardor3d/util/screen/ScreenExportable.java
@@ -3,7 +3,7 @@
  *
  * This file is part of Ardor3D.
  *
- * Ardor3D is free software: you can redistribute it and/or modify it 
+ * Ardor3D is free software: you can redistribute it and/or modify it
  * under the terms of its license which may be found in the accompanying
  * LICENSE file or at <http://www.ardor3d.com/LICENSE>.
  */
@@ -20,16 +20,18 @@ public interface ScreenExportable {
      * Export the given image data (byte buffer) in a manner of our choosing. Note that this byte buffer should be
      * treated by the implementing class as immutable and temporary. If you need access to it after returning from the
      * method, make a copy.
-     * 
+     *
      * @param data
      *            the data from the screen. Please respect the data's limit() value.
      * @param width
+     *            the width
      * @param height
+     *            the height
      */
     public void export(ByteBuffer data, int width, int height);
 
     /**
-     * 
+     *
      * @return the image data format we'd like to pull in.
      */
     public ImageDataFormat getFormat();