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

Commit 553c8c77 authored by Marie Janssen's avatar Marie Janssen Committed by Andre Eisenbach
Browse files

Bluetooth: minor documentation fix to de-confuse 

It was somewhat unclear which is the preferred method of retrieving a
BluetoothAdapter.  Make it clear that using BluetoothManager is
preferred, and remove references to the old method in BluetoothManager
docs since it is only avaialable in API 18 or higher.

Test: recompile, check that documentation is updated
Fix: 33355430
Change-Id: Ia20b4e45dca03bc2f13c2ab477799b89c5e14f45
parent 12e09759

core/java/android/bluetooth/BluetoothAdapter.java

+8 −7
Original line number Diff line number Diff line
@@ -70,9 +70,10 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; 
 * devices, and start a scan for Bluetooth LE devices.

 *

 * <p>To get a {@link BluetoothAdapter} representing the local Bluetooth

 * adapter, when running on JELLY_BEAN_MR1 and below, call the

 * static {@link #getDefaultAdapter} method; when running on JELLY_BEAN_MR2 and

 * higher, call {@link BluetoothManager#getAdapter}.

 * adapter, call the {@link BluetoothManager#getAdapter} function on {@link BluetoothManager}.

 * On JELLY_BEAN_MR1 and below you will need to use the static {@link #getDefaultAdapter}

 * method instead.

 * </p><p>

 * Fundamentally, this is your starting point for all

 * Bluetooth actions. Once you have the local adapter, you can get a set of

 * {@link BluetoothDevice} objects representing all paired devices with
@@ -81,14 +82,13 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; 
 * listen for incoming connection requests with

 * {@link #listenUsingRfcommWithServiceRecord(String,UUID)}; or start a scan for

 * Bluetooth LE devices with {@link #startLeScan(LeScanCallback callback)}.

 *

 * <p>This class is thread safe.

 *

 * </p>

 * <p>This class is thread safe.</p>

 * <p class="note"><strong>Note:</strong>

 * Most methods require the {@link android.Manifest.permission#BLUETOOTH}

 * permission and some also require the

 * {@link android.Manifest.permission#BLUETOOTH_ADMIN} permission.

 *

 * </p>

 * <div class="special reference">

 * <h3>Developer Guides</h3>

 * <p>
@@ -565,6 +565,7 @@ public final class BluetoothAdapter { 
     * <p>Currently Android only supports one Bluetooth adapter, but the API

     * could be extended to support more. This will always return the default

     * adapter.

     * </p>

     * @return the default local adapter, or null if Bluetooth is not supported

     *         on this hardware platform

     */

core/java/android/bluetooth/BluetoothManager.java

+1 −4
Original line number Diff line number Diff line
@@ -32,10 +32,7 @@ import java.util.List; 
 * Use {@link android.content.Context#getSystemService(java.lang.String)}

 * with {@link Context#BLUETOOTH_SERVICE} to create an {@link BluetoothManager},

 * then call {@link #getAdapter} to obtain the {@link BluetoothAdapter}.

 * <p>

 * Alternately, you can just call the static helper

 * {@link BluetoothAdapter#getDefaultAdapter()}.

 *

 * </p>

 * <div class="special reference">

 * <h3>Developer Guides</h3>

 * <p>