Documentation review with Simon, minor changes

This commit is contained in:
Dirk Ziegelmeier
2016-07-27 08:05:38 +02:00
parent 1993b0257c
commit 6b524367a3
10 changed files with 39 additions and 20 deletions

View File

@@ -52,10 +52,6 @@
* @defgroup netconn_udp UDP only
* @ingroup netconn
* UDP only functions
*
* @defgroup netconn_dns DNS
* @ingroup netconn
* DNS lookup
*/
/* This is the part of the API that is linked with
@@ -204,7 +200,6 @@ netconn_delete(struct netconn *conn)
}
/**
* @ingroup netconn_tcp
* Get the local or remote IP address and port of a netconn.
* For RAW netconns, this returns the protocol instead of a port!
*
@@ -893,7 +888,7 @@ netconn_join_leave_group(struct netconn *conn,
#if LWIP_DNS
/**
* @ingroup netconn_dns
* @ingroup netconn_common
* Execute a DNS query, only one IP address is returned
*
* @param name a string representation of the DNS host name to query

View File

@@ -40,7 +40,9 @@
* @defgroup netbuf Network buffers
* @ingroup netconn
* Network buffer descriptor for @ref netconn. Based on @ref pbuf internally
* to avoid copying data around.
* to avoid copying data around.\n
* Buffers must not be shared accross multiple threads, all functions except
* netbuf_new() and netbuf_delete() are not thread-safe.
*/
#include "lwip/opt.h"