* Fix many javadoc errors mostly related to incorrect HTML or missing references

experimental
shadowislord 11 years ago
parent 81498d6f79
commit 6b12d5c638
  1. 2
      jme3-android/src/main/java/com/jme3/app/AndroidHarness.java
  2. 2
      jme3-android/src/main/java/com/jme3/audio/android/AndroidMediaPlayerAudioRenderer.java
  3. 2
      jme3-blender/src/main/java/com/jme3/scene/plugins/blender/modifiers/ArmatureModifier.java
  4. 30
      jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderAWT.java
  5. 10
      jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderDDS.java
  6. 19
      jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/blending/TextureBlenderLuminance.java
  7. 3
      jme3-blender/src/main/java/com/jme3/scene/plugins/blender/textures/generating/TextureGenerator.java
  8. 3
      jme3-bullet/src/common/java/com/jme3/bullet/collision/PhysicsCollisionListener.java
  9. 6
      jme3-core/src/main/java/com/jme3/animation/Bone.java
  10. 8
      jme3-core/src/main/java/com/jme3/app/state/AppState.java
  11. 5
      jme3-core/src/main/java/com/jme3/asset/AssetManager.java
  12. 2
      jme3-core/src/main/java/com/jme3/cinematic/Cinematic.java
  13. 1
      jme3-core/src/main/java/com/jme3/input/FlyByCamera.java
  14. 34
      jme3-core/src/main/java/com/jme3/renderer/Renderer.java
  15. 2
      jme3-core/src/main/java/com/jme3/scene/shape/Box.java
  16. 6
      jme3-core/src/main/java/com/jme3/scene/shape/Dome.java
  17. 2
      jme3-core/src/main/java/com/jme3/texture/FrameBuffer.java
  18. 4
      jme3-core/src/main/java/com/jme3/texture/Image.java
  19. 4
      jme3-core/src/main/java/com/jme3/texture/image/ImageRaster.java
  20. 3
      jme3-core/src/plugins/java/com/jme3/cursors/plugins/JmeCursor.java
  21. 4
      jme3-core/src/plugins/java/com/jme3/material/plugins/ConditionParser.java
  22. 6
      jme3-core/src/plugins/java/com/jme3/material/plugins/ShaderNodeLoaderDelegate.java
  23. 3
      jme3-desktop/src/main/java/com/jme3/cursors/plugins/CursorLoader.java
  24. 2
      jme3-networking/src/main/java/com/jme3/network/MessageConnection.java
  25. 2
      jme3-networking/src/main/java/com/jme3/network/kernel/tcp/SelectorKernel.java
  26. 2
      jme3-niftygui/src/main/java/com/jme3/niftygui/NiftyJmeDisplay.java
  27. 3
      jme3-plugins/src/xml/java/com/jme3/export/xml/DOMSerializer.java
  28. 19
      jme3-terrain/src/main/java/com/jme3/terrain/GeoMap.java
  29. 2
      jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/NeighbourFinder.java
  30. 2
      jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/TerrainQuad.java
  31. 2
      jme3-terrain/src/main/java/com/jme3/terrain/noise/Basis.java
  32. 2
      jme3-terrain/src/main/java/com/jme3/terrain/noise/ShaderUtils.java
  33. 2
      sdk/JME3TestsTemplateAndroid/mobile/src/com/jmonkeyengine/tests/TestsHarness.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 * how the surfaceview is able to display Android views that are located
* under the surfaceview jME uses to render the scenegraph. * under the surfaceview jME uses to render the scenegraph.
* 0 = Opaque surfaceview background (fastest) * 0 = Opaque surfaceview background (fastest)
* 1->7 = Transparent surfaceview background * 1->7 = Transparent surfaceview background
* 8 or higher = Translucent surfaceview background * 8 or higher = Translucent surfaceview background
* (default = 0) * (default = 0)
*/ */

