Skip to content

Commit 3598b6f

Browse files
kartbennashif
authored andcommitted
modules: openthread: fix doxygen for openthread_set_nat64_receive_cb
Fix include guards and better document the kconfig dependency Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 7987614 commit 3598b6f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

modules/openthread/include/openthread.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,17 +133,19 @@ int openthread_stop(void);
133133
*/
134134
void openthread_set_receive_cb(openthread_receive_cb cb, void *context);
135135

136+
#if defined(CONFIG_OPENTHREAD_NAT64_TRANSLATOR) || defined(__DOXYGEN__)
136137
/**
137138
* @brief Set the additional callback for receiving NAT64 translated packets.
138139
*
139140
* @details This callback is called once a packet from OpenThread NAT64 translator
140141
* is received and can be used to inject packets into the Zephyr networking stack.
141142
* Setting this callback is optional.
142143
*
144+
* @kconfig_dep{CONFIG_OPENTHREAD_NAT64_TRANSLATOR}
145+
*
143146
* @param cb Callback to set.
144147
* @param context Context to pass to the callback.
145148
*/
146-
#if defined(CONFIG_OPENTHREAD_NAT64_TRANSLATOR)
147149
void openthread_set_nat64_receive_cb(openthread_receive_cb cb, void *context);
148150
#endif /* CONFIG_OPENTHREAD_NAT64_TRANSLATOR */
149151

0 commit comments

Comments
 (0)