From 22fb2ffc1ebaa66fb57dcf00a3baa8261e6433e3 Mon Sep 17 00:00:00 2001 From: Krzysztof KosiƄski Date: Tue, 14 May 2019 19:22:59 -0700 Subject: 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 --- include/android/hardware_buffer_jni.h | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) (limited to 'include') 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 @@ -14,8 +14,14 @@ * limitations under the License. */ +/** + * @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 + +/** @} */ -- cgit v1.2.3-59-g8ed1b