Skip to content

Commit 60e1a21

Browse files
committed
jme3-android: resolve javadoc diagnostics caused by 3fbc83b
1 parent 216d2c4 commit 60e1a21

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
/**
5757
* <b>A RelativeLayout Class Holder that holds a #{{@link GLSurfaceView}} using #{{@link OGLESContext}} as a renderer to render
5858
* a JME game on an android view for custom xmL designs.</b>
59-
* @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 ,
59+
* The main idea of #{@link JmeSurfaceView} class is to start a jMonkeyEngine application in a {@link SystemListener} context in a GL_ES thread ,
6060
* 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)
6161
* and the user has the ability to handle a couple of actions asynchronously as displaying a progress bar on a SplashScreen or
6262
* an image or even play a preface game music of choice.
@@ -104,8 +104,8 @@ public JmeSurfaceView(@NonNull Context context, @Nullable AttributeSet attrs, in
104104
/**
105105
* starts the jmeRenderer on a GlSurfaceView attached to a RelativeLayout.
106106
* @param delayMillis delay of the appearance of jme game on the screen , this doesn't delay the renderer though.
107-
* @apiNote use #{@link JmeSurfaceView#NO_DELAY} to disable the delay ,
108-
* any values less than 1ms#{@link JmeSurfaceView#NO_DELAY} would be ignored & the delay would be disabled.
107+
* Use #{@link JmeSurfaceView#NO_DELAY} to disable the delay ,
108+
* any values less than 1ms#{@link JmeSurfaceView#NO_DELAY} would be ignored and the delay would be disabled.
109109
*/
110110
public void startRenderer(int delayMillis) {
111111
this.delayMillis = Math.max(NO_DELAY, delayMillis);
@@ -271,7 +271,7 @@ public void destroy() {
271271
}
272272

273273
/**
274-
* Displays an error dialog with a throwable message(error/exception) & with 2 buttons.
274+
* Displays an error dialog with a throwable message(error/exception) and 2 buttons.
275275
* @param throwable the throwable stack.
276276
* @param message the string message.
277277
*/
@@ -369,7 +369,7 @@ public int getEglAlphaBits() {
369369
* the depth buffer or Z-buffer is basically coupled with stencil buffer ,
370370
* usually 8bits stencilBuffer + 24bits depthBuffer = 32bits shared memory.
371371
* @param eglDepthBits the depth bits.
372-
* @see JmeSurfaceView#setEglStencilBits(int).
372+
* @see JmeSurfaceView#setEglStencilBits(int)
373373
*/
374374
public void setEglDepthBits(int eglDepthBits) {
375375
this.eglDepthBits = eglDepthBits;
@@ -403,11 +403,11 @@ public int getEglSamples() {
403403

404404
/**
405405
* Set the number of stencil buffer bits.
406-
* Stencil buffer is used in depth-based shadow maps & shadow rendering as it limits rendering,
406+
* Stencil buffer is used in depth-based shadow maps and shadow rendering as it limits rendering,
407407
* it's coupled with Z-buffer or depth buffer,usually 8bits stencilBuffer + 24bits depthBuffer = 32bits shared memory.
408408
* (default = 0)
409409
* @param eglStencilBits the desired number of stencil bits.
410-
* @see JmeSurfaceView#setEglDepthBits(int).
410+
* @see JmeSurfaceView#setEglDepthBits(int)
411411
*/
412412
public void setEglStencilBits(int eglStencilBits) {
413413
this.eglStencilBits = eglStencilBits;
@@ -431,7 +431,7 @@ public void setFrameRate(int frameRate) {
431431

432432
/**
433433
* gets the limited FrameRate level for egl config.
434-
* @implNote
434+
*
435435
* @return the limit frameRate in integers.
436436
*/
437437
public int getFrameRate() {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
package com.jme3.app.jmeSurfaceView;
3333

3434
/**
35-
* Embedded interface designed to listen to exceptions & fire when an exception is thrown.
36-
* @see JmeSurfaceView#setOnExceptionThrown(OnExceptionThrown).
35+
* Embedded interface designed to listen to exceptions and fire when an exception is thrown.
36+
* @see JmeSurfaceView#setOnExceptionThrown(OnExceptionThrown)
3737
*/
3838
public interface OnExceptionThrown {
3939
/**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
/**
3838
* Embedded interface class(abstract) to listen for the moment when when the GL thread holding the #{@link JmeSurfaceView}
3939
* joins the UI thread , after asynchronous rendering.
40-
* @see JmeSurfaceView#setOnRendererCompleted(OnRendererCompleted).
40+
* @see JmeSurfaceView#setOnRendererCompleted(OnRendererCompleted)
4141
*/
4242
public interface OnRendererCompleted {
4343
/**

0 commit comments

Comments
 (0)