From 77b790375f4e6899a6a30b62b8be6b66564d41ae Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Thu, 19 Nov 2015 15:54:52 +0100 Subject: [PATCH] drivers/periph: some doxygen fixes - added todos to periph module description - repaired group names (e.g. s/driver_xx/drivers_xx/) --- drivers/include/periph/adc.h | 4 ++-- drivers/include/periph/cpuid.h | 4 ++-- drivers/include/periph/dac.h | 4 ++-- drivers/include/periph/dev_enums.h | 6 +++--- drivers/include/periph/doc.txt | 18 ++++++++++++------ drivers/include/periph/gpio.h | 4 ++-- drivers/include/periph/i2c.h | 4 ++-- drivers/include/periph/pwm.h | 4 ++-- drivers/include/periph/random.h | 4 ++-- drivers/include/periph/rtc.h | 4 ++-- drivers/include/periph/rtt.h | 4 ++-- drivers/include/periph/spi.h | 4 ++-- drivers/include/periph/timer.h | 4 ++-- drivers/include/periph/uart.h | 4 ++-- 14 files changed, 39 insertions(+), 33 deletions(-) diff --git a/drivers/include/periph/adc.h b/drivers/include/periph/adc.h index d6c841087b..b009dc8129 100644 --- a/drivers/include/periph/adc.h +++ b/drivers/include/periph/adc.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_adc ADC - * @ingroup driver_periph + * @defgroup drivers_periph_adc ADC + * @ingroup drivers_periph * @brief Low-level ADC peripheral driver * @{ * diff --git a/drivers/include/periph/cpuid.h b/drivers/include/periph/cpuid.h index 7929659019..fabcd011cc 100644 --- a/drivers/include/periph/cpuid.h +++ b/drivers/include/periph/cpuid.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_cpuid CPUID - * @ingroup driver_periph + * @defgroup drivers_periph_cpuid CPUID + * @ingroup drivers_periph * @brief Low-level CPU ID peripheral driver * * Provides access the CPU's serial number diff --git a/drivers/include/periph/dac.h b/drivers/include/periph/dac.h index b827ece489..bf30e546ae 100644 --- a/drivers/include/periph/dac.h +++ b/drivers/include/periph/dac.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_dac DAC - * @ingroup driver_periph + * @defgroup drivers_periph_dac DAC + * @ingroup drivers_periph * @brief Low-level DAC peripheral driver * * @{ diff --git a/drivers/include/periph/dev_enums.h b/drivers/include/periph/dev_enums.h index 95e026ad8d..f8238913e5 100644 --- a/drivers/include/periph/dev_enums.h +++ b/drivers/include/periph/dev_enums.h @@ -7,15 +7,15 @@ */ /** - * @ingroup driver_periph + * @ingroup drivers_periph * * @{ * @file * @brief Device enumerations for backward compatibility with existing * peripheral driver implementations * - * TODO: Remove this file once all peripheral drivers are ported to the more - * efficient implementations style + * @todo Remove this file once all peripheral drivers are ported to the + * more efficient implementations style * * @author Hauke Petersen */ diff --git a/drivers/include/periph/doc.txt b/drivers/include/periph/doc.txt index fa91a5cc2f..3dc1a49533 100644 --- a/drivers/include/periph/doc.txt +++ b/drivers/include/periph/doc.txt @@ -1,5 +1,5 @@ /* - * Copyright (C) 2013 Freie Universität Berlin + * Copyright (C) 2013-2015 Freie Universität Berlin * * 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 @@ -7,11 +7,17 @@ */ /** - * @defgroup driver_periph Peripheral drivers + * @defgroup drivers_periph Peripheral Driver Interface * @ingroup drivers - * @brief Low-level peripheral drivers + * @brief Low-level peripheral driver interface for vendor and platform + * independent access to MCU peripherals as UART, SPI, etc * - * The module contains the low-level peripheral driver layer. It consists of a set - * of platform independent interface definitions and cpu specific implementations - * for every targeted platform. + * The module contains the low-level peripheral driver interface. This interface + * defines a standardized interface to access MCU peripherals that is not tied + * to any specific vendor, platform or architecture. + * + * @todo describe concept in detail + * @todo link to driver model + * @todo describe/link implementation guide + * @todo list best practices */ diff --git a/drivers/include/periph/gpio.h b/drivers/include/periph/gpio.h index c8c6cae878..cef16f3020 100644 --- a/drivers/include/periph/gpio.h +++ b/drivers/include/periph/gpio.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_gpio GPIO - * @ingroup driver_periph + * @defgroup drivers_periph_gpio GPIO + * @ingroup drivers_periph * @brief Low-level GPIO peripheral driver * * @{ diff --git a/drivers/include/periph/i2c.h b/drivers/include/periph/i2c.h index 052e3272f4..81ffebc4d6 100644 --- a/drivers/include/periph/i2c.h +++ b/drivers/include/periph/i2c.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_i2c I2C - * @ingroup driver_periph + * @defgroup drivers_periph_i2c I2C + * @ingroup drivers_periph * @brief Low-level I2C peripheral driver * * @{ diff --git a/drivers/include/periph/pwm.h b/drivers/include/periph/pwm.h index a64eebcfa0..875131060d 100644 --- a/drivers/include/periph/pwm.h +++ b/drivers/include/periph/pwm.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_pwm PWM - * @ingroup driver_periph + * @defgroup drivers_periph_pwm PWM + * @ingroup drivers_periph * @brief Low-level PWM peripheral driver * * @{ diff --git a/drivers/include/periph/random.h b/drivers/include/periph/random.h index 7eb587d961..4b93adeccd 100644 --- a/drivers/include/periph/random.h +++ b/drivers/include/periph/random.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_random Random - * @ingroup driver_periph + * @defgroup drivers_periph_random Random + * @ingroup drivers_periph * @brief Low-level (pseudo) random number generator driver * * The quality of the random data read from this interface is highly diff --git a/drivers/include/periph/rtc.h b/drivers/include/periph/rtc.h index 9e336043ad..935bb30afa 100644 --- a/drivers/include/periph/rtc.h +++ b/drivers/include/periph/rtc.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_rtc RTC - * @ingroup driver_periph + * @defgroup drivers_periph_rtc RTC + * @ingroup drivers_periph * @brief Low-level RTC (Real Time Clock) peripheral driver * * @note diff --git a/drivers/include/periph/rtt.h b/drivers/include/periph/rtt.h index 7157e77173..3675c4fa44 100644 --- a/drivers/include/periph/rtt.h +++ b/drivers/include/periph/rtt.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_rtt RTT - * @ingroup driver_periph + * @defgroup drivers_periph_rtt RTT + * @ingroup drivers_periph * @brief Low-level RTT (Real Time Timer) peripheral driver * * @{ diff --git a/drivers/include/periph/spi.h b/drivers/include/periph/spi.h index 042408b2de..cd7151e7a4 100644 --- a/drivers/include/periph/spi.h +++ b/drivers/include/periph/spi.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_spi SPI - * @ingroup driver_periph + * @defgroup drivers_periph_spi SPI + * @ingroup drivers_periph * @brief Low-level SPI peripheral driver * * The current design of this interface targets implementations that use the SPI in blocking mode. diff --git a/drivers/include/periph/timer.h b/drivers/include/periph/timer.h index 623fccc595..7bc6210c05 100644 --- a/drivers/include/periph/timer.h +++ b/drivers/include/periph/timer.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_timer Timer - * @ingroup driver_periph + * @defgroup drivers_periph_timer Timer + * @ingroup drivers_periph * @brief Low-level timer peripheral driver * @{ * diff --git a/drivers/include/periph/uart.h b/drivers/include/periph/uart.h index a652b89749..c29f3b4b26 100644 --- a/drivers/include/periph/uart.h +++ b/drivers/include/periph/uart.h @@ -7,8 +7,8 @@ */ /** - * @defgroup driver_periph_uart UART - * @ingroup driver_periph + * @defgroup drivers_periph_uart UART + * @ingroup drivers_periph * @brief Low-level UART peripheral driver * @{ *