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

driver/cc110x: Fixed indent/alignment in doc

Browse Source 
The Doxygen documentation blocks have not been correctly aligned. This commit
fixes this.
This commit is contained in:
Marian Buschsieweke 2019-09-04 13:15:15 +02:00
parent aa6f9e5b25
commit 3da3280930
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F
18 changed files with 369 additions and 361 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
drivers/cc110x/include/cc110x_communication.h
View File

@ -56,7 +56,8 @@ static inline void cc110x_release(cc110x_t *dev)
/** /**
* @brief Read a single configuration/status register from the transceiver * @brief Read a single configuration/status register from the transceiver
* *
* @param dev Device descriptor of the transceiver to read the register from * @param dev Device descriptor of the transceiver to read the register
* from
* @param addr Address of the register to read * @param addr Address of the register to read
* @param dest Where to store the received register content * @param dest Where to store the received register content
* *
@ -83,7 +84,8 @@ uint8_t cc110x_read(cc110x_t *dev, uint8_t addr, uint8_t *dest);
* This function has more overhead than @ref cc110x_read, but it is the only * This function has more overhead than @ref cc110x_read, but it is the only
* reliable way to access frequently updated status registers. * reliable way to access frequently updated status registers.
* *
* @param dev Device descriptor of the transceiver to read the register from * @param dev Device descriptor of the transceiver to read the register
* from
* @param addr Address of the register to read * @param addr Address of the register to read
* @param dest Where to store the received register content * @param dest Where to store the received register content
* *
@ -158,7 +160,7 @@ uint8_t cc110x_burst_write(cc110x_t *dev, uint8_t addr,
* @brief Send a command to the transceiver * @brief Send a command to the transceiver
* *
* @param dev Device descriptor of the transceiver to send the command to * @param dev Device descriptor of the transceiver to send the command to
* @param cmd_strobe Command to send * @param cmd Command to send
* *
* @return The received status byte * @return The received status byte
* *
@ -167,7 +169,7 @@ uint8_t cc110x_burst_write(cc110x_t *dev, uint8_t addr,
* @ref cc110x_status to get the status byte in a reliable * @ref cc110x_status to get the status byte in a reliable
* way. * way.
*/ */
uint8_t cc110x_cmd(cc110x_t *dev, uint8_t cmd_strobe); uint8_t cc110x_cmd(cc110x_t *dev, uint8_t cmd);
/** /**
* @brief Get the transceivers status byte in a reliable way * @brief Get the transceivers status byte in a reliable way

13
drivers/cc110x/include/cc110x_constants.h
View File

@ -393,7 +393,8 @@ extern "C" {
/** @} */ /** @} */
/** /**
* @name Possible values for the IOCFG2, IOCFG1, and IOCFG0 configuration registers * @name Possible values for the IOCFG2, IOCFG1, and IOCFG0 configuration
* registers
* *
* See Table 41 on page 62 in the data sheet. Only values relevant to the * See Table 41 on page 62 in the data sheet. Only values relevant to the
* driver are listed. * driver are listed.
@ -402,8 +403,8 @@ extern "C" {
*/ */
/** /**
* @brief GDOx goes HIGH when data has to be read from RX FIFO or when a packet * @brief GDOx goes HIGH when data has to be read from RX FIFO or when a
* is fully received * packet is fully received
* *
* Depends on the threshold set for the RX-FIFO in the FIFOTHR configuration * Depends on the threshold set for the RX-FIFO in the FIFOTHR configuration
* register * register
@ -467,11 +468,13 @@ extern "C" {
* @{ * @{
*/ */
/** /**
* @brief Bitmask to get the GDO0 state from the PKTSTATUS status register value * @brief Bitmask to get the GDO0 state from the PKTSTATUS status register
* value
*/ */
#define CC110X_PKTSTATUS_GDO0 0x01 #define CC110X_PKTSTATUS_GDO0 0x01
/** /**
* @brief Bitmask to get the GDO2 state from the PKTSTATUS status register value * @brief Bitmask to get the GDO2 state from the PKTSTATUS status register
* value
*/ */
#define CC110X_PKTSTATUS_GDO2 0x04 #define CC110X_PKTSTATUS_GDO2 0x04
/** /**

15
drivers/cc110x/include/cc110x_settings.h
View File

@ -141,23 +141,24 @@ extern const cc110x_chanmap_t cc110x_chanmap_868mhz_lora;
/** @} */ /** @} */
/** /**
* @name Base frequency, channel bandwidth and data rate configurations for CC110x transceivers * @name Base frequency, channel bandwidth and data rate configurations for
* CC110x transceivers
* *
* @{ * @{
*/ */
/** /**
* @brief CC110x configuration: 433MHz band, 38.4kbps data rate, 50 kHz channel * @brief CC110x configuration: 433MHz band, 38.4kbps data rate, 50 kHz
* width * channel width
*/ */
extern const cc110x_config_t cc110x_config_433mhz_38kbps_50khz; extern const cc110x_config_t cc110x_config_433mhz_38kbps_50khz;
/** /**
* @brief CC110x configuration: 433MHz band, 250kbps data rate, 300 kHz channel * @brief CC110x configuration: 433MHz band, 250kbps data rate, 300 kHz
* width * channel width
*/ */
extern const cc110x_config_t cc110x_config_433mhz_250kbps_300khz; extern const cc110x_config_t cc110x_config_433mhz_250kbps_300khz;
/** /**
* @brief CC110x configuration: 868MHz band, 250kbps data rate, 300 kHz channel * @brief CC110x configuration: 868MHz band, 250kbps data rate, 300 kHz
* width * channel width
*/ */
extern const cc110x_config_t cc110x_config_868mhz_250kbps_300khz; extern const cc110x_config_t cc110x_config_868mhz_250kbps_300khz;
/** @} */ /** @} */

