riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #7512 from aabadie/cpu_mips_doc

Browse Source 
cpu: doxygen cleanup
This commit is contained in:
Joakim Nohlgård 2017-09-01 11:34:08 +02:00 committed by GitHub
commit d512967fb6
16 changed files with 71 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
cpu/mips32r2_common/include/cpu.h
View File

@ -7,13 +7,13 @@
*/
/**
* @defgroup cpu_mips32r2_commom MIPS32R2 Common
* @defgroup cpu_mips32r2_commom Imagination Technologies MIPS32R2 Common
* @ingroup cpu
* @brief Common implementations and headers for mips32r2 compliant devices
* @brief Imagination Technologies MIPS32R2 common
* @{
*
* @file
* @brief Common implementations and headers for mips32r2 compliant devices
* @brief Common implementations and headers for Imagination Technologies MIPS32R2 compliant devices
*
* @author Neil Jones <neil.jones@imgtec.com>
*/

11
cpu/mips32r2_common/include/cpu_conf.h
View File

@ -6,20 +6,19 @@
* directory for more details.
*/
#ifndef CPU_CONF_H
#define CPU_CONF_H
/**
* @defgroup cpu_mips32r2_commom MIPS32R2 Common
* @ingroup cpu
* @ingroup cpu_mips32r2_commom
* @{
*
* @file
* @brief Common CPU definitions for mip32r2 compatable devices.
* @brief Common CPU definitions for MIPS32R2 compliant devices.
*
* @author Neil Jones <neil.jones@imgtec.com>
*/
#ifndef CPU_CONF_H
#define CPU_CONF_H
#ifdef __cplusplus
extern "C" {
#endif

3
cpu/mips32r2_common/include/eic_irq.h
View File

@ -7,8 +7,7 @@
*/
/**
* @defgroup cpu_mips32r2_commom MIPS32R2 Common
* @ingroup cpu
* @ingroup cpu_mips32r2_commom
* @{
*
* @file

8
cpu/mips_pic32_common/doc.txt Normal file
View File

@ -0,0 +1,8 @@
/**
* @defgroup cpu_mips_pic32_common Microchip MIPS common
* @ingroup cpu
* @brief Microchip MIPS common
*
* This module contains all common code and definition to all Microchip MIPS
* cpu families supported by RIOT: @ref cpu_mips_pic32mx, @ref cpu_mips_pic32mz.
*/

3
cpu/mips_pic32_common/include/periph_cpu_common.h
View File

@ -10,10 +10,11 @@
/**
* @ingroup cpu_mips_pic32_common
* @brief Shared CPU specific definitions for the MIPS family.
* @{
*
* @file
* @brief CPU specific definitions for internal peripheral handling
* @brief Shared CPU specific definitions for the MIPS family.
*
* @author Francois Berder <francois.berder@imgtec.com>
*/

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

@ -9,9 +9,9 @@
*/
/**
* @defgroup cpu_mips_pic32mx MIPS PIC32MX
* @defgroup cpu_mips_pic32mx Microchip PIC32MX
* @ingroup cpu
* @brief CPU definitions for pic32mx devices.
* @brief CPU definitions for Microchip PIC32MX devices.
* @{
*
* @file

5
cpu/mips_pic32mx/include/cpu_conf.h
View File

@ -9,12 +9,11 @@
*/
/**
* @defgroup cpu_mips_pic32mx MIPS PIC32MX
* @ingroup cpu
* @ingroup cpu_mips_pic32mx
* @{
*
* @file
* @brief CPU definitions for pic32mx devices.
* @brief CPU definitions for Microchip PIC32MX devices.
*
* @author Neil Jones <neil.jones@imgtec.com>
*/

6
cpu/mips_pic32mz/include/cpu.h
View File

@ -9,13 +9,13 @@
*/
/**
* @defgroup cpu_mips_pic32mz MIPS PIC32MZ
* @defgroup cpu_mips_pic32mz Microchip PIC32MZ
* @ingroup cpu
* @brief CPU definitions for pic32mz devices.
* @brief CPU definitions for Microchip PIC32MZ devices.
* @{
*
* @file
* @brief CPU definitions for pic32mz devices.
* @brief CPU definitions for Microchip PIC32MZ devices.
*
* @author Neil Jones <neil.jones@imgtec.com>
*/

5
cpu/mips_pic32mz/include/cpu_conf.h
View File

@ -9,12 +9,11 @@
*/
/**
* @defgroup cpu_mips_pic32mz MIPS PIC32MZ
* @ingroup cpu
* @ingroup cpu_mips_pic32mz
* @{
*
* @file
* @brief CPU definitions for pic32mz devices.
* @brief CPU definitions for Microchip PIC32MZ devices.
*
* @author Neil Jones <neil.jones@imgtec.com>
*/

16
cpu/msp430_common/include/cpu.h
View File

@ -7,20 +7,20 @@
* directory for more details.
*/
#ifndef CPU_H
#define CPU_H
/**
* @defgroup cpu_msp430_common TI MSP430
* @ingroup cpu
* @brief Texas Instruments MSP430 specific code
<h2>First steps</h2>
\li See the <a href="../manual/index.html">manual</a> for toolchain and ide setup
*
* @{
* @file
* @brief Texas Instruments MSP430 specific code
*
*/
#ifndef CPU_H
#define CPU_H
#include <stdio.h>
#include <msp430.h>
@ -163,5 +163,5 @@ static inline void cpu_print_last_instruction(void)
}
#endif
/** @} */
#endif /* CPU_H */
/** @} */

