From c7e20150f00597396ef0caff0708e5d945da851d Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Tue, 26 Jul 2016 19:42:16 +0200 Subject: [PATCH] Update and restructure docs of some lwip core functions --- src/api/tcpip.c | 2 +- src/core/init.c | 5 +++-- src/include/lwip/tcpip.h | 4 ++++ 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/src/api/tcpip.c b/src/api/tcpip.c index 32abf5f8..d9fcc700 100644 --- a/src/api/tcpip.c +++ b/src/api/tcpip.c @@ -441,7 +441,7 @@ tcpip_trycallback(struct tcpip_callback_msg* msg) } /** - * @ingroup lwIP + * @ingroup lwip * Initialize this module: * - initialize all sub modules * - start the tcpip_thread diff --git a/src/core/init.c b/src/core/init.c index 3cf504f4..8b8cf37c 100644 --- a/src/core/init.c +++ b/src/core/init.c @@ -36,7 +36,8 @@ */ /** - * @defgroup lwIP lwIP + * @defgroup lwip lwIP + * @ingroup infrastructure */ #include "lwip/opt.h" @@ -321,7 +322,7 @@ #endif /* !LWIP_DISABLE_TCP_SANITY_CHECKS */ /** - * @ingroup lwIP + * @ingroup lwip * Initialize all modules. * Use this in NO_SYS mode. Use tcpip_init() otherwise. */ diff --git a/src/include/lwip/tcpip.h b/src/include/lwip/tcpip.h index 49a732c5..29184bfa 100644 --- a/src/include/lwip/tcpip.h +++ b/src/include/lwip/tcpip.h @@ -76,6 +76,10 @@ err_t tcpip_inpkt(struct pbuf *p, struct netif *inp, netif_input_fn input_fn); err_t tcpip_input(struct pbuf *p, struct netif *inp); err_t tcpip_callback_with_block(tcpip_callback_fn function, void *ctx, u8_t block); +/** + * @ingroup lwip + * @see tcpip_callback_with_block + */ #define tcpip_callback(f, ctx) tcpip_callback_with_block(f, ctx, 1) struct tcpip_callback_msg* tcpip_callbackmsg_new(tcpip_callback_fn function, void *ctx);