Skip to content

Commit 19b0ae1

Browse files
anhmolteivindj-nordic
authored andcommitted
include: event_scheduler: use retval to list specific return values
Use @RetVal instead of @return when listing specific return values. Signed-off-by: Andreas Moltumyr <[email protected]>
1 parent f9668a7 commit 19b0ae1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

include/event_scheduler.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ struct event_scheduler_event {
5858
* @param data Event data.
5959
* @param len Event data length.
6060
*
61-
* @return 0 On success.
62-
* @return -EFAULT @p handler is @c NULL.
63-
* @return -EINVAL Invalid @p data and @p len combination.
64-
* @return -ENOMEM No memory to schedule this event.
61+
* @retval 0 On success.
62+
* @retval -EFAULT @p handler is @c NULL.
63+
* @retval -EINVAL Invalid @p data and @p len combination.
64+
* @retval -ENOMEM No memory to schedule this event.
6565
*/
6666
int event_scheduler_defer(evt_handler_t handler, void *data, size_t len);
6767

@@ -70,7 +70,7 @@ int event_scheduler_defer(evt_handler_t handler, void *data, size_t len);
7070
*
7171
* Process deferred events in the main thread.
7272
*
73-
* @return 0 On success.
73+
* @retval 0 On success.
7474
*/
7575
int event_scheduler_process(void);
7676

0 commit comments

Comments
 (0)