summaryrefslogtreecommitdiff
path: root/core/java/android/bluetooth/BluetoothProfile.java
diff options
context:
space:
mode:
authorJaikumar Ganesh <jaikumar@google.com>2011-01-25 16:03:13 -0800
committerJaikumar Ganesh <jaikumar@google.com>2011-01-25 16:53:39 -0800
commitc8fa4ff838a0c3d2c67db65540fa751e5abe27ed (patch)
tree5c9aaf651a48afe1f1aef2b943061da0ac9bec69 /core/java/android/bluetooth/BluetoothProfile.java
parentd63219f62248d067462403bed9e0539df53dd2dd (diff)
Improve readability of java docs for the public APIs.
Change-Id: I0a0f1be04ed2ea2c14498a1a2ed4b050191ec95b
Diffstat (limited to 'core/java/android/bluetooth/BluetoothProfile.java')
-rw-r--r--core/java/android/bluetooth/BluetoothProfile.java17
1 files changed, 10 insertions, 7 deletions
diff --git a/core/java/android/bluetooth/BluetoothProfile.java b/core/java/android/bluetooth/BluetoothProfile.java
index 3949b26186eb..ef80195d935d 100644
--- a/core/java/android/bluetooth/BluetoothProfile.java
+++ b/core/java/android/bluetooth/BluetoothProfile.java
@@ -105,6 +105,7 @@ public interface BluetoothProfile {
* from this intent.
*
* <p>Requires {@link android.Manifest.permission#BLUETOOTH_ADMIN}
+ * permission.
*
* @param device Remote Bluetooth Device
* @return false on immediate error,
@@ -132,6 +133,7 @@ public interface BluetoothProfile {
* two scenarios.
*
* <p>Requires {@link android.Manifest.permission#BLUETOOTH_ADMIN}
+ * permission.
*
* @param device Remote Bluetooth Device
* @return false on immediate error,
@@ -145,20 +147,20 @@ public interface BluetoothProfile {
*
* <p> Return the set of devices which are in state {@link #STATE_CONNECTED}
*
- * <p>Requires {@link android.Manifest.permission#BLUETOOTH}
+ * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission.
*
* @return List of devices. The list will be empty on error.
*/
public List<BluetoothDevice> getConnectedDevices();
/**
- * Get a set of devices that match any of the given connection
+ * Get a list of devices that match any of the given connection
* states.
*
- * <p> If none of devices match any of the given states,
- * an empty set will be returned.
+ * <p> If none of the devices match any of the given states,
+ * an empty list will be returned.
*
- * <p>Requires {@link android.Manifest.permission#BLUETOOTH}
+ * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission.
*
* @param states Array of states. States can be one of
* {@link #STATE_CONNECTED}, {@link #STATE_CONNECTING},
@@ -170,7 +172,7 @@ public interface BluetoothProfile {
/**
* Get the current connection state of the profile
*
- * <p>Requires {@link android.Manifest.permission#BLUETOOTH}
+ * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission.
*
* @param device Remote bluetooth device.
* @return State of the profile connection. One of
@@ -187,6 +189,7 @@ public interface BluetoothProfile {
* {@link #PRIORITY_OFF},
*
* <p>Requires {@link android.Manifest.permission#BLUETOOTH_ADMIN}
+ * permission.
*
* @param device Paired bluetooth device
* @param priority
@@ -202,7 +205,7 @@ public interface BluetoothProfile {
* {@link #PRIORITY_AUTO_CONNECT}, {@link #PRIORITY_OFF},
* {@link #PRIORITY_ON}, {@link #PRIORITY_UNDEFINED}
*
- * <p>Requires {@link android.Manifest.permission#BLUETOOTH}
+ * <p>Requires {@link android.Manifest.permission#BLUETOOTH} permission.
*
* @param device Bluetooth device
* @return priority of the device