diff --git a/sys/include/net/gnrc/csma_sender.h b/sys/include/net/gnrc/csma_sender.h index 2accf592fbdaf5d9d3ae3af4d79024418a6a76cb..e322bc37dd05dc88a35b07a81f8cbec78b4cb050 100644 --- a/sys/include/net/gnrc/csma_sender.h +++ b/sys/include/net/gnrc/csma_sender.h @@ -7,7 +7,7 @@ */ /** - * @defgroup net_gnrc_csma_sender Helper interface to send packets via CSMA/CA + * @defgroup net_gnrc_csma_sender CSMA/CA helper * @ingroup net_gnrc * @brief This interface allows code from layer 2 (MAC) or higher * to send packets with CSMA/CA, whatever the abilities and/or @@ -103,12 +103,15 @@ int csma_sender_csma_ca_send(gnrc_netdev_t *dev, gnrc_pktsnip_t *pkt); * @brief Sends a 802.15.4 frame when medium is avaiable. * * This function is useful for sending packets without the whole CSMA/CA - * procedure, but *after* ensuring medium is available, that is : - * after a successful CCA. <br/> - * It is especially useful for broadcasting specific packets, - * like beacons; or for many sending packets in burst. <br/> - * ATTENTION: It only tries to send the given data once. If you want the - * complete CSMA/CA procedure with retries, use @c csma_sender_csma_ca_send(). + * procedure, but *after* ensuring medium is available, that is after a + * successful CCA. + * + * It is especially useful for broadcasting specific packets, like beacons; or + * for many sending packets in burst. + * + * @warning **ATTENTION:** It only tries to send the given data once. If you + * want the complete CSMA/CA procedure with retries, use + * @ref csma_sender_csma_ca_send(). * * @param[in] dev netdev device, needs to be already initialized * @param[in] pkt pointer to the data in the packet buffer; diff --git a/sys/net/gnrc/link_layer/csma_sender/gnrc_csma_sender.c b/sys/net/gnrc/link_layer/csma_sender/gnrc_csma_sender.c index 3d5a999799763394808742336d5e4f114bd0aecb..e1bb0bb4d17f5150d473ed4ebac7b998bca9817c 100644 --- a/sys/net/gnrc/link_layer/csma_sender/gnrc_csma_sender.c +++ b/sys/net/gnrc/link_layer/csma_sender/gnrc_csma_sender.c @@ -81,9 +81,10 @@ static inline uint32_t choose_backoff_period(int be) * it must be a complete 802.15.4-compliant frame, * ready to be sent to the radio transceiver * - * @return the return value of device driver's @c send_data() - * function if medium was avilable - * @return -ECANCELED if an internal driver error occured + * @return the return value of device driver's + * gnrc_netdev_driver_t::send_data() + * function if medium was available + * @return -ECANCELED if an internal driver error occurred * @return -EBUSY if radio medium was not available * to send the given data */