CLEANUP: event_hdl: fix comment typo about _sync assertion

Fixing a comment relative to EVENT_HDL_ASSERT_SYNC macro where a
typo was made and the comment was lacking some context.
This commit is contained in:
Aurelien DARRAGON 2023-04-04 21:43:31 +02:00 committed by Christopher Faulet
parent 363ef4daa7
commit 147691fd83

View File

@ -141,11 +141,12 @@ struct event_hdl_cb
/* manage the subscription responsible for handing the event to us */ /* manage the subscription responsible for handing the event to us */
const struct event_hdl_sub_mgmt *sub_mgmt; const struct event_hdl_sub_mgmt *sub_mgmt;
/* used for the function wants to make sure /* may be used by sync event handler to ensure
* it runs in sync mode, and thus is eligible to access unsafe data. * it runs in sync mode, and thus is eligible to access unsafe data.
* This could save the day when users are copy-pasting function * This could save the day when users are copy-pasting function
* logic from a sync handler to an async handler without * logic from a sync handler to an async handler without
* taking appropriate precautions and unsafe accesses are performed. * taking appropriate precautions and unsafe accesses are performed.
* (See EVENT_HDL_ASSERT_SYNC macro API helper)
*/ */
uint8_t _sync; uint8_t _sync;
}; };