Skip to content

Commit 42c9c79

Browse files
aaronemasseyjgl-meta
authored andcommitted
fuel_gauge: Clarify props array is NOT permuted
It is potentially ambiguous as to whether the props array pinter in the fuel_gauge_get_prop() function permutes the given array. Explicitly call out that the array will NOT be permuted. Signed-off-by: Aaron Massey <[email protected]>
1 parent 428f4a6 commit 42c9c79

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

include/zephyr/drivers/fuel_gauge.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,8 @@ __subsystem struct fuel_gauge_driver_api {
213213
* @param dev Pointer to the battery fuel-gauge device
214214
* @param props pointer to array of fuel_gauge_get_property struct where the property struct
215215
* field is set by the caller to determine what property is read from the
216-
* fuel gauge device into the fuel_gauge_get_property struct's value field.
216+
* fuel gauge device into the fuel_gauge_get_property struct's value field. The props array
217+
* maintains the same order of properties as it was given.
217218
* @param props_len number of properties in props array
218219
*
219220
* @return return=0 if successful, return < 0 if getting all properties failed, return > 0 if some

0 commit comments

Comments
 (0)