riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ng_netapi: enhance documentation with references

Browse Source
This commit is contained in:
Martine Lenders 2015-07-10 16:00:46 +02:00 committed by Martine Lenders
parent b9b3cd02f5
commit 293d0e3b58
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
sys/include/net/ng_netapi.h
View File

@ -39,32 +39,33 @@ extern "C" {
#endif
/**
* @brief Message type for passing data up the network stack
* @brief @ref core_msg type for passing a @ref net_ng_pkt up the network stack
*/
#define NG_NETAPI_MSG_TYPE_RCV (0x0201)
/**
* @brief Message type for passing data down the network stack
* @brief @ref core_msg type for passing a @ref net_ng_pkt down the network stack
*/
#define NG_NETAPI_MSG_TYPE_SND (0x0202)
/**
* @brief Message type for setting options of network modules
* @brief @ref core_msg type for setting options of network modules
*/
#define NG_NETAPI_MSG_TYPE_SET (0x0203)
/**
* @brief Message type for getting options from network modules
* @brief @ref core_msg type for getting options from network modules
*/
#define NG_NETAPI_MSG_TYPE_GET (0x0204)
/**
* @brief Message type for replying to get and set option messages
* @brief @ref core_msg type for replying to get and set option messages
*/
#define NG_NETAPI_MSG_TYPE_ACK (0x0205)
/**
* @brief Data structure to be send for setting and getting options
* @brief Data structure to be send for setting (@ref NG_NETAPI_MSG_TYPE_SET)
* and getting (@ref NG_NETAPI_MSG_TYPE_GET) options
*/
typedef struct {
netopt_t opt; /**< the option to get/set */