docs: update remaining api_msg_msg references

This updates some remaining references to the old struct api_msg_msg
(renamed to struct api_msg) in comment blocks
This commit is contained in:
Joel Cunningham 2017-08-01 11:56:54 -05:00
parent a81b19aa62
commit 5d2be3460f

View File

@ -589,7 +589,7 @@ accept_function(void *arg, struct tcp_pcb *newpcb, err_t err)
* Create a new pcb of a specific type. * Create a new pcb of a specific type.
* Called from lwip_netconn_do_newconn(). * Called from lwip_netconn_do_newconn().
* *
* @param msg the api_msg_msg describing the connection type * @param msg the api_msg describing the connection type
*/ */
static void static void
pcb_new(struct api_msg *msg) pcb_new(struct api_msg *msg)
@ -660,7 +660,7 @@ pcb_new(struct api_msg *msg)
* Create a new pcb of a specific type inside a netconn. * Create a new pcb of a specific type inside a netconn.
* Called from netconn_new_with_proto_and_callback. * Called from netconn_new_with_proto_and_callback.
* *
* @param m the api_msg_msg describing the connection type * @param m the api_msg describing the connection type
*/ */
void void
lwip_netconn_do_newconn(void *m) lwip_netconn_do_newconn(void *m)
@ -1060,7 +1060,7 @@ lwip_netconn_do_close_internal(struct netconn *conn WRITE_DELAYED_PARAM)
* Delete the pcb inside a netconn. * Delete the pcb inside a netconn.
* Called from netconn_delete. * Called from netconn_delete.
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_delconn(void *m) lwip_netconn_do_delconn(void *m)
@ -1158,7 +1158,7 @@ lwip_netconn_do_delconn(void *m)
* Bind a pcb contained in a netconn * Bind a pcb contained in a netconn
* Called from netconn_bind. * Called from netconn_bind.
* *
* @param m the api_msg_msg pointing to the connection and containing * @param m the api_msg pointing to the connection and containing
* the IP address and port to bind to * the IP address and port to bind to
*/ */
void void
@ -1198,7 +1198,7 @@ lwip_netconn_do_bind(void *m)
* Bind a pcb contained in a netconn to an interface * Bind a pcb contained in a netconn to an interface
* Called from netconn_bind_if. * Called from netconn_bind_if.
* *
* @param m the api_msg_msg pointing to the connection and containing * @param m the api_msg pointing to the connection and containing
* the IP address and port to bind to * the IP address and port to bind to
*/ */
void void
@ -1292,7 +1292,7 @@ lwip_netconn_do_connected(void *arg, struct tcp_pcb *pcb, err_t err)
* Connect a pcb contained inside a netconn * Connect a pcb contained inside a netconn
* Called from netconn_connect. * Called from netconn_connect.
* *
* @param m the api_msg_msg pointing to the connection and containing * @param m the api_msg pointing to the connection and containing
* the IP address and port to connect to * the IP address and port to connect to
*/ */
void void
@ -1366,7 +1366,7 @@ lwip_netconn_do_connect(void *m)
* Only used for UDP netconns. * Only used for UDP netconns.
* Called from netconn_disconnect. * Called from netconn_disconnect.
* *
* @param m the api_msg_msg pointing to the connection to disconnect * @param m the api_msg pointing to the connection to disconnect
*/ */
void void
lwip_netconn_do_disconnect(void *m) lwip_netconn_do_disconnect(void *m)
@ -1390,7 +1390,7 @@ lwip_netconn_do_disconnect(void *m)
* Set a TCP pcb contained in a netconn into listen mode * Set a TCP pcb contained in a netconn into listen mode
* Called from netconn_listen. * Called from netconn_listen.
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_listen(void *m) lwip_netconn_do_listen(void *m)
@ -1474,7 +1474,7 @@ lwip_netconn_do_listen(void *m)
* Send some data on a RAW or UDP pcb contained in a netconn * Send some data on a RAW or UDP pcb contained in a netconn
* Called from netconn_send * Called from netconn_send
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_send(void *m) lwip_netconn_do_send(void *m)
@ -1531,7 +1531,7 @@ lwip_netconn_do_send(void *m)
* Indicate data has been received from a TCP pcb contained in a netconn * Indicate data has been received from a TCP pcb contained in a netconn
* Called from netconn_recv * Called from netconn_recv
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_recv(void *m) lwip_netconn_do_recv(void *m)
@ -1556,7 +1556,7 @@ lwip_netconn_do_recv(void *m)
/** Indicate that a TCP pcb has been accepted /** Indicate that a TCP pcb has been accepted
* Called from netconn_accept * Called from netconn_accept
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_accepted(void *m) lwip_netconn_do_accepted(void *m)
@ -1755,7 +1755,7 @@ err_mem:
* Send some data on a TCP pcb contained in a netconn * Send some data on a TCP pcb contained in a netconn
* Called from netconn_write * Called from netconn_write
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_write(void *m) lwip_netconn_do_write(void *m)
@ -1809,7 +1809,7 @@ lwip_netconn_do_write(void *m)
* Return a connection's local or remote address * Return a connection's local or remote address
* Called from netconn_getaddr * Called from netconn_getaddr
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_getaddr(void *m) lwip_netconn_do_getaddr(void *m)
@ -1876,7 +1876,7 @@ lwip_netconn_do_getaddr(void *m)
* Called from netconn_close * Called from netconn_close
* In contrast to closing sockets, the netconn is not deallocated. * In contrast to closing sockets, the netconn is not deallocated.
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_close(void *m) lwip_netconn_do_close(void *m)
@ -1952,7 +1952,7 @@ lwip_netconn_do_close(void *m)
* Join multicast groups for UDP netconns. * Join multicast groups for UDP netconns.
* Called from netconn_join_leave_group * Called from netconn_join_leave_group
* *
* @param m the api_msg_msg pointing to the connection * @param m the api_msg pointing to the connection
*/ */
void void
lwip_netconn_do_join_leave_group(void *m) lwip_netconn_do_join_leave_group(void *m)