scratch/lwip
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some documentation cleanups and include more comments that have been already in code into doxygen docs

Browse Source
This commit is contained in:
Dirk Ziegelmeier
2016-08-07 10:05:34 +02:00
parent cf66233873
commit 8d07629b71
19 changed files with 190 additions and 254 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
src/api/api_lib.c
View File

@@ -1,6 +1,24 @@
/**
* @file
* Sequential API External module
*
* @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.
*
* @defgroup netconn_common Common functions
* @ingroup netconn
* For use with TCP and UDP
*
* @defgroup netconn_tcp TCP only
* @ingroup netconn
* TCP only functions
*
* @defgroup netconn_udp UDP only
* @ingroup netconn
* UDP only functions
*/
/*
@@ -34,26 +52,6 @@
* Author: Adam Dunkels <adam@sics.se>
*/
/**
* @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.
*
* @defgroup netconn_common Common functions
* @ingroup netconn
* For use with TCP and UDP
*
* @defgroup netconn_tcp TCP only
* @ingroup netconn
* TCP only functions
*
* @defgroup netconn_udp UDP only
* @ingroup netconn
* UDP only functions
*/
/* This is the part of the API that is linked with
the application */