Skip to content

Commit 3c6ebed

Browse files
committed
Replace {@code} with backticks in thermal NDK comment
This will generate <code> tag properly instead of <pre> Bug: 367803904 Test: n/a Flag: EXEMPT ndk Change-Id: I59d53925cf15b33364190557951a4c03d18f4071 Merged-In: If5456fdc009b1154101cdae95d8d2943b030fbad
1 parent 2d66014 commit 3c6ebed

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

include/android/thermal.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -254,18 +254,18 @@ typedef struct AThermalHeadroomThreshold AThermalHeadroomThreshold;
254254
* The headroom threshold is used to interpret the possible thermal throttling status based on
255255
* the headroom prediction. For example, if the headroom threshold for
256256
* {@link ATHERMAL_STATUS_LIGHT} is 0.7, and a headroom prediction in 10s returns 0.75
257-
* (or {@code AThermal_getThermalHeadroom(10)=0.75}), one can expect that in 10 seconds the system
257+
* (or `AThermal_getThermalHeadroom(10)=0.75`), one can expect that in 10 seconds the system
258258
* could be in lightly throttled state if the workload remains the same. The app can consider
259259
* taking actions according to the nearest throttling status the difference between the headroom and
260260
* the threshold.
261261
* <p>
262262
* For new devices it's guaranteed to have a single sensor, but for older devices with multiple
263263
* sensors reporting different threshold values, the minimum threshold is taken to be conservative
264264
* on predictions. Thus, when reading real-time headroom, it's not guaranteed that a real-time value
265-
* of 0.75 (or {@code AThermal_getThermalHeadroom(0)}=0.75) exceeding the threshold of 0.7 above
265+
* of 0.75 (or `AThermal_getThermalHeadroom(0)`=0.75) exceeding the threshold of 0.7 above
266266
* will always come with lightly throttled state
267-
* (or {@code AThermal_getCurrentThermalStatus()=ATHERMAL_STATUS_LIGHT}) but it can be lower
268-
* (or {@code AThermal_getCurrentThermalStatus()=ATHERMAL_STATUS_NONE}).
267+
* (or `AThermal_getCurrentThermalStatus()=ATHERMAL_STATUS_LIGHT`) but it can be lower
268+
* (or `AThermal_getCurrentThermalStatus()=ATHERMAL_STATUS_NONE`).
269269
* While it's always guaranteed that the device won't be throttled heavier than the unmet
270270
* threshold's state, so a real-time headroom of 0.75 will never come with
271271
* {@link #ATHERMAL_STATUS_MODERATE} but always lower, and 0.65 will never come with

0 commit comments

Comments
 (0)