From 293d0e3b5829bb2c25aae4a6293c2be6bdb406d2 Mon Sep 17 00:00:00 2001
From: Martine Lenders <mail@martine-lenders.eu>
Date: Fri, 10 Jul 2015 16:00:46 +0200
Subject: [PATCH] ng_netapi: enhance documentation with references
---
sys/include/net/ng_netapi.h | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/sys/include/net/ng_netapi.h b/sys/include/net/ng_netapi.h
index fa756bd852..7d81bcc32b 100644
--- a/sys/include/net/ng_netapi.h
+++ b/sys/include/net/ng_netapi.h
@@ -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 */
--
GitLab