RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

drivers/periph: some doxygen fixes

Browse Source 
- added todos to periph module description
- repaired group names (e.g. s/driver_xx/drivers_xx/)
This commit is contained in:
Hauke Petersen 2015-11-19 15:54:52 +01:00
parent 80b8d2ed37
commit 77b790375f
14 changed files with 39 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
drivers/include/periph/adc.h
View File

@ -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
* @{
*

4
drivers/include/periph/cpuid.h
View File

@ -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

4
drivers/include/periph/dac.h
View File

@ -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
*
* @{

6
drivers/include/periph/dev_enums.h
View File

@ -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 <hauke.petersen@fu-berlin.de>
*/

18
drivers/include/periph/doc.txt
View File

@ -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
*/

4
drivers/include/periph/gpio.h
View File

@ -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
*
* @{

4
drivers/include/periph/i2c.h
View File

@ -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
*
* @{

4
drivers/include/periph/pwm.h
View File

@ -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
*
* @{

4
drivers/include/periph/random.h
View File

@ -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

4
drivers/include/periph/rtc.h
View File

@ -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

4
drivers/include/periph/rtt.h
View File

@ -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
*
* @{

4
drivers/include/periph/spi.h
View File

@ -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.

4
drivers/include/periph/timer.h
View File

@ -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
* @{
*

4
drivers/include/periph/uart.h
View File

@ -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
* @{
*