michaelh/zephyr
1
0
Fork 0
Code Releases Activity

zbus: Fix documentation of ZBUS_LISTENER_DEFINE

Browse source 
The macro is clearly creating the listener in the enabled
state since it is calling the ZBUS_LISTENER_DEFINE_WITH_ENABLE
with 2nd argument being true. Fix the documentation, and add
the same remark to ZBUS_SUBSCRIBER_DEFINE documentation as
well.

Signed-off-by: Miika Karanki <miika.karanki@vaisala.com>
This commit is contained in:
Miika Karanki 2023-08-31 15:55:15 +03:00 • committed by Maureen Helm
commit 39de786b08
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
include/zephyr/zbus/zbus.h
View file

@ -342,7 +342,8 @@ k_timeout_t _zbus_timeout_remainder(uint64_t end_ticks);
* *
* This macro defines an observer of subscriber type. It defines a message queue where the * This macro defines an observer of subscriber type. It defines a message queue where the
* subscriber will receive the notification asynchronously, and initialize the ``struct * subscriber will receive the notification asynchronously, and initialize the ``struct
* zbus_observer`` defining the subscriber. * zbus_observer`` defining the subscriber. The subscribers are defined in the enabled
* state with this macro.
* *
* @param[in] _name The subscriber's name. * @param[in] _name The subscriber's name.
* @param[in] _queue_size The notification queue's size. * @param[in] _queue_size The notification queue's size.
@ -371,7 +372,7 @@ k_timeout_t _zbus_timeout_remainder(uint64_t end_ticks);
* *
* This macro defines an observer of listener type. This macro establishes the callback where the * This macro defines an observer of listener type. This macro establishes the callback where the
* listener will be notified synchronously and initialize the ``struct zbus_observer`` defining the * listener will be notified synchronously and initialize the ``struct zbus_observer`` defining the
* listener. The listeners are defined in the disabled state with this macro. * listener. The listeners are defined in the enabled state with this macro.
* *
* @param[in] _name The listener's name. * @param[in] _name The listener's name.
* @param[in] _cb The callback function. * @param[in] _cb The callback function.