Skip to content

Commit

Permalink
zbus: Fix documentation of ZBUS_LISTENER_DEFINE
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
vai-mikar authored and MaureenHelm committed Sep 1, 2023
1 parent 18e9860 commit 39de786
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions include/zephyr/zbus/zbus.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* 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] _queue_size The notification queue's size.
Expand Down Expand Up @@ -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
* 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] _cb The callback function.
Expand Down

0 comments on commit 39de786

Please sign in to comment.