Skip to content

Commit 3dcb5d7

Browse files
Qbicznashif
authored andcommitted
include: adc: Fix async ADC API documentation
Add information about sequence structure lifespan and fix broken return value description. Signed-off-by: Filip Kubicz <[email protected]>
1 parent 81c6662 commit 3dcb5d7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

include/adc.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,14 +346,14 @@ static inline int adc_read(struct device *dev,
346346
*
347347
* @param dev Pointer to the device structure for the driver instance.
348348
* @param sequence Structure specifying requested sequence of samplings.
349+
* Caller should ensure lifetime of this structure spans
350+
* until asynchronous read is finished.
349351
* @param async Pointer to a valid and ready to be signaled struct
350352
* k_poll_signal. (Note: if NULL this function will not notify
351353
* the end of the transaction, and whether it went successfully
352354
* or not).
353355
*
354-
* @returns The same
355-
* 0 on success, negative error code otherwise. The returned values
356-
* are the
356+
* @returns 0 on success, negative error code otherwise.
357357
*
358358
*/
359359
static inline int adc_read_async(struct device *dev,

0 commit comments

Comments
 (0)