Skip to content

Commit

Permalink
zbus: separate clang-format control comments
Browse files Browse the repository at this point in the history
Add a line of whitespace between `/* clang-format off */` comments and
the first line of doxygen comment blocks. Some intellisense parsers
will combine all sequential comment blocks when providing code context.
This results in the control comment appearing in the help text for
`ZBUS_CHAN_DEFINE`, for example.

Signed-off-by: Jordan Yates <[email protected]>
  • Loading branch information
JordanYates authored and carlescufi committed Sep 4, 2024
1 parent 1ed77cb commit 08a7808
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions include/zephyr/zbus/zbus.h
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,7 @@ struct zbus_channel_observation {
/** @endcond */

/* clang-format off */

/**
* @brief Add a static channel observervation.
*
Expand Down Expand Up @@ -321,6 +322,7 @@ struct zbus_channel_observation {
#define ZBUS_OBSERVERS(...) __VA_ARGS__

/* clang-format off */

/**
* @brief Zbus channel definition.
*
Expand Down Expand Up @@ -383,6 +385,7 @@ struct zbus_channel_observation {
}

/* clang-format off */

/**
* @brief Define and initialize a subscriber.
*
Expand Down Expand Up @@ -428,6 +431,7 @@ struct zbus_channel_observation {
ZBUS_SUBSCRIBER_DEFINE_WITH_ENABLE(_name, _queue_size, true)

/* clang-format off */

/**
* @brief Define and initialize a listener.
*
Expand Down Expand Up @@ -467,6 +471,7 @@ struct zbus_channel_observation {
#define ZBUS_LISTENER_DEFINE(_name, _cb) ZBUS_LISTENER_DEFINE_WITH_ENABLE(_name, _cb, true)

/* clang-format off */

/**
* @brief Define and initialize a message subscriber.
*
Expand Down

0 comments on commit 08a7808

Please sign in to comment.