Explorar el Código

jme3-android: resolve javadoc diagnostics caused by 3fbc83b5

Stephen Gold hace 4 años
padre
commit
60e1a21d30

+ 8 - 8
jme3-android/src/main/java/com/jme3/app/jmeSurfaceView/JmeSurfaceView.java

@@ -56,7 +56,7 @@ import java.util.logging.Logger;
 /**
  * <b>A RelativeLayout Class Holder that holds a #{{@link GLSurfaceView}} using #{{@link OGLESContext}} as a renderer to render
  * a JME game on an android view for custom xmL designs.</b>
- * @apiNote The main idea of #{@link JmeSurfaceView} class is to start a jMonkeyEngine application in a SystemListener#{@link SystemListener} context in a GL_ES thread ,
+ * The main idea of #{@link JmeSurfaceView} class is to start a jMonkeyEngine application in a {@link SystemListener} context in a GL_ES thread ,
  * then the GLSurfaceView holding the GL_ES thread joins the UI thread with a delay of user's choice using a #{@link Handler} , during the delay , the game runs normally in the GL_ES thread(but without coming up on the UI)
  * and the user has the ability to handle a couple of actions asynchronously as displaying a progress bar on a SplashScreen or
  * an image or even play a preface game music of choice.
@@ -104,8 +104,8 @@ public class JmeSurfaceView extends RelativeLayout implements SystemListener, Di
     /**
      * starts the jmeRenderer on a GlSurfaceView attached to a RelativeLayout.
      * @param delayMillis delay of the appearance of jme game on the screen , this doesn't delay the renderer though.
-     * @apiNote use #{@link JmeSurfaceView#NO_DELAY} to disable the delay ,
-     * any values less than 1ms#{@link JmeSurfaceView#NO_DELAY} would be ignored & the delay would be disabled.
+     * Use #{@link JmeSurfaceView#NO_DELAY} to disable the delay ,
+     * any values less than 1ms#{@link JmeSurfaceView#NO_DELAY} would be ignored and the delay would be disabled.
      */
     public void startRenderer(int delayMillis) {
         this.delayMillis = Math.max(NO_DELAY, delayMillis);
@@ -271,7 +271,7 @@ public class JmeSurfaceView extends RelativeLayout implements SystemListener, Di
     }
 
     /**
-     * Displays an error dialog with a throwable message(error/exception) & with 2 buttons.
+     * Displays an error dialog with a throwable message(error/exception) and 2 buttons.
      * @param throwable the throwable stack.
      * @param message the string message.
      */
@@ -369,7 +369,7 @@ public class JmeSurfaceView extends RelativeLayout implements SystemListener, Di
      * the depth buffer or Z-buffer is basically coupled with stencil buffer ,
      * usually 8bits stencilBuffer + 24bits depthBuffer = 32bits shared memory.
      * @param eglDepthBits the depth bits.
-     * @see JmeSurfaceView#setEglStencilBits(int).
+     * @see JmeSurfaceView#setEglStencilBits(int)
      */
     public void setEglDepthBits(int eglDepthBits) {
         this.eglDepthBits = eglDepthBits;
@@ -403,11 +403,11 @@ public class JmeSurfaceView extends RelativeLayout implements SystemListener, Di
 
     /**
      * Set the number of stencil buffer bits.
-     * Stencil buffer is used in depth-based shadow maps & shadow rendering as it limits rendering,
+     * Stencil buffer is used in depth-based shadow maps and shadow rendering as it limits rendering,
      * it's coupled with Z-buffer or depth buffer,usually 8bits stencilBuffer + 24bits depthBuffer = 32bits shared memory.
      * (default = 0)
      * @param eglStencilBits the desired number of stencil bits.
-     * @see JmeSurfaceView#setEglDepthBits(int).
+     * @see JmeSurfaceView#setEglDepthBits(int)
      */
     public void setEglStencilBits(int eglStencilBits) {
         this.eglStencilBits = eglStencilBits;
@@ -431,7 +431,7 @@ public class JmeSurfaceView extends RelativeLayout implements SystemListener, Di
 
     /**
      * gets the limited FrameRate level for egl config.
-     * @implNote
+     *
      * @return the limit frameRate in integers.
      */
     public int getFrameRate() {

+ 2 - 2
jme3-android/src/main/java/com/jme3/app/jmeSurfaceView/OnExceptionThrown.java

@@ -32,8 +32,8 @@
 package com.jme3.app.jmeSurfaceView;
 
 /**
- * Embedded interface designed to listen to exceptions & fire when an exception is thrown.
- * @see JmeSurfaceView#setOnExceptionThrown(OnExceptionThrown).
+ * Embedded interface designed to listen to exceptions and fire when an exception is thrown.
+ * @see JmeSurfaceView#setOnExceptionThrown(OnExceptionThrown)
  */
 public interface OnExceptionThrown {
     /**

+ 1 - 1
jme3-android/src/main/java/com/jme3/app/jmeSurfaceView/OnRendererCompleted.java

@@ -37,7 +37,7 @@ import com.jme3.system.AppSettings;
 /**
  * Embedded interface class(abstract) to listen for the moment when when the GL thread holding the #{@link JmeSurfaceView}
  * joins the UI thread , after asynchronous rendering.
- * @see JmeSurfaceView#setOnRendererCompleted(OnRendererCompleted).
+ * @see JmeSurfaceView#setOnRendererCompleted(OnRendererCompleted)
  */
 public interface OnRendererCompleted {
     /**