espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-30 18:57:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

change(esp-event): Update the doxygen comment of esp_event_handler_register

Browse Source 
Add a comment to specify what happens when registering a handler several times
to the same event.
This commit is contained in:
Guillaume Souchere
2025-06-12 08:23:20 +02:00
parent 4c3d086c13
commit 8f57d672d2
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/esp_event/include/esp_event.h
View File

@ -118,7 +118,9 @@ esp_err_t esp_event_loop_run(esp_event_loop_handle_t event_loop, TickType_t tick
*
* Registering multiple handlers to events is possible. Registering a single handler to multiple events is
* also possible. However, registering the same handler to the same event multiple times would cause the
* previous registrations to be overwritten.
* overwriting of the event_handler_arg but the handler will be kept at the same position in the list associated
* with the event that triggers it. It means that the call order of registered handlers for that event will remain
* the same.
*
* @param[in] event_base the base ID of the event to register the handler for
* @param[in] event_id the ID of the event to register the handler for