From 544c590d5b3482d08882d05826bba6192a4b78dc Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Tue, 7 Feb 2017 11:16:38 +0100 Subject: [PATCH 1/2] drivers: fixed doxygen groups --- drivers/doc.txt | 6 ++++++ drivers/include/diskio.h | 2 +- drivers/include/enc28j60.h | 2 +- drivers/include/flashrom.h | 7 ++++++- drivers/include/gpioint.h | 4 +++- drivers/include/lpd8808.h | 2 +- drivers/include/nvram.h | 2 +- drivers/include/pn532.h | 10 ++++++---- drivers/include/sdcard_spi.h | 2 +- 9 files changed, 26 insertions(+), 11 deletions(-) diff --git a/drivers/doc.txt b/drivers/doc.txt index 2962185bbb..23e16eb169 100644 --- a/drivers/doc.txt +++ b/drivers/doc.txt @@ -37,3 +37,9 @@ * The group of actuators includes all kind of devices that can actively * interact with the physical world, as e.g. motors, lights, sound devices, etc. */ + +/** + * @defgroup drivers_storage Storage Device Drivers + * @ingroup drivers + * @brief Drivers for storage devices + */ diff --git a/drivers/include/diskio.h b/drivers/include/diskio.h index 35e9e27764..1e45815663 100644 --- a/drivers/include/diskio.h +++ b/drivers/include/diskio.h @@ -9,7 +9,7 @@ /** * @defgroup drivers_diskio Disk IO Driver - * @ingroup drivers + * @ingroup drivers_storage * @brief Low level disk interface * * The connection between the MCU and the SRF08 is based on the i2c-interface. diff --git a/drivers/include/enc28j60.h b/drivers/include/enc28j60.h index 87b61a03fa..694e4720f7 100644 --- a/drivers/include/enc28j60.h +++ b/drivers/include/enc28j60.h @@ -8,7 +8,7 @@ /** * @defgroup driver_enc28j60 ENC28J60 - * @ingroup drivers + * @ingroup drivers_netdev * @brief Driver for the ENC28J60 Ethernet Adapter * @{ * diff --git a/drivers/include/flashrom.h b/drivers/include/flashrom.h index d6ccafb862..2620319dec 100644 --- a/drivers/include/flashrom.h +++ b/drivers/include/flashrom.h @@ -8,14 +8,19 @@ /** * @defgroup drivers_flashrom Flash memory driver - * @ingroup drivers + * @ingroup drivers_periph * @brief Generic flash memory driver + * + * @note This interface is deprecated, use `periph/flaspage` instead + * * @{ * * @file * + * * @brief Generic flash memory driver * @author unknown + * */ #ifndef FLASHROM_H diff --git a/drivers/include/gpioint.h b/drivers/include/gpioint.h index 0faa924120..72c72af4fd 100644 --- a/drivers/include/gpioint.h +++ b/drivers/include/gpioint.h @@ -8,11 +8,13 @@ /** * @defgroup drivers_gpioint GPIO IRQ Multiplexer - * @ingroup drivers + * @ingroup drivers_periph * @brief Provides an API to implement interrupt handlers on IO pins. * * Multiplexer and interrupt handling must be implemented platform specific. * + * @note This interface is deprecated, use `periph/gpio.h` instead + * * @{ * * @file diff --git a/drivers/include/lpd8808.h b/drivers/include/lpd8808.h index 7cabdfa3ca..63eb98aaec 100644 --- a/drivers/include/lpd8808.h +++ b/drivers/include/lpd8808.h @@ -8,7 +8,7 @@ /** * @defgroup drivers_lpd8808 LPD8808 based LED Strip - * @ingroup drivers + * @ingroup drivers_actuators * @brief Driver for LPD8808 based LED strips * * LPD8808 based LED strips consist of a number of LEDs driven by LPD8808 chips. diff --git a/drivers/include/nvram.h b/drivers/include/nvram.h index 2ad3d9f135..6bc79feff6 100644 --- a/drivers/include/nvram.h +++ b/drivers/include/nvram.h @@ -8,7 +8,7 @@ /** * @defgroup drivers_nvram Non-volatile RAM - * @ingroup drivers + * @ingroup drivers_storage * @brief Non-volatile RAM interface * * This API is designed around non-volatile memories which do not need blockwise diff --git a/drivers/include/pn532.h b/drivers/include/pn532.h index 73dc57dec2..47072ba47e 100644 --- a/drivers/include/pn532.h +++ b/drivers/include/pn532.h @@ -7,13 +7,15 @@ */ /** - * @defgroup drivers_pn532 PN532 NFC Reader - * @ingroup drivers + * @defgroup drivers_pn532 PN532 NFC Reader + * @ingroup drivers_netdev + * @brief PN532 NFC radio device driver * * @{ * @file - * @brief PN532 driver - * @author Víctor Ariño + * @brief PN532 driver + * + * @author Víctor Ariño */ #ifndef NFC_READER_INCLUDE_PN532_H diff --git a/drivers/include/sdcard_spi.h b/drivers/include/sdcard_spi.h index 0d19a56d1b..c2ed3d3dde 100644 --- a/drivers/include/sdcard_spi.h +++ b/drivers/include/sdcard_spi.h @@ -8,7 +8,7 @@ /** * @defgroup drivers_sdcard_spi SPI SD-Card driver - * @ingroup drivers + * @ingroup drivers_storage * @brief Driver for reading and writing sd-cards via spi interface. * @{ * From 17c5931125c09bf335170e1d7e2d8d8550f737f4 Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Tue, 7 Feb 2017 11:16:50 +0100 Subject: [PATCH 2/2] boards/nucleo-common: fixed doxygen groups --- boards/nucleo-common/include/arduino_pinmap.h | 2 +- boards/nucleo-common/include/board_common.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/boards/nucleo-common/include/arduino_pinmap.h b/boards/nucleo-common/include/arduino_pinmap.h index 617850eb2b..16b6210632 100644 --- a/boards/nucleo-common/include/arduino_pinmap.h +++ b/boards/nucleo-common/include/arduino_pinmap.h @@ -7,7 +7,7 @@ */ /** - * @ingroup boards_arduino-zero + * @ingroup boards_nucleo-common * @{ * * @file diff --git a/boards/nucleo-common/include/board_common.h b/boards/nucleo-common/include/board_common.h index 0aca63d094..c39aed56f7 100644 --- a/boards/nucleo-common/include/board_common.h +++ b/boards/nucleo-common/include/board_common.h @@ -8,7 +8,7 @@ /** * @defgroup boards_nucleo_common STM Nucleo Common - * @ingroup drivers_periph + * @ingroup boards * @brief Common files for STM Nucleo boards * @{ *