kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-24 22:13:52 +01:00
Code Releases Activity

Merge pull request #1229 from OlegHahm/description_unification

Browse Source 
Unification of descriptive text of similar modules
This commit is contained in:
Martine Lenders 2014-05-25 12:45:21 +02:00
commit 1bee1e1184
20 changed files with 88 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
boards/arduino-due/include/board.h
View File

@ -9,7 +9,7 @@
/**
* @defgroup board_arduino-due Arduino Due
* @ingroup boards
* @brief Board specific files for the Arduino Due board.
* @brief Support for the Arduino Due board.
* @{
*
* @file board.h

4
boards/avsextrem/include/board.h
View File

@ -10,11 +10,11 @@
/**
* @defgroup boards_avsextrem Avsextrem
* @ingroup boards
* @brief Boards specific drivers and configuration for the Avsextrem board
* @brief Support for the Avsextrem board
* @{
*
* @file board.h
* @brief avsextrem board configuration
* @brief Boards specific drivers and configuration for the Avsextrem board
*
* @author Freie Universität Berlin, Computer Systems & Telematics
* @author Heiko Will

1
boards/mbed_lpc1768/include/board.h
View File

@ -7,6 +7,7 @@
*
* @defgroup mbed_lpc1768 mbed NXP LPC1768 development kit
* @ingroup boards
* @brief Support for the mbed NXP LPC1768 board.
* @{
*/

2
boards/msb-430/include/board.h
View File

