From 6b12d5c638069f099c98ebd53e237652d5d82946 Mon Sep 17 00:00:00 2001 From: shadowislord Date: Sat, 31 May 2014 13:12:46 -0400 Subject: [PATCH] * Fix many javadoc errors mostly related to incorrect HTML or missing references --- .../java/com/jme3/app/AndroidHarness.java | 2 +- .../AndroidMediaPlayerAudioRenderer.java | 2 +- .../blender/modifiers/ArmatureModifier.java | 2 +- .../textures/blending/TextureBlenderAWT.java | 30 +++++++++++++++- .../textures/blending/TextureBlenderDDS.java | 10 +++++- .../blending/TextureBlenderLuminance.java | 19 ++++++++++- .../textures/generating/TextureGenerator.java | 3 -- .../collision/PhysicsCollisionListener.java | 3 +- .../main/java/com/jme3/animation/Bone.java | 6 ++-- .../java/com/jme3/app/state/AppState.java | 8 +++-- .../java/com/jme3/asset/AssetManager.java | 5 +-- .../java/com/jme3/cinematic/Cinematic.java | 2 +- .../main/java/com/jme3/input/FlyByCamera.java | 1 - .../main/java/com/jme3/renderer/Renderer.java | 34 +++++++++---------- .../main/java/com/jme3/scene/shape/Box.java | 2 +- .../main/java/com/jme3/scene/shape/Dome.java | 6 ++-- .../java/com/jme3/texture/FrameBuffer.java | 2 +- .../src/main/java/com/jme3/texture/Image.java | 4 +-- .../com/jme3/texture/image/ImageRaster.java | 4 +-- .../com/jme3/cursors/plugins/JmeCursor.java | 3 +- .../material/plugins/ConditionParser.java | 4 ++- .../plugins/ShaderNodeLoaderDelegate.java | 6 ++-- .../jme3/cursors/plugins/CursorLoader.java | 3 +- .../com/jme3/network/MessageConnection.java | 2 +- .../network/kernel/tcp/SelectorKernel.java | 2 +- .../com/jme3/niftygui/NiftyJmeDisplay.java | 2 +- .../com/jme3/export/xml/DOMSerializer.java | 3 -- .../main/java/com/jme3/terrain/GeoMap.java | 19 ++++++----- .../terrain/geomipmap/NeighbourFinder.java | 2 +- .../jme3/terrain/geomipmap/TerrainQuad.java | 2 +- .../java/com/jme3/terrain/noise/Basis.java | 2 +- .../com/jme3/terrain/noise/ShaderUtils.java | 2 +- .../com/jmonkeyengine/tests/TestsHarness.java | 2 +- 33 files changed, 127 insertions(+), 72 deletions(-) diff --git a/jme3-android/src/main/java/com/jme3/app/AndroidHarness.java b/jme3-android/src/main/java/com/jme3/app/AndroidHarness.java index 0e108b3c2..d14a27e30 100644 --- a/jme3-android/src/main/java/com/jme3/app/AndroidHarness.java +++ b/jme3-android/src/main/java/com/jme3/app/AndroidHarness.java @@ -77,7 +77,7 @@ public class AndroidHarness extends Activity implements TouchListener, DialogInt * how the surfaceview is able to display Android views that are located * under the surfaceview jME uses to render the scenegraph. * 0 = Opaque surfaceview background (fastest) - * 1->7 = Transparent surfaceview background + * 1->7 = Transparent surfaceview background * 8 or higher = Translucent surfaceview background * (default = 0) */ diff --git a/jme3-android/src/main/java/com/jme3/audio/android/AndroidMediaPlayerAudioRenderer.java b/jme3-android/src/main/java/com/jme3/audio/android/AndroidMediaPlayerAudioRenderer.java index df1bea3b6..52c4c8fdb 100644 --- a/jme3-android/src/main/java/com/jme3/audio/android/AndroidMediaPlayerAudioRenderer.java +++ b/jme3-android/src/main/java/com/jme3/audio/android/AndroidMediaPlayerAudioRenderer.java @@ -309,7 +309,7 @@ public class AndroidMediaPlayerAudioRenderer implements AndroidAudioRenderer, * the channel of the last played instance. * * It is not possible to get information about the state of the soundpool of - * a specific streamid, so removing is not possilbe -> noone knows when + * a specific streamid, so removing is not possilbe -> noone knows when * sound finished. */ public void playSourceInstance(AudioSource src) { diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/modifiers/ArmatureModifier.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/modifiers/ArmatureModifier.java index 94e289dde..9576d94ac 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/modifiers/ArmatureModifier.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/modifiers/ArmatureModifier.java @@ -247,7 +247,7 @@ import com.jme3.util.BufferUtils; if (boneEnvelope.isInEnvelope(pos)) { vertexGroup.addVertex(index, boneEnvelope.getWeight()); } else if (boneIndex == 5) { - System.out.println("Się nie załapał: " + pos); + System.out.println("Si nie zaapa: " + pos); } } } diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderAWT.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderAWT.java index 9ebf4eeac..d7f26b1be 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderAWT.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderAWT.java @@ -43,7 +43,35 @@ import java.nio.ByteBuffer; import java.util.ArrayList; /** - * The class that is responsible for blending the following texture types:
  • RGBA8
  • ABGR8
  • BGR8
  • RGB8 Not yet supported (but will be):
  • ARGB4444:
  • RGB10:
  • RGB111110F:
  • RGB16:
  • RGB16F:
  • RGB16F_to_RGB111110F:
  • RGB16F_to_RGB9E5:
  • RGB32F:
  • RGB565:
  • RGB5A1:
  • RGB9E5:
  • RGBA16:
  • RGBA16F + *

    + * The class that is responsible for blending the following texture types: + *

    + * + * + *

    + * Not yet supported (but will be): + *

    + * + * * @author Marcin Roguski (Kaelthas) */ public class TextureBlenderAWT extends AbstractTextureBlender { diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderDDS.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderDDS.java index f6a2e8a91..264ebc1da 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderDDS.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderDDS.java @@ -12,7 +12,15 @@ import java.util.ArrayList; import jme3tools.converters.RGB565; /** - * The class that is responsible for blending the following texture types:
  • DXT1
  • DXT1A
  • DXT3
  • DXT5 + *

    + * The class that is responsible for blending the following texture types: + *

    + * * @author Marcin Roguski (Kaelthas) */ public class TextureBlenderDDS extends TextureBlenderAWT { diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderLuminance.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderLuminance.java index eac0ae0d5..06035ca31 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderLuminance.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderLuminance.java @@ -14,7 +14,24 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * The class that is responsible for blending the following texture types:
  • Luminance8
  • Luminance8Alpha8 Not yet supported (but will be):
  • Luminance16:
  • Luminance16Alpha16:
  • Luminance16F:
  • Luminance16FAlpha16F:
  • Luminance32F: + *

    + * The class that is responsible for blending the following texture types: + *

    + * + *

    + * Not yet supported (but will be): + *

    + * + * * @author Marcin Roguski (Kaelthas) */ public class TextureBlenderLuminance extends AbstractTextureBlender { diff --git a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/generating/TextureGenerator.java b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/generating/TextureGenerator.java index c001e463c..e459a0dfb 100644 --- a/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/generating/TextureGenerator.java +++ b/jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/generating/TextureGenerator.java @@ -70,9 +70,6 @@ public abstract class TextureGenerator { /** * This method applies brightness and contrast for RGB textures. - * @param tex - * texture structure - * @param texres */ protected void applyBrightnessAndContrast(BrightnessAndContrastData bacd, TexturePixel texres) { texres.red = (texres.red - 0.5f) * bacd.contrast + bacd.brightness; diff --git a/jme3-bullet/src/common/java/com/jme3/bullet/collision/PhysicsCollisionListener.java b/jme3-bullet/src/common/java/com/jme3/bullet/collision/PhysicsCollisionListener.java index 86ba943ab..b49e3627f 100644 --- a/jme3-bullet/src/common/java/com/jme3/bullet/collision/PhysicsCollisionListener.java +++ b/jme3-bullet/src/common/java/com/jme3/bullet/collision/PhysicsCollisionListener.java @@ -38,7 +38,8 @@ package com.jme3.bullet.collision; public interface PhysicsCollisionListener { /** - * Called when a collision happened in the PhysicsSpace, called from render thread.
    + * Called when a collision happened in the PhysicsSpace, called from render thread. + * * Do not store the event object as it will be cleared after the method has finished. * @param event the CollisionEvent */ diff --git a/jme3-core/src/main/java/com/jme3/animation/Bone.java b/jme3-core/src/main/java/com/jme3/animation/Bone.java index f6958c04b..dc4dc7092 100644 --- a/jme3-core/src/main/java/com/jme3/animation/Bone.java +++ b/jme3-core/src/main/java/com/jme3/animation/Bone.java @@ -61,14 +61,14 @@ public final class Bone implements Savable { private Node attachNode; /** * Initial transform is the local bind transform of this bone. - * PARENT SPACE -> BONE SPACE + * PARENT SPACE -> BONE SPACE */ private Vector3f initialPos; private Quaternion initialRot; private Vector3f initialScale; /** * The inverse world bind transform. - * BONE SPACE -> MODEL SPACE + * BONE SPACE -> MODEL SPACE */ private Vector3f worldBindInversePos; private Quaternion worldBindInverseRot; @@ -80,7 +80,7 @@ public final class Bone implements Savable { private Quaternion localRot = new Quaternion(); private Vector3f localScale = new Vector3f(1.0f, 1.0f, 1.0f); /** - * MODEL SPACE -> BONE SPACE (in animated state) + * MODEL SPACE -> BONE SPACE (in animated state) */ private Vector3f worldPos = new Vector3f(); private Quaternion worldRot = new Quaternion(); diff --git a/jme3-core/src/main/java/com/jme3/app/state/AppState.java b/jme3-core/src/main/java/com/jme3/app/state/AppState.java index cd6e02e51..72988c0ef 100644 --- a/jme3-core/src/main/java/com/jme3/app/state/AppState.java +++ b/jme3-core/src/main/java/com/jme3/app/state/AppState.java @@ -73,7 +73,7 @@ public interface AppState { * Called by {@link AppStateManager} when transitioning this {@code AppState} * from initializing to running.
    * This will happen on the next iteration through the update loop after - * {@link AppStateManager#attach()} was called. + * {@link AppStateManager#attach(com.jme3.app.state.AppState) } was called. *

    * AppStateManager will call this only from the update loop * inside the rendering thread. This means is it safe to modify the scene @@ -110,7 +110,8 @@ public interface AppState { public boolean isEnabled(); /** - * Called by {@link AppStateManager#attach()} when transitioning this + * Called by {@link AppStateManager#attach(com.jme3.app.state.AppState) } + * when transitioning this * AppState from detached to initializing. *

    * There is no assumption about the thread from which this function is @@ -124,7 +125,8 @@ public interface AppState { public void stateAttached(AppStateManager stateManager); /** - * Called by {@link AppStateManager#detach()} when transitioning this + * Called by {@link AppStateManager#detach(com.jme3.app.state.AppState) } + * when transitioning this * AppState from running to terminating. *

    * There is no assumption about the thread from which this function is diff --git a/jme3-core/src/main/java/com/jme3/asset/AssetManager.java b/jme3-core/src/main/java/com/jme3/asset/AssetManager.java index 16fa9e0f5..b1d623070 100644 --- a/jme3-core/src/main/java/com/jme3/asset/AssetManager.java +++ b/jme3-core/src/main/java/com/jme3/asset/AssetManager.java @@ -219,8 +219,9 @@ public interface AssetManager { public void setAssetEventListener(AssetEventListener listener); /** - * Manually locates an asset with the given {@link AssetKey}. This method - * should be used for debugging or internal uses.
    + * Manually locates an asset with the given {@link AssetKey}. + * This method should be used for debugging or internal uses. + *
    * The call will attempt to locate the asset by invoking the * {@link AssetLocator} that are registered with this AssetManager, * in the same way that the {@link AssetManager#loadAsset(com.jme3.asset.AssetKey) } diff --git a/jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java b/jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java index 4872bb195..2fa9b24bb 100644 --- a/jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java +++ b/jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java @@ -470,7 +470,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState { /** * called internally * - * @see AppState#render() + * @see AppState#render(com.jme3.renderer.RenderManager) */ public void render(RenderManager rm) { } diff --git a/jme3-core/src/main/java/com/jme3/input/FlyByCamera.java b/jme3-core/src/main/java/com/jme3/input/FlyByCamera.java index a030cd4e5..d1dbe0aef 100644 --- a/jme3-core/src/main/java/com/jme3/input/FlyByCamera.java +++ b/jme3-core/src/main/java/com/jme3/input/FlyByCamera.java @@ -279,7 +279,6 @@ public class FlyByCamera implements AnalogListener, ActionListener { /** * Registers the FlyByCamera to receive input events from the provided * Dispatcher. - * @param inputManager */ public void unregisterInput(){ diff --git a/jme3-core/src/main/java/com/jme3/renderer/Renderer.java b/jme3-core/src/main/java/com/jme3/renderer/Renderer.java index 4c1b3605b..ef3871e98 100644 --- a/jme3-core/src/main/java/com/jme3/renderer/Renderer.java +++ b/jme3-core/src/main/java/com/jme3/renderer/Renderer.java @@ -39,6 +39,7 @@ import com.jme3.scene.Mesh; import com.jme3.scene.VertexBuffer; import com.jme3.shader.Shader; import com.jme3.shader.Shader.ShaderSource; +import com.jme3.system.AppSettings; import com.jme3.texture.FrameBuffer; import com.jme3.texture.Image; import com.jme3.texture.Texture; @@ -321,39 +322,38 @@ public interface Renderer { /** * If enabled, color values rendered to the main framebuffer undergo - * linear -> sRGB conversion. + * linear -> sRGB conversion. * * This is identical to {@link FrameBuffer#setSrgb(boolean)} except it is toggled * for the main framebuffer instead of an offscreen buffer. * * This should be set together with {@link Renderer#setLinearizeSrgbImages(boolean)} * - * As a shorthand, the user can set {@link AppSettings#setSrgbPipeline(boolean)} to true + * As a shorthand, the user can set {@link AppSettings#setGammaCorrection(boolean)} to true * to toggle both {@link Renderer#setLinearizeSrgbImages(boolean)} and * {@link Renderer#setMainFrameBufferSrgb(boolean)} if the - * {@link Caps#} is supported by the GPU. + * {@link Caps#Srgb} is supported by the GPU. * * @throws RendererException If the GPU hardware does not support sRGB. * - * @seealso FrameBuffer#setSrgb(boolean) - * - * @seealso Caps#Srgb + * @see FrameBuffer#setSrgb(boolean) + * @see Caps#Srgb */ public void setMainFrameBufferSrgb(boolean srgb); /** - * If enabled, all {@link Image images} with the {@link Image#setSRGB(boolean) sRGB flag} + * If enabled, all {@link Image images} with the {@link Image#setColorSpace(com.jme3.texture.image.ColorSpace) sRGB flag} * set shall undergo an sRGB to linear RGB color conversion when read by a shader. * * The conversion is performed for the following formats: - * - {@link Format#RGB8} - * - {@link Format#RGBA8} - * - {@link Format#Luminance8} - * - {@link Format#LuminanceAlpha8} - * - {@link Format#DXT1} - * - {@link Format#DXT1a} - * - {@link Format#DXT3} - * - {@link Format#DXT5} + * - {@link Image.Format#RGB8} + * - {@link Image.Format#RGBA8} + * - {@link Image.Format#Luminance8} + * - {@link Image.Format#Luminance8Alpha8} + * - {@link Image.Format#DXT1} + * - {@link Image.Format#DXT1A} + * - {@link Image.Format#DXT3} + * - {@link Image.Format#DXT5} * * For all other formats, no conversion is performed. * @@ -361,9 +361,9 @@ public interface Renderer { * * @throws RendererException If the GPU hardware does not support sRGB. * - * @param linearize If sRGB images undergo sRGB -> linear conversion prior to rendering. + * @param linearize If sRGB images undergo sRGB -> linear conversion prior to rendering. * - * @seealso Caps#Srgb + * @see Caps#Srgb */ public void setLinearizeSrgbImages(boolean linearize); diff --git a/jme3-core/src/main/java/com/jme3/scene/shape/Box.java b/jme3-core/src/main/java/com/jme3/scene/shape/Box.java index 3b40439c8..05f85427c 100644 --- a/jme3-core/src/main/java/com/jme3/scene/shape/Box.java +++ b/jme3-core/src/main/java/com/jme3/scene/shape/Box.java @@ -95,7 +95,7 @@ public class Box extends AbstractBox { * the given amount in each direction. So, for example, a box * with extent of 0.5 would be the unit cube. * - * @Deprecated: Due to constant confusion of geometry centers and the center + * @deprecated Due to constant confusion of geometry centers and the center * of the box mesh this method has been deprecated. * * @param center the center of the box. diff --git a/jme3-core/src/main/java/com/jme3/scene/shape/Dome.java b/jme3-core/src/main/java/com/jme3/scene/shape/Dome.java index fd61ce2d3..3e2cfb031 100644 --- a/jme3-core/src/main/java/com/jme3/scene/shape/Dome.java +++ b/jme3-core/src/main/java/com/jme3/scene/shape/Dome.java @@ -73,7 +73,7 @@ public class Dome extends Mesh { * Constructs a dome for use as a SkyDome. The SkyDome is centered at the origin * and only visible from the inside. * @param planes - * The number of planes along the Z-axis. Must be >= 2. + * The number of planes along the Z-axis. Must be >= 2. * Influences how round the arch of the dome is. * @param radialSamples * The number of samples along the radial. @@ -95,7 +95,7 @@ public class Dome extends Mesh { * @param center * Center of the dome. * @param planes - * The number of planes along the Z-axis. Must be >= 2. + * The number of planes along the Z-axis. Must be >= 2. * Influences how round the arch of the dome is. * @param radialSamples * The number of samples along the radial. @@ -119,7 +119,7 @@ public class Dome extends Mesh { * @param center * Center of the dome. * @param planes - * The number of planes along the Z-axis. Must be >= 2. + * The number of planes along the Z-axis. Must be >= 2. * Influences how round the arch of the dome is. * @param radialSamples * The number of samples along the radial. diff --git a/jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java b/jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java index ca00de89d..591494cbd 100644 --- a/jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java +++ b/jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java @@ -519,7 +519,7 @@ public class FrameBuffer extends NativeObject { * for this option to take any effect. * * Rendering operations performed on this framebuffer shall undergo a linear - * -> sRGB color space conversion when this flag is enabled. If + * -> sRGB color space conversion when this flag is enabled. If * {@link RenderState#getBlendMode() blending} is enabled, it will be * performed in linear space by first decoding the stored sRGB pixel values * into linear, combining with the shader result, and then converted back to diff --git a/jme3-core/src/main/java/com/jme3/texture/Image.java b/jme3-core/src/main/java/com/jme3/texture/Image.java index 1d5939c8d..0f0038b18 100644 --- a/jme3-core/src/main/java/com/jme3/texture/Image.java +++ b/jme3-core/src/main/java/com/jme3/texture/Image.java @@ -895,7 +895,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ { * such conversion must not be performed, for example, when loading normal * maps. * - * @param colorSpace @see ColorSpace. Set to sRGB to enable srgb -> linear + * @param colorSpace @see ColorSpace. Set to sRGB to enable srgb -> linear * conversion, Linear otherwise. * * @seealso Renderer#setLinearizeSrgbImages(boolean) @@ -907,7 +907,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ { /** * Specifies that this image is an SRGB image and therefore must undergo an - * sRGB -> linear RGB color conversion prior to being read by a shader and + * sRGB -> linear RGB color conversion prior to being read by a shader and * with the {@link Renderer#setLinearizeSrgbImages(boolean)} option is * enabled. * diff --git a/jme3-core/src/main/java/com/jme3/texture/image/ImageRaster.java b/jme3-core/src/main/java/com/jme3/texture/image/ImageRaster.java index d16129708..b4e583c35 100644 --- a/jme3-core/src/main/java/com/jme3/texture/image/ImageRaster.java +++ b/jme3-core/src/main/java/com/jme3/texture/image/ImageRaster.java @@ -72,8 +72,8 @@ public abstract class ImageRaster { * @param slice Which slice to use. Only applies to 3D images, 2D image * arrays or cubemaps. */ - public static ImageRaster create(Image image, int slices) { - return JmeSystem.createImageRaster(image, slices); + public static ImageRaster create(Image image, int slice) { + return JmeSystem.createImageRaster(image, slice); } /** diff --git a/jme3-core/src/plugins/java/com/jme3/cursors/plugins/JmeCursor.java b/jme3-core/src/plugins/java/com/jme3/cursors/plugins/JmeCursor.java index 1c5f4a21d..22f22bc7d 100644 --- a/jme3-core/src/plugins/java/com/jme3/cursors/plugins/JmeCursor.java +++ b/jme3-core/src/plugins/java/com/jme3/cursors/plugins/JmeCursor.java @@ -36,8 +36,9 @@ import java.nio.IntBuffer; /** * A Jme representation of the LWJGL Cursor class. * + * Created Jun 6, 2012 12:12:38 PM + * * @author MadJack - * @creation Jun 6, 2012 12:12:38 PM */ public class JmeCursor { diff --git a/jme3-core/src/plugins/java/com/jme3/material/plugins/ConditionParser.java b/jme3-core/src/plugins/java/com/jme3/material/plugins/ConditionParser.java index aed88c10c..e75597bfd 100644 --- a/jme3-core/src/plugins/java/com/jme3/material/plugins/ConditionParser.java +++ b/jme3-core/src/plugins/java/com/jme3/material/plugins/ConditionParser.java @@ -80,11 +80,13 @@ public class ConditionParser { * defines names * * supported expression syntax example: + * * "(LightMap && SeparateTexCoord) || !ColorMap" * "#if (defined(LightMap) && defined(SeparateTexCoord)) || !defined(ColorMap)" * "#ifdef LightMap" * "#ifdef (LightMap && SeparateTexCoord) || !ColorMap" - * + * + * * @param expression the expression to parse * @return the list of defines */ diff --git a/jme3-core/src/plugins/java/com/jme3/material/plugins/ShaderNodeLoaderDelegate.java b/jme3-core/src/plugins/java/com/jme3/material/plugins/ShaderNodeLoaderDelegate.java index dd1bc6dcd..5abe4d1ee 100644 --- a/jme3-core/src/plugins/java/com/jme3/material/plugins/ShaderNodeLoaderDelegate.java +++ b/jme3-core/src/plugins/java/com/jme3/material/plugins/ShaderNodeLoaderDelegate.java @@ -269,7 +269,7 @@ public class ShaderNodeLoaderDelegate { } /** - * reads a variable declaration statement + * reads a variable declaration statement <glslType> <varName> * * @param statement the statement to parse * @return a ShaderNodeVariable axtracted from the statement @@ -350,9 +350,11 @@ public class ShaderNodeLoaderDelegate { * left variable. Sets the name, nameSpace and swizzling of the right * variable types will be determined later. * + * * Format : .[.] = * .[.][:Condition] - * + * + * * @param statement the statement to read * @return the read mapping */ diff --git a/jme3-desktop/src/main/java/com/jme3/cursors/plugins/CursorLoader.java b/jme3-desktop/src/main/java/com/jme3/cursors/plugins/CursorLoader.java index 29d196964..ce82cbe17 100644 --- a/jme3-desktop/src/main/java/com/jme3/cursors/plugins/CursorLoader.java +++ b/jme3-desktop/src/main/java/com/jme3/cursors/plugins/CursorLoader.java @@ -51,9 +51,8 @@ import java.util.ArrayList; import javax.imageio.ImageIO; /** - * + * Created Jun 5, 2012 9:45:58 AM * @author MadJack - * @creation Jun 5, 2012 9:45:58 AM */ public class CursorLoader implements AssetLoader { final private static int FDE_OFFSET = 6; // first directory entry offset diff --git a/jme3-networking/src/main/java/com/jme3/network/MessageConnection.java b/jme3-networking/src/main/java/com/jme3/network/MessageConnection.java index 6c88636dc..0938e1e45 100644 --- a/jme3-networking/src/main/java/com/jme3/network/MessageConnection.java +++ b/jme3-networking/src/main/java/com/jme3/network/MessageConnection.java @@ -34,7 +34,7 @@ package com.jme3.network; /** * The source of a received message and the common abstract interface - * of client->server and server->client objects. + * of client->server and server->client objects. * * @version $Revision$ * @author Paul Speed diff --git a/jme3-networking/src/main/java/com/jme3/network/kernel/tcp/SelectorKernel.java b/jme3-networking/src/main/java/com/jme3/network/kernel/tcp/SelectorKernel.java index 42aa3ddbc..e69a9e52a 100644 --- a/jme3-networking/src/main/java/com/jme3/network/kernel/tcp/SelectorKernel.java +++ b/jme3-networking/src/main/java/com/jme3/network/kernel/tcp/SelectorKernel.java @@ -227,7 +227,7 @@ public class SelectorKernel extends AbstractKernel /** * Because we want to keep the keys to ourselves, we'll do - * the endpoint -> key mapping internally. + * the endpoint -> key mapping internally. */ private Map endpointKeys = new ConcurrentHashMap(); diff --git a/jme3-niftygui/src/main/java/com/jme3/niftygui/NiftyJmeDisplay.java b/jme3-niftygui/src/main/java/com/jme3/niftygui/NiftyJmeDisplay.java index ac036b17e..acf648b37 100644 --- a/jme3-niftygui/src/main/java/com/jme3/niftygui/NiftyJmeDisplay.java +++ b/jme3-niftygui/src/main/java/com/jme3/niftygui/NiftyJmeDisplay.java @@ -145,7 +145,7 @@ public class NiftyJmeDisplay implements SceneProcessor { * @param assetManager jME AssetManager * @param inputManager jME InputManager * @param audioRenderer jME AudioRenderer - * @param viewport Viewport to use + * @param vp Viewport to use */ public NiftyJmeDisplay(AssetManager assetManager, InputManager inputManager, diff --git a/jme3-plugins/src/xml/java/com/jme3/export/xml/DOMSerializer.java b/jme3-plugins/src/xml/java/com/jme3/export/xml/DOMSerializer.java index f889a8eb6..3aa431c9a 100644 --- a/jme3-plugins/src/xml/java/com/jme3/export/xml/DOMSerializer.java +++ b/jme3-plugins/src/xml/java/com/jme3/export/xml/DOMSerializer.java @@ -108,9 +108,6 @@ public class DOMSerializer { * * @param encoding the encoding to use, passing in {@code null} results in the * default encoding (UTF-8) being set. - * @throws IllegalCharsetNameException if the given charset name is illegal. - * @throws UnsupportedCharsetException if the given charset is not supported by the - * current JVM. */ public void setEncoding(String encoding) { this.encoding = Charset.forName(encoding); diff --git a/jme3-terrain/src/main/java/com/jme3/terrain/GeoMap.java b/jme3-terrain/src/main/java/com/jme3/terrain/GeoMap.java index 75a538136..21b222023 100644 --- a/jme3-terrain/src/main/java/com/jme3/terrain/GeoMap.java +++ b/jme3-terrain/src/main/java/com/jme3/terrain/GeoMap.java @@ -96,7 +96,7 @@ public class GeoMap implements Savable { * * @param x the X coordinate * @param y the Y coordinate - * @returns an arbitrary height looked up from the heightmap + * @return an arbitrary height looked up from the heightmap * * @throws NullPointerException If isLoaded() is false */ @@ -111,7 +111,7 @@ public class GeoMap implements Savable { * getWidth()*getHeight() index is lower right * * @param i The index - * @returns an arbitrary height looked up from the heightmap + * @return an arbitrary height looked up from the heightmap * * @throws NullPointerException If isLoaded() is false */ @@ -123,7 +123,7 @@ public class GeoMap implements Savable { /** * Returns the width of this Geomap * - * @returns the width of this Geomap + * @return the width of this Geomap */ public int getWidth() { return width; @@ -132,7 +132,7 @@ public class GeoMap implements Savable { /** * Returns the height of this Geomap * - * @returns the height of this Geomap + * @return the height of this Geomap */ public int getHeight() { return height; @@ -143,7 +143,7 @@ public class GeoMap implements Savable { * If false, then the data is unavailable- must be loaded with load() * before the methods getHeight/getNormal can be used * - * @returns wether the geomap data is loaded in system memory + * @return wether the geomap data is loaded in system memory */ public boolean isLoaded() { return true; @@ -152,8 +152,8 @@ public class GeoMap implements Savable { /** * Creates a normal array from the normal data in this Geomap * - * @param store A preallocated FloatBuffer where to store the data (optional), size must be >= getWidth()*getHeight()*3 - * @returns store, or a new FloatBuffer if store is null + * @param store A preallocated FloatBuffer where to store the data (optional), size must be >= getWidth()*getHeight()*3 + * @return store, or a new FloatBuffer if store is null * * @throws NullPointerException If isLoaded() or hasNormalmap() is false */ @@ -227,10 +227,11 @@ public class GeoMap implements Savable { * The scale argument specifies the scale to use for the vertex buffer. * For example, if scale is 10,1,10, then the greatest X value is getWidth()*10 * - * @param store A preallocated FloatBuffer where to store the data (optional), size must be >= getWidth()*getHeight()*3 + * @param store A preallocated FloatBuffer where to store the data (optional), + * size must be >= getWidth()*getHeight()*3 * @param scale Created vertexes are scaled by this vector * - * @returns store, or a new FloatBuffer if store is null + * @return store, or a new FloatBuffer if store is null * * @throws NullPointerException If isLoaded() is false */ diff --git a/jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/NeighbourFinder.java b/jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/NeighbourFinder.java index ccaf8d1d5..516c6dba1 100644 --- a/jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/NeighbourFinder.java +++ b/jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/NeighbourFinder.java @@ -43,7 +43,7 @@ package com.jme3.terrain.geomipmap; * The general orientation of TerrainQuads and their sub-quads is as such: * * - * +-- x+ ----> + * +-- x+ ----> * | * | 1 | 3 (quadrants) * z+ --+-- diff --git a/jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/TerrainQuad.java b/jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/TerrainQuad.java index 8c9e0bc14..8cceb85bb 100644 --- a/jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/TerrainQuad.java +++ b/jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/TerrainQuad.java @@ -100,7 +100,7 @@ import java.util.logging.Logger; * | : : * | : : * | 0.....: - * +---------> +z + * +---------> +z * (world coordinates) * * @author Brent Owens diff --git a/jme3-terrain/src/main/java/com/jme3/terrain/noise/Basis.java b/jme3-terrain/src/main/java/com/jme3/terrain/noise/Basis.java index 9d640cd98..7f48aa21f 100644 --- a/jme3-terrain/src/main/java/com/jme3/terrain/noise/Basis.java +++ b/jme3-terrain/src/main/java/com/jme3/terrain/noise/Basis.java @@ -35,7 +35,7 @@ import java.nio.FloatBuffer; /** * Interface for - basically 3D - noise generation algorithms, based on the - * book: Texturing & Modeling - A Procedural Approach + * book: Texturing & Modeling - A Procedural Approach * * The main concept is to look at noise as a basis for generating fractals. * Basis can be anything, like a simple: diff --git a/jme3-terrain/src/main/java/com/jme3/terrain/noise/ShaderUtils.java b/jme3-terrain/src/main/java/com/jme3/terrain/noise/ShaderUtils.java index d1c2f6e84..360baec37 100644 --- a/jme3-terrain/src/main/java/com/jme3/terrain/noise/ShaderUtils.java +++ b/jme3-terrain/src/main/java/com/jme3/terrain/noise/ShaderUtils.java @@ -40,7 +40,7 @@ import java.nio.ByteOrder; /** * Helper class containing useful functions explained in the book: - * Texturing & Modeling - A Procedural Approach + * Texturing & Modeling - A Procedural Approach * * @author Anthyon * diff --git a/sdk/JME3TestsTemplateAndroid/mobile/src/com/jmonkeyengine/tests/TestsHarness.java b/sdk/JME3TestsTemplateAndroid/mobile/src/com/jmonkeyengine/tests/TestsHarness.java index f38fa102a..598a57d7c 100644 --- a/sdk/JME3TestsTemplateAndroid/mobile/src/com/jmonkeyengine/tests/TestsHarness.java +++ b/sdk/JME3TestsTemplateAndroid/mobile/src/com/jmonkeyengine/tests/TestsHarness.java @@ -11,7 +11,7 @@ public class TestsHarness extends AndroidHarness{ /* * Note that you can ignore the errors displayed in this file, * the android project will build regardless. - * Install the 'Android' plugin under Tools->Plugins->Available Plugins + * Install the 'Android' plugin under Tools->Plugins->Available Plugins * to get error checks and code completion for the Android project files. */