Update and restructure docs of some lwip core functions

This commit is contained in:
Dirk Ziegelmeier 2016-07-26 19:42:16 +02:00
parent c6831648e2
commit c7e20150f0
3 changed files with 8 additions and 3 deletions

View File

@ -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

View File

@ -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.
*/

View File

@ -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);