From 9f8386c21510c191cd5617f23b904deef0c9ab2c Mon Sep 17 00:00:00 2001
From: Alexandre Abadie <alexandre.abadie@inria.fr>
Date: Tue, 12 Jun 2018 10:35:56 +0200
Subject: [PATCH] drivers*: add saul doc group to related drivers
---
drivers/include/adcxx1c.h | 5 ++++-
drivers/include/ads101x.h | 5 ++++-
drivers/include/adxl345.h | 3 +++
drivers/include/bmp180.h | 5 ++++-
drivers/include/bmx055.h | 3 +++
drivers/include/bmx280.h | 2 ++
drivers/include/dht.h | 3 +++
drivers/include/fxos8700.h | 2 ++
drivers/include/grove_ledbar.h | 3 +++
drivers/include/hdc1000.h | 3 +++
drivers/include/hts221.h | 3 +++
drivers/include/io1_xplained.h | 2 ++
drivers/include/isl29020.h | 3 +++
drivers/include/jc42.h | 2 ++
drivers/include/l3g4200d.h | 8 ++++++--
drivers/include/lis2dh12.h | 3 +++
drivers/include/lis3dh.h | 3 +++
drivers/include/lis3mdl.h | 3 +++
drivers/include/lps331ap.h | 3 +++
drivers/include/lsm303dlhc.h | 3 +++
drivers/include/lsm6dsl.h | 2 ++
drivers/include/mag3110.h | 19 +++++++++++--------
drivers/include/mma8x5x.h | 15 +++++++++------
drivers/include/mpl3115a2.h | 2 ++
drivers/include/mpu9150.h | 3 +++
drivers/include/pulse_counter.h | 2 ++
drivers/include/si114x.h | 3 +++
drivers/include/si70xx.h | 5 ++++-
drivers/include/tcs37727.h | 3 ++-
drivers/include/tmp006.h | 2 ++
drivers/include/tsl2561.h | 3 +++
drivers/include/veml6070.h | 3 +++
32 files changed, 108 insertions(+), 21 deletions(-)
diff --git a/drivers/include/adcxx1c.h b/drivers/include/adcxx1c.h
index 8d3fdfa1c2..5fa7a8f6ed 100644
--- a/drivers/include/adcxx1c.h
+++ b/drivers/include/adcxx1c.h
@@ -9,9 +9,12 @@
/**
* @defgroup drivers_adcxx1c ADCXX1C ADC device driver
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief I2C Analog-to-Digital Converter device driver
*
- * This driver works with adc081c, adc101c and adc121c versions.
+ * This driver works with adc081c, adc101c and adc121c versions.
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/ads101x.h b/drivers/include/ads101x.h
index e65497cfab..9f4c497d18 100644
--- a/drivers/include/ads101x.h
+++ b/drivers/include/ads101x.h
@@ -10,9 +10,12 @@
/**
* @defgroup drivers_ads101x ADS101x/111x ADC device driver
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief I2C Analog-to-Digital Converter device driver
*
- * This driver works with ADS1013-5 and ADS1113-5.
+ * This driver works with ADS1013-5 and ADS1113-5.
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/adxl345.h b/drivers/include/adxl345.h
index 1106ef6fa7..a59236168c 100644
--- a/drivers/include/adxl345.h
+++ b/drivers/include/adxl345.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_adxl345 ADXL345 3-Axis accelerometer
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver interface for the ADXL345
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/bmp180.h b/drivers/include/bmp180.h
index e7b7940952..6919bc7e73 100644
--- a/drivers/include/bmp180.h
+++ b/drivers/include/bmp180.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_bmp180 BMP180 temperature and pressure sensor
* @ingroup drivers_sensors
- * @brief Device driver interface for the BMP180 sensor.
+ * @ingroup drivers_saul
+ * @brief Device driver interface for the BMP180 sensor
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/bmx055.h b/drivers/include/bmx055.h
index 3471703f34..9eca87ee26 100644
--- a/drivers/include/bmx055.h
+++ b/drivers/include/bmx055.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_bmx055 BMX055 9-axis sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the Bosch BMX055 9-axis sensor
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/bmx280.h b/drivers/include/bmx280.h
index 972102d79d..0288930cc6 100644
--- a/drivers/include/bmx280.h
+++ b/drivers/include/bmx280.h
@@ -10,6 +10,7 @@
/**
* @defgroup drivers_bmx280 BMP280/BME280 temperature, pressure and humidity sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver interface for the Bosch BMP280 and BME280 sensors.
*
* BMP280 and BME280 measure temperature in centi °C and pressure in Pa. BME280
@@ -19,6 +20,7 @@
* * [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)
*
+ * This driver provides @ref drivers_saul capabilities.
* @{
* @file
* @brief Device driver interface for the BMX280 sensors (BMP280 and BME280).
diff --git a/drivers/include/dht.h b/drivers/include/dht.h
index 1132b632cf..37c7df7e4e 100644
--- a/drivers/include/dht.h
+++ b/drivers/include/dht.h
@@ -11,9 +11,12 @@
/**
* @defgroup drivers_dht DHT Family of Humidity and Temperature Sensors
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the DHT Family of humidity
* and temperature sensors
*
+ * This driver provides @ref drivers_saul capabilities.
+ *
* @{
*
* @file
diff --git a/drivers/include/fxos8700.h b/drivers/include/fxos8700.h
index f6cc1ea981..5602bd8e3c 100644
--- a/drivers/include/fxos8700.h
+++ b/drivers/include/fxos8700.h
@@ -9,11 +9,13 @@
/**
* @defgroup drivers_fxos8700 FXOS8700 3-axis accelerometer/magnetometer
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the FXOS8700 3-axis accelerometer/magnetometer
*
* The connection between the MCU and the FXOS8700 is based on the
* I2C-interface.
*
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/grove_ledbar.h b/drivers/include/grove_ledbar.h
index a28d97a83d..0f9e6d12c2 100644
--- a/drivers/include/grove_ledbar.h
+++ b/drivers/include/grove_ledbar.h
@@ -9,8 +9,11 @@
/**
* @defgroup drivers_grove_ledbar Grove ledbar
* @ingroup drivers_actuators
+ * @ingroup drivers_saul
* @brief Driver for the Grove ledbar
*
+ * This driver provides @ref drivers_saul capabilities.
+ *
* @{
* @file
* @brief Interface for the Grove ledbar driver
diff --git a/drivers/include/hdc1000.h b/drivers/include/hdc1000.h
index 2f57d31eef..f7a7ba1f50 100644
--- a/drivers/include/hdc1000.h
+++ b/drivers/include/hdc1000.h
@@ -10,6 +10,7 @@
/**
* @defgroup drivers_hdc1000 HDC1000 Humidity and Temperature Sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the TI HDC1000 Humidity and Temperature Sensor
*
* The driver will initialize the sensor for best resolution (14 bit). Currently
@@ -26,6 +27,8 @@
* @note The driver does currently not support using the devices heating
* unit.
*
+ * This driver provides @ref drivers_saul capabilities.
+ *
* @{
*
* @file
diff --git a/drivers/include/hts221.h b/drivers/include/hts221.h
index 12e3b58602..385653c69f 100644
--- a/drivers/include/hts221.h
+++ b/drivers/include/hts221.h
@@ -9,8 +9,11 @@
/**
* @defgroup drivers_hts221 ST HTS221 digital Humidity Sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the ST HTS221 digital Humidity Sensor
*
+ * This driver provides @ref drivers_saul capabilities.
+ *
* @{
* @file
* @brief Interface definition for the ST HTS221 driver
diff --git a/drivers/include/io1_xplained.h b/drivers/include/io1_xplained.h
index 16d75ec8e8..164789a905 100644
--- a/drivers/include/io1_xplained.h
+++ b/drivers/include/io1_xplained.h
@@ -9,6 +9,7 @@
/**
* @defgroup drivers_io1_xplained Atmel IO1 Xplained Extension board
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver interface for the Atmel IO1 Xplained extension.
*
* This board contains several sensors and actuators:
@@ -27,6 +28,7 @@
* (http://www.atmel.com/images/atmel-42078-io1-xplained-pro_user-guide.pdf)
* for more information
*
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/isl29020.h b/drivers/include/isl29020.h
index b8b62af62d..3fdf574384 100644
--- a/drivers/include/isl29020.h
+++ b/drivers/include/isl29020.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_isl29020 ISL29020 light sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the ISL29020 light sensor
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/jc42.h b/drivers/include/jc42.h
index 6f103a71c5..4b6097a3b9 100644
--- a/drivers/include/jc42.h
+++ b/drivers/include/jc42.h
@@ -9,6 +9,7 @@
/**
* @defgroup drivers_jc42 JC42 compliant temperature sensor driver
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
*
* @brief JC42 compliant temperature sensor driver
*
@@ -20,6 +21,7 @@
* temperature from these sensors. The sensors support a alarm wire, but this
* is not supported by this driver.
*
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/l3g4200d.h b/drivers/include/l3g4200d.h
index a03cd55896..118d5dc62f 100644
--- a/drivers/include/l3g4200d.h
+++ b/drivers/include/l3g4200d.h
@@ -9,14 +9,18 @@
/**
* @defgroup drivers_l3g4200d L3G4200D gyroscope
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the L3G4200D gyroscope
+ *
+ * This driver provides @ref drivers_saul capabilities.
+ *
+ * @note The current state of the driver only implements a very basic polling mode.
+ *
* @{
*
* @file
* @brief Device driver interface for the L3G4200D gyroscope
*
- * @note The current state of the driver only implements a very basic polling mode.
- *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
diff --git a/drivers/include/lis2dh12.h b/drivers/include/lis2dh12.h
index 37d47477d4..1a6abb79da 100644
--- a/drivers/include/lis2dh12.h
+++ b/drivers/include/lis2dh12.h
@@ -9,6 +9,7 @@
/**
* @defgroup drivers_lis2dh12 LIS2DH12 Accelerometer
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the STM LIS2DH12 accelerometer
*
* This device driver provides a minimal interface to LIS2DH12 devices. As of
@@ -23,6 +24,8 @@
* support is quite simple, as all bus related functions (acquire, release,
* read, write) are cleanly separated in the code.
*
+ * This driver provides @ref drivers_saul capabilities.
+ *
* @{
* @file
* @brief Interface definition for the STM LIS2DH12 accelerometer
diff --git a/drivers/include/lis3dh.h b/drivers/include/lis3dh.h
index ffd29aeb2f..2b2c3cebe9 100644
--- a/drivers/include/lis3dh.h
+++ b/drivers/include/lis3dh.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_lis3dh LIS3DH accelerometer
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the LIS3DH accelerometer
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/lis3mdl.h b/drivers/include/lis3mdl.h
index 0630124f0a..2708c62075 100644
--- a/drivers/include/lis3mdl.h
+++ b/drivers/include/lis3mdl.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_lis3mdl LIS3MDL 3-axis magnetometer
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the LIS3MDL 3-axis magnetometer
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/lps331ap.h b/drivers/include/lps331ap.h
index cda4e5b197..0e7c5908d0 100644
--- a/drivers/include/lps331ap.h
+++ b/drivers/include/lps331ap.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_lps331ap LPS331AP Pressure Sensor Driver
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the LPS331AP pressure sensor
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/lsm303dlhc.h b/drivers/include/lsm303dlhc.h
index 7d4b21f424..3db5e1ed7a 100644
--- a/drivers/include/lsm303dlhc.h
+++ b/drivers/include/lsm303dlhc.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_lsm303dlhc LSM303DLHC 3D accelerometer/magnetometer
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the LSM303DLHC 3D accelerometer/magnetometer
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/lsm6dsl.h b/drivers/include/lsm6dsl.h
index 70563b31f3..3dc6ee4478 100644
--- a/drivers/include/lsm6dsl.h
+++ b/drivers/include/lsm6dsl.h
@@ -10,8 +10,10 @@
/**
* @defgroup drivers_lsm6dsl LSM6DSL 3D accelerometer/gyroscope
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the LSM6DSL 3D accelerometer/gyroscope
*
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/mag3110.h b/drivers/include/mag3110.h
index b055ca4e7d..84d6977da1 100644
--- a/drivers/include/mag3110.h
+++ b/drivers/include/mag3110.h
@@ -10,16 +10,19 @@
/**
* @defgroup drivers_mag3110 MAG3110 3-Axis Digital Magnetometer
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the Freescale MAG3110 magnetometer.
- * After initialization and set activ the magnetometer
- * will make measurements at periodic times.
- * The output rate and over sample ratio
- * can be determined by magnetometer initialization.
- * The measured values of magnetic field strength and
- * die temperature have uncalibrated offsets.
- * To get correct measurement values, the individual
- * offsets must be measured and set accordingly.
*
+ * After initialization and set activ the magnetometer will make measurements
+ * at periodic times.
+ * The output rate and over sample ratio can be determined by magnetometer
+ * initialization.
+ * The measured values of magnetic field strength and die temperature have
+ * uncalibrated offsets.
+ * To get correct measurement values, the individual offsets must be measured
+ * and set accordingly.
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/mma8x5x.h b/drivers/include/mma8x5x.h
index 33dc214747..7c9abf29fa 100644
--- a/drivers/include/mma8x5x.h
+++ b/drivers/include/mma8x5x.h
@@ -10,14 +10,17 @@
/**
* @defgroup drivers_mma8x5x MMA8x5x Accelerometer
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the Freescale MMA8x5x 3-Axis accelerometer.
- * The driver will initialize the accelerometer for best
- * resolution. After the initialization the accelerometer will make
- * measurements at periodic times. The measurements period and
- * scale range can be determined by accelerometer initialization.
- * This driver only implements basic functionality (i.e. no support
- * for external interrupt pins).
*
+ * The driver will initialize the accelerometer for best resolution. After the
+ * initialization the accelerometer will make measurements at periodic times.
+ * The measurements period and scale range can be determined by accelerometer
+ * initialization.
+ * This driver only implements basic functionality (i.e. no support
+ * for external interrupt pins).
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/mpl3115a2.h b/drivers/include/mpl3115a2.h
index 88adaf9b76..6678d4a6fd 100644
--- a/drivers/include/mpl3115a2.h
+++ b/drivers/include/mpl3115a2.h
@@ -10,6 +10,7 @@
/**
* @defgroup drivers_mpl3115a2 MPL3115A2 Pressure Sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the Freescale MPL3115A2 pressure sensor.
*
* The driver will initialize the sensor for pressure measurement. The
@@ -17,6 +18,7 @@
* the sensor can be set active to run periodic measurements. The oversample
* ratio can be configured during sensor initialization.
*
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/mpu9150.h b/drivers/include/mpu9150.h
index 25e2ceec4d..a6ff986fbb 100644
--- a/drivers/include/mpu9150.h
+++ b/drivers/include/mpu9150.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_mpu9150 MPU-9150 accelerometer/magnetometer/gyroscope
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver interface for the MPU-9150
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/pulse_counter.h b/drivers/include/pulse_counter.h
index 5e69cf8d43..70c0b9cc24 100644
--- a/drivers/include/pulse_counter.h
+++ b/drivers/include/pulse_counter.h
@@ -9,9 +9,11 @@
/**
* @defgroup drivers_pulse_counter Pulse counter
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
*
* @brief GPIO based pulse counting driver
*
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/si114x.h b/drivers/include/si114x.h
index 828d7192c1..9a86cf1f74 100644
--- a/drivers/include/si114x.h
+++ b/drivers/include/si114x.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_si114x Si1145/6/7 UV/Ambient light/Proximity sensors
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver for the Si1145/6/7 sensors family
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/si70xx.h b/drivers/include/si70xx.h
index 34dcc402d2..49a67776a6 100644
--- a/drivers/include/si70xx.h
+++ b/drivers/include/si70xx.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_si70xx Si7006/13/20/21 temperature and humidity sensors
* @ingroup drivers_sensors
- * @brief Driver for the Si7006/13/20/21 temperature and humidity sensor.
+ * @ingroup drivers_saul
+ * @brief Driver for the Si7006/13/20/21 temperature and humidity sensor
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/tcs37727.h b/drivers/include/tcs37727.h
index f28d4b3247..3e2e66a5aa 100644
--- a/drivers/include/tcs37727.h
+++ b/drivers/include/tcs37727.h
@@ -10,9 +10,10 @@
/**
* @defgroup drivers_tcs37727 TCS37727 RGB Light Sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the AMS TCS37727 Color Light-To-Digital Converter
*
- *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/tmp006.h b/drivers/include/tmp006.h
index e37ccf0c0a..82b4cd4c2f 100644
--- a/drivers/include/tmp006.h
+++ b/drivers/include/tmp006.h
@@ -10,6 +10,7 @@
/**
* @defgroup drivers_tmp006 TI TMP006 Infrared Thermopile Sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Driver for the Texas Instruments TMP006 sensor.
*
* The TI TMP006 (Infrared Thermopile Contactless Temperature Sensor) measures
@@ -65,6 +66,7 @@
*
* The calculation and constants are wrapped from TI TMP006 User's Guide SBOU107.
*
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/tsl2561.h b/drivers/include/tsl2561.h
index 1427755bc9..4985a99722 100644
--- a/drivers/include/tsl2561.h
+++ b/drivers/include/tsl2561.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_tsl2561 TSL2561 illuminance sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver interface for the illuminance TSL2561 sensor
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
diff --git a/drivers/include/veml6070.h b/drivers/include/veml6070.h
index 6b41586603..bdefd37a94 100644
--- a/drivers/include/veml6070.h
+++ b/drivers/include/veml6070.h
@@ -9,7 +9,10 @@
/**
* @defgroup drivers_veml6070 VEML6070 UV sensor
* @ingroup drivers_sensors
+ * @ingroup drivers_saul
* @brief Device driver interface for the VEML6070 UV sensor
+ *
+ * This driver provides @ref drivers_saul capabilities.
* @{
*
* @file
--
GitLab