From 40062c3ac3f1be293f31925b3d97962e4d494b6e Mon Sep 17 00:00:00 2001 From: Thomas Eichinger Date: Thu, 12 Feb 2015 14:39:17 +0100 Subject: [PATCH] net/ng_netconf.h: fix doxygen comments --- sys/include/net/ng_netconf.h | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/sys/include/net/ng_netconf.h b/sys/include/net/ng_netconf.h index d3d3482849..4567f5ceb4 100644 --- a/sys/include/net/ng_netconf.h +++ b/sys/include/net/ng_netconf.h @@ -91,10 +91,18 @@ typedef enum { typedef enum { NETCONF_STATE_OFF = 0, /**< powered off */ NETCONF_STATE_SLEEP, /**< sleep mode */ - NETCONF_STATE_IDLE, /**< idle mode */ - NETCONF_STATE_RX, /**< receive mode */ - NETCONF_STATE_TX, /**< transmit mode */ - NETCONF_STATE_RESET, /**< reset mode */ + NETCONF_STATE_IDLE, /**< idle mode, + * the device listens to receive packets */ + NETCONF_STATE_RX, /**< receive mode, + * the device currently receives a packet */ + NETCONF_STATE_TX, /**< transmit mode, + * set: triggers transmission of a preloaded packet + * (see *NETCONF_OPT_PRELOADING*). The resulting + * state of the network device is *NETCONF_STATE_IDLE* + * get: the network device is in the process of + * transmitting a packet */ + NETCONF_STATE_RESET, /**< triggers a hardware reset. The resulting + * state of the network device is *NETCONF_STATE_IDLE* */ /* add other states if needed */ } ng_netconf_state_t;