cpu*: fix doxygen grouping

2018-06-01 12:25:00 +02:00 · 2018-06-01 12:25:00 +02:00 · 938677cc83
commit 938677cc83
parent 4133908fe0
30 changed files with 75 additions and 32 deletions
--- a/cpu/cc2538/periph/hwrng.c
+++ b/cpu/cc2538/periph/hwrng.c
@ -9,7 +9,7 @@

 /**
 * @ingroup     cpu_cc2538
- * @ingroup     drivers_periph_hwng
+ * @ingroup     drivers_periph_hwrng
 * @{
 *
 * @file
--- a/cpu/cc26x0/include/cc26x0_i2c.h
+++ b/cpu/cc26x0/include/cc26x0_i2c.h
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup         cpu_cc26x0_i2c_definitions
+ * @ingroup         cpu_cc26x0_definitions
 * @{
 *
 * @file
--- a/cpu/cc26x0/include/cc26x0_ioc.h
+++ b/cpu/cc26x0/include/cc26x0_ioc.h
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup         cpu_cc26x0_ioc_definitions
+ * @ingroup         cpu_cc26x0_definitions
 * @{
 *
 * @file
--- a/cpu/cc430/cc430-adc.c
+++ b/cpu/cc430/cc430-adc.c
@ -34,7 +34,7 @@
 * ************************************************************************************************/

 /**
- * @ingroup cc430
+ * @ingroup cpu_cc430
 * @{
 */

--- a/cpu/cc430/doc.txt
+++ b/cpu/cc430/doc.txt
@ -7,7 +7,7 @@
 */

 /**
- * @defgroup    cc430 TI CC430
+ * @defgroup    cpu_cc430 TI CC430
 * @brief       Texas Instruments CC430 specific code
 * @ingroup     cpu
 */