@ -27,7 +27,7 @@ and the mailinglist (subscription via web site)
/**
* @defgroup boards_msb430 MSB-430
* @ingroup boards
* @brief Support for the msb-430 board
* @brief Support for the ScatterWeb MSB-430 board
*
* <h2>Compontents</h2>
* \li MSP430

2
boards/msba2/include/board.h
View File

@ -9,7 +9,7 @@
/**
* @defgroup boards_msba2 MSB-A2
* @ingroup boards
* @brief Support for the MSB-A2 board
* @brief Support for the ScatterWeb MSB-A2 board
* @{
*
* @file board.h

2
boards/udoo/include/board.h
View File

@ -9,7 +9,7 @@
/**
* @defgroup board_udoo UDOO
* @ingroup boards
* @brief Board specific files for the UDOO board.
* @brief Support for the UDOO board.
* @{
*
* @file board.h

1
boards/z1/include/board.h
View File

@ -13,6 +13,7 @@
/**
* @defgroup board_z1 Zolertia Z1
* @ingroup boards
* @brief Support for the Zolertia Z1 board.
*
<h2>Components</h2>
\li MSP430F2617

123
cpu/arm_common/include/arm_common.h
View File

@ -1,101 +1,94 @@
/******************************************************************************
* Copyright 2008-2009, Freie Universitaet Berlin (FUB). All rights reserved.
/*
* Copyright (C) 2008-2009, 2014 Freie Universität Berlin
*
* These sources were developed at the Freie Universitaet Berlin, Computer Systems
* and Telematics group (http://cst.mi.fu-berlin.de).
* -------------------------------------------------------------------------------
* This file is part of RIOT.
* This file is subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*
*******************************************************************************/
* Public License v2.1. See the file LICENSE in the top level directory for
* more details.
*/
#ifndef __ARM_COMMON_H
#define __ARM_COMMON_H
/**
* @defgroup arm_common ARM CPU common
* @ingroup cpu
* @defgroup arm_common ARM CPU common
* @brief Common implementations and headers for ARM based micro-controllers
* @ingroup cpu
* @{
*/
/**
* @file
* @brief ARM CPU common declarations
* @brief ARM CPU common declarations
*
* @author Freie Universität Berlin, Computer Systems & Telematics
* @version $Revision$
*
* @note $Id$
*/
#include "bitarithm.h"
/**
* @name PCONP Constants
* @name PCONP Constants
* @{
*/
#define PCTIM0 BIT1
#define PCTIM1 BIT2
#define PCUART0 BIT3
#define PCUART1 BIT4
#define PCPWM1 BIT6
#define PCI2C0 BIT7
#define PCSPI BIT8
#define PCRTC BIT9
#define PCSSP1 BIT10
#define PCEMC BIT11
#define PCAD BIT12
#define PCAN1 BIT13
#define PCAN2 BIT14
#define PCI2C1 BIT19
#define PCSSP0 BIT21
#define PCTIM2 BIT22
#define PCTIM3 BIT23
#define PCUART2 BIT24
#define PCUART3 BIT25
#define PCI2C2 BIT26
#define PCI2S BIT27
#define PCSDC BIT28
#define PCGPDMA BIT29
#define PCENET BIT30
#define PCUSB BIT31
#define PCTIM0 (BIT1)
#define PCTIM1 (BIT2)
#define PCUART0 (BIT3)
#define PCUART1 (BIT4)
#define PCPWM1 (BIT6)
#define PCI2C0 (BIT7)
#define PCSPI (BIT8)
#define PCRTC (BIT9)
#define PCSSP1 (BIT10)
#define PCEMC (BIT11)
#define PCAD (BIT12)
#define PCAN1 (BIT13)
#define PCAN2 (BIT14)
#define PCI2C1 (BIT19)
#define PCSSP0 (BIT21)
#define PCTIM2 (BIT22)
#define PCTIM3 (BIT23)
#define PCUART2 (BIT24)
#define PCUART3 (BIT25)
#define PCI2C2 (BIT26)
#define PCI2S (BIT27)
#define PCSDC (BIT28)
#define PCGPDMA (BIT29)
#define PCENET (BIT30)
#define PCUSB (BIT31)
/** @} */
/**
* @name PCON Constants
* @name PCON Constants
* @{
*/
#define PM0 BIT0
#define PM1 BIT1
#define BODPDM BIT2
#define BOGD BIT3
#define BORD BIT4
#define PM2 BIT7
#define PM0 (BIT0)
#define PM1 (BIT1)
#define BODPDM (BIT2)
#define BOGD (BIT3)
#define BORD (BIT4)
#define PM2 (BIT7)
#define PM_IDLE (PM0)
#define PM_SLEEP (PM2|PM0)
#define PM_POWERDOWN (PM1)
#define PM_IDLE (PM0)
#define PM_SLEEP (PM2|PM0)
#define PM_POWERDOWN (PM1)
/** @} */
/**
* @name Timer Symbols
* @name Timer Symbols
* @{
*/
#define MR0I BIT0
#define MR0R BIT1
#define MR0S BIT2
#define MR1I BIT3
#define MR1R BIT4
#define MR1S BIT5
#define MR2I BIT6
#define MR2R BIT7
#define MR2S BIT8
#define MR3I BIT9
#define MR3R BIT10
#define MR3S BIT11
#define MR0I (BIT0)
#define MR0R (BIT1)
#define MR0S (BIT2)
#define MR1I (BIT3)
#define MR1R (BIT4)
#define MR1S (BIT5)
#define MR2I (BIT6)
#define MR2R (BIT7)
#define MR2S (BIT8)
#define MR3I (BIT9)
#define MR3R (BIT10)
#define MR3S (BIT11)
/** @} */
/** @} */

1
cpu/cc430/include/cc430-rtc.h
View File

@ -16,7 +16,6 @@ See the file LICENSE in the top level directory for more details.
#include "time.h"
/**
* @defgroup cc430_rtc CC430 Real Time Clock
* @ingroup cc430
*/

16
cpu/cortexm_common/doc.txt
View File

