Merge pull request #13491 from gschorcht/doc/fix_driver_grouping

doc: fix of several documenation structure problems in drivers
RIOT-OS · Feb 27, 2020 · c7e1c35 · c7e1c35
2 parents 244c7da + a27e77c
commit c7e1c35
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 8 deletions.
diff --git a/drivers/doc.txt b/drivers/doc.txt
@@ -51,17 +51,24 @@
  * @brief       Drivers for display devices
  */
 
- /**
+/**
  * @defgroup    drivers_soft_periph Soft Peripheral Driver Interface
  * @ingroup     drivers
  * @brief       Software emulated @ref drivers_periph for UART, SPI, etc
  */
 
- /**
+/**
  * @defgroup    drivers_power Power Supply Drivers
  * @ingroup     drivers
  * @brief       Drivers for power supply devices
  *
  * The group of power supply drivers indludes all kinds of AC/DC, DC/DC supply devices
  * or charger ICs which can be controlled from the host e.g by config pin settings or by bus.
  */
+
+/**
+ * @defgroup    drivers_misc Miscellaneous Drivers
+ * @ingroup     drivers
+ * @brief       Drivers for different kinds of devices that do not match any
+ *              other category
+ */
diff --git a/drivers/include/at.h b/drivers/include/at.h
@@ -8,7 +8,7 @@
 
 /**
  * @defgroup    drivers_at AT (Hayes) command set library
- * @ingroup     drivers
+ * @ingroup     drivers_misc
  * @brief       AT (Hayes) command set library
  *
  * This module provides functions to interact with devices using AT commands.

diff --git a/drivers/include/at24cxxx.h b/drivers/include/at24cxxx.h
@@ -8,6 +8,7 @@
 
 /**
  * @defgroup    drivers_at24cxxx AT24CXXX EEPROM unit
+ * @ingroup     drivers_misc
  * @brief       Device driver interface for the AT24CXXX EEPROM units
  *
  * @{

diff --git a/drivers/include/at24mac.h b/drivers/include/at24mac.h
@@ -7,7 +7,8 @@
  */
 
 /**
- * @defgroup    drivers_at24mac unique ID chip
+ * @defgroup    drivers_at24mac AT24MAC unique ID chip
+ * @ingroup     drivers_misc
  * @brief       Device driver interface for the AT24MAC I2C chip
  * @{
  *

diff --git a/drivers/include/bmx280.h b/drivers/include/bmx280.h
@@ -9,8 +9,7 @@
  */
 
 /**
- * @defgroup    drivers_bmx280 BMP280/BME280 temperature, pressure and humidity
- *                             sensor
+ * @defgroup    drivers_bmx280 BMP280/BME280 temperature, pressure and humidity sensor
  * @ingroup     drivers_sensors
  * @brief       Device driver interface for the Bosch BMP280 and BME280 sensors
  *

diff --git a/drivers/include/sps30.h b/drivers/include/sps30.h
@@ -7,9 +7,10 @@
  */
 
 /**
- * @defgroup    drivers_sps30 Sensirion SPS30 Particulate Matter Sensor
+ * @defgroup    drivers_sps30 SPS30 Particulate Matter Sensor
  * @ingroup     drivers_sensors
  * @ingroup     drivers_saul
+ * @brief       Driver for the Sensirion SPS30 Particulate Matter Sensor
  *
  * About
  * =====

diff --git a/pkg/cryptoauthlib/doc.txt b/pkg/cryptoauthlib/doc.txt
@@ -1,6 +1,6 @@
 /**
  * @defgroup pkg_cryptoauthlib Microchip CryptoAuthentication Library
- * @ingroup  pkg drivers sys_crypto
+ * @ingroup  pkg drivers_misc sys_crypto
  * @brief    Provides the library for Microchip CryptoAuth devices
  * @see      https://github.com/MicrochipTech/cryptoauthlib
  *
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,7 @@ @@
     /**
      * @defgroup    drivers_at24cxxx AT24CXXX EEPROM unit
+     * @ingroup     drivers_misc
      * @brief       Device driver interface for the AT24CXXX EEPROM units
      *
      * @{
@@ Expand Down @@