From a625e8ae2a47d372601c9f8032ddeeb60caf62cd Mon Sep 17 00:00:00 2001 From: "sky..ok" Date: Tue, 8 May 2012 15:11:38 +0000 Subject: [PATCH] Javadoc fixes R PHUN git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@9358 75d07b2b-3a1a-0410-a2c5-0572b91ccdca --- .../android/com/jme3/asset/AndroidImageInfo.java | 2 +- .../core/com/jme3/asset/CloneableSmartAsset.java | 4 ++-- .../src/core/com/jme3/bounding/BoundingVolume.java | 5 ----- engine/src/core/com/jme3/export/JmeExporter.java | 4 ++-- .../src/core/com/jme3/input/controls/package.html | 2 +- engine/src/core/com/jme3/material/RenderState.java | 6 +++--- engine/src/core/com/jme3/renderer/Renderer.java | 13 +++++++------ engine/src/desktop/com/jme3/app/SettingsDialog.java | 3 +-- .../desktop/jme3tools/navigation/MapModel2D.java | 2 +- 9 files changed, 18 insertions(+), 23 deletions(-) diff --git a/engine/src/android/com/jme3/asset/AndroidImageInfo.java b/engine/src/android/com/jme3/asset/AndroidImageInfo.java index c8eb5390e..1b5c796e1 100644 --- a/engine/src/android/com/jme3/asset/AndroidImageInfo.java +++ b/engine/src/android/com/jme3/asset/AndroidImageInfo.java @@ -9,7 +9,7 @@ import java.io.IOException; import java.io.InputStream; /** - * AndroidImageInfo is set in a jME3 image via the {@link Image#setEfficientData(java.lang.Object)} + * AndroidImageInfo 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 AndroidImageInfo and provide their own implementation of the * {@link AndroidImageInfo#loadBitmap()} method to acquire a bitmap by their own means. diff --git a/engine/src/core/com/jme3/asset/CloneableSmartAsset.java b/engine/src/core/com/jme3/asset/CloneableSmartAsset.java index affaab19a..a74470698 100644 --- a/engine/src/core/com/jme3/asset/CloneableSmartAsset.java +++ b/engine/src/core/com/jme3/asset/CloneableSmartAsset.java @@ -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. diff --git a/engine/src/core/com/jme3/bounding/BoundingVolume.java b/engine/src/core/com/jme3/bounding/BoundingVolume.java index 8db2e57d1..6caf6bed9 100644 --- a/engine/src/core/com/jme3/bounding/BoundingVolume.java +++ b/engine/src/core/com/jme3/bounding/BoundingVolume.java @@ -63,11 +63,6 @@ public abstract class BoundingVolume implements Savable, Cloneable, Collidable { */ AABB, - /** - * {@link com.jme3.bounding.OrientedBoundingBox} - */ - OBB, - /** * Currently unsupported by jME3. */ diff --git a/engine/src/core/com/jme3/export/JmeExporter.java b/engine/src/core/com/jme3/export/JmeExporter.java index 956dfd80d..943b21d27 100644 --- a/engine/src/core/com/jme3/export/JmeExporter.java +++ b/engine/src/core/com/jme3/export/JmeExporter.java @@ -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); } diff --git a/engine/src/core/com/jme3/input/controls/package.html b/engine/src/core/com/jme3/input/controls/package.html index bd556a55b..3eb3d251d 100644 --- a/engine/src/core/com/jme3/input/controls/package.html +++ b/engine/src/core/com/jme3/input/controls/package.html @@ -12,7 +12,7 @@ to input events regardless of the type of input used.

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). diff --git a/engine/src/core/com/jme3/material/RenderState.java b/engine/src/core/com/jme3/material/RenderState.java index 4dc4d112b..d0288028e 100644 --- a/engine/src/core/com/jme3/material/RenderState.java +++ b/engine/src/core/com/jme3/material/RenderState.java @@ -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 { diff --git a/engine/src/core/com/jme3/renderer/Renderer.java b/engine/src/core/com/jme3/renderer/Renderer.java index b94bd1d5d..818231979 100644 --- a/engine/src/core/com/jme3/renderer/Renderer.java +++ b/engine/src/core/com/jme3/renderer/Renderer.java @@ -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(); diff --git a/engine/src/desktop/com/jme3/app/SettingsDialog.java b/engine/src/desktop/com/jme3/app/SettingsDialog.java index 4402604a1..d2cc6b29c 100644 --- a/engine/src/desktop/com/jme3/app/SettingsDialog.java +++ b/engine/src/desktop/com/jme3/app/SettingsDialog.java @@ -52,11 +52,10 @@ import javax.swing.*; * GameSettings class. The GameSettings 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 { diff --git a/engine/src/desktop/jme3tools/navigation/MapModel2D.java b/engine/src/desktop/jme3tools/navigation/MapModel2D.java index 47b323cba..71c8ad758 100644 --- a/engine/src/desktop/jme3tools/navigation/MapModel2D.java +++ b/engine/src/desktop/jme3tools/navigation/MapModel2D.java @@ -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() {