RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #7295 from aabadie/fix_doc_drivers

Browse Source 
drivers: doxygen documentation improvement
This commit is contained in:
Martine Lenders 2017-07-02 23:46:59 +02:00 committed by GitHub
commit ed227c7d34
16 changed files with 48 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
drivers/include/adcxx1c.h
View File

@ -10,13 +10,13 @@
* @defgroup drivers_adcxx1x ADCXX1C ADC device driver
* @ingroup drivers_sensors
* @brief I2C Analog-to-Digital Converter device driver
*
* This driver works with adc081c, adc101c and adc121c versions.
* @{
*
* @file
* @brief ADCXX1C ADC device driver
*
* This driver works with adc081c, adc101c and adc121c versions.
*
* @author Vincent Dupont <vincent@otakeys.com>
*/

4
drivers/include/bmp180.h
View File

@ -7,9 +7,9 @@
*/
/**
* @defgroup drivers_bmp180 BMP180
* @defgroup drivers_bmp180 BMP180 temperature and pressure sensor
* @ingroup drivers_sensors
* @brief Device driver interface for the BMP180 sensor
* @brief Device driver interface for the BMP180 sensor.
* @{
*
* @file

11
drivers/include/bmx280.h
View File

@ -8,9 +8,16 @@
*/
/**
* @defgroup drivers_bmx280 BMX280
* @defgroup drivers_bmx280 BMP280/BME280 temperature, pressure and humidity sensor
* @ingroup drivers_sensors
* @brief Device driver interface for the BMX280 sensors (BMP280 and BME280).
* @brief Device driver interface for the Bosch BMP280 and BME280 sensors.
*
* BMP280 and BME280 measure temperature in centi °C and pressure in Pa. BME280
* can also measure relative humidity in %.
*
* For more information, see the datasheets:
* * [BMP280](https://ae-bst.resource.bosch.com/media/_tech/media/datasheets/BST-BMP280-DS001-18.pdf)
* * [BME280](https://ae-bst.resource.bosch.com/media/_tech/media/datasheets/BST-BME280_DS001-11.pdf)
*
* @{
* @file

4
drivers/include/cc110x.h
View File

@ -8,9 +8,9 @@
*/
/**
* @defgroup drivers_cc110x CC110x
* @defgroup drivers_cc110x CC1100/CC1101 radio driver
* @ingroup drivers_netdev
* @brief TI CC110x
* @brief Driver for TI CC1100/CC1101 radios
* @{
* @file
* @brief Public interface for cc110x driver

2
drivers/include/cc2420.h
View File

@ -7,7 +7,7 @@
*/
/**
* @defgroup drivers_cc2420 CC2420 driver
* @defgroup drivers_cc2420 CC2420 radio driver
* @ingroup drivers_netdev
* @{
*

23
drivers/include/io1_xplained.h
View File

@ -7,13 +7,30 @@
*/
/**
* @defgroup drivers_io1_xplained IO1_XPLAINED
* @defgroup drivers_io1_xplained Atmel IO1 Xplained Extension board
* @ingroup drivers_sensors
* @brief Device driver interface for the IO1 Xplained extension.
* @brief Device driver interface for the Atmel IO1 Xplained extension.
*
* This board contains several sensors and actuators:
* * @ref drivers_at30tse75x
* * TEMT6000 Light sensor (not yet supported by this driver)
* * microSD card connector (not yet supported by this driver)
* * one yellow LED
* * 2 GPIO pins
*
* This board can be used with the following Atmel evaluation boards:
* * @ref boards_samr21-xpro
* * @ref boards_samd21-xpro
* * @ref boards_saml21-xpro
*
* See the [datasheet]
* (http://www.atmel.com/images/atmel-42078-io1-xplained-pro_user-guide.pdf)
* for more information
*
* @{
*
* @file
* @brief Device driver interface for the IO1 Xplained extention.
* @brief Device driver interface for the Atmel IO1 Xplained extention.
*
* @author Alexandre Abadie <alexandre.abadie@inria.fr>
*/

2
drivers/include/led.h
View File

@ -8,7 +8,7 @@
/**
* @defgroup drivers_led Control on-board LEDs
* @ingroup drivers
* @ingroup drivers_actuators
* @brief Access macros to control the on-board LEDs
*
* This header contains a set of macros for controlling the on-board LEDs of

2
drivers/include/mpu9150.h
View File

@ -7,7 +7,7 @@
*/
/**
* @defgroup drivers_mpu9150 MPU-9150
* @defgroup drivers_mpu9150 MPU-9150 accelerometer/magnetometer/gyroscope
* @ingroup drivers_sensors
* @brief Device driver interface for the MPU-9150
* @{

2
drivers/include/sht11.h
View File

@ -10,7 +10,7 @@
#define SHT11_H
/**
* @defgroup drivers_sht11 SHT11
* @defgroup drivers_sht11 SHT11 Humidity and Temperature Sensor
* @ingroup drivers_sensors
* @brief Driver for Sensirion SHT11 Humidity and Temperature Sensor
* @{

2
drivers/include/si70xx.h
View File

@ -7,7 +7,7 @@
*/
/**
* @defgroup driver_si70xx Si70xx
* @defgroup driver_si70xx Si7006/13/20/21 temperature and humidity sensors
* @ingroup drivers_sensors
* @brief Driver for the Si7006/13/20/21 temperature and humidity sensor.
* @{

2
drivers/include/srf02.h
View File

@ -8,7 +8,7 @@
*/
/**
* @defgroup driver_srf02 SRF02
* @defgroup driver_srf02 SRF02 ultrasonic range sensor
* @ingroup drivers_sensors
* @brief Driver for the SRF02 ultrasonic range sensor
* @{

4
drivers/include/sx127x.h
View File

@ -8,9 +8,9 @@
*/
/**
* @defgroup drivers_sx127x SX127X
* @defgroup drivers_sx127x Semtech SX1272 and SX1276 radios driver
* @ingroup drivers_netdev
* @brief Semtech SX127X driver (SX1272 and SX1276)
* @brief Driver for Semtech SX1272 and SX1276 radios.
*
* This module contains the driver for radio devices of the Semtech SX127x
* series (SX1272 and SX1276).

4
drivers/include/tsl2561.h
View File

@ -7,9 +7,9 @@
*/
/**
* @defgroup drivers_tsl2561 TSL2561
* @defgroup drivers_tsl2561 TSL2561 illuminance sensor
* @ingroup drivers_sensors
* @brief Device driver interface for the illuminance TSL2561 sensor
* @brief Device driver interface for the illuminance TSL2561 sensor
* @{
*
* @file

2
drivers/include/veml6070.h
View File

@ -7,7 +7,7 @@
*/
/**
* @defgroup drivers_veml6070 VEML6070
* @defgroup drivers_veml6070 VEML6070 UV sensor
* @ingroup drivers_sensors
* @brief Device driver interface for the VEML6070 UV sensor
* @{

2
drivers/include/w5100.h
View File

@ -7,7 +7,7 @@
*/
/**
* @defgroup drivers_w5100 W5100
* @defgroup drivers_w5100 W5100 ethernet driver
* @ingroup drivers_netdev
* @brief Driver for W5100 ethernet devices
*

3
drivers/io1_xplained/include/io1_xplained_internals.h
View File

@ -7,8 +7,7 @@
*/
/**
* @defgroup drivers_io1_xplained IO1_XPLAINED
* @ingroup drivers_sensors
* @ingroup drivers_io1_xplained
* @brief Internal addresses, constants for the IO1 Xplained extension.
* @{
*