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

Commit 45e1f989 authored by Dan Stoza's avatar Dan Stoza Committed by Automerger Merge Worker
Browse files

Merge "Add <p> tags for PowerManager#getThermalHeadroom" into rvc-dev am:...

Merge "Add <p> tags for PowerManager#getThermalHeadroom" into rvc-dev am: 571a08fe am: b39ce8b1 am: ec72d270

Change-Id: I9311ec11d94831812abb44d2c0c08c7388bbd4c2
parents 61b32763 ec72d270
Loading
Loading
Loading
Loading
+3 −3
Original line number Original line Diff line number Diff line
@@ -1984,20 +1984,20 @@ public final class PowerManager {
     * temperature sensor. This means that there is no benefit to calling this function more
     * temperature sensor. This means that there is no benefit to calling this function more
     * frequently than about once per second, and attempts to call significantly more frequently may
     * frequently than about once per second, and attempts to call significantly more frequently may
     * result in the function returning {@code NaN}.
     * result in the function returning {@code NaN}.
     *
     * <p>
     * In addition, in order to be able to provide an accurate forecast, the system does not attempt
     * In addition, in order to be able to provide an accurate forecast, the system does not attempt
     * to forecast until it has multiple temperature samples from which to extrapolate. This should
     * to forecast until it has multiple temperature samples from which to extrapolate. This should
     * only take a few seconds from the time of the first call, but during this time, no forecasting
     * only take a few seconds from the time of the first call, but during this time, no forecasting
     * will occur, and the current headroom will be returned regardless of the value of
     * will occur, and the current headroom will be returned regardless of the value of
     * {@code forecastSeconds}.
     * {@code forecastSeconds}.
     *
     * <p>
     * The value returned is a non-negative float that represents how much of the thermal envelope
     * The value returned is a non-negative float that represents how much of the thermal envelope
     * is in use (or is forecasted to be in use). A value of 1.0 indicates that the device is (or
     * is in use (or is forecasted to be in use). A value of 1.0 indicates that the device is (or
     * will be) throttled at {@link #THERMAL_STATUS_SEVERE}. Such throttling can affect the CPU,
     * will be) throttled at {@link #THERMAL_STATUS_SEVERE}. Such throttling can affect the CPU,
     * GPU, and other subsystems. Values may exceed 1.0, but there is no implied mapping to specific
     * GPU, and other subsystems. Values may exceed 1.0, but there is no implied mapping to specific
     * thermal status levels beyond that point. This means that values greater than 1.0 may
     * thermal status levels beyond that point. This means that values greater than 1.0 may
     * correspond to {@link #THERMAL_STATUS_SEVERE}, but may also represent heavier throttling.
     * correspond to {@link #THERMAL_STATUS_SEVERE}, but may also represent heavier throttling.
     *
     * <p>
     * A value of 0.0 corresponds to a fixed distance from 1.0, but does not correspond to any
     * A value of 0.0 corresponds to a fixed distance from 1.0, but does not correspond to any
     * particular thermal status or temperature. Values on (0.0, 1.0] may be expected to scale
     * particular thermal status or temperature. Values on (0.0, 1.0] may be expected to scale
     * linearly with temperature, though temperature changes over time are typically not linear.
     * linearly with temperature, though temperature changes over time are typically not linear.