deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Minor documentation improvements.

Browse source
This commit is contained in:
Nicolas Tsiftes 2011-12-01 14:22:48 +01:00
parent a81cbbbd80
commit 220e6f7b88
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
core/net/uip.h
View file

@ -825,13 +825,13 @@ CCIF void uip_send(const void *data, int len);
* *
* \param rport The remote port number in network byte order. * \param rport The remote port number in network byte order.
* *
* \return The uip_udp_conn structure for the new connection or NULL * \return The uip_udp_conn structure for the new connection, or NULL
* if no connection could be allocated. * if no connection could be allocated.
*/ */
struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport); struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
/** /**
* Removed a UDP connection. * Remove a UDP connection.
* *
* \param conn A pointer to the uip_udp_conn structure for the connection. * \param conn A pointer to the uip_udp_conn structure for the connection.
* *
@ -942,7 +942,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
} while(0) } while(0)
/** /**
* Construct an IPv6 address from eight 8-bit words. * Construct an IPv6 address from sixteen 8-bit words.
* *
* This function constructs an IPv6 address. * This function constructs an IPv6 address.
* *
@ -969,7 +969,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
/** /**
* Copy an IP address to another IP address. * Copy an IP address from one place to another.
* *
* Copies an IP address from one place to another. * Copies an IP address from one place to another.
* *
@ -1001,7 +1001,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
uip_ipaddr(&ipaddr1, 192,16,1,2); uip_ipaddr(&ipaddr1, 192,16,1,2);
if(uip_ipaddr_cmp(&ipaddr2, &ipaddr1)) { if(uip_ipaddr_cmp(&ipaddr2, &ipaddr1)) {
printf("They are the same"); printf("They are the same");
} }
\endcode \endcode
* *
@ -1201,7 +1201,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
#endif /* UIP_HTONS */ #endif /* UIP_HTONS */
/** /**
* Convert 16-bit quantity from host byte order to network byte order. * Convert a 16-bit quantity from host byte order to network byte order.
* *
* This function is primarily used for converting variables from host * This function is primarily used for converting variables from host
* byte order to network byte order. For converting constants to * byte order to network byte order. For converting constants to
@ -1407,11 +1407,11 @@ struct uip_stats {
IP length, high byte. */ IP length, high byte. */
uip_stats_t lblenerr; /**< Number of packets dropped due to wrong uip_stats_t lblenerr; /**< Number of packets dropped due to wrong
IP length, low byte. */ IP length, low byte. */
uip_stats_t fragerr; /**< Number of packets dropped since they uip_stats_t fragerr; /**< Number of packets dropped because they
were IP fragments. */ were IP fragments. */
uip_stats_t chkerr; /**< Number of packets dropped due to IP uip_stats_t chkerr; /**< Number of packets dropped due to IP
checksum errors. */ checksum errors. */
uip_stats_t protoerr; /**< Number of packets dropped since they uip_stats_t protoerr; /**< Number of packets dropped because they
were neither ICMP, UDP nor TCP. */ were neither ICMP, UDP nor TCP. */
} ip; /**< IP statistics. */ } ip; /**< IP statistics. */
struct { struct {
@ -1432,10 +1432,10 @@ struct uip_stats {
checksum. */ checksum. */
uip_stats_t ackerr; /**< Number of TCP segments with a bad ACK uip_stats_t ackerr; /**< Number of TCP segments with a bad ACK
number. */ number. */
uip_stats_t rst; /**< Number of recevied TCP RST (reset) segments. */ uip_stats_t rst; /**< Number of received TCP RST (reset) segments. */
uip_stats_t rexmit; /**< Number of retransmitted TCP segments. */ uip_stats_t rexmit; /**< Number of retransmitted TCP segments. */
uip_stats_t syndrop; /**< Number of dropped SYNs due to too few uip_stats_t syndrop; /**< Number of dropped SYNs because too few
connections was avaliable. */ connections were available. */
uip_stats_t synrst; /**< Number of SYNs for closed ports, uip_stats_t synrst; /**< Number of SYNs for closed ports,
triggering a RST. */ triggering a RST. */
} tcp; /**< TCP statistics. */ } tcp; /**< TCP statistics. */