abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2026-08-12 02:23:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Convert IP address type numbers to an enum to improve documentation

Browse Source
This commit is contained in:
Dirk Ziegelmeier
2016-09-27 09:46:51 +02:00
parent 97b774ceb9
commit 6abcd00f71
4 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/core/raw.c
View File

@@ -471,7 +471,7 @@ raw_new(u8_t proto)
* @return The RAW PCB which was created. NULL if the PCB data structure
* could not be allocated.
*
* @param type IP address type, see IPADDR_TYPE_XX definitions.
* @param type IP address type, see @ref lwip_ip_addr_type definitions.
* If you want to listen to IPv4 and IPv6 (dual-stack) packets,
* supply @ref IPADDR_TYPE_ANY as argument and bind to @ref IP_ANY_TYPE.
* @param proto the protocol number (next header) of the IPv6 packet payload

2
src/core/tcp.c
View File

@@ -1602,7 +1602,7 @@ tcp_new(void)
* place it on any of the TCP PCB lists.
* The pcb is not put on any list until binding using tcp_bind().
*
* @param type IP address type, see IPADDR_TYPE_XX definitions.
* @param type IP address type, see @ref lwip_ip_addr_type definitions.
* If you want to listen to IPv4 and IPv6 (dual-stack) connections,
* supply @ref IPADDR_TYPE_ANY as argument and bind to @ref IP_ANY_TYPE.
* @return a new tcp_pcb that initially is in state CLOSED

2
src/core/udp.c
View File

@@ -1143,7 +1143,7 @@ udp_new(void)
* @ingroup udp_raw
* Create a UDP PCB for specific IP type.
*
* @param type IP address type, see IPADDR_TYPE_XX definitions.
* @param type IP address type, see @ref lwip_ip_addr_type definitions.
* If you want to listen to IPv4 and IPv6 (dual-stack) packets,
* supply @ref IPADDR_TYPE_ANY as argument and bind to @ref IP_ANY_TYPE.
* @return The UDP PCB which was created. NULL if the PCB data structure