Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a53d8653 authored by Siarhei Vishniakou's avatar Siarhei Vishniakou
Browse files

Correct docs about the returned native objects 

The native objects returned by the function are actually copies of the
Java objects. So, they do not have any relationship with the original
Java objects, and their lifetimes do not depend on them.

Bug: 150954805
Test: none
Change-Id: I21c35bf34eb10d2ce7b4716b886840b11b0c08de
parent 8d143381

include/android/input.h

+7 −10
Original line number Diff line number Diff line
@@ -988,11 +988,9 @@ int64_t AKeyEvent_getDownTime(const AInputEvent* key_event); 
int64_t AKeyEvent_getEventTime(const AInputEvent* key_event);



/**

 * Creates a native AInputEvent* object associated with the specified Java android.view.KeyEvent.

 * The result may be used with generic and KeyEvent-specific AInputEvent_* functions.

 * The object returned by this function must be disposed using {@link AInputEvent_release()}.

 * User must guarantee that lifetime for object referenced by keyEvent is prolongated

 * up to release of returned AInputEvent*.

 * Creates a native AInputEvent* object that is a copy of the specified Java android.view.KeyEvent.

 * The result may be used with generic and KeyEvent-specific AInputEvent_* functions. The object

 * returned by this function must be disposed using {@link AInputEvent_release()}.

 */

const AInputEvent* AKeyEvent_fromJava(JNIEnv* env, jobject keyEvent);
@@ -1312,11 +1310,10 @@ float AMotionEvent_getHistoricalAxisValue(const AInputEvent* motion_event, 
        int32_t axis, size_t pointer_index, size_t history_index);



/**

 * Creates a native AInputEvent* object associated with the specified Java android.view.MotionEvent.

 * The result may be used with generic and MotionEvent-specific AInputEvent_* functions.

 * The object returned by this function must be disposed using {@link AInputEvent_release()}.

 * User must guarantee that object referenced by motionEvent won't be recycled and

 * its lifetime is prolongated up to release of returned AInputEvent*.

 * Creates a native AInputEvent* object that is a copy of the specified Java

 * android.view.MotionEvent. The result may be used with generic and MotionEvent-specific

 * AInputEvent_* functions. The object returned by this function must be disposed using

 * {@link AInputEvent_release()}.

 */

const AInputEvent* AMotionEvent_fromJava(JNIEnv* env, jobject motionEvent);