diff --git a/cpu/mips32r2_common/include/cpu.h b/cpu/mips32r2_common/include/cpu.h index 119adc58ac031e427c442fce5855646d57d13ff1..b4bf80a907d835e2b5bed104f419c7589c9c06d1 100644 --- a/cpu/mips32r2_common/include/cpu.h +++ b/cpu/mips32r2_common/include/cpu.h @@ -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> */ diff --git a/cpu/mips32r2_common/include/cpu_conf.h b/cpu/mips32r2_common/include/cpu_conf.h index d4d65a02522128a3ea194b4bec803c8e2e3e0e80..54ed0671b0167602138adc9f771c553e15f52e37 100644 --- a/cpu/mips32r2_common/include/cpu_conf.h +++ b/cpu/mips32r2_common/include/cpu_conf.h @@ -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 diff --git a/cpu/mips32r2_common/include/eic_irq.h b/cpu/mips32r2_common/include/eic_irq.h index c24c38875c898ceeeb28e71e178fd605f1324f98..dfb5b6e4944e6819d444261909dde03b25ccdb02 100644 --- a/cpu/mips32r2_common/include/eic_irq.h +++ b/cpu/mips32r2_common/include/eic_irq.h @@ -7,8 +7,7 @@ */ /** - * @defgroup cpu_mips32r2_commom MIPS32R2 Common - * @ingroup cpu + * @ingroup cpu_mips32r2_commom * @{ * * @file diff --git a/cpu/mips_pic32_common/doc.txt b/cpu/mips_pic32_common/doc.txt new file mode 100644 index 0000000000000000000000000000000000000000..3e6ca00a48431944029bb13252df710b7d6f3d38 --- /dev/null +++ b/cpu/mips_pic32_common/doc.txt @@ -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. + */ diff --git a/cpu/mips_pic32_common/include/periph_cpu_common.h b/cpu/mips_pic32_common/include/periph_cpu_common.h index e9cd0c4074b6948a5f2d36255bb89fe492f50ba6..3a3361f996f174e329eb1611ef509ee2be6d4c71 100644 --- a/cpu/mips_pic32_common/include/periph_cpu_common.h +++ b/cpu/mips_pic32_common/include/periph_cpu_common.h @@ -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> */ diff --git a/cpu/mips_pic32mx/include/cpu.h b/cpu/mips_pic32mx/include/cpu.h index ccd58cbd26ed2172b88ed49780968253032a374b..45e64c4dbcec17f0e284aa467ec95eb1facc4a1c 100644 --- a/cpu/mips_pic32mx/include/cpu.h +++ b/cpu/mips_pic32mx/include/cpu.h @@ -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 diff --git a/cpu/mips_pic32mx/include/cpu_conf.h b/cpu/mips_pic32mx/include/cpu_conf.h index 6db3ffbdbc2618287613ea42fc7b3e13a2b13312..0647ad398db6e8d490aad48edeab8b95d12a817b 100644 --- a/cpu/mips_pic32mx/include/cpu_conf.h +++ b/cpu/mips_pic32mx/include/cpu_conf.h @@ -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> */ diff --git a/cpu/mips_pic32mz/include/cpu.h b/cpu/mips_pic32mz/include/cpu.h index 0be7a974b20ab33c753db07a96fa0495ae0f1daa..e2ca23db66bcbdee59da10e7b2acaa342fcd0134 100644 --- a/cpu/mips_pic32mz/include/cpu.h +++ b/cpu/mips_pic32mz/include/cpu.h @@ -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> */ diff --git a/cpu/mips_pic32mz/include/cpu_conf.h b/cpu/mips_pic32mz/include/cpu_conf.h index 3e120effb0de8a826152e58a58747be5c7a765a0..2b2f70bcbf29564006ec320ba4a46b3d4e9d73e4 100644 --- a/cpu/mips_pic32mz/include/cpu_conf.h +++ b/cpu/mips_pic32mz/include/cpu_conf.h @@ -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> */ diff --git a/cpu/msp430_common/include/cpu.h b/cpu/msp430_common/include/cpu.h index 88a1aac8469c85d089d0dc3163921af85aaf6acf..529c2183c2287595098444178863969dafd15455 100644 --- a/cpu/msp430_common/include/cpu.h +++ b/cpu/msp430_common/include/cpu.h @@ -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 */ +/** @} */ diff --git a/cpu/msp430_common/include/cpu_conf.h b/cpu/msp430_common/include/cpu_conf.h index e76aa7b6bb8957e0a7184a21daf20045f5609f3a..f33ab97bda28c6a9b03e4b40960a53d73117faaf 100644 --- a/cpu/msp430_common/include/cpu_conf.h +++ b/cpu/msp430_common/include/cpu_conf.h @@ -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 */ +/** @} */ diff --git a/cpu/msp430_common/include/msp430_types.h b/cpu/msp430_common/include/msp430_types.h index 81114dd195a10da5338b5191e93a5b353198e456..a1acec8c86c3ce0d00547c4f8a68db760f5799a9 100644 --- a/cpu/msp430_common/include/msp430_types.h +++ b/cpu/msp430_common/include/msp430_types.h @@ -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 */ +/** @} */ diff --git a/cpu/msp430_common/include/stdio.h b/cpu/msp430_common/include/stdio.h index 2a5223ba6024f7f6c9517e4c3c42f7c1959b9672..2a67eb2ac19e6823460c9e476525e10cc757c5cf 100644 --- a/cpu/msp430_common/include/stdio.h +++ b/cpu/msp430_common/include/stdio.h @@ -7,7 +7,7 @@ */ /** - * @ingroup msp430 + * @ingroup cpu_msp430_common * @{ * * @file @@ -42,3 +42,4 @@ int getchar(void); #endif #endif /* STDIO_H */ +/** @} */ diff --git a/cpu/msp430_common/include/stdlib.h b/cpu/msp430_common/include/stdlib.h index 20bc817c84a3dfa39c5c0c37291a36154d01d990..30549a61a099368e915fc9dfd63127400114d452 100644 --- a/cpu/msp430_common/include/stdlib.h +++ b/cpu/msp430_common/include/stdlib.h @@ -7,7 +7,7 @@ */ /** - * @ingroup msp430 + * @ingroup cpu_msp430_common * @{ * * @file @@ -38,3 +38,4 @@ extern "C" { #endif #endif /* STDLIB_H */ +/** @} */ diff --git a/cpu/msp430_common/include/sys/stat.h b/cpu/msp430_common/include/sys/stat.h index 2b3ec0933d6a32bdffcbc5ed3c5cb8a4bbfd1cc9..45843a7be9e576c2b239ed26aace8e53cff6ec47 100644 --- a/cpu/msp430_common/include/sys/stat.h +++ b/cpu/msp430_common/include/sys/stat.h @@ -7,6 +7,9 @@ */ /** + * @ingroup cpu_msp430_common + * + * @{ * @file * @brief POSIX compatible sys/stat.h definitions * @author Joakim NohlgÄrd <joakim.nohlgard@eistec.se> diff --git a/cpu/msp430_common/include/unistd.h b/cpu/msp430_common/include/unistd.h index 39049c605f99363fea73bd8982ad8d8b2bca8de7..55930fab6b22d4a65e3b2c9178ac57351ddd385c 100644 --- a/cpu/msp430_common/include/unistd.h +++ b/cpu/msp430_common/include/unistd.h @@ -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 */ +/** @} */