From 2b3a9d2e8238655b4366416f546d154b470df0df Mon Sep 17 00:00:00 2001 From: Alexandre Abadie Date: Thu, 24 Aug 2017 19:51:44 +0200 Subject: [PATCH] cpu/mips: cleanup doxygen documentation --- cpu/mips32r2_common/include/cpu.h | 6 +++--- cpu/mips32r2_common/include/cpu_conf.h | 11 +++++------ cpu/mips32r2_common/include/eic_irq.h | 3 +-- cpu/mips_pic32_common/doc.txt | 8 ++++++++ cpu/mips_pic32_common/include/periph_cpu_common.h | 3 ++- cpu/mips_pic32mx/include/cpu.h | 4 ++-- cpu/mips_pic32mx/include/cpu_conf.h | 5 ++--- cpu/mips_pic32mz/include/cpu.h | 6 +++--- cpu/mips_pic32mz/include/cpu_conf.h | 5 ++--- 9 files changed, 28 insertions(+), 23 deletions(-) create mode 100644 cpu/mips_pic32_common/doc.txt diff --git a/cpu/mips32r2_common/include/cpu.h b/cpu/mips32r2_common/include/cpu.h index 119adc58ac..b4bf80a907 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 */ diff --git a/cpu/mips32r2_common/include/cpu_conf.h b/cpu/mips32r2_common/include/cpu_conf.h index d4d65a0252..54ed0671b0 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 */ +#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 c24c38875c..dfb5b6e494 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 0000000000..3e6ca00a48 --- /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 e9cd0c4074..3a3361f996 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 */ diff --git a/cpu/mips_pic32mx/include/cpu.h b/cpu/mips_pic32mx/include/cpu.h index ccd58cbd26..45e64c4dbc 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 6db3ffbdbc..0647ad398d 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 */ diff --git a/cpu/mips_pic32mz/include/cpu.h b/cpu/mips_pic32mz/include/cpu.h index 0be7a974b2..e2ca23db66 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 */ diff --git a/cpu/mips_pic32mz/include/cpu_conf.h b/cpu/mips_pic32mz/include/cpu_conf.h index 3e120effb0..2b2f70bcbf 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 */