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

doc: fix doxygen grouping of cpu periph drivers

This commit is contained in:
smlng 2017-06-22 15:43:17 +02:00
parent 9d3f9f2589
commit 692cf96297
132 changed files with 282 additions and 76 deletions

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_arm7_common
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_atmega_common
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_atmega_common
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -8,7 +8,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_atmega_common
* @ingroup drivers_periph_spi
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_atmega_common
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_atmega_common
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_cc2538
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_cc2538
* @ingroup drivers_periph_hwng
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @addtogroup driver_periph
* @ingroup cpu_cc2538
* @ingroup drivers_periph
* @{
*
* @file

View File

@ -8,7 +8,8 @@
*/
/**
* @addtogroup cpu_cc2538
* @ingroup cpu_cc2538
* @ingroup drivers_periph_spi
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_cc2538
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_cc2538
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_cc26x0
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_cc26x0
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_cc26x0
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -8,10 +8,15 @@
*/
/**
* @ingroup driver_periph_rtc
* @ingroup cc430
* @ingroup drivers_periph_rtc
* @{
*
* @file
* @brief CC430 real time clock implementation
* @author Oliver Hahm <oliver.hahm@inria.fr>
*
* @}
*/
#include <string.h>

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup cpu_cc430
* @ingroup cc430
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_cortexm_common
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_ezr32wg
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_ezr32wg
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_ezr32wg
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup cpu_kinetis_common_adc
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_adc
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup cpu_kinetis_common_dac
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_dac
*
* @{
*

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup cpu_kinetis_common_gpio
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_gpio
*
* @{
*

View File

@ -8,7 +8,8 @@
*/
/**
* @ingroup cpu_kinetis_common_rnga
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_hwng
*
* @{
*

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup cpu_kinetis_common_rngb
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_hwng
* @{
*
* @file

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup cpu_kinetis_common_i2c
* @ingroup cpu_kinetis_commo
* @ingroup drivers_periph_i2c
*
* @note This driver only implements the 7-bit addressing master mode.
*

View File

@ -8,7 +8,8 @@
*/
/**
* @ingroup cpu_kinetis_common_mcg
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_mcg
* @{
*
* @file

View File

@ -10,6 +10,7 @@
/**
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup cpu_kinetis_common_pwm
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_pwm
*
* @{
*

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup cpu_kinetis_common_rtt
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_rtc
*
* @{
*

View File

@ -8,7 +8,8 @@
*/
/**
* @ingroup cpu_kinetis_common_rtt
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_rtt
*
* @{
*

View File

@ -10,7 +10,8 @@
*/
/**
* @ingroup cpu_kinetis_common_spi
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_spi
*
* @{
*

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup cpu_kinetis_common_timer
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_timer
*
* @{
*

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup cpu_kinetis_common_uart
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_uart
*
* @{
*

View File

@ -8,7 +8,8 @@
*/
/**
* @ingroup cpu_kinetis_common_wdog
* @ingroup cpu_kinetis_common
* @ingroup drivers_periph_watchdog
*
* @{
*

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lm4f120
* @ingroup drivers_periph_adc
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lm4f120
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_lm4f120
* @ingroup drivers_periph_timer
* @{
*
* @file timer.c

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lm4f120
* @ingroup drivers_periph_uart
* @{
*
* @file uart.c

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc11u34
* @ingroup drivers_periph_adc
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc11u34
* @ingroup drivers_periph_cpuid
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc11u34
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup lpc11u34
* @ingroup drivers_periph_pwm
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_lpc11u34
* @ingroup drivers_periph_spi
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc11u34
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc11u34
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_lpc1768
* @ingroup drivers_periph_cpuid
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc1768
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc1768
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup lpc2387
* @ingroup cpu_lpc2387
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc2387
* @ingroup drivers_periph_pwm
* @{
*
* @file

View File

@ -7,6 +7,19 @@
* directory for more details.
*/
/**
* @ingroup cpu_lpc2387
* @ingroup drivers_periph_rtc
* @{
*
* @file
* @brief Peripheral UART driver implementation
*
* @author Kaspar Schleiser <kaspar@schleiser.de>
*
* @}
*/
#include <sys/time.h>
#include <stdint.h>
#include <string.h>

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_lpc2387
* @ingroup drivers_periph_spi
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc2387
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_lpc2387
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup cpu_mips32r2_common
* @ingroup cpu_mips32r2_common
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -6,6 +6,17 @@
* directory for more details.
*/
/**
* @ingroup cpu_mips32r2_common
* @ingroup drivers_periph_timer
* @{
*
* @file
* @brief Implementation of the low-level timer driver
*
* @}
*/
#include <mips/cpu.h>
#include <mips/m32c0.h>
#include <mips/regdef.h>

View File

@ -8,6 +8,17 @@
*
*/
/**
* @ingroup cpu_mips_pic32_common
* @ingroup drivers_periph_gpio
* @{
*
* @file
* @brief Low-level GPIO driver implementation
*
* @}
*/
#include <assert.h>
#include <stdint.h>
#include "periph/gpio.h"

View File

@ -7,6 +7,17 @@
* directory for more details.
*
*/
/**
* @ingroup cpu_mips_pic32_common
* @ingroup drivers_periph_uart
* @{
*
* @file
* @brief Peripheral UART driver implementation
*
* @}
*/
#include <assert.h>
#include "periph/uart.h"
#include "board.h"

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_msp430_common
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_msp430fxyz
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_msp430fxyz
* @ingroup drivers_periph_spi
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_msp430fxyz
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_msp430fxyz
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @addtogroup cpu_native
* @ingroup cpu_native
* @ingroup drivers_periph_cpuid
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup native_cpu
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -9,7 +9,7 @@
/**
* @ingroup native_cpu
* @defgroup native_rng
* @ingroup drivers_periph_hwrng
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup native_cpu
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -7,16 +7,19 @@
*/
/**
* Native CPU periph/rtc.h implementation
* @ingroup cpu_native
* @ingroup drivers_periph_rtc
* @{
*
* @file
* @brief Native CPU periph/rtc.h implementation
*
* The implementation uses POSIX system calls to emulate a real-time
* clock based on the system clock.
*
* @author Ludwig Knüpfer <ludwig.knuepfer@fu-berlin.de>
*
* @ingroup _native_cpu
* @defgroup _native_rtc
* @file
* @}
*/
#include <time.h>

View File

@ -5,20 +5,24 @@
* 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
* directory for more details.
*
* @ingroup timer
* @ingroup native_cpu
*/
/**
* @ingroup native_cpu
* @ingroup drivers_periph_timer
* @{
* @author Ludwig Knüpfer <ludwig.knuepfer@fu-berlin.de>
* @author Kaspar Schleiser <kaspar@schleiser.de>
*
* @file
* @brief Native CPU periph/timer.h implementation
* @brief Native CPU periph/timer.h implementation
*
* Uses POSIX realtime clock and POSIX itimer to mimic hardware.
*
* This is based on native's hwtimer implementation by Ludwig Knüpfer.
* I removed the multiplexing, as xtimer does the same. (kaspar)
*
* @author Ludwig Knüpfer <ludwig.knuepfer@fu-berlin.de>
* @author Kaspar Schleiser <kaspar@schleiser.de>
*
* @}
*/

View File

@ -8,12 +8,15 @@
/**
* @ingroup native_cpu
* @ingroup drivers_periph_uart
* @{
*
* @file
* @brief UART implementation based on /dev/tty devices on host
*
* @author Takuo Yonezawa <Yonezawa-T2@mail.dnp.co.jp>
*
* @}
*/
#include <errno.h>
@ -174,5 +177,3 @@ void uart_write(uart_t uart, const uint8_t *data, size_t len)
_native_write(tty_fds[uart], data, len);
}
/** @} */

View File

@ -8,15 +8,13 @@
*/
/**
* @ingroup cpu_nrf51822
* @ingroup cpu_nrf51
* @ingroup drivers_periph_adc
* @{
*
* @file
* @brief Low-level ADC driver implementation
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Ludwig Knüpfer <ludwig.knuepfer@fu-berlin.de>
*
* @}
*/

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_nrf51
* @ingroup drivers_periph_i2c
* @{
*
* @file
@ -17,7 +18,16 @@
*
* @}
*/
/**
* @ingroup cpu_nrf51
* @ingroup drivers_periph_i2c
* @{
*
* @file
* @brief Low-level I2V driver implementation
*
* @}
*/
#include "cpu.h"
#include "mutex.h"
#include "assert.h"

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_nrf5x_common
* @ingroup drivers_periph_flashpage
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_nrf5x_common
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_nrf5x_common
* @ingroup drivers_periph_hwrng
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_nrf5x_common
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_nrf5x_common
* @ingroup drivers_periph_rtt
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_nrf5x_common
* @ingroup drivers_periph_spi
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_nrf5x_common
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -10,6 +10,7 @@
/**
* @ingroup cpu_nrf5x_common
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -8,6 +8,16 @@
* directory for more details.
*/
/**
* @ingroup cpu_sam0_common
* @ingroup drivers_periph_adc
* @{
*
* @file
* @brief Low-level ADC driver implementation
*
* @}
*/
#include <stdint.h>
#include "cpu.h"
#include "periph/gpio.h"

View File

@ -7,7 +7,8 @@
*/
/**
* @addtogroup cpu_sam0_common
* @ingroup cpu_sam0_common
* @ingroup drivers_periph_cpuid
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_sam0_common
* @ingroup drivers_periph_adc
* @{
*
* @file

View File

@ -7,12 +7,16 @@
*/
/**
* @ingroup cpu_samd21
* @ingroup cpu_sam0_common
* @ingroup drivers_periph_i2c
* @{
*
* @file
* @brief Low-level I2C driver implementation
*
* @author Baptiste Clenet <bapclenet@gmail.com>
* @author Thomas Eichinger <thomas.eichinger@fu-berlin.de>
*
* @}
*/

View File

@ -9,7 +9,8 @@
*/
/**
* @ingroup cpu_samd21
* @ingroup cpu_sam0_common
* @ingroup drivers_periph_spi
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @addtogroup cpu_sam3
* @ingroup cpu_sam3
* @ingroup drivers_periph_cpuid
* @{
*
* @file

View File

@ -10,6 +10,7 @@
/**
* @ingroup cpu_sam3
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_sam3
* @ingroup drivers_periph_hwrng
* @{
*
* @file

View File

@ -8,7 +8,8 @@
*/
/**
* @ingroup cpu_sam3x8e
* @ingroup cpu_sam3
* @ingroup drivers_periph_pwm
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_sam3
* @ingroup drivers_periph_spi
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_sam3
* @ingroup drivers_periph_timer
* @{
*
* @file

View File

@ -8,6 +8,7 @@
/**
* @ingroup cpu_sam3
* @ingroup drivers_periph_uart
* @{
*
* @file

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_samd21
* @ingroup drivers_periph_gpio
* @{
*
* @file

View File

@ -10,6 +10,7 @@
/**
* @ingroup cpu_samd21
* @ingroup drivers_periph_pm
* @{
*
* @file

View File

@ -9,6 +9,7 @@
/**
* @ingroup cpu_samd21
* @ingroup drivers_periph_pwm
* @{
*
* @file

View File

@ -8,10 +8,14 @@
/**
* @ingroup cpu_samd21
* @ingroup drivers_periph_rtc
* @{
*
* @file
* @brief Low-level RTC driver implementation
*
* @author Baptiste Clenet <bapclenet@gmail.com>
*
* @}
*/

View File

@ -8,10 +8,14 @@
/**
* @ingroup cpu_samd21
* @ingroup drivers_periph_rtt
* @{
*
* @file
* @brief Low-level RTT driver implementation
*
* @author Daniel Krebs <github@daniel-krebs.net>
*
* @}
*/

View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup driver_periph
* @ingroup cpu_samd21
* @ingroup drivers_periph_timer
* @{
*
* @file

Some files were not shown because too many files have changed in this diff Show More