Skip to content

Commit 2a17297

Browse files
committed
change(esp-event): Update the doxygen comment of esp_event_handler_register
Add a comment to specify what happens when registering a handler several times to the same event.
1 parent a8bf745 commit 2a17297

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

components/esp_event/include/esp_event.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@ esp_err_t esp_event_loop_run(esp_event_loop_handle_t event_loop, TickType_t tick
118118
*
119119
* Registering multiple handlers to events is possible. Registering a single handler to multiple events is
120120
* also possible. However, registering the same handler to the same event multiple times would cause the
121-
* previous registrations to be overwritten.
121+
* overwriting of the event_handler_arg but the handler will be kept at the same position in the list associated
122+
* with the event that triggers it. It means that the call order of registered handlers for that event will remain
123+
* the same.
122124
*
123125
* @param[in] event_base the base ID of the event to register the handler for
124126
* @param[in] event_id the ID of the event to register the handler for

0 commit comments

Comments
 (0)