20
drivers/include/cc110x.h
View File

@ -447,8 +447,8 @@ typedef struct {
typedef struct { typedef struct {
const cc110x_patable_t *patable; /**< Pointer to the PATABLE to use */ const cc110x_patable_t *patable; /**< Pointer to the PATABLE to use */
/** /**
* @brief Pointer to the configuration of the base frequency, data rate and * @brief Pointer to the configuration of the base frequency, data rate
* channel bandwidth; or `NULL` to keep the default. * and channel bandwidth; or `NULL` to keep the default.
*/ */
const cc110x_config_t *config; const cc110x_config_t *config;
const cc110x_chanmap_t *channels; /**< Pointer to the default channel map */ const cc110x_chanmap_t *channels; /**< Pointer to the default channel map */
@ -492,13 +492,14 @@ typedef struct __attribute__((packed)) {
*/ */
uint8_t data[CC110X_MAX_FRAME_SIZE]; uint8_t data[CC110X_MAX_FRAME_SIZE];
/** /**
* @brief Index of the next @ref cc110x_framebuf_t::data element to transfer * @brief Index of the next @ref cc110x_framebuf_t::data element to
* transfer
* *
* In RX mode: Index of the next @ref cc110x_framebuf_t::data element to store * In RX mode: Index of the next @ref cc110x_framebuf_t::data element to
* data read from the RX-FIFO into. * store data read from the RX-FIFO into.
* *
* In TX mode: Index of the next @ref cc110x_framebuf_t::data element to write * In TX mode: Index of the next @ref cc110x_framebuf_t::data element to
* to the TX-FIFO. * write to the TX-FIFO.
*/ */
uint8_t pos; uint8_t pos;
} cc110x_framebuf_t; } cc110x_framebuf_t;
@ -562,8 +563,9 @@ int cc110x_setup(cc110x_t *dev, const cc110x_params_t *params);
* @retval -EINVAL Called with invalid argument * @retval -EINVAL Called with invalid argument
* @retval -EIO Communication with the transceiver failed * @retval -EIO Communication with the transceiver failed
* *
* @pre The application developer checked in the documentation that the channel * @pre The application developer checked in the documentation that the
* map in @p chanmap is compatible with the configuration in @p conf * channel map in @p chanmap is compatible with the configuration in
* @p conf
* *
* Because the configuration (potentially) changes the channel bandwidth, the * Because the configuration (potentially) changes the channel bandwidth, the
* old channel map is rendered invalid. This API therefore asks for both to make * old channel map is rendered invalid. This API therefore asks for both to make