From d62d3edc08d90485e07c87a5839908e89933e3ad Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Wed, 12 Jul 2017 11:08:35 +0200 Subject: [PATCH] Update tcpip.c/.h documentation --- src/api/tcpip.c | 2 ++ src/include/lwip/tcpip.h | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/api/tcpip.c b/src/api/tcpip.c index 2c85b9f9..55d7fc57 100644 --- a/src/api/tcpip.c +++ b/src/api/tcpip.c @@ -252,6 +252,7 @@ tcpip_input(struct pbuf *p, struct netif *inp) } /** + * @ingroup lwip_os * Call a specific function in the thread context of * tcpip_thread for easy access synchronization. * A function called in that way may access lwIP core code @@ -286,6 +287,7 @@ tcpip_callback(tcpip_callback_fn function, void *ctx) } /** + * @ingroup lwip_os * Call a specific function in the thread context of * tcpip_thread for easy access synchronization. * A function called in that way may access lwIP core code diff --git a/src/include/lwip/tcpip.h b/src/include/lwip/tcpip.h index d640dd7a..7ce81063 100644 --- a/src/include/lwip/tcpip.h +++ b/src/include/lwip/tcpip.h @@ -79,7 +79,9 @@ err_t tcpip_input(struct pbuf *p, struct netif *inp); err_t tcpip_try_callback(tcpip_callback_fn function, void *ctx); err_t tcpip_callback(tcpip_callback_fn function, void *ctx); -/* for compatibility with older lwIP versions */ +/** @ingroup lwip_os + * @deprecated use tcpip_try_callback() or tcpip_callback() instead + */ #define tcpip_callback_with_block(function, ctx, block) ((block != 0)? tcpip_callback(function, ctx) : tcpip_try_callback(function, ctx)) struct tcpip_callback_msg* tcpip_callbackmsg_new(tcpip_callback_fn function, void *ctx);