diff options
| author | 2021-06-17 21:41:18 +0000 | |
|---|---|---|
| committer | 2021-06-17 21:41:18 +0000 | |
| commit | 5f9e20b375377c88d7a83d7dcb1c0b34d6e3dce5 (patch) | |
| tree | fb160e96409f1b3bf4e3c5161a35baa50be47a68 | |
| parent | fee0ac21582684345bbdc281d1c2523f061f1508 (diff) | |
| parent | 8f886322ae5ba416f8ad5777af7bbd8972e44f0d (diff) | |
Merge "Update code comments to mention sensor name uniqueness." into sc-dev
| -rw-r--r-- | core/java/android/hardware/Sensor.java | 3 | ||||
| -rw-r--r-- | core/java/android/hardware/SensorManager.java | 4 |
2 files changed, 5 insertions, 2 deletions
diff --git a/core/java/android/hardware/Sensor.java b/core/java/android/hardware/Sensor.java index ec6c23384859..37469e916eef 100644 --- a/core/java/android/hardware/Sensor.java +++ b/core/java/android/hardware/Sensor.java @@ -952,7 +952,8 @@ public final class Sensor { } /** - * @return name string of the sensor. + * @return name string of the sensor. The name is guaranteed to be unique + * for a particular sensor type. */ public String getName() { return mName; diff --git a/core/java/android/hardware/SensorManager.java b/core/java/android/hardware/SensorManager.java index 0a76a9c6bee3..713b66abed21 100644 --- a/core/java/android/hardware/SensorManager.java +++ b/core/java/android/hardware/SensorManager.java @@ -399,7 +399,9 @@ public abstract class SensorManager { * Use this method to get the list of available sensors of a certain type. * Make multiple calls to get sensors of different types or use * {@link android.hardware.Sensor#TYPE_ALL Sensor.TYPE_ALL} to get all the - * sensors. + * sensors. Note that the {@link android.hardware.Sensor#getName()} is + * expected to yield a value that is unique across any sensors that return + * the same value for {@link android.hardware.Sensor#getType()}. * * <p class="note"> * NOTE: Both wake-up and non wake-up sensors matching the given type are |