sigonasr2/jmonkeyengine
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Javadoc fixes R PHUN

Browse Source 
git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@9358 75d07b2b-3a1a-0410-a2c5-0572b91ccdca
This commit is contained in:
sky..ok 2012-05-08 15:11:38 +00:00
parent 8bfe663402
commit a625e8ae2a
9 changed files with 18 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
engine/src/android/com/jme3/asset/AndroidImageInfo.java
View File

@ -9,7 +9,7 @@ import java.io.IOException;
import java.io.InputStream;
/**
* <code>AndroidImageInfo</code> is set in a jME3 image via the {@link Image#setEfficientData(java.lang.Object)}
* <code>AndroidImageInfo</code> is set in a jME3 image via the {@link Image#setEfficentData(java.lang.Object) }
* method to retrieve a {@link Bitmap} when it is needed by the renderer.
* User code may extend <code>AndroidImageInfo</code> and provide their own implementation of the
* {@link AndroidImageInfo#loadBitmap()} method to acquire a bitmap by their own means.

4
engine/src/core/com/jme3/asset/CloneableSmartAsset.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2010 jMonkeyEngine
* Copyright (c) 2009-2012 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -47,7 +47,7 @@ import com.jme3.asset.cache.WeakRefCloneAssetCache;
* If the {@link AssetManager#loadAsset(com.jme3.asset.AssetKey) } method
* is called twice with the same asset key (equals() wise, not necessarily reference wise)
* then both assets will have the same asset key set (reference wise) via
* {@link Asset#setKey(com.jme3.asset.AssetKey) }, then this asset key
* {@link AssetKey#AssetKey() }, then this asset key
* is used to track all instances of that asset. Once all clones of the asset
* are garbage collected, the shared asset key becomes unreachable and at that
* point it is removed from the smart asset cache.

5
engine/src/core/com/jme3/bounding/BoundingVolume.java
View File

@ -63,11 +63,6 @@ public abstract class BoundingVolume implements Savable, Cloneable, Collidable {
*/
AABB,
/**
* {@link com.jme3.bounding.OrientedBoundingBox}
*/
OBB,
/**
* Currently unsupported by jME3.
*/

4
engine/src/core/com/jme3/export/JmeExporter.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2010 jMonkeyEngine
* Copyright (c) 2009-2012 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -68,7 +68,7 @@ public interface JmeExporter {
* Returns the {@link OutputCapsule} for the given savable object.
*
* @param object The object to retrieve an output capsule for.
* @return
* @return the {@link OutputCapsule} for the given savable object.
*/
public OutputCapsule getCapsule(Savable object);
}

2
engine/src/core/com/jme3/input/controls/package.html
View File

@ -12,7 +12,7 @@ to input events regardless of the type of input used.
<p>
Users will receive input in one of two forms, either
{@link com.jme3.input.controls.AnalogListener} (analog input) or
{@link com.jme3.input.controls.Action} (digital/action input).
{@link com.jme3.input.controls.ActionListener} (digital/action input).
</body>

6
engine/src/core/com/jme3/material/RenderState.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2010 jMonkeyEngine
* Copyright (c) 2009-2012 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -213,8 +213,8 @@ public class RenderState implements Cloneable, Savable {
* com.jme3.material.RenderState.StencilOperation,
* com.jme3.material.RenderState.StencilOperation,
* com.jme3.material.RenderState.StencilOperation,
* com.jme3.material.RenderState.StencilFunction,
* com.jme3.material.RenderState.StencilFunction)}
* com.jme3.material.RenderState.TestFunction,
* com.jme3.material.RenderState.TestFunction) }
*/
public enum StencilOperation {

13
engine/src/core/com/jme3/renderer/Renderer.java
View File

@ -42,6 +42,7 @@ import com.jme3.shader.Shader.ShaderSource;
import com.jme3.texture.FrameBuffer;
import com.jme3.texture.Image;
import com.jme3.texture.Texture;
import com.jme3.util.NativeObject;
import java.nio.ByteBuffer;
import java.util.EnumSet;
@ -270,21 +271,21 @@ public interface Renderer {
public void renderMesh(Mesh mesh, int lod, int count);
/**
* Resets all previously used GLObjects on this Renderer.
* The state of the GLObjects is reset in such way, that using
* Resets all previously used {@link NativeObject Native Objects} on this Renderer.
* The state of the native objects is reset in such way, that using
* them again will cause the renderer to reupload them.
* Call this method when you know the GL context is going to shutdown.
*
* @see GLObject#resetObject()
* @see NativeObject#resetObject()
*/
public void resetGLObjects();
/**
* Deletes all previously used GLObjects on this Renderer, and
* then resets the GLObjects.
* Deletes all previously used {@link NativeObject Native Objects} on this Renderer, and
* then resets the native objects.
*
* @see #resetGLObjects()
* @see GLObject#deleteObject(com.jme3.renderer.Renderer)
* @see NativeObject#deleteObject(com.jme3.renderer.Renderer)
*/
public void cleanup();

3
engine/src/desktop/com/jme3/app/SettingsDialog.java
View File

@ -52,11 +52,10 @@ import javax.swing.*;
* <code>GameSettings</code> class. The <code>GameSettings</code> object
* is still created by the client application, and passed during construction.
*
* @see com.jme.system.GameSettings
* @see AppSettings
* @author Mark Powell
* @author Eric Woroshow
* @author Joshua Slack - reworked for proper use of GL commands.
* @version $Id: LWJGLPropertiesDialog.java 4131 2009-03-19 20:15:28Z blaine.dev $
*/
public final class SettingsDialog extends JDialog {

2
engine/src/desktop/jme3tools/navigation/MapModel2D.java
View File

@ -290,7 +290,7 @@ public class MapModel2D {
/**
* Returns the pixel (x,y) centre of the map
* @return {@link Point) object marking the map's (x,y) centre
* @return {@link Point} object marking the map's (x,y) centre
* @since 1.0
*/
public Point getPixelCentre() {