patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

net: context: Fix send function documentation

Browse source 
Newly added net_context_send_new()/net_context_sendto_new() take
void *buf, size_t len params but in docstring, refer to "network
buffer", which is apperently copy-paste artifact.

Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
This commit is contained in:
Paul Sokolovsky 2019-02-19 18:47:27 +03:00 committed by Kumar Gala
parent fff2011fb5
commit 9744985af1
1 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
include/net/net_context.h
View file

@ -790,7 +790,7 @@ int net_context_send(struct net_pkt *pkt,
void *user_data); void *user_data);
/** /**
* @brief Send a network buffer to a peer. * @brief Send data to a peer.
* *
* @details This function can be used to send network data to a peer * @details This function can be used to send network data to a peer
* connection. This function will return immediately if the timeout * connection. This function will return immediately if the timeout
@ -861,7 +861,7 @@ int net_context_sendto(struct net_pkt *pkt,
/** /**
* @brief Send a network buffer to a peer specified by address. * @brief Send data to a peer specified by address.
* *
* @details This function can be used to send network data to a peer * @details This function can be used to send network data to a peer
* specified by address. This variant can only be used for datagram * specified by address. This variant can only be used for datagram
@ -878,8 +878,7 @@ int net_context_sendto(struct net_pkt *pkt,
* @param context The network context to use. * @param context The network context to use.
* @param buf The data buffer to send * @param buf The data buffer to send
* @param len Length of the buffer * @param len Length of the buffer
* @param dst_addr Destination address. This will override the address * @param dst_addr Destination address.
* already set in network buffer.
* @param addrlen Length of the address. * @param addrlen Length of the address.
* @param cb Caller-supplied callback function. * @param cb Caller-supplied callback function.
* @param timeout Timeout for the connection. Possible values * @param timeout Timeout for the connection. Possible values