Several additional documentation fixes.

This commit is contained in:
likewise 2003-06-04 08:58:51 +00:00
parent ea08652416
commit 08703f46f8

View File

@ -505,16 +505,13 @@ etharp_arp_input(struct netif *netif, struct eth_addr *ethaddr, struct pbuf *p)
* *
* If ARP failed to allocate resources, NULL is returned. * If ARP failed to allocate resources, NULL is returned.
* *
* A returned non-NULL packet should be sent by the caller and * A returned non-NULL packet should be sent by the caller.
* etharp_output_sent() must be called afterwards to free any ARP
* request.
* *
* @param netif The lwIP network interface which the IP packet will be sent on. * @param netif The lwIP network interface which the IP packet will be sent on.
* @param ipaddr The IP address of the packet destination. * @param ipaddr The IP address of the packet destination.
* @param pbuf The pbuf(s) containing the IP packet to be sent. * @param pbuf The pbuf(s) containing the IP packet to be sent.
* *
* @return If non-NULL, a packet ready to be sent. * @return If non-NULL, a packet ready to be sent.
* @see etharp_output_sent()
*/ */
struct pbuf * struct pbuf *
etharp_output(struct netif *netif, struct ip_addr *ipaddr, struct pbuf *q) etharp_output(struct netif *netif, struct ip_addr *ipaddr, struct pbuf *q)
@ -641,10 +638,6 @@ etharp_output(struct netif *netif, struct ip_addr *ipaddr, struct pbuf *q)
* @note Might be used in the future by manual IP configuration * @note Might be used in the future by manual IP configuration
* as well. * as well.
* *
* TODO: enqueue q here if possible (BEWARE: possible other packet already
* queued.
* TODO: The host requirements RFC states that ARP should save at least one
* packet, and this should be the _latest_ packet.
* TODO: use the ctime field to see how long ago an ARP request was sent, * TODO: use the ctime field to see how long ago an ARP request was sent,
* possibly retry. * possibly retry.
*/ */
@ -656,9 +649,8 @@ err_t etharp_query(struct netif *netif, struct ip_addr *ipaddr, struct pbuf *q)
err_t result = ERR_OK; err_t result = ERR_OK;
u8_t i; u8_t i;
u8_t perform_arp_request = 1; u8_t perform_arp_request = 1;
/* prevent warning if ARP_QUEUEING == 0 */ /* prevent 'unused argument' warning if ARP_QUEUEING == 0 */
if (q); (void)q;
srcaddr = (struct eth_addr *)netif->hwaddr; srcaddr = (struct eth_addr *)netif->hwaddr;
/* bail out if this IP address is pending */ /* bail out if this IP address is pending */
for (i = 0; i < ARP_TABLE_SIZE; ++i) { for (i = 0; i < ARP_TABLE_SIZE; ++i) {