@ -309,7 +309,7 @@ public class AndroidMediaPlayerAudioRenderer implements AndroidAudioRenderer,
* the channel of the last played instance. * the channel of the last played instance.
* *
* It is not possible to get information about the state of the soundpool of * 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. * sound finished.
*/ */
public void playSourceInstance(AudioSource src) { public void playSourceInstance(AudioSource src) {

@ -247,7 +247,7 @@ import com.jme3.util.BufferUtils;
if (boneEnvelope.isInEnvelope(pos)) { if (boneEnvelope.isInEnvelope(pos)) {
vertexGroup.addVertex(index, boneEnvelope.getWeight()); vertexGroup.addVertex(index, boneEnvelope.getWeight());
} else if (boneIndex == 5) { } else if (boneIndex == 5) {
System.out.println("Się nie załapał: " + pos); System.out.println("Si nie zaapa: " + pos);
} }
} }
} }

@ -43,7 +43,35 @@ import java.nio.ByteBuffer;
import java.util.ArrayList; import java.util.ArrayList;
/** /**
* The class that is responsible for blending the following texture types: <li>RGBA8 <li>ABGR8 <li>BGR8 <li>RGB8 Not yet supported (but will be): <li>ARGB4444: <li>RGB10: <li>RGB111110F: <li>RGB16: <li>RGB16F: <li>RGB16F_to_RGB111110F: <li>RGB16F_to_RGB9E5: <li>RGB32F: <li>RGB565: <li>RGB5A1: <li>RGB9E5: <li>RGBA16: <li>RGBA16F * <p>
* The class that is responsible for blending the following texture types:
* </p>
* <ul>
* <li>RGBA8</li>
* <li>ABGR8</li>
* <li>BGR8</li>
* <li>RGB8</li>
* </ul>
*
* <p>
* Not yet supported (but will be):
* </p>
* <ul>
* <li>ARGB4444</li>
* <li>RGB10</li>
* <li>RGB111110F</li>
* <li>RGB16</li>
* <li>RGB16F</li>
* <li>RGB16F_to_RGB111110F</li>
* <li>RGB16F_to_RGB9E5</li>
* <li>RGB32F</li>
* <li>RGB565</li>
* <li>RGB5A1</li>
* <li>RGB9E5</li>
* <li>RGBA16</li>
* <li>RGBA16F</li>
* </ul>
*
* @author Marcin Roguski (Kaelthas) * @author Marcin Roguski (Kaelthas)
*/ */
public class TextureBlenderAWT extends AbstractTextureBlender { public class TextureBlenderAWT extends AbstractTextureBlender {

@ -12,7 +12,15 @@ import java.util.ArrayList;
import jme3tools.converters.RGB565; import jme3tools.converters.RGB565;
/** /**
* The class that is responsible for blending the following texture types: <li>DXT1 <li>DXT1A <li>DXT3 <li>DXT5 * <p>
* The class that is responsible for blending the following texture types:
* </p>
* <ul>
* <li>DXT1</li>
* <li>DXT1A</li>
* <li>DXT3</li>
* <li>DXT5</li>
* </ul>
* @author Marcin Roguski (Kaelthas) * @author Marcin Roguski (Kaelthas)
*/ */
public class TextureBlenderDDS extends TextureBlenderAWT { public class TextureBlenderDDS extends TextureBlenderAWT {

@ -14,7 +14,24 @@ import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
/** /**
* The class that is responsible for blending the following texture types: <li>Luminance8 <li>Luminance8Alpha8 Not yet supported (but will be): <li>Luminance16: <li>Luminance16Alpha16: <li>Luminance16F: <li>Luminance16FAlpha16F: <li>Luminance32F: * <p>
* The class that is responsible for blending the following texture types:
* </p>
* <ul>
* <li>Luminance8</li>
* <li>Luminance8Alpha8</li>
* </ul>
* <p>
* Not yet supported (but will be):
* </p>
* <ul>
* <li>Luminance16</li>
* <li>Luminance16Alpha16</li>
* <li>Luminance16F</li>
* <li>Luminance16FAlpha16F</li>
* <li>Luminance32F</li>
* </ul>
*
* @author Marcin Roguski (Kaelthas) * @author Marcin Roguski (Kaelthas)
*/ */
public class TextureBlenderLuminance extends AbstractTextureBlender { public class TextureBlenderLuminance extends AbstractTextureBlender {

@ -70,9 +70,6 @@ public abstract class TextureGenerator {
/** /**
* This method applies brightness and contrast for RGB textures. * This method applies brightness and contrast for RGB textures.
* @param tex
* texture structure
* @param texres
*/ */
protected void applyBrightnessAndContrast(BrightnessAndContrastData bacd, TexturePixel texres) { protected void applyBrightnessAndContrast(BrightnessAndContrastData bacd, TexturePixel texres) {
texres.red = (texres.red - 0.5f) * bacd.contrast + bacd.brightness; texres.red = (texres.red - 0.5f) * bacd.contrast + bacd.brightness;

@ -38,7 +38,8 @@ package com.jme3.bullet.collision;
public interface PhysicsCollisionListener { public interface PhysicsCollisionListener {
/** /**
* Called when a collision happened in the PhysicsSpace, <i>called from render thread</i>.<br/> * Called when a collision happened in the PhysicsSpace, <i>called from render thread</i>.
*
* Do not store the event object as it will be cleared after the method has finished. * Do not store the event object as it will be cleared after the method has finished.
* @param event the CollisionEvent * @param event the CollisionEvent
*/ */

@ -61,14 +61,14 @@ public final class Bone implements Savable {
private Node attachNode; private Node attachNode;
/** /**
* Initial transform is the local bind transform of this bone. * Initial transform is the local bind transform of this bone.
* PARENT SPACE -> BONE SPACE * PARENT SPACE -&gt; BONE SPACE
*/ */
private Vector3f initialPos; private Vector3f initialPos;
private Quaternion initialRot; private Quaternion initialRot;
private Vector3f initialScale; private Vector3f initialScale;
/** /**
* The inverse world bind transform. * The inverse world bind transform.
* BONE SPACE -> MODEL SPACE * BONE SPACE -&gt; MODEL SPACE
*/ */
private Vector3f worldBindInversePos; private Vector3f worldBindInversePos;
private Quaternion worldBindInverseRot; private Quaternion worldBindInverseRot;
@ -80,7 +80,7 @@ public final class Bone implements Savable {
private Quaternion localRot = new Quaternion(); private Quaternion localRot = new Quaternion();
private Vector3f localScale = new Vector3f(1.0f, 1.0f, 1.0f); private Vector3f localScale = new Vector3f(1.0f, 1.0f, 1.0f);
/** /**
* MODEL SPACE -> BONE SPACE (in animated state) * MODEL SPACE -&gt; BONE SPACE (in animated state)
*/ */
private Vector3f worldPos = new Vector3f(); private Vector3f worldPos = new Vector3f();
private Quaternion worldRot = new Quaternion(); private Quaternion worldRot = new Quaternion();

@ -73,7 +73,7 @@ public interface AppState {
* Called by {@link AppStateManager} when transitioning this {@code AppState} * Called by {@link AppStateManager} when transitioning this {@code AppState}
* from <i>initializing</i> to <i>running</i>.<br> * from <i>initializing</i> to <i>running</i>.<br>
* This will happen on the next iteration through the update loop after * 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.
* <p> * <p>
* <code>AppStateManager</code> will call this only from the update loop * <code>AppStateManager</code> will call this only from the update loop
* inside the rendering thread. This means is it safe to modify the scene * inside the rendering thread. This means is it safe to modify the scene
@ -110,7 +110,8 @@ public interface AppState {
public boolean isEnabled(); public boolean isEnabled();
/** /**
* Called by {@link AppStateManager#attach()} when transitioning this * Called by {@link AppStateManager#attach(com.jme3.app.state.AppState) }
* when transitioning this
* <code>AppState</code> from <i>detached</i> to <i>initializing</i>. * <code>AppState</code> from <i>detached</i> to <i>initializing</i>.
* <p> * <p>
* There is no assumption about the thread from which this function is * There is no assumption about the thread from which this function is
@ -124,7 +125,8 @@ public interface AppState {
public void stateAttached(AppStateManager stateManager); 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
* <code>AppState</code> from <i>running</i> to <i>terminating</i>. * <code>AppState</code> from <i>running</i> to <i>terminating</i>.
* <p> * <p>
* There is no assumption about the thread from which this function is * There is no assumption about the thread from which this function is

@ -219,8 +219,9 @@ public interface AssetManager {
public void setAssetEventListener(AssetEventListener listener); public void setAssetEventListener(AssetEventListener listener);
/** /**
* Manually locates an asset with the given {@link AssetKey}. This method * Manually locates an asset with the given {@link AssetKey}.
* should be used for debugging or internal uses. <br/> * This method should be used for debugging or internal uses.
* <br>
* The call will attempt to locate the asset by invoking the * The call will attempt to locate the asset by invoking the
* {@link AssetLocator} that are registered with this <code>AssetManager</code>, * {@link AssetLocator} that are registered with this <code>AssetManager</code>,
* in the same way that the {@link AssetManager#loadAsset(com.jme3.asset.AssetKey) } * in the same way that the {@link AssetManager#loadAsset(com.jme3.asset.AssetKey) }

@ -470,7 +470,7 @@ public class Cinematic extends AbstractCinematicEvent implements AppState {
/** /**
* called internally * called internally
* *
* @see AppState#render() * @see AppState#render(com.jme3.renderer.RenderManager)
*/ */
public void render(RenderManager rm) { public void render(RenderManager rm) {
} }

@ -279,7 +279,6 @@ public class FlyByCamera implements AnalogListener, ActionListener {
/** /**
* Registers the FlyByCamera to receive input events from the provided * Registers the FlyByCamera to receive input events from the provided
* Dispatcher. * Dispatcher.
* @param inputManager
*/ */
public void unregisterInput(){ public void unregisterInput(){

@ -39,6 +39,7 @@ import com.jme3.scene.Mesh;
import com.jme3.scene.VertexBuffer; import com.jme3.scene.VertexBuffer;
import com.jme3.shader.Shader; import com.jme3.shader.Shader;
import com.jme3.shader.Shader.ShaderSource; import com.jme3.shader.Shader.ShaderSource;
import com.jme3.system.AppSettings;
import com.jme3.texture.FrameBuffer; import com.jme3.texture.FrameBuffer;
import com.jme3.texture.Image; import com.jme3.texture.Image;
import com.jme3.texture.Texture; import com.jme3.texture.Texture;
@ -321,39 +322,38 @@ public interface Renderer {
/** /**
* If enabled, color values rendered to the main framebuffer undergo * If enabled, color values rendered to the main framebuffer undergo
* linear -> sRGB conversion. * linear -&gt; sRGB conversion.
* *
* This is identical to {@link FrameBuffer#setSrgb(boolean)} except it is toggled * This is identical to {@link FrameBuffer#setSrgb(boolean)} except it is toggled
* for the main framebuffer instead of an offscreen buffer. * for the main framebuffer instead of an offscreen buffer.
* *
* This should be set together with {@link Renderer#setLinearizeSrgbImages(boolean)} * 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 * to toggle both {@link Renderer#setLinearizeSrgbImages(boolean)} and
* {@link Renderer#setMainFrameBufferSrgb(boolean)} if the * {@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. * @throws RendererException If the GPU hardware does not support sRGB.
* *
* @seealso FrameBuffer#setSrgb(boolean) * @see FrameBuffer#setSrgb(boolean)
* * @see Caps#Srgb
* @seealso Caps#Srgb
*/ */
public void setMainFrameBufferSrgb(boolean 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. * set shall undergo an sRGB to linear RGB color conversion when read by a shader.
* *
* The conversion is performed for the following formats: * The conversion is performed for the following formats:
* - {@link Format#RGB8} * - {@link Image.Format#RGB8}
* - {@link Format#RGBA8} * - {@link Image.Format#RGBA8}
* - {@link Format#Luminance8} * - {@link Image.Format#Luminance8}
* - {@link Format#LuminanceAlpha8} * - {@link Image.Format#Luminance8Alpha8}
* - {@link Format#DXT1} * - {@link Image.Format#DXT1}
* - {@link Format#DXT1a} * - {@link Image.Format#DXT1A}
* - {@link Format#DXT3} * - {@link Image.Format#DXT3}
* - {@link Format#DXT5} * - {@link Image.Format#DXT5}
* *
* For all other formats, no conversion is performed. * 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. * @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 -&gt; linear conversion prior to rendering.
* *
* @seealso Caps#Srgb * @see Caps#Srgb
*/ */
public void setLinearizeSrgbImages(boolean linearize); public void setLinearizeSrgbImages(boolean linearize);

@ -95,7 +95,7 @@ public class Box extends AbstractBox {
* the given amount in <em>each</em> direction. So, for example, a box * the given amount in <em>each</em> direction. So, for example, a box
* with extent of 0.5 would be the unit cube. * 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. * of the box mesh this method has been deprecated.
* *
* @param center the center of the box. * @param center the center of the box.

@ -73,7 +73,7 @@ public class Dome extends Mesh {
* Constructs a dome for use as a SkyDome. The SkyDome is centered at the origin * Constructs a dome for use as a SkyDome. The SkyDome is centered at the origin
* and only visible from the inside. * and only visible from the inside.
* @param planes * @param planes
* The number of planes along the Z-axis. Must be >= 2. * The number of planes along the Z-axis. Must be &gt;= 2.
* Influences how round the arch of the dome is. * Influences how round the arch of the dome is.
* @param radialSamples * @param radialSamples
* The number of samples along the radial. * The number of samples along the radial.
@ -95,7 +95,7 @@ public class Dome extends Mesh {
* @param center * @param center
* Center of the dome. * Center of the dome.
* @param planes * @param planes
* The number of planes along the Z-axis. Must be >= 2. * The number of planes along the Z-axis. Must be &gt;= 2.
* Influences how round the arch of the dome is. * Influences how round the arch of the dome is.
* @param radialSamples * @param radialSamples
* The number of samples along the radial. * The number of samples along the radial.
@ -119,7 +119,7 @@ public class Dome extends Mesh {
* @param center * @param center
* Center of the dome. * Center of the dome.
* @param planes * @param planes
* The number of planes along the Z-axis. Must be >= 2. * The number of planes along the Z-axis. Must be &gt;= 2.
* Influences how round the arch of the dome is. * Influences how round the arch of the dome is.
* @param radialSamples * @param radialSamples
* The number of samples along the radial. * The number of samples along the radial.

@ -519,7 +519,7 @@ public class FrameBuffer extends NativeObject {
* for this option to take any effect. * for this option to take any effect.
* *
* Rendering operations performed on this framebuffer shall undergo a linear * Rendering operations performed on this framebuffer shall undergo a linear
* -> sRGB color space conversion when this flag is enabled. If * -&gt; sRGB color space conversion when this flag is enabled. If
* {@link RenderState#getBlendMode() blending} is enabled, it will be * {@link RenderState#getBlendMode() blending} is enabled, it will be
* performed in linear space by first decoding the stored sRGB pixel values * performed in linear space by first decoding the stored sRGB pixel values
* into linear, combining with the shader result, and then converted back to * into linear, combining with the shader result, and then converted back to

@ -895,7 +895,7 @@ public class Image extends NativeObject implements Savable /*, Cloneable*/ {
* such conversion must not be performed, for example, when loading normal * such conversion must not be performed, for example, when loading normal
* maps. * maps.
* *
* @param colorSpace @see ColorSpace. Set to sRGB to enable srgb -> linear * @param colorSpace @see ColorSpace. Set to sRGB to enable srgb -&gt; linear
* conversion, Linear otherwise. * conversion, Linear otherwise.
* *
* @seealso Renderer#setLinearizeSrgbImages(boolean) * @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 * 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 -&gt; linear RGB color conversion prior to being read by a shader and
* with the {@link Renderer#setLinearizeSrgbImages(boolean)} option is * with the {@link Renderer#setLinearizeSrgbImages(boolean)} option is
* enabled. * enabled.
* *

@ -72,8 +72,8 @@ public abstract class ImageRaster {
* @param slice Which slice to use. Only applies to 3D images, 2D image * @param slice Which slice to use. Only applies to 3D images, 2D image
* arrays or cubemaps. * arrays or cubemaps.
*/ */
public static ImageRaster create(Image image, int slices) { public static ImageRaster create(Image image, int slice) {
return JmeSystem.createImageRaster(image, slices); return JmeSystem.createImageRaster(image, slice);
} }
/** /**

@ -36,8 +36,9 @@ import java.nio.IntBuffer;
/** /**
* A Jme representation of the LWJGL Cursor class. * A Jme representation of the LWJGL Cursor class.
* *
* Created Jun 6, 2012 12:12:38 PM
*
* @author MadJack * @author MadJack
* @creation Jun 6, 2012 12:12:38 PM
*/ */
public class JmeCursor { public class JmeCursor {

@ -80,11 +80,13 @@ public class ConditionParser {
* defines names * defines names
* *
* supported expression syntax example: * supported expression syntax example:
* <code>
* "(LightMap && SeparateTexCoord) || !ColorMap" * "(LightMap && SeparateTexCoord) || !ColorMap"
* "#if (defined(LightMap) && defined(SeparateTexCoord)) || !defined(ColorMap)" * "#if (defined(LightMap) && defined(SeparateTexCoord)) || !defined(ColorMap)"
* "#ifdef LightMap" * "#ifdef LightMap"
* "#ifdef (LightMap && SeparateTexCoord) || !ColorMap" * "#ifdef (LightMap && SeparateTexCoord) || !ColorMap"
* * </code>
*
* @param expression the expression to parse * @param expression the expression to parse
* @return the list of defines * @return the list of defines
*/ */

@ -269,7 +269,7 @@ public class ShaderNodeLoaderDelegate {
} }
/** /**
* reads a variable declaration statement <glslType> <varName> * reads a variable declaration statement &lt;glslType&gt; &lt;varName&gt;
* *
* @param statement the statement to parse * @param statement the statement to parse
* @return a ShaderNodeVariable axtracted from the statement * @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 * left variable. Sets the name, nameSpace and swizzling of the right
* variable types will be determined later. * variable types will be determined later.
* *
* <code>
* Format : <nameSpace>.<varName>[.<swizzling>] = * Format : <nameSpace>.<varName>[.<swizzling>] =
* <nameSpace>.<varName>[.<swizzling>][:Condition] * <nameSpace>.<varName>[.<swizzling>][:Condition]
* * </code>
*
* @param statement the statement to read * @param statement the statement to read
* @return the read mapping * @return the read mapping
*/ */

@ -51,9 +51,8 @@ import java.util.ArrayList;
import javax.imageio.ImageIO; import javax.imageio.ImageIO;
/** /**
* * Created Jun 5, 2012 9:45:58 AM
* @author MadJack * @author MadJack
* @creation Jun 5, 2012 9:45:58 AM
*/ */
public class CursorLoader implements AssetLoader { public class CursorLoader implements AssetLoader {
final private static int FDE_OFFSET = 6; // first directory entry offset final private static int FDE_OFFSET = 6; // first directory entry offset

@ -34,7 +34,7 @@ package com.jme3.network;
/** /**
* The source of a received message and the common abstract interface * The source of a received message and the common abstract interface
* of client->server and server->client objects. * of client-&gt;server and server-&gt;client objects.
* *
* @version $Revision$ * @version $Revision$
* @author Paul Speed * @author Paul Speed

@ -227,7 +227,7 @@ public class SelectorKernel extends AbstractKernel
/** /**
* Because we want to keep the keys to ourselves, we'll do * Because we want to keep the keys to ourselves, we'll do
* the endpoint -> key mapping internally. * the endpoint -&gt; key mapping internally.
*/ */
private Map<NioEndpoint,SelectionKey> endpointKeys = new ConcurrentHashMap<NioEndpoint,SelectionKey>(); private Map<NioEndpoint,SelectionKey> endpointKeys = new ConcurrentHashMap<NioEndpoint,SelectionKey>();

@ -145,7 +145,7 @@ public class NiftyJmeDisplay implements SceneProcessor {
* @param assetManager jME AssetManager * @param assetManager jME AssetManager
* @param inputManager jME InputManager * @param inputManager jME InputManager
* @param audioRenderer jME AudioRenderer * @param audioRenderer jME AudioRenderer
* @param viewport Viewport to use * @param vp Viewport to use
*/ */
public NiftyJmeDisplay(AssetManager assetManager, public NiftyJmeDisplay(AssetManager assetManager,
InputManager inputManager, InputManager inputManager,

@ -108,9 +108,6 @@ public class DOMSerializer {
* *
* @param encoding the encoding to use, passing in {@code null} results in the * @param encoding the encoding to use, passing in {@code null} results in the
* default encoding (UTF-8) being set. * 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) { public void setEncoding(String encoding) {
this.encoding = Charset.forName(encoding); this.encoding = Charset.forName(encoding);

@ -96,7 +96,7 @@ public class GeoMap implements Savable {
* *
* @param x the X coordinate * @param x the X coordinate
* @param y the Y 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 * @throws NullPointerException If isLoaded() is false
*/ */
@ -111,7 +111,7 @@ public class GeoMap implements Savable {
* getWidth()*getHeight() index is lower right * getWidth()*getHeight() index is lower right
* *
* @param i The index * @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 * @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
* *
* @returns the width of this Geomap * @return the width of this Geomap
*/ */
public int getWidth() { public int getWidth() {
return width; return width;
@ -132,7 +132,7 @@ public class GeoMap implements Savable {
/** /**
* Returns the height of this Geomap * Returns the height of this Geomap
* *
* @returns the height of this Geomap * @return the height of this Geomap
*/ */
public int getHeight() { public int getHeight() {
return height; return height;
@ -143,7 +143,7 @@ public class GeoMap implements Savable {
* If false, then the data is unavailable- must be loaded with load() * If false, then the data is unavailable- must be loaded with load()
* before the methods getHeight/getNormal can be used * 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() { public boolean isLoaded() {
return true; return true;
@ -152,8 +152,8 @@ public class GeoMap implements Savable {
/** /**
* Creates a normal array from the normal data in this Geomap * 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 * @param store A preallocated FloatBuffer where to store the data (optional), size must be &gt;= getWidth()*getHeight()*3
* @returns store, or a new FloatBuffer if store is null * @return store, or a new FloatBuffer if store is null
* *
* @throws NullPointerException If isLoaded() or hasNormalmap() is false * @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. * 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 * 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 &gt;= getWidth()*getHeight()*3
* @param scale Created vertexes are scaled by this vector * @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 * @throws NullPointerException If isLoaded() is false
*/ */

@ -43,7 +43,7 @@ package com.jme3.terrain.geomipmap;
* The general orientation of TerrainQuads and their sub-quads is as such: * The general orientation of TerrainQuads and their sub-quads is as such:
* *
* *
* +-- x+ ----> * +-- x+ ----&gt;
* | * |
* | 1 | 3 (quadrants) * | 1 | 3 (quadrants)
* z+ --+-- * z+ --+--

@ -100,7 +100,7 @@ import java.util.logging.Logger;
* | : : * | : :
* | : : * | : :
* | 0.....: * | 0.....:
* +---------> +z * +---------&gt; +z
* (world coordinates) * (world coordinates)
* </pre> * </pre>
* @author Brent Owens * @author Brent Owens

@ -35,7 +35,7 @@ import java.nio.FloatBuffer;
/** /**
* Interface for - basically 3D - noise generation algorithms, based on the * Interface for - basically 3D - noise generation algorithms, based on the
* book: Texturing & Modeling - A Procedural Approach * book: Texturing &amp; Modeling - A Procedural Approach
* *
* The main concept is to look at noise as a basis for generating fractals. * The main concept is to look at noise as a basis for generating fractals.
* Basis can be anything, like a simple: * Basis can be anything, like a simple:

@ -40,7 +40,7 @@ import java.nio.ByteOrder;
/** /**
* Helper class containing useful functions explained in the book: * Helper class containing useful functions explained in the book:
* Texturing & Modeling - A Procedural Approach * Texturing &amp; Modeling - A Procedural Approach
* *
* @author Anthyon * @author Anthyon
* *

@ -11,7 +11,7 @@ public class TestsHarness extends AndroidHarness{
/* /*
* Note that you can ignore the errors displayed in this file, * Note that you can ignore the errors displayed in this file,
* the android project will build regardless. * the android project will build regardless.
* Install the 'Android' plugin under Tools->Plugins->Available Plugins * Install the 'Android' plugin under Tools-&gt;Plugins-&gt;Available Plugins
* to get error checks and code completion for the Android project files. * to get error checks and code completion for the Android project files.
*/ */

Loading…
Cancel
Save