10
cpu/msp430_common/include/cpu_conf.h
View File

@ -6,6 +6,15 @@
* directory for more details.
*/
/**
* @ingroup cpu_msp430_common
* @{
*
* @file
* @brief Common CPU definitions fpr MSP430
*
*/
#ifndef CPU_CONF_H
#define CPU_CONF_H
@ -69,3 +78,4 @@ extern "C" {
#endif
#endif /* CPU_CONF_H */
/** @} */

9
cpu/msp430_common/include/msp430_types.h
View File

@ -6,6 +6,14 @@
* directory for more details.
*/
/**
* @ingroup cpu_msp430_common
* @{
*
* @file
* @brief basic types for MSP430
*/
#ifndef MSP430_TYPES_H
#define MSP430_TYPES_H
@ -89,3 +97,4 @@ typedef uint32_t useconds_t; /**< Used for time in microseconds */
#endif
#endif /* MSP430_TYPES_H */
/** @} */

3
cpu/msp430_common/include/stdio.h
View File

@ -7,7 +7,7 @@
*/
/**
* @ingroup msp430
* @ingroup cpu_msp430_common
* @{
*
* @file
@ -42,3 +42,4 @@ int getchar(void);
#endif
#endif /* STDIO_H */
/** @} */

3
cpu/msp430_common/include/stdlib.h
View File

@ -7,7 +7,7 @@
*/
/**
* @ingroup msp430
* @ingroup cpu_msp430_common
* @{
*
* @file
@ -38,3 +38,4 @@ extern "C" {
#endif
#endif /* STDLIB_H */
/** @} */

3
cpu/msp430_common/include/sys/stat.h
View File

@ -7,6 +7,9 @@
*/
/**
* @ingroup cpu_msp430_common
*
* @{
* @file
* @brief POSIX compatible sys/stat.h definitions
* @author Joakim Nohlgård <joakim.nohlgard@eistec.se>

9
cpu/msp430_common/include/unistd.h
View File

@ -7,6 +7,14 @@
* directory for more details.
*/
/**
* @ingroup cpu_msp430_common
* @{
*
* @file
* @brief unistd.h wrapper for MSP430
*/
#ifndef UNISTD_H
#define UNISTD_H
@ -108,3 +116,4 @@ ssize_t write(int, const void *, size_t);
#endif
#endif /* UNISTD_H */
/** @} */