Restructure documentation. Create two top-level sections for thread-safe and callback-style APIs.

This commit is contained in:
Dirk Ziegelmeier
2016-07-26 18:39:53 +02:00
parent 8140c77d7d
commit 8a9de94b1f
11 changed files with 20 additions and 2 deletions

View File

@@ -36,6 +36,7 @@
/**
* @defgroup netconn Netconn API
* @ingroup threadsafe_api
* Thread-safe, to be called from non-TCPIP threads only.
* TX/RX handling based on @ref netbuf (containing @ref pbuf)
* to avoid copying data around.
@@ -115,7 +116,6 @@ netconn_apimsg(tcpip_callback_fn fn, struct api_msg *apimsg)
}
/**
* @ingroup netconn_common
* Create a new netconn (of a specific type) that has a callback function.
* The corresponding pcb is also created.
*

View File

@@ -33,6 +33,7 @@
/**
* @defgroup netifapi NETIF API
* @ingroup threadsafe_api
* Thread-safe functions to be called from non-TCPIP threads
*
* @defgroup netifapi_netif NETIF related

View File

@@ -40,6 +40,7 @@
/**
* @defgroup socket Socket API
* @ingroup threadsafe_api
* BSD-style socket API.\n
* Thread-safe, to be called from non-TCPIP threads only.\n
* Can be activated by defining LWIP_SOCKET to 1.\n

View File

@@ -441,6 +441,7 @@ tcpip_trycallback(struct tcpip_callback_msg* msg)
}
/**
* @ingroup lwIP
* Initialize this module:
* - initialize all sub modules
* - start the tcpip_thread