diff options
| author | 2019-05-14 19:22:59 -0700 | |
|---|---|---|
| committer | 2019-05-16 13:56:51 -0700 | |
| commit | 22fb2ffc1ebaa66fb57dcf00a3baa8261e6433e3 (patch) | |
| tree | 55837d509475ddcca545926a676e6737dd51bd1f | |
| parent | 0e7098cf53395b297c5affe30a9356b76fe2ff84 (diff) | |
Fix documentation for AHardwareBuffer_(to|from)HardwareBuffer.
These functions were not showing up in the NDK documentation due to
missing Doxygen commands.
Bug: https://github.com/android-ndk/ndk/issues/706
Bug: 132738639
Test: N/A, documentation-only fix
Change-Id: I329f79da251e62b5f4f05feb7ce837c728e2cb32
| -rw-r--r-- | include/android/hardware_buffer_jni.h | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/include/android/hardware_buffer_jni.h b/include/android/hardware_buffer_jni.h index 7c4be24dbd..aedf36903d 100644 --- a/include/android/hardware_buffer_jni.h +++ b/include/android/hardware_buffer_jni.h @@ -15,7 +15,13 @@ */ /** + * @addtogroup AHardwareBuffer + * @{ + */ + +/** * @file hardware_buffer_jni.h + * @brief JNI glue for native hardware buffers. */ #ifndef ANDROID_HARDWARE_BUFFER_JNI_H @@ -30,23 +36,25 @@ __BEGIN_DECLS /** - * Return the AHardwareBuffer associated with a Java HardwareBuffer object, - * for interacting with it through native code. This method does not acquire any - * additional reference to the AHardwareBuffer that is returned. To keep the - * AHardwareBuffer live after the Java HardwareBuffer object got garbage - * collected, be sure to use AHardwareBuffer_acquire() to acquire an additional - * reference. + * Return the AHardwareBuffer wrapped by a Java HardwareBuffer object. + * + * This method does not acquire any additional reference to the AHardwareBuffer + * that is returned. To keep the AHardwareBuffer live after the Java + * HardwareBuffer object got garbage collected, be sure to use AHardwareBuffer_acquire() + * to acquire an additional reference. */ AHardwareBuffer* AHardwareBuffer_fromHardwareBuffer(JNIEnv* env, - jobject hardwareBufferObj); + jobject hardwareBufferObj) __INTRODUCED_IN(26); /** * Return a new Java HardwareBuffer object that wraps the passed native * AHardwareBuffer object. */ jobject AHardwareBuffer_toHardwareBuffer(JNIEnv* env, - AHardwareBuffer* hardwareBuffer); + AHardwareBuffer* hardwareBuffer) __INTRODUCED_IN(26); __END_DECLS #endif // ANDROID_HARDWARE_BUFFER_JNI_H + +/** @} */ |