1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-17 02:23:49 +01:00

cpu/mips: cleanup doxygen documentation

This commit is contained in:
Alexandre Abadie 2017-08-24 19:51:44 +02:00
parent 480f77065b
commit 2b3a9d2e82
9 changed files with 28 additions and 23 deletions

View File

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

View File

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

View File

@ -7,8 +7,7 @@
*/ */
/** /**
* @defgroup cpu_mips32r2_commom MIPS32R2 Common * @ingroup cpu_mips32r2_commom
* @ingroup cpu
* @{ * @{
* *
* @file * @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.
*/

View File

@ -10,10 +10,11 @@
/** /**
* @ingroup cpu_mips_pic32_common * @ingroup cpu_mips_pic32_common
* @brief Shared CPU specific definitions for the MIPS family.
* @{ * @{
* *
* @file * @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> * @author Francois Berder <francois.berder@imgtec.com>
*/ */

View File

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

View File

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

View File

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

View File

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