doc: put network devices and sensors in subgroups

2025-01-17 04:52:59 +01:00 · 2015-09-25 21:06:17 +02:00 · 2015-09-25 21:06:17 +02:00 · f035bced0c
commit f035bced0c
parent 6f720306c9
33 changed files with 52 additions and 33 deletions
--- a/cpu/nrf51/include/nrfmin.h
+++ b/cpu/nrf51/include/nrfmin.h
@ -8,7 +8,7 @@

 /**
 * @defgroup        drivers_nrf51822_nrfmin NRF Minimal Radio Driver
- * @ingroup         drivers
+ * @ingroup         drivers_netdev
 * @brief           Minimal driver for the NRF51822 radio
 *
 * This driver enables the use of the NRF51822 radio in a IEEE802.15.4 like
--- a/drivers/doc.txt
+++ b/drivers/doc.txt
@ -1,5 +1,6 @@
 /*
 * Copyright (C) 2013 Freie Universität Berlin
+ * Copyright (C) 2015 INRIA
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
@ -12,3 +13,18 @@
 *
 * The module contains all kind of drivers for specific devices.
 */
+
+/**
+ * @defgroup    drivers_netdev Network Device Drivers
+ * @ingroup     drivers
+ * @brief       Drivers for external network devices.
+ */
+
+/**
+ * @defgroup    drivers_sensors Sensor Device Drivers
+ * @ingroup     drivers
+ * @brief       Drivers for external sensors.
+ *
+ * Most of these drivers will be connected over some bus or serial connection
+ * to the MCU.
+ */
--- a/drivers/include/adt7310.h
+++ b/drivers/include/adt7310.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_adt7310 ADT7310 SPI temperature sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the Analog Devices ADT7310 temperature sensor.
 *
 * ## Description
--- a/drivers/include/at86rf2xx.h
+++ b/drivers/include/at86rf2xx.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_at86rf2xx AT86RF2xx based drivers
- * @ingroup     drivers
+ * @ingroup     drivers_netdev
 *
 * This module contains drivers for radio devices in Atmel's AT86RF2xx series.
 * The driver is aimed to work with all devices of this series.
