summaryrefslogtreecommitdiff
path: root/framework/java/android/bluetooth/BluetoothAdapter.java
diff options
context:
space:
mode:
authorRahul Sabnis <rahulsabnis@google.com>2022-05-26 13:52:33 -0700
committerRahul Sabnis <rahulsabnis@google.com>2022-05-26 13:53:45 -0700
commit715aa0e1da6024f85b0fcdb875f4c49be5a466ed (patch)
treefcb8f0aa7afb5b98ad91c0985be4c241c327d760 /framework/java/android/bluetooth/BluetoothAdapter.java
parentf6745c0f487e99e46f6e96c11e31d002896dbc87 (diff)
Update API docs to indicate that BT addresses are to be provided in big
endian. Tag: #feature Bug: 233217148 Test: Manual (docs change) Ignore-AOSP-First: Android T docs change Change-Id: Iee36345088c886d5b43120bb10d8ddf52133de07
Diffstat (limited to 'framework/java/android/bluetooth/BluetoothAdapter.java')
-rw-r--r--framework/java/android/bluetooth/BluetoothAdapter.java8
1 files changed, 4 insertions, 4 deletions
diff --git a/framework/java/android/bluetooth/BluetoothAdapter.java b/framework/java/android/bluetooth/BluetoothAdapter.java
index eed12635c5..e4bfc42b86 100644
--- a/framework/java/android/bluetooth/BluetoothAdapter.java
+++ b/framework/java/android/bluetooth/BluetoothAdapter.java
@@ -1005,8 +1005,8 @@ public final class BluetoothAdapter {
/**
* Get a {@link BluetoothDevice} object for the given Bluetooth hardware
* address.
- * <p>Valid Bluetooth hardware addresses must be upper case, in a format
- * such as "00:11:22:33:AA:BB". The helper {@link #checkBluetoothAddress} is
+ * <p>Valid Bluetooth hardware addresses must be upper case, in big endian byte order, and in a
+ * format such as "00:11:22:33:AA:BB". The helper {@link #checkBluetoothAddress} is
* available to validate a Bluetooth address.
* <p>A {@link BluetoothDevice} will always be returned for a valid
* hardware address, even if this adapter has never seen that device.
@@ -1024,8 +1024,8 @@ public final class BluetoothAdapter {
/**
* Get a {@link BluetoothDevice} object for the given Bluetooth hardware
* address and addressType.
- * <p>Valid Bluetooth hardware addresses must be upper case, in a format
- * such as "00:11:22:33:AA:BB". The helper {@link #checkBluetoothAddress} is
+ * <p>Valid Bluetooth hardware addresses must be upper case, in big endian byte order, and in a
+ * format such as "00:11:22:33:AA:BB". The helper {@link #checkBluetoothAddress} is
* available to validate a Bluetooth address.
* <p>A {@link BluetoothDevice} will always be returned for a valid
* hardware address and type, even if this adapter has never seen that device.