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

Merge pull request #1202 from OlegHahm/cortex_doxygen_cleanup

Browse Source 
documentation: cleanup doxygen for SAM3x8e and Z1
This commit is contained in:
Oleg Hahm 2014-05-19 11:34:32 +02:00
commit e980f82f99
30 changed files with 60 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -11,8 +11,8 @@
#define _Z1_BOARD_H #define _Z1_BOARD_H
/** /**
* @defgroup board_z1 * @defgroup board_z1 Zolertia Z1
* @ingroup board_z1 * @ingroup boards
* *
<h2>Components</h2> <h2>Components</h2>
\li MSP430F2617 \li MSP430F2617

3
cpu/sam3x8e/include/component/component_adc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Analog-to-digital Converter */ /** SOFTWARE API DEFINITION FOR Analog-to-digital Converter */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_ADC Analog-to-digital Converter */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_ADC Analog-to-digital Converter */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_can.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Controller Area Network */ /** SOFTWARE API DEFINITION FOR Controller Area Network */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_CAN Controller Area Network */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_CAN Controller Area Network */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_chipid.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Chip Identifier */ /** SOFTWARE API DEFINITION FOR Chip Identifier */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_CHIPID Chip Identifier */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_CHIPID Chip Identifier */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_dacc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Digital-to-Analog Converter Controller */ /** SOFTWARE API DEFINITION FOR Digital-to-Analog Converter Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_DACC Digital-to-Analog Converter Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_DACC Digital-to-Analog Converter Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_dmac.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR DMA Controller */ /** SOFTWARE API DEFINITION FOR DMA Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_DMAC DMA Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_DMAC DMA Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_efc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Embedded Flash Controller */ /** SOFTWARE API DEFINITION FOR Embedded Flash Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_EFC Embedded Flash Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_EFC Embedded Flash Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_emac.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Ethernet MAC 10/100 */ /** SOFTWARE API DEFINITION FOR Ethernet MAC 10/100 */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_EMAC Ethernet MAC 10/100 */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_EMAC Ethernet MAC 10/100 */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_gpbr.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR General Purpose Backup Register */ /** SOFTWARE API DEFINITION FOR General Purpose Backup Register */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_GPBR General Purpose Backup Register */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_GPBR General Purpose Backup Register */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_hsmci.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR High Speed MultiMedia Card Interface */ /** SOFTWARE API DEFINITION FOR High Speed MultiMedia Card Interface */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_HSMCI High Speed MultiMedia Card Interface */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_HSMCI High Speed MultiMedia Card Interface */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_matrix.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR AHB Bus Matrix */ /** SOFTWARE API DEFINITION FOR AHB Bus Matrix */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_MATRIX AHB Bus Matrix */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_MATRIX AHB Bus Matrix */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_pdc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Peripheral DMA Controller */ /** SOFTWARE API DEFINITION FOR Peripheral DMA Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_PDC Peripheral DMA Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_PDC Peripheral DMA Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_pio.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Parallel Input/Output Controller */ /** SOFTWARE API DEFINITION FOR Parallel Input/Output Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_PIO Parallel Input/Output Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_PIO Parallel Input/Output Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_pmc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Power Management Controller */ /** SOFTWARE API DEFINITION FOR Power Management Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_PMC Power Management Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_PMC Power Management Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_pwm.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Pulse Width Modulation Controller */ /** SOFTWARE API DEFINITION FOR Pulse Width Modulation Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_PWM Pulse Width Modulation Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_PWM Pulse Width Modulation Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_rstc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Reset Controller */ /** SOFTWARE API DEFINITION FOR Reset Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_RSTC Reset Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_RSTC Reset Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_rtc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Real-time Clock */ /** SOFTWARE API DEFINITION FOR Real-time Clock */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_RTC Real-time Clock */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_RTC Real-time Clock */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_rtt.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Real-time Timer */ /** SOFTWARE API DEFINITION FOR Real-time Timer */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_RTT Real-time Timer */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_RTT Real-time Timer */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_sdramc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR SDRAM Controller */ /** SOFTWARE API DEFINITION FOR SDRAM Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_SDRAMC SDRAM Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_SDRAMC SDRAM Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_smc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Static Memory Controller */ /** SOFTWARE API DEFINITION FOR Static Memory Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_SMC Static Memory Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_SMC Static Memory Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_spi.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Serial Peripheral Interface */ /** SOFTWARE API DEFINITION FOR Serial Peripheral Interface */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_SPI Serial Peripheral Interface */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_SPI Serial Peripheral Interface */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_ssc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Synchronous Serial Controller */ /** SOFTWARE API DEFINITION FOR Synchronous Serial Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_SSC Synchronous Serial Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_SSC Synchronous Serial Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_supc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Supply Controller */ /** SOFTWARE API DEFINITION FOR Supply Controller */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_SUPC Supply Controller */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_SUPC Supply Controller */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_tc.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Timer Counter */ /** SOFTWARE API DEFINITION FOR Timer Counter */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_TC Timer Counter */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_TC Timer Counter */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_trng.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR True Random Number Generator */ /** SOFTWARE API DEFINITION FOR True Random Number Generator */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_TRNG True Random Number Generator */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_TRNG True Random Number Generator */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_twi.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Two-wire Interface */ /** SOFTWARE API DEFINITION FOR Two-wire Interface */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_TWI Two-wire Interface */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_TWI Two-wire Interface */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_uart.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Universal Asynchronous Receiver Transmitter */ /** SOFTWARE API DEFINITION FOR Universal Asynchronous Receiver Transmitter */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_UART Universal Asynchronous Receiver Transmitter */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_UART Universal Asynchronous Receiver Transmitter */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_uotghs.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR USB On-The-Go Interface */ /** SOFTWARE API DEFINITION FOR USB On-The-Go Interface */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_UOTGHS USB On-The-Go Interface */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_UOTGHS USB On-The-Go Interface */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_usart.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Universal Synchronous Asynchronous Receiver Transmitter */ /** SOFTWARE API DEFINITION FOR Universal Synchronous Asynchronous Receiver Transmitter */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_USART Universal Synchronous Asynchronous Receiver Transmitter */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_USART Universal Synchronous Asynchronous Receiver Transmitter */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))

3
cpu/sam3x8e/include/component/component_wdt.h
View File

@ -33,7 +33,8 @@
/* ============================================================================= */ /* ============================================================================= */
/** SOFTWARE API DEFINITION FOR Watchdog Timer */ /** SOFTWARE API DEFINITION FOR Watchdog Timer */
/* ============================================================================= */ /* ============================================================================= */
/** \addtogroup SAM3XA_WDT Watchdog Timer */ /** \ingroup SAM3X8E_cmsis */
/** \defgroup SAM3XA_WDT Watchdog Timer */
/*@{*/ /*@{*/
#if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__)) #if !(defined(__ASSEMBLY__) || defined(__IAR_SYSTEMS_ASM__))