--- a/drivers/include/cc110x.h
+++ b/drivers/include/cc110x.h
@ -9,7 +9,7 @@

 /**
 * @defgroup    drivers_cc110x CC110x
- * @ingroup     drivers
+ * @ingroup     drivers_netdev
 * @brief       TI CC110x
 * @{
 * @file
--- a/drivers/include/dht.h
+++ b/drivers/include/dht.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_dht DHT Family of Humidity and Temperature Sensors
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for the DHT Family of humidity
 *              and temperature sensors
 *
--- a/drivers/include/encx24j600.h
+++ b/drivers/include/encx24j600.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_encx24j600 ENCX24J600
- * @ingroup     drivers
+ * @ingroup     drivers_netdev
 * @brief       Driver for the ENCX24J600 Ethernet Adapter
 * @{
 *
--- a/drivers/include/hdc1000.h
+++ b/drivers/include/hdc1000.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_hdc1000 HDC1000 Humidity and Temperature Sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the Texas Instruments HDC1000
 *              Humidity and Temperature Sensor.
 *              The driver will initialize the sensor for best
--- a/drivers/include/hih6130.h
+++ b/drivers/include/hih6130.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_hih6130 HIH6130 humidity and temperature sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for Honeywell HumidIcon Digital
 *              Humidity/Temperature Sensors: HIH-6130/6131 Series
 * @{
--- a/drivers/include/ina220.h
+++ b/drivers/include/ina220.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_ina220 INA220 current/power monitor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for Texas Instruments INA220 High or Low Side,
 *              Bi-Directional CURRENT/POWER MONITOR with Two-Wire Interface
 * @{
--- a/drivers/include/isl29020.h
+++ b/drivers/include/isl29020.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_isl29020 ISL29020 light sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for the ISL29020 light sensor
 * @{
 *
--- a/drivers/include/isl29125.h
+++ b/drivers/include/isl29125.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_isl29125 ISL29125 RGB light sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for the ISL29125 RGB light sensor
 *
 * ## Description
--- a/drivers/include/kw2xrf.h
+++ b/drivers/include/kw2xrf.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_kw2xrf kw2x radio-driver
- * @ingroup     drivers
+ * @ingroup     drivers_netdev
 * @brief       Device driver for the Freescale KW2xD radio
 * @{
 *
--- a/drivers/include/l3g4200d.h
+++ b/drivers/include/l3g4200d.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_l3g4200d L3G4200D gyroscope
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for the L3G4200D gyroscope
 * @{
 *
--- a/drivers/include/lis3dh.h
+++ b/drivers/include/lis3dh.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_lis3dh LIS3DH accelerometer
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for the LIS3DH accelerometer
 * @{
 *
--- a/drivers/include/lm75a-temp-sensor.h
+++ b/drivers/include/lm75a-temp-sensor.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    lm75a LM75A
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the LM75A digital temperature sensor and thermal watchdog
 *
 * The connection between the MCU and the LM75A is based on the i2c-interface.
--- a/drivers/include/lps331ap.h
+++ b/drivers/include/lps331ap.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_lps331ap LPS331AP Pressure Sensor Driver
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for the LPS331AP pressure sensor
 * @{
 *
--- a/drivers/include/lsm303dlhc.h
+++ b/drivers/include/lsm303dlhc.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_lsm303dlhc LSM303DLHC 3D accelerometer/magnetometer
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for the LSM303DLHC 3D accelerometer/magnetometer
 * @{
 *
--- a/drivers/include/ltc4150_arch.h
+++ b/drivers/include/ltc4150_arch.h
@ -15,7 +15,7 @@ extern "C" {

 /**
 * @defgroup    ltc4150 LTC4150
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the Linear Technology LTC4150 Coulomb Counter
 * @{
 *
--- a/drivers/include/mag3110.h
+++ b/drivers/include/mag3110.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_mag3110 MAG3110 3-Axis Digital Magnetometer
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the Freescale MAG3110 magnetometer.
 *              After initialization and set activ the magnetometer
 *              will make measurements at periodic times.
--- a/drivers/include/mma8652.h
+++ b/drivers/include/mma8652.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_mma8652 MMA8652 Accelerometer
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the Freescale MMA8652 3-Axis accelerometer.
 *              The driver will initialize the accelerometer for
 *              best resolution (12 bit).
--- a/drivers/include/mpl3115a2.h
+++ b/drivers/include/mpl3115a2.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_mpl3115a2 MPL3115A2 Pressure Sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the Freescale MPL3115A2 pressure sensor.
 *              The driver will initialize the sensor for
 *              pressure measurement. The conversion duration
--- a/drivers/include/mpu9150.h
+++ b/drivers/include/mpu9150.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_mpu9150 MPU-9150
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver interface for the MPU-9150
 * @{
 *
--- a/drivers/include/mq3.h
+++ b/drivers/include/mq3.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_mq3 MQ-3 Alcohol Tester
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver for the MQ-3 alcohol sensor
 * @{
 *
--- a/drivers/include/net/netdev2.h
+++ b/drivers/include/net/netdev2.h
@ -10,9 +10,10 @@
 */

 /**
- * @defgroup    drivers_netdev2 Low-Level Network Driver Interface
- * @ingroup     drivers
- * @brief       Low-level network driver interface
+ * @defgroup    drivers_netdev_netdev2 Generic Low-Level Network Driver Interface v2
+ * @ingroup     drivers_netdev
+ * @brief       This is the second version of a generic low-level network
+ *              driver interface
 * @{
 *
 * This interface is supposed to be a low-level interface for network drivers.
--- a/drivers/include/nrf24l01p.h
+++ b/drivers/include/nrf24l01p.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_nrf24l01p NRF24L01+ Driver Interface
- * @ingroup     drivers
+ * @ingroup     drivers_netdev
 *
 * @brief       Low-level driver for nrf24l01+ transceiver
 *
--- a/drivers/include/pir.h
+++ b/drivers/include/pir.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_pir PIR Motion Sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Device driver interface for the PIR motion sensor
 * @{
 *
--- a/drivers/include/sht11.h
+++ b/drivers/include/sht11.h
@ -12,7 +12,7 @@
 /**
 * @defgroup    sht11   SHT11
 * @brief       Driver for Sensirion SHT11 Humidity and Temperature Sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @{
 *
 * @file
--- a/drivers/include/srf02.h
+++ b/drivers/include/srf02.h
@ -9,7 +9,7 @@

 /**
 * @defgroup    driver_srf02 SRF02
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the SRF02 ultrasonic range sensor
 * @{
 *
--- a/drivers/include/srf08.h
+++ b/drivers/include/srf08.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    driver_srf08 SRF08 ultrasonic range sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the SRF08 ultrasonic range sensor
 *
 * The connection between the MCU and the SRF08 is based on the i2c-interface.
--- a/drivers/include/tmp006.h
+++ b/drivers/include/tmp006.h
@ -8,7 +8,7 @@

 /**
 * @defgroup    drivers_tmp006 TMP006 Infrared Thermopile Sensor
- * @ingroup     drivers
+ * @ingroup     drivers_sensors
 * @brief       Driver for the Texas Instruments TMP006 sensor.
 *              The sensor measures the temperature of an object
 *              without the need of direct contact with the object.
--- a/drivers/include/xbee.h
+++ b/drivers/include/xbee.h
@ -9,7 +9,7 @@

 /**
 * @defgroup    drivers_xbee XBee driver
- * @ingroup     drivers
+ * @ingroup     drivers_netdev
 * @brief       High-level driver for the XBee S1 802.15.4 modem
 * @{
 *
--- a/sys/include/net/gnrc/gnrc_netdev2.h
+++ b/sys/include/net/gnrc/gnrc_netdev2.h
@ -7,7 +7,9 @@
 */

 /**
+ * @defgroup  net_gnrc_netdev2   Adaption layer for GNRC on top of Netdev2
 * @ingroup   net_gnrc
+ * @brief     Provides the glue code for @ref gnrc on top of @ref drivers_netdev_netdev2
 * @{
 *
 * @file