From da43a5e7a43a21b3f3597ff346483e394d65e1b1 Mon Sep 17 00:00:00 2001 From: Ludwig Ortmann Date: Thu, 4 Dec 2014 10:03:15 +0100 Subject: [PATCH] doc: periph: various fixes and cleanup - unify file/module @brief - distinct @file section more visibly in source - provide missing @brief's - move module details/notes from file to module sections - provide missing macro definition for building --- doc/doxygen/riot.doxyfile | 1 + drivers/include/periph/cpuid.h | 7 +++++-- drivers/include/periph/dac.h | 14 +++++++------- drivers/include/periph/gpio.h | 2 +- drivers/include/periph/i2c.h | 2 +- drivers/include/periph/pwm.h | 2 +- drivers/include/periph/random.h | 11 ++++++----- drivers/include/periph/rtc.h | 2 +- drivers/include/periph/rtt.h | 3 ++- drivers/include/periph/spi.h | 8 ++++---- 10 files changed, 29 insertions(+), 23 deletions(-) diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 7ed1422809..d2a396d24a 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -1980,6 +1980,7 @@ INCLUDE_FILE_PATTERNS = PREDEFINED = __attribute__(x)= \ ADC_NUMOF \ CPUID_ID_LEN \ + DAC_NUMOF \ GPIO_NUMOF \ I2C_NUMOF \ PWM_NUMOF \ diff --git a/drivers/include/periph/cpuid.h b/drivers/include/periph/cpuid.h index 6b3f143ada..25deae2700 100644 --- a/drivers/include/periph/cpuid.h +++ b/drivers/include/periph/cpuid.h @@ -9,10 +9,13 @@ /** * @defgroup driver_periph_cpuid CPUID * @ingroup driver_periph - * @{ + * @brief Low-level CPU ID peripheral driver * + * Provides access the CPU's serial number + * + * @{ * @file - * @brief Provides access the CPU's serial number + * @brief Low-level CPUID peripheral driver interface definitions * * @author Martine Lenders */ diff --git a/drivers/include/periph/dac.h b/drivers/include/periph/dac.h index 62d1840aca..efed0fe02d 100644 --- a/drivers/include/periph/dac.h +++ b/drivers/include/periph/dac.h @@ -10,8 +10,8 @@ * @defgroup driver_periph_dac DAC * @ingroup driver_periph * @brief Low-level DAC peripheral driver - * @{ * + * @{ * @file * @brief Low-level DAC peripheral driver interface definitions * @@ -28,15 +28,15 @@ extern "C" { #endif -/* guard file in case no ADC device is defined */ +/* guard file in case no DAC device is defined */ #if DAC_NUMOF /** - * @brief Definition avialable DAC devices - * - * Each DAC device is based on a hardware DAC which can have one or more - * independet channels. - */ + * @brief Definition avialable DAC devices + * + * Each DAC device is based on a hardware DAC which can have one or more + * independet channels. + */ typedef enum { #if DAC_0_EN DAC_0 = 0, /**< DAC device 0 */ diff --git a/drivers/include/periph/gpio.h b/drivers/include/periph/gpio.h index f766f73d11..40a0fb3f74 100644 --- a/drivers/include/periph/gpio.h +++ b/drivers/include/periph/gpio.h @@ -10,8 +10,8 @@ * @defgroup driver_periph_gpio GPIO * @ingroup driver_periph * @brief Low-level GPIO peripheral driver - * @{ * + * @{ * @file * @brief Low-level GPIO peripheral driver interface definitions * diff --git a/drivers/include/periph/i2c.h b/drivers/include/periph/i2c.h index 860391d171..34684da222 100644 --- a/drivers/include/periph/i2c.h +++ b/drivers/include/periph/i2c.h @@ -10,8 +10,8 @@ * @defgroup driver_periph_i2c I2C * @ingroup driver_periph * @brief Low-level I2C peripheral driver - * @{ * + * @{ * @file * @brief Low-level I2C peripheral driver interface definition * diff --git a/drivers/include/periph/pwm.h b/drivers/include/periph/pwm.h index aae23e8495..14b492cf96 100644 --- a/drivers/include/periph/pwm.h +++ b/drivers/include/periph/pwm.h @@ -10,8 +10,8 @@ * @defgroup driver_periph_pwm PWM * @ingroup driver_periph * @brief Low-level PWM peripheral driver - * @{ * + * @{ * @file * @brief Low-level PWM peripheral driver interface definitions * diff --git a/drivers/include/periph/random.h b/drivers/include/periph/random.h index e49c8381c4..c0b4823dd9 100644 --- a/drivers/include/periph/random.h +++ b/drivers/include/periph/random.h @@ -9,12 +9,9 @@ /** * @defgroup driver_periph_random Random * @ingroup driver_periph - * @{ + * @brief Low-level (pseudo) random number generator driver * - * @file - * @brief (Pseudo) random number generator low-level driver interface - * - * NOTE: The quality of the random data read from this interface is highly + * The quality of the random data read from this interface is highly * dependent on hardware dependent implementation. Most platforms utilize a * hardware (Pseudo) Random Number Generator. The quality of the generated * random data can be however very different. @@ -22,6 +19,10 @@ * @note REFER TO YOUR PLATFORMS IMPLEMENTATION ABOUT INFORMATION ABOUT THE * QUALITY OF RANDOMNES! * + * @{ + * @file + * @brief Low-level random peripheral driver interface definitions + * * @author Christian Mehlis */ diff --git a/drivers/include/periph/rtc.h b/drivers/include/periph/rtc.h index 128484d530..6e5941cecb 100644 --- a/drivers/include/periph/rtc.h +++ b/drivers/include/periph/rtc.h @@ -10,8 +10,8 @@ * @defgroup driver_periph_rtc RTC * @ingroup driver_periph * @brief Low-level RTC (Real Time Clock) peripheral driver - * @{ * + * @{ * @file * @brief Low-level RTC peripheral driver interface definitions * diff --git a/drivers/include/periph/rtt.h b/drivers/include/periph/rtt.h index 2d0eb7e7ac..8ed18cb0f5 100644 --- a/drivers/include/periph/rtt.h +++ b/drivers/include/periph/rtt.h @@ -9,8 +9,9 @@ /** * @defgroup driver_periph_rtt RTT * @ingroup driver_periph - * @{ + * @brief Low-level RTT (Real Time Timer) peripheral driver * + * @{ * @file * @brief Low-level RTT (Real Time Timer) peripheral driver interface * definitions diff --git a/drivers/include/periph/spi.h b/drivers/include/periph/spi.h index 0acf736dbd..b1c6016606 100644 --- a/drivers/include/periph/spi.h +++ b/drivers/include/periph/spi.h @@ -10,15 +10,15 @@ * @defgroup driver_periph_spi SPI * @ingroup driver_periph * @brief Low-level SPI peripheral driver - * @{ - * - * @file - * @brief Low-level SPI peripheral driver interface definitions * * The current design of this interface targets implementations that use the SPI in blocking mode. * * TODO: add means for asynchronous SPI usage * + * @{ + * @file + * @brief Low-level SPI peripheral driver interface definitions + * * @author Hauke Petersen */