Explorar o código

jme3-android: improve the javadoc

Stephen Gold %!s(int64=4) %!d(string=hai) anos
pai
achega
300eb86464

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

@@ -358,8 +358,8 @@ public class AndroidHarness extends Activity implements TouchListener, DialogInt
      * Called by the android alert dialog, terminate the activity and OpenGL
      * rendering
      *
-     * @param dialog
-     * @param whichButton
+     * @param dialog ignored
+     * @param whichButton the button index
      */
     @Override
     public void onClick(DialogInterface dialog, int whichButton) {

+ 6 - 6
jme3-android/src/main/java/com/jme3/app/AndroidHarnessFragment.java

@@ -229,7 +229,7 @@ public class AndroidHarnessFragment extends Fragment implements
      * other methods.  View related objects should not be reused, but rather
      * created and destroyed along with the Activity.
      *
-     * @param savedInstanceState
+     * @param savedInstanceState the saved instance state
      */
     @Override
     public void onCreate(Bundle savedInstanceState) {
@@ -282,9 +282,9 @@ public class AndroidHarnessFragment extends Fragment implements
      * by the Activity's layout parameters for this Fragment.  For jME, we also
      * update the application reference to the new view.
      *
-     * @param inflater
-     * @param container
-     * @param savedInstanceState
+     * @param inflater ignored
+     * @param container ignored
+     * @param savedInstanceState ignored
      * @return the new view
      */
     @Override
@@ -431,8 +431,8 @@ public class AndroidHarnessFragment extends Fragment implements
      * Called by the android alert dialog, terminate the activity and OpenGL
      * rendering
      *
-     * @param dialog
-     * @param whichButton
+     * @param dialog ignored
+     * @param whichButton the button index
      */
     @Override
     public void onClick(DialogInterface dialog, int whichButton) {

+ 7 - 2
jme3-android/src/main/java/com/jme3/app/state/VideoRecorderAppState.java

@@ -132,9 +132,14 @@ public class VideoRecorderAppState extends AbstractAppState {
     }
 
     /**
-     * This constructor allows you to specify the output file of the video as well as the quality
+     * This constructor allows you to specify the output file of the video as
+     * well as the quality.
+     *
      * @param file the video file
-     * @param quality the quality of the jpegs in the video stream (0.0 smallest file - 1.0 largest file)
+     * @param quality the quality of the jpegs in the video stream (0.0 smallest
+     * file - 1.0 largest file)
+     * @param framerate the frame rate of the resulting video, the application
+     * will be locked to this framerate
      */
     public VideoRecorderAppState(File file, float quality, int framerate) {
         this.file = file;

+ 2 - 1
jme3-android/src/main/java/com/jme3/system/android/OGLESContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2020 jMonkeyEngine
+ * Copyright (c) 2009-2021 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -101,6 +101,7 @@ public class OGLESContext implements JmeContext, GLSurfaceView.Renderer, SoftTex
      * GLSurfaceView. Only one GLSurfaceView can be created at this time. The
      * given configType specifies how to determine the display configuration.
      *
+     * @param context (not null)
      * @return GLSurfaceView The newly created view
      */
     public GLSurfaceView createView(Context context) {

+ 3 - 0
jme3-android/src/main/java/com/jme3/util/AndroidLogHandler.java

@@ -90,6 +90,9 @@ public class AndroidLogHandler extends Handler {
      * Returns the short logger tag for the given logger name.
      * Traditionally loggers are named by fully-qualified Java classes; this
      * method attempts to return a concise identifying part of such names.
+     * 
+     * @param loggerName the logger name, or null for anonymous
+     * @return the short logger tag
      */
     public static String loggerNameToTag(String loggerName) {
         // Anonymous logger.