Minor change (doxygen tags)

This commit is contained in:
fbernon 2007-11-24 22:13:25 +00:00
parent 7797ada1f5
commit 3d9c76a69c
5 changed files with 6 additions and 5 deletions

View File

@ -185,6 +185,7 @@ netconn_type(struct netconn *conn)
* @param conn the netconn to query * @param conn the netconn to query
* @param addr a pointer to which to save the IP address * @param addr a pointer to which to save the IP address
* @param port a pointer to which to save the port (or protocol for RAW) * @param port a pointer to which to save the port (or protocol for RAW)
* @param local 1 to get the local IP address, 0 to get the remote one
* @return ERR_CONN for invalid connections * @return ERR_CONN for invalid connections
* ERR_OK if the information was retrieved * ERR_OK if the information was retrieved
*/ */

View File

@ -1024,7 +1024,7 @@ do_dns_found(const char *name, struct ip_addr *ipaddr, void *arg)
* Execute a DNS query * Execute a DNS query
* Called from netconn_gethostbyname * Called from netconn_gethostbyname
* *
* @param msg the dns_api_msg pointing to the query * @param arg the dns_api_msg pointing to the query
*/ */
void void
do_gethostbyname(void *arg) do_gethostbyname(void *arg)

View File

@ -316,7 +316,7 @@ tcpip_thread(void *arg)
* *
* @param p the received packet, p->payload pointing to the Ethernet header or * @param p the received packet, p->payload pointing to the Ethernet header or
* to an IP header (if netif doesn't got NETIF_FLAG_ETHARP flag) * to an IP header (if netif doesn't got NETIF_FLAG_ETHARP flag)
* @param netif the network interface on which the packet was received * @param inp the network interface on which the packet was received
*/ */
err_t err_t
tcpip_input(struct pbuf *p, struct netif *inp) tcpip_input(struct pbuf *p, struct netif *inp)

View File

@ -779,7 +779,7 @@ dns_enqueue(const char *name, dns_found_callback found, void *callback_arg)
* - DNS_REQUEST_QUEUED and queues a request to be sent to the DNS server * - DNS_REQUEST_QUEUED and queues a request to be sent to the DNS server
* for resolution if no errors are present. * for resolution if no errors are present.
* *
* @param name the hostname that is to be queried * @param hostname the hostname that is to be queried
* @param addr pointer to a struct ip_addr where to store the address if it is already * @param addr pointer to a struct ip_addr where to store the address if it is already
* cached in the dns_table (only valid if DNS_COMPLETE is returned!) * cached in the dns_table (only valid if DNS_COMPLETE is returned!)
* @param found a callback founction to be called on success, failure or timeout (only if * @param found a callback founction to be called on success, failure or timeout (only if

View File

@ -85,9 +85,9 @@
* layer at which the pbuf is allocated and the requested size * layer at which the pbuf is allocated and the requested size
* (from the size parameter). * (from the size parameter).
* *
* @param l flag to define header size * @param layer flag to define header size
* @param length size of the pbuf's payload * @param length size of the pbuf's payload
* @param flag this parameter decides how and where the pbuf * @param type this parameter decides how and where the pbuf
* should be allocated as follows: * should be allocated as follows:
* *
* - PBUF_RAM: buffer memory for pbuf is allocated as one large * - PBUF_RAM: buffer memory for pbuf is allocated as one large