Skip to content

Commit 300eb86

Browse files
committed
jme3-android: improve the javadoc
1 parent 0b140b1 commit 300eb86

File tree

5 files changed

+20
-11
lines changed

5 files changed

+20
-11
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -358,8 +358,8 @@ public void run() {
358358
* Called by the android alert dialog, terminate the activity and OpenGL
359359
* rendering
360360
*
361-
* @param dialog
362-
* @param whichButton
361+
* @param dialog ignored
362+
* @param whichButton the button index
363363
*/
364364
@Override
365365
public void onClick(DialogInterface dialog, int whichButton) {

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ public void onAttach(Activity activity) {
229229
* other methods. View related objects should not be reused, but rather
230230
* created and destroyed along with the Activity.
231231
*
232-
* @param savedInstanceState
232+
* @param savedInstanceState the saved instance state
233233
*/
234234
@Override
235235
public void onCreate(Bundle savedInstanceState) {
@@ -282,9 +282,9 @@ public void onCreate(Bundle savedInstanceState) {
282282
* by the Activity's layout parameters for this Fragment. For jME, we also
283283
* update the application reference to the new view.
284284
*
285-
* @param inflater
286-
* @param container
287-
* @param savedInstanceState
285+
* @param inflater ignored
286+
* @param container ignored
287+
* @param savedInstanceState ignored
288288
* @return the new view
289289
*/
290290
@Override
@@ -431,8 +431,8 @@ public void run() {
431431
* Called by the android alert dialog, terminate the activity and OpenGL
432432
* rendering
433433
*
434-
* @param dialog
435-
* @param whichButton
434+
* @param dialog ignored
435+
* @param whichButton the button index
436436
*/
437437
@Override
438438
public void onClick(DialogInterface dialog, int whichButton) {

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

+7-2
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,14 @@ public VideoRecorderAppState(File file, float quality) {
132132
}
133133

134134
/**
135-
* This constructor allows you to specify the output file of the video as well as the quality
135+
* This constructor allows you to specify the output file of the video as
136+
* well as the quality.
137+
*
136138
* @param file the video file
137-
* @param quality the quality of the jpegs in the video stream (0.0 smallest file - 1.0 largest file)
139+
* @param quality the quality of the jpegs in the video stream (0.0 smallest
140+
* file - 1.0 largest file)
141+
* @param framerate the frame rate of the resulting video, the application
142+
* will be locked to this framerate
138143
*/
139144
public VideoRecorderAppState(File file, float quality, int framerate) {
140145
this.file = file;

jme3-android/src/main/java/com/jme3/system/android/OGLESContext.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2009-2020 jMonkeyEngine
2+
* Copyright (c) 2009-2021 jMonkeyEngine
33
* All rights reserved.
44
*
55
* Redistribution and use in source and binary forms, with or without
@@ -101,6 +101,7 @@ public Type getType() {
101101
* GLSurfaceView. Only one GLSurfaceView can be created at this time. The
102102
* given configType specifies how to determine the display configuration.
103103
*
104+
* @param context (not null)
104105
* @return GLSurfaceView The newly created view
105106
*/
106107
public GLSurfaceView createView(Context context) {

jme3-android/src/main/java/com/jme3/util/AndroidLogHandler.java

+3
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ static int getAndroidLevel(Level level) {
9090
* Returns the short logger tag for the given logger name.
9191
* Traditionally loggers are named by fully-qualified Java classes; this
9292
* method attempts to return a concise identifying part of such names.
93+
*
94+
* @param loggerName the logger name, or null for anonymous
95+
* @return the short logger tag
9396
*/
9497
public static String loggerNameToTag(String loggerName) {
9598
// Anonymous logger.

0 commit comments

Comments
 (0)