Skip to content

Commit c3fdec1

Browse files
SQUASHME: addring other comments
1 parent 268b441 commit c3fdec1

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

drivers/include/at86rf231.h

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*/
88

99
/**
10-
* @defgroup drivers_at86rf231
10+
* @defgroup drivers_at86rf231 at86rf231
1111
* @ingroup drivers
1212
* @brief Device driver for the Atmel AT86RF231 radio
1313
* @{
@@ -59,7 +59,7 @@ extern "C" {
5959
#define AT86RF231_BROADCAST_ADDRESS (0xFFFF)
6060

6161
/**
62-
* @biref at86rf231's lowest supported channel
62+
* @brief at86rf231's lowest supported channel
6363
*/
6464
#define AT86RF231_MIN_CHANNEL (11)
6565

@@ -73,19 +73,24 @@ extern "C" {
7373
*/
7474
typedef struct __attribute__((packed))
7575
{
76-
/* @{ */
76+
/** @{ */
7777
uint8_t length; /**< the length of the frame of the frame including fcs*/
7878
ieee802154_frame_t frame; /**< the ieee802154 frame */
7979
int8_t rssi; /**< the rssi value */
8080
uint8_t crc; /**< 1 if crc was successfull, 0 otherwise */
8181
uint8_t lqi; /**< the link quality indicator */
82-
/* @} */
82+
/** @} */
8383
} at86rf231_packet_t;
8484

8585
extern netdev_t at86rf231_netdev; /**< netdev representation of this driver */
8686

87+
/**
88+
* @brief States to be assigned to `driver_state`
89+
* @{
90+
*/
8791
#define AT_DRIVER_STATE_DEFAULT (0)
8892
#define AT_DRIVER_STATE_SENDING (1)
93+
/** @} */
8994

9095
/**
9196
* @brief To keep state inside of at86rf231 driver

drivers/include/netdev/802154.h

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ typedef struct {
171171
/**
172172
* @see netdev_driver_t::get_option
173173
*
174-
* @detail The options are constrained as follows:
174+
* @details The options are constrained as follows:
175175
*
176176
* *opt* | type | *value_len*
177177
* --------------------------- | ----------- | -----------
@@ -190,7 +190,7 @@ typedef struct {
190190
/**
191191
* @see netdev_driver_t::set_option
192192
*
193-
* @detail The options are constrained as follows:
193+
* @details The options are constrained as follows:
194194
*
195195
* *opt* | type | *value_len* | *value*
196196
* --------------------------- | ----------- | ----------- | --------
@@ -232,6 +232,7 @@ typedef struct {
232232
* @brief Load the transceiver TX buffer with the given
233233
* IEEE 802.15.4 packet.
234234
*
235+
* @param[in] dev the network device
235236
* @param[in] kind Kind of packet to transmit.
236237
* @param[in] dest Address of the node to which the packet is sent.
237238
* @param[in] use_long_addr 1 to use the 64-bit address mode
@@ -269,6 +270,8 @@ typedef struct {
269270
/**
270271
* @brief Transmit the data loaded into the transceiver TX buffer.
271272
*
273+
* @param[in] dev the network device
274+
*
272275
* @return The outcome of this packet's transmission.
273276
* @see netdev_802154_tx_status_t
274277
*/
@@ -281,6 +284,7 @@ typedef struct {
281284
* by calling successively functions netdev_802154_driver_t::load_tx()
282285
* and netdev_802154_driver_t::transmit().
283286
*
287+
* @param[in] dev the network device
284288
* @param[in] kind Kind of packet to transmit.
285289
* @param[in] dest Address of the node to which the packet is sent.
286290
* @param[in] use_long_addr 1 to use the 64-bit address mode
@@ -319,12 +323,13 @@ typedef struct {
319323
* @brief Add a function to be called back when the radio transceiver
320324
* has received a incoming packet.
321325
*
322-
* @detail This function differentiates from
326+
* @details This function differentiates from
323327
* netdev_driver_t::add_receive_data_callback() as it expects
324328
* a callback that excepts the raw frame format of IEEE 802.15.4,
325329
* rather than just the source and destination addresses and the
326330
* payload.
327331
*
332+
* @param[in] dev the network device
328333
* @param[in] recv_func the callback function to invoke for each
329334
* packet received by the radio transceiver.
330335
* @see netdev_802153_raw_packet_cb_t
@@ -340,6 +345,7 @@ typedef struct {
340345
/**
341346
* @brief Remove a callback set by netdev_802154_driver_t::add_receive_raw_callback()
342347
*
348+
* @param[in] dev the network device
343349
* @param[in] recv_func the callback function to invoke for each
344350
* packet received by the radio transceiver.
345351
* @see netdev_802153_raw_packet_cb_t
@@ -355,6 +361,8 @@ typedef struct {
355361
* @brief Indicates if the radio medium is available for transmission
356362
* ("Clear Channel Assessment").
357363
*
364+
* @param[in] dev the network device
365+
*
358366
* @return 1 if radio medium is "clear" (available);
359367
* @return 0 if another transmission is already running.
360368
* @return -ENODEV, if *dev* is not recognized
@@ -407,6 +415,7 @@ int netdev_802154_send_data(netdev_t *dev, void *dest, size_t dest_len,
407415
* netdev_802154_driver_t::transmit() successfully. Default value for
408416
* netdev_802154_driver_t::send()
409417
*
418+
* @param[in] dev the network device
410419
* @param[in] kind Kind of packet to transmit.
411420
* @param[in] dest Address of the node to which the packet is sent.
412421
* @param[in] use_long_addr 1 to use the 64-bit address mode

0 commit comments

Comments
 (0)