abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2026-05-16 05:06:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Some documentation updates and fixes

Browse Source 
Dedicated Zero-copy RX page
Fix doxygen warnings
This commit is contained in:
Dirk Ziegelmeier
2017-04-27 12:40:16 +02:00
parent 6aac9377ee
commit a09a8e4a06
5 changed files with 54 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/include/lwip/api.h
View File

@@ -276,7 +276,7 @@ struct netconn {
/** This vector type is passed to @ref netconn_write_vectors_partly to send
* multiple buffers at once.
* ATTENTION: This type has to directly map @ref struct iovec since one is casted
* ATTENTION: This type has to directly map struct iovec since one is casted
* into the other!
*/
struct netvector {

8
src/include/lwip/opt.h
View File

@@ -2733,9 +2733,9 @@
*
* Options need to appended like this:
* LWIP_ASSERT("dhcp option overflow", dhcp->options_out_len + option_len + 2 <= DHCP_OPTIONS_LEN);
* dhcp->msg_out->options[dhcp->options_out_len++] = <option_number>;
* dhcp->msg_out->options[dhcp->options_out_len++] = <option_len>;
* dhcp->msg_out->options[dhcp->options_out_len++] = <option_bytes>;
* dhcp->msg_out->options[dhcp->options_out_len++] = &lt;option_number&gt;;
* dhcp->msg_out->options[dhcp->options_out_len++] = &lt;option_len&gt;;
* dhcp->msg_out->options[dhcp->options_out_len++] = &lt;option_bytes&gt;;
* [...]
*/
#ifdef __DOXYGEN__
@@ -2759,7 +2759,7 @@
* - offset: offset in pbuf where option *data* begins
* Returns void
*
* A nice way to get the option contents is @ref pbuf_get_contiguous:
* A nice way to get the option contents is pbuf_get_contiguous():
* u8_t buf[32];
* u8_t *ptr = (u8_t*)pbuf_get_contiguous(p, buf, sizeof(buf), LWIP_MIN(option_len, sizeof(buf)), offset);
*/