Skip to content

Commit aa7d794

Browse files
committed
include: drivers: comparator: add doxygen doc to comparator_callback_t
While reasonably straightforward, ensure the signature of the comparator_callback_t is properly documented. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 506e953 commit aa7d794

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

include/zephyr/drivers/comparator.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,12 @@ enum comparator_trigger {
3535
COMPARATOR_TRIGGER_BOTH_EDGES
3636
};
3737

38-
/** Comparator callback template */
38+
/**
39+
* @brief Comparator callback template
40+
*
41+
* @param dev Comparator device
42+
* @param user_data Pointer to the user data that was provided when the trigger callback was set
43+
*/
3944
typedef void (*comparator_callback_t)(const struct device *dev, void *user_data);
4045

4146
/** @cond INTERNAL_HIDDEN */

0 commit comments

Comments
 (0)