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

Commit e57676ba authored by Aravind Akella's avatar Aravind Akella
Browse files

Documentation fix for Sensor.getMaxDelay() 

Change-Id: Ibec32f098b2036ec1f9795ec8155dac47b5df4fd
parent b730542b

core/java/android/hardware/Sensor.java

+5 −6
Original line number Diff line number Diff line
@@ -737,12 +737,11 @@ public final class Sensor { 
    }



    /**

     * This value is defined only for continuous mode sensors. It is the delay between two

     * sensor events corresponding to the lowest frequency that this sensor supports. When

     * lower frequencies are requested through registerListener() the events will be generated

     * at this frequency instead. It can be used to estimate when the batch FIFO may be full.

     * Older devices may set this value to zero. Ignore this value in case it is negative

     * or zero.

     * This value is defined only for continuous and on-change sensors. It is the delay between two

     * sensor events corresponding to the lowest frequency that this sensor supports. When lower

     * frequencies are requested through registerListener() the events will be generated at this

     * frequency instead. It can be used to estimate when the batch FIFO may be full. Older devices

     * may set this value to zero. Ignore this value in case it is negative or zero.

     *

     * @return The max delay for this sensor in microseconds.

     */