@ -1,40 +1,40 @@
/**
* @defgroup cortexm Cortex-M
* @defgroup cpu_cortexm Cortex-M
* @brief ARM Cortex-M specific code
* @ingroup cpu
*/
/**
* @defgroup CMSIS_Core_FunctionInterface
* @ingroup cortexm
* @ingroup cpu_cortexm
*/
/**
* @defgroup CMSIS_core_register
* @ingroup cortexm
* @ingroup cpu_cortexm
*/
/**
* @defgroup CMSIS_glob_defs
* @ingroup cortexm
* @ingroup cpu_cortexm
*/
/**
* @defgroup CMSIS_MISRA_Exceptions
* @ingroup cortexm
* @ingroup cpu_cortexm
*/
/**
* @defgroup CMSIS_core_definitions
* @ingroup cortexm
* @ingroup cpu_cortexm
*/
/**
* @defgroup CMSIS_SIMD_intrinsics
* @ingroup cortexm
* @ingroup cpu_cortexm
*/
/**
* @defgroup CMSIS_Core_InstructionInterface
* @ingroup cortexm
* @ingroup cpu_cortexm
*/

4
cpu/cortexm_common/include/cpu.h
View File

@ -7,9 +7,7 @@
*/
/**
* @defgroup cpu_cortexm_common ARM Cortex-M common files
* @ingroup cpu
* @brief Common implementations and headers for Cortex-M family based micro-controllers
* @addtogroup cpu_cortexm
* @{
*
* @file cpu.h

1
cpu/lpc1768/include/cmsis.h
View File

@ -6,6 +6,7 @@
/**
* @defgroup CMSIS
* @brief Cortex Microcontroller Software Interface Standard
* @ingroup cpu
* @{
*

3
cpu/lpc1768/include/cpu.h
View File

@ -3,7 +3,8 @@
/**
* @defgroup lpc1768 NXP LPC1768
* @ingroup cpu
* @brief NXP LPC1768 specific code
* @ingroup cpu
* @{
*/

10
cpu/native/include/cpu.h
View File

@ -1,8 +1,4 @@
/**
* Native CPU interface
*
* The native CPU uses system calls to simulate hardware access.
*
/*
* Copyright (C) 2013 Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
*
* This file is subject to the terms and conditions of the GNU Lesser General
@ -12,7 +8,9 @@
/**
* @ingroup arch
* @defgroup native_cpu Native CPU
* @defgroup native_cpu Native
* @brief Native CPU specific code
* @details The native CPU uses system calls to simulate hardware access.
* @ingroup cpu
* @brief CPU abstraction for the native port
* @{

2
cpu/sam3x8e/doc.txt
View File

@ -1,7 +1,7 @@
/**
* @defgroup cpu_sam3x8e Atmel SAM3X8E
* @ingroup cpu
* @brief Implementation of Atmel's SAM3X8E Cortex-M3 MCU
* @brief Atmel SAM3X8E Cortex-M3 MCU specific code
*/
/**

2
drivers/cc110x/cc1100.h
View File

@ -15,7 +15,7 @@
/**
* @defgroup drivers_cc110x CC110x
* @ingroup drivers
* @brief Texas Instruments CC110x driver
* @brief Driver for Texas Instruments CC110x (including CMSA/CA MAC)
*
* <h3>Quick links</h3>
* \li \ref cc1100_packet_layer0_t MAC packet format

2
drivers/include/adc.h
View File

@ -1,7 +1,7 @@
/**
* @defgroup drivers_adc ADC
* @ingroup drivers
* @brief Generic ADC driver
* @brief Generic interface for ADC drivers
* @{
*
* @file adc.h

2
drivers/include/cc110x_ng/cc110x-interface.h
View File

@ -9,7 +9,7 @@
/**
* @defgroup drivers_cc110x_ng CC110x_ng
* @brief Next generation version of the TI CC110x driver
* @brief Driver for Texas Instruments CC110x (without MAC protocol)
* @ingroup drivers
* @{
*

2
drivers/include/rtc.h
View File

@ -15,7 +15,7 @@ and Telematics group (http://cst.mi.fu-berlin.de).
/**
* @defgroup rtc Realtime Clock
* @ingroup drivers
* @brief Generic real time clock driver
* @brief Generic real time clock driver interface
* @{
*/

1
drivers/include/sht11.h
View File

@ -17,6 +17,7 @@ and Telematics group (http://cst.mi.fu-berlin.de).
/**
* @defgroup sht11 SHT11
* @brief Driver for Sensirion SHT11 Humidity and Temperature Sensor
* @ingroup drivers
* @{
*