--- a/cpu/cc430/include/cc430-rtc.h
+++ b/cpu/cc430/include/cc430-rtc.h
@ -16,7 +16,7 @@ extern "C" {
 #endif

 /**
- * @ingroup     cc430
+ * @ingroup     cpu_cc430
 */

 /**
--- a/cpu/cc430/periph/rtc.c
+++ b/cpu/cc430/periph/rtc.c
@ -8,7 +8,7 @@
 */

 /**
- * @ingroup     cc430
+ * @ingroup     cpu_cc430
 * @ingroup     drivers_periph_rtc
 * @{
 *
--- a/cpu/cc430/periph/timer.c
+++ b/cpu/cc430/periph/timer.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     cc430
+ * @ingroup     cpu_cc430
 * @ingroup     drivers_periph_timer
 * @{
 *
--- a/cpu/cortexm_common/panic.c
+++ b/cpu/cortexm_common/panic.c
@ -9,7 +9,7 @@
 */

 /**
- * @ingroup     cortex-m_common
+ * @ingroup     cpu_cortexm_common
 * @{
 *
 * @file
--- a/cpu/efm32/doc.txt
+++ b/cpu/efm32/doc.txt
@ -1,7 +1,7 @@
 /**
 * @defgroup        cpu_efm32 Silicon Labs EFM32/EFR32/EZR32
 * @ingroup         cpu
- * @brief           Implementation of Silicon Labs's EFM32/EFR32/EZR32 MCUs
+ * @brief           Silicon Labs's EFM32/EFR32/EZR32 MCUs implementation
 *
 * This module contains all code and definitions for the Silicon Labs
 * EFM32/EFR32/EZR32 MCUs. It uses the Gecko SDK (vendor library) for the
@ -64,3 +64,39 @@
 * The EFM32/EFR32/EZR32 MCUs have support for low-power peripherals. Support
 * is enabled by default, but can be disabled by setting LOW_POWER_ENABLED=0.
 */
+
+/**
+ * @defgroup        cpu_efm32gg Silicon Labs EFM32GG family
+ * @ingroup         cpu_efm32
+ * @brief           Silicon Labs's EFM32GG MCUs family implementation
+ */
+
+/**
+ * @defgroup        cpu_efm32lg Silicon Labs EFM32LG family
+ * @ingroup         cpu_efm32
+ * @brief           Silicon Labs's EFM32LG MCUs family implementation
+ */
+
+/**
+ * @defgroup        cpu_efm32pg1b Silicon Labs EFM32PG1B family
+ * @ingroup         cpu_efm32
+ * @brief           Silicon Labs's EFM32PG1B MCUs family implementation
+ */
+
+/**
+ * @defgroup        cpu_efm32pg12b Silicon Labs EFM32PG12B family
+ * @ingroup         cpu_efm32
+ * @brief           Silicon Labs's EFM32PG12B MCUs family implementation
+ */
+
+/**
+ * @defgroup        cpu_efr32mg1p Silicon Labs EFR32MG1P family
+ * @ingroup         cpu_efm32
+ * @brief           Silicon Labs's EFR32MG1P MCUs family implementation
+ */
+
+/**
+ * @defgroup        cpu_efr32mg12p Silicon Labs EFR32MG12P family
+ * @ingroup         cpu_efm32
+ * @brief           Silicon Labs's EFR32MG12P MCUs family implementation
+ */
--- a/cpu/kinetis/include/vectors_kinetis.h
+++ b/cpu/kinetis/include/vectors_kinetis.h
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     cpu_k22f
+ * @ingroup     cpu_kinetis
 * @{
 *
 * @file
--- a/cpu/kinetis/periph/hwrng.c
+++ b/cpu/kinetis/periph/hwrng.c
@ -9,7 +9,7 @@

 /**
 * @ingroup     cpu_kinetis
- * @ingroup     drivers_periph_hwng
+ * @ingroup     drivers_periph_hwrng
 *
 * @{
 *
--- a/cpu/kinetis/periph/i2c.c
+++ b/cpu/kinetis/periph/i2c.c
@ -9,7 +9,7 @@
 */

 /**
- * @ingroup     cpu_kinetis_commo
+ * @ingroup     cpu_kinetis
 * @ingroup     drivers_periph_i2c
 *
 * @note        This driver only implements the 7-bit addressing master mode.
--- a/cpu/kinetis/periph/mcg.c
+++ b/cpu/kinetis/periph/mcg.c
@ -9,7 +9,7 @@

 /**
 * @ingroup     cpu_kinetis
- * @ingroup     drivers_periph_mcg
+ * @ingroup     cpu_kinetis_mcg
 * @{
 *
 * @file
--- a/cpu/kinetis/periph/wdog.c
+++ b/cpu/kinetis/periph/wdog.c
@ -9,7 +9,7 @@

 /**
 * @ingroup     cpu_kinetis
- * @ingroup     drivers_periph_watchdog
+ * @ingroup     cpu_kinetis_wdog
 *
 * @{
 *
--- a/cpu/lpc2387/cpu.c
+++ b/cpu/lpc2387/cpu.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     lpc2387
+ * @ingroup     cpu_lpc2387
 * @{
 */

--- a/cpu/lpc2387/doc/lpc2387.doc
+++ b/cpu/lpc2387/doc/lpc2387.doc
@ -1,6 +1,6 @@
 /**
 * @defgroup lpc2387_intro LPC2387 Introduction
- * @ingroup lpc2387
+ * @ingroup cpu_lpc2387

 <h2>First steps</h2>
 \li See the manual for toolchain and ide setup
--- a/cpu/lpc2387/include/cpu.h
+++ b/cpu/lpc2387/include/cpu.h
@ -10,7 +10,7 @@
 #define CPU_H

 /**
- * @defgroup    lpc2387     NXP LPC2387
+ * @defgroup    cpu_lpc2387     NXP LPC2387
 * @ingroup     cpu
 * @brief       NXP LPC2387 specific code
 * @{
--- a/cpu/lpc2387/include/cpu_conf.h
+++ b/cpu/lpc2387/include/cpu_conf.h
@ -15,8 +15,7 @@ extern "C" {
 #endif

 /**
- * @ingroup     conf
- * @ingroup     lpc2387
+ * @ingroup     cpu_lpc2387
 *
 * @{
 */
--- a/cpu/lpc2387/lpc23xx-iap.c
+++ b/cpu/lpc2387/lpc23xx-iap.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup lpc2387
+ * @ingroup cpu_lpc2387
 * @{
 */

--- a/cpu/mips32r2_common/include/eic_irq.h
+++ b/cpu/mips32r2_common/include/eic_irq.h
@ -7,7 +7,9 @@
 */

 /**
- * @ingroup     cpu_mips32r2_commom
+ * @defgroup        cpu_mips32r2_common Imagination Technologies MIPS32R2 Common
+ * @ingroup         cpu
+ * @brief           Imagination Technologies MIPS32R2 Common implementation
 * @{
 *
 * @file
--- a/cpu/mips32r2_common/newlib_syscalls_mips_uhi/syscalls.c
+++ b/cpu/mips32r2_common/newlib_syscalls_mips_uhi/syscalls.c
@ -7,7 +7,7 @@
 */

 /**
-  * @ingroup sys_newlib
+  * @ingroup    sys_newlib
  * @{
  *
  * @file
--- a/cpu/mips32r2_generic/include/cpu.h
+++ b/cpu/mips32r2_generic/include/cpu.h
@ -7,9 +7,9 @@
 */

 /**
- * @defgroup    cpu_mips32r2_generic Imagination Technologies MIPS32R2 Common
+ * @defgroup    cpu_mips32r2_generic Imagination Technologies MIPS32R2 generic
 * @ingroup     cpu
- * @brief       Imagination Technologies MIPS32R2 common
+ * @brief       Imagination Technologies MIPS32R2 generic
 * @{
 *
 * @file
--- a/cpu/msp430fxyz/include/periph_cpu.h
+++ b/cpu/msp430fxyz/include/periph_cpu.h
@ -7,7 +7,9 @@
 */

 /**
- * @ingroup         cpu_msp430fxyz
+ * @defgroup    cpu_msp430fxyz TI MSP430F
+ * @ingroup     cpu
+ * @brief       Texas Instruments MSP430F family specific code
 * @{
 *
 * @file
--- a/cpu/nrf51/cpu.c
+++ b/cpu/nrf51/cpu.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     cpu_nrf51822
+ * @ingroup     cpu_nrf51
 * @{
 *
 * @file
--- a/cpu/nrf51/include/cpu_conf.h
+++ b/cpu/nrf51/include/cpu_conf.h
@ -7,7 +7,9 @@
 */

 /**
- * @ingroup         cpu_nrf51822
+ * @defgroup        cpu_nrf51 Nordic nRF51 MCU
+ * @ingroup         cpu
+ * @brief           Nordic nRF51 family of CPUs
 * @{
 *
 * @file
--- a/cpu/nrf51/vectors.c
+++ b/cpu/nrf51/vectors.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     cpu_nrf51822
+ * @ingroup     cpu_nrf51
 * @{
 *
 * @file
--- a/cpu/nrf52/include/cpu_conf.h
+++ b/cpu/nrf52/include/cpu_conf.h
@ -7,7 +7,9 @@
 */

 /**
- * @ingroup     cpu_nrf52
+ * @defgroup        cpu_nrf52 Nordic nRF52 MCU
+ * @ingroup         cpu
+ * @brief           Nordic nRF52 family of CPUs
 * @{
 *
 * @file
--- a/cpu/sam3/vectors.c
+++ b/cpu/sam3/vectors.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     cpu_sam3x8e
+ * @ingroup     cpu_sam3
 * @{
 *
 * @file
--- a/cpu/sam_common/ldscripts/sam3x8e.ld
+++ b/cpu/sam_common/ldscripts/sam3x8e.ld
@ -7,7 +7,7 @@
 */

 /**
- * @addtogroup      cpu_sam3x8e
+ * @addtogroup      cpu_sam3
 * @{
 *
 * @file