michaelh/zephyr
1
0
Fork 0
Code Releases Activity

net: core: Fix documentation for core helpers

Browse source 
The doxygen documentation was not properly generated for the
network core helpers.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-19 14:11:15 +02:00 • committed by Anas Nashif
commit b71e1f941f
1 changed files with 19 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

25
include/net/net_core.h
View file

@ -64,20 +64,33 @@ struct net_if;
* @brief Net Verdict
*/
enum net_verdict {
NET_OK, /** Packet has been taken care of */
NET_CONTINUE, /** Packet has not been touched,
other part should decide about its fate */
NET_DROP, /** Packet must be dropped */
/** Packet has been taken care of. */
NET_OK,
/** Packet has not been touched, other part should decide about its
* fate.
*/
NET_CONTINUE,
/** Packet must be dropped. */
NET_DROP,
};
/* Called by lower network stack when a network packet has been received */
/**
* @brief Called by lower network stack or network device driver when
* a network packet has been received. The function will push the packet up in
* the network stack for further processing.
*
* @param iface Network interface where the packet was received.
* @param pkt Network packet data.
*
* @return 0 if ok, <0 if error.
*/
int net_recv_data(struct net_if *iface, struct net_pkt *pkt);
/**
* @brief Send data to network.
*
* @details Send data to network. This should not be used normally by
* applications as it requires that the pktfer and fragments are properly
* applications as it requires that the network packet is properly
* constructed.
*
* @param pkt Network packet.