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

Commit 4883c52b authored by Leon Scroggins III's avatar Leon Scroggins III
Browse files

Fix docs for bitmap.h 

Bug: 135133301
Test: Generate docs

- Fix errors in bitmap documentation.
- Add links where relevant.
- Move comment in sensor.h so it will apply to the module, and not
AHardwareBuffer.

Change-Id: Iec00725522e74eccab9346665562081211a870eb
parent 144cb00a

include/android/bitmap.h

+13 −13
Original line number Diff line number Diff line
@@ -81,8 +81,8 @@ enum { 


enum {

    /** If this bit is set in AndroidBitmapInfo.flags, the Bitmap uses the

      * HARDWARE Config, and its AHardwareBuffer can be retrieved via

      * AndroidBitmap_getHardwareBuffer.

      * HARDWARE Config, and its {@link AHardwareBuffer} can be retrieved via

      * {@link AndroidBitmap_getHardwareBuffer}.

      */

    ANDROID_BITMAP_FLAGS_IS_HARDWARE = 1 << 31,

};
@@ -120,10 +120,10 @@ int AndroidBitmap_getInfo(JNIEnv* env, jobject jbitmap, 
#if __ANDROID_API__ >= 30



/**

 * Given a java bitmap object, return its ADataSpace.

 * Given a java bitmap object, return its {@link ADataSpace}.

 *

 * Note that ADataSpace only exposes a few values. This may return

 * ADATASPACE_UNKNOWN, even for Named ColorSpaces, if they have no

 * Note that {@link ADataSpace} only exposes a few values. This may return

 * {@link ADATASPACE_UNKNOWN}, even for Named ColorSpaces, if they have no

 * corresponding ADataSpace.

 */

int32_t AndroidBitmap_getDataSpace(JNIEnv* env, jobject jbitmap)  __INTRODUCED_IN(30);
@@ -206,14 +206,14 @@ typedef bool (*AndroidBitmap_CompressWriteFunc)(void* userContext, 
 *  @param dataspace {@link ADataSpace} describing the color space of the

 *                   pixels.

 *  @param pixels Pointer to pixels to compress.

 *  @param format (@link AndroidBitmapCompressFormat} to compress to.

 *  @param format {@link AndroidBitmapCompressFormat} to compress to.

 *  @param quality Hint to the compressor, 0-100. The value is interpreted

 *                 differently depending on the

 *                 {@link AndroidBitmapCompressFormat}.

 *  @param userContext User-defined data which will be passed to the supplied

 *                     {@link AndroidBitmap_CompressWriteFunc} each time it is

 *                     called. May be null.

 *  @parm fn Function that writes the compressed data. Will be called each time

 *  @param fn Function that writes the compressed data. Will be called each time

 *            the compressor has compressed more data that is ready to be

 *            written. May be called more than once for each call to this method.

 *            May not be null.
@@ -235,11 +235,11 @@ struct AHardwareBuffer; 
 *

 *  @param bitmap Handle to an android.graphics.Bitmap.

 *  @param outBuffer On success, is set to a pointer to the

 *         AHardwareBuffer associated with bitmap. This acquires

 *         {@link AHardwareBuffer} associated with bitmap. This acquires

 *         a reference on the buffer, and the client must call

 *         AHardwareBuffer_release when finished with it.

 *         {@link AHardwareBuffer_release} when finished with it.

 *  @return AndroidBitmap functions result code.

 *          ANDROID_BITMAP_RESULT_BAD_PARAMETER if bitmap is not a

 *          {@link ANDROID_BITMAP_RESULT_BAD_PARAMETER} if bitmap is not a

 *          HARDWARE Bitmap.

 */

int AndroidBitmap_getHardwareBuffer(JNIEnv* env, jobject bitmap,

include/android/sensor.h

+3 −6
Original line number Diff line number Diff line
@@ -15,6 +15,9 @@ 
 */



/**

 * Structures and functions to receive and process sensor events in

 * native code.

 *

 * @addtogroup Sensor

 * @{

 */
@@ -42,12 +45,6 @@ 
 *   - DO NOT CHANGE THE LAYOUT OR SIZE OF STRUCTURES

 */



/**

 * Structures and functions to receive and process sensor events in

 * native code.

 *

 */



#include <android/looper.h>



#include <stdbool.h>