From e55c4469771f9f88626b362aa7b7226c4f424ed7 Mon Sep 17 00:00:00 2001 From: Jakub Pawlowski Date: Tue, 25 Apr 2017 08:07:11 -0700 Subject: [PATCH] Bluetooth: document status value in PHY read/update Bug: 37544152 Test: none Change-Id: I2bac468f833c73cd282b1dac80b6553917996604 --- core/java/android/bluetooth/BluetoothGattCallback.java | 6 ++++-- .../java/android/bluetooth/BluetoothGattServerCallback.java | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/core/java/android/bluetooth/BluetoothGattCallback.java b/core/java/android/bluetooth/BluetoothGattCallback.java index 11a15c66385a9..c6f82ffb7ae48 100644 --- a/core/java/android/bluetooth/BluetoothGattCallback.java +++ b/core/java/android/bluetooth/BluetoothGattCallback.java @@ -30,7 +30,8 @@ public abstract class BluetoothGattCallback{ * {@link BluetoothDevice#PHY_LE_2M}, and {@link BluetoothDevice#PHY_LE_CODED}. * @param rxPhy the receiver PHY in use. One of {@link BluetoothDevice#PHY_LE_1M}, * {@link BluetoothDevice#PHY_LE_2M}, and {@link BluetoothDevice#PHY_LE_CODED}. - * @param status status of the operation + * @param status Status of the PHY update operation. + * {@link BluetoothGatt#GATT_SUCCESS} if the operation succeeds. */ public void onPhyUpdate(BluetoothGatt gatt, int txPhy, int rxPhy, int status) { } @@ -43,7 +44,8 @@ public abstract class BluetoothGattCallback{ * {@link BluetoothDevice#PHY_LE_2M}, and {@link BluetoothDevice#PHY_LE_CODED}. * @param rxPhy the receiver PHY in use. One of {@link BluetoothDevice#PHY_LE_1M}, * {@link BluetoothDevice#PHY_LE_2M}, and {@link BluetoothDevice#PHY_LE_CODED}. - * @param status status of the operation + * @param status Status of the PHY read operation. + * {@link BluetoothGatt#GATT_SUCCESS} if the operation succeeds. */ public void onPhyRead(BluetoothGatt gatt, int txPhy, int rxPhy, int status) { } diff --git a/core/java/android/bluetooth/BluetoothGattServerCallback.java b/core/java/android/bluetooth/BluetoothGattServerCallback.java index 3b8f962bf73e4..02307bd9ef9f8 100644 --- a/core/java/android/bluetooth/BluetoothGattServerCallback.java +++ b/core/java/android/bluetooth/BluetoothGattServerCallback.java @@ -167,7 +167,8 @@ public abstract class BluetoothGattServerCallback { * {@link BluetoothDevice#PHY_LE_2M}, and {@link BluetoothDevice#PHY_LE_CODED} * @param rxPhy the receiver PHY in use. One of {@link BluetoothDevice#PHY_LE_1M}, * {@link BluetoothDevice#PHY_LE_2M}, and {@link BluetoothDevice#PHY_LE_CODED} - * @param status status of the operation + * @param status Status of the PHY update operation. + * {@link BluetoothGatt#GATT_SUCCESS} if the operation succeeds. */ public void onPhyUpdate(BluetoothDevice device, int txPhy, int rxPhy, int status) { } @@ -180,7 +181,8 @@ public abstract class BluetoothGattServerCallback { * {@link BluetoothDevice#PHY_LE_2M}, and {@link BluetoothDevice#PHY_LE_CODED} * @param rxPhy the receiver PHY in use. One of {@link BluetoothDevice#PHY_LE_1M}, * {@link BluetoothDevice#PHY_LE_2M}, and {@link BluetoothDevice#PHY_LE_CODED} - * @param status status of the operation + * @param status Status of the PHY read operation. + * {@link BluetoothGatt#GATT_SUCCESS} if the operation succeeds. */ public void onPhyRead(BluetoothDevice device, int txPhy, int rxPhy, int status) { }