Skip to content

Commit c55ab89

Browse files
AnnsAnnscrasbe
AnnsAnns
and
crasbe
committed
boards: add doc.md for multiple boards missing documentation
boards: remove duplicate doc group declarations boards/bastwan: fix doxygen errors boards/ublox-c030-u201: fix doxygen errors Co-authored-by: crasbe <crasbe@gmail.com>
1 parent c9fa913 commit c55ab89

14 files changed

Lines changed: 92 additions & 32 deletions

File tree

‎boards/bastwan/doc.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@defgroup boards_bastwan BastWan
2+
@ingroup boards
3+
@brief Support for the BastWan board
4+
5+
## Overview
6+
7+
The BastWan is a development board featuring the Microchip SAMR34 series
8+
SoC with integrated LoRa radio. It is suitable for low-power IoT and
9+
LoRaWAN projects and includes the MCU and radio on a compact evaluation board.

‎boards/bastwan/include/board.h‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_bastwan BastWAN board
10-
* @ingroup boards
11-
* @brief Support for the BASTWAN SAM R34 board.
9+
* @ingroup boards_bastwan
1210
* @{
1311
*
1412
* @file
1513
* @brief Support for the BASTWAN SAM R34 board.
1614
* Based on the work from
17-
* Dylan Laduranty <dylan.laduranty@mesotic.com> for the Microchip
15+
* Dylan Laduranty <dylan.laduranty@mesotic.com> for the Microchip
1816
* SAM R34 Xplained Pro board.
1917
*
2018
* @author Lokotius Filzer <h-filzer@pixelsalat.de>
@@ -41,15 +39,15 @@ extern "C"
4139
#define SX127X_PARAM_DIO2 GPIO_PIN(PA, 12) /* D4 */
4240
#define SX127X_PARAM_DIO3 GPIO_PIN(PB, 17) /* D5 */
4341
#define SX127X_PARAM_PASELECT (SX127X_PA_RFO)
44-
/** @}*/
42+
/** @} */
4543

4644
/**
4745
* @name Board specific configuration
48-
* @{
46+
* @{
4947
*/
50-
#define TCXO_PWR_PIN GPIO_PIN(PB, 3)
51-
#define TX_OUTPUT_SEL_PIN GPIO_PIN(PA, 13)
52-
#define TX_SWITCH_PWR_PIN GPIO_PIN(PA, 28)
48+
#define TCXO_PWR_PIN GPIO_PIN(PB, 3) /**< Enable the TCXO power */
49+
#define TX_OUTPUT_SEL_PIN GPIO_PIN(PA, 13) /**< Select the TX output */
50+
#define TX_SWITCH_PWR_PIN GPIO_PIN(PA, 28) /**< Select the TX power */
5351
/** @}*/
5452

5553
/**

‎boards/frdm-kl43z/doc.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@defgroup boards_frdm-kl43z NXP FRDM-KL43Z
2+
@ingroup boards
3+
@brief Support for the NXP FRDM-KL43Z board
4+
5+
## Overview
6+
7+
The FRDM-KL43Z is an NXP Freedom development board based on the
8+
MKL43Z256VLH4 ARM Cortex-M0+ MCU. It provides a compact platform for
9+
low-power embedded applications and experiments with the Kinetis L family.

‎boards/frdm-kl43z/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_frdm-kl43z NXP FRDM-KL43Z Board
10-
* @ingroup boards
11-
* @brief Support for the NXP FRDM-KL43Z
9+
* @ingroup boards_frdm-kl43z
1210
* @{
1311
*
1412
* @file

‎boards/hifive1/doc.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@defgroup boards_hifive1 SiFive HiFive1
2+
@ingroup boards
3+
@brief Support for the SiFive HiFive1 board
4+
5+
## Overview
6+
7+
The HiFive1 is an open-source development board based on the SiFive FE310 RISC-V core.
8+
It is designed for RISC-V software and hardware experimentation
9+
and supports running RIOT OS on a RISC-V platform.

‎boards/hifive1/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_hifive1 SiFive HiFive1 RISC-V board
10-
* @ingroup boards
11-
* @brief Support for the SiFive HiFive1 RISC-V board
9+
* @ingroup boards_hifive1
1210
* @{
1311
*
1412
* @file

‎boards/hifive1b/doc.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@defgroup boards_hifive1b SiFive HiFive1 Revision B
2+
@ingroup boards
3+
@brief Support for the SiFive HiFive1 Revision B board
4+
5+
## Overview
6+
7+
HiFive1 Revision B is an updated variant of the HiFive1 development board
8+
using a RISC-V FE310 series MCU with improvements in board configuration.
9+
It remains a compact platform for RISC-V development with RIOT OS.

‎boards/hifive1b/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_hifive1b SiFive HiFive1b RISC-V board
10-
* @ingroup boards
11-
* @brief Support for the SiFive HiFive1b RISC-V board
9+
* @ingroup boards_hifive1b
1210
* @{
1311
*
1412
* @file

‎boards/samr30-xpro/doc.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@defgroup boards_samr30-xpro Microchip SAM R30 Xplained Pro
2+
@ingroup boards
3+
@brief Support for the Microchip SAM R30 Xplained Pro
4+
5+
## Overview
6+
7+
The SAM R30 Xplained Pro is an evaluation board from Microchip featuring the SAM R30 series SoC.
8+
It combines an ARM Cortex-M0+ MCU with integrated sub-GHz/2.4 GHz radio capabilities,
9+
suited for wireless IoT development.

‎boards/samr30-xpro/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_samr30-xpro Atmel SAM R30 Xplained Pro
10-
* @ingroup boards
11-
* @brief Support for the Atmel SAM R30 Xplained Pro board.
9+
* @ingroup boards_samr30-xpro
1210
* @{
1311
*
1412
* @file

0 commit comments

Comments
 (0)