boards/stm32Discovery: rename doc.txt -> doc.md

2025-12-15 09:33:50 +01:00 · 2025-04-14 16:55:12 +02:00 · 2025-04-14 16:55:12 +02:00 · d7853eec2e
commit d7853eec2e
parent 103ab62689
18 changed files with 74 additions and 92 deletions
--- a/boards/stm32f030f4-demo/doc.txt
+++ b/boards/stm32f030f4-demo/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_stm32f030f4-demo STM32F030F4 Demo Board
@ingroup     boards
@brief       Support for the STM32F030F4 Demo Board
@ -50,5 +49,3 @@ and debug via GDB by simply typing
 ```
 make BOARD=stm32f030f4-demo debug
 ```
-
- */
--- a/boards/stm32f0discovery/doc.md
+++ b/boards/stm32f0discovery/doc.md
@ -0,0 +1,8 @@
+@defgroup    boards_stm32f0discovery STM32F0Discovery
+@ingroup     boards
+@brief       Support for the STM32F0Discovery board
+
+## Overview
+
+The STM32F0Discovery is a board from ST's Discovery family supporting
+ARM Cortex-M0 STM32F051 microcontroller with 8KiB of RAM and 64KiB of Flash.
--- a/boards/stm32f0discovery/doc.txt
+++ b/boards/stm32f0discovery/doc.txt
@ -1,5 +0,0 @@
-/**
-@defgroup    boards_stm32f0discovery STM32F0Discovery
-@ingroup     boards
-@brief       Support for the STM32F0Discovery board
- */
--- a/boards/stm32f3discovery/doc.txt
+++ b/boards/stm32f3discovery/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_stm32f3discovery STM32F3Discovery
@ingroup     boards
@brief       Support for the STM32F3Discovery board
@ -158,4 +157,3 @@ toolchain.
   - **PA10** is connected with **TX** on the UART converter
   - **PA9** is connected with **RX** on the UART converter
 2. done
- */
--- a/boards/stm32f429i-disc1/doc.md
+++ b/boards/stm32f429i-disc1/doc.md
@ -0,0 +1,10 @@
+@defgroup    boards_stm32f429i-disc1 STM32F429I-DISC1
+@ingroup     boards
+@brief       Support for the STM32F429I-DISC1 board
+
+## Overview
+
+The STM32F429I-DISC1 is a board from ST's Discovery family supporting ARM
+Cortex-M4 STM32F429ZI microcontroller with 256KiB of RAM and 2MiB of Flash.
+
+This board is a replacement for older STM32F429I-DISCO board.
--- a/boards/stm32f429i-disc1/doc.txt
+++ b/boards/stm32f429i-disc1/doc.txt
@ -1,5 +0,0 @@
-/**
- * @defgroup    boards_stm32f429i-disc1 STM32F429I-DISC1
- * @ingroup     boards
- * @brief       Support for the STM32F429I-DISC1 board
- */
--- a/boards/stm32f429i-disco/doc.txt
+++ b/boards/stm32f429i-disco/doc.txt
@ -1,8 +1,6 @@
-/**
- * @defgroup    boards_stm32f429i-disco STM32F429I-DISCO
- * @ingroup     boards
- * @brief       Support for the STM32F429I-DISCO board
- */
+@defgroup    boards_stm32f429i-disco STM32F429I-DISCO
+@ingroup     boards
+@brief       Support for the STM32F429I-DISCO board

 ### General information

--- a/boards/stm32f4discovery/doc.txt
+++ b/boards/stm32f4discovery/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_stm32f4discovery STM32F4Discovery
@ingroup     boards
@brief       Support for the STM32F4Discovery board
@ -260,5 +259,4 @@ is a good value to start with.
 ### macOS & make term
 If you want the terminal to work using `make term` command and get a message
 about missing tty device install the driver from
-https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers .
- */
+https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers .
--- a/boards/stm32f723e-disco/doc.txt
+++ b/boards/stm32f723e-disco/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_stm32f723e-disco STM32F723E-DISCO board
@ingroup     boards
@brief       Support for the STM32F723E-DISCO board
@ -34,4 +33,3 @@ By default, the USB OTG FS port is used. To use the USB OTG HS port with the
 internal UTMI+ HS PHY, enable the module `periph_usbdev_hs_utmi`:

    make BOARD=stm32f723e-disco USEMODULE=periph_usbdev_hs_utmi -C examples/advanced/usbus_minimal
- */
--- a/boards/stm32f746g-disco/doc.txt
+++ b/boards/stm32f746g-disco/doc.txt
@ -1,7 +1,6 @@
-/**
- * @defgroup    boards_stm32f746g-disco STM32F746G-DISCO
- * @ingroup     boards
- * @brief       Support for the STM32F746G-DISCO board.
+@defgroup    boards_stm32f746g-disco STM32F746G-DISCO
+@ingroup     boards
+@brief       Support for the STM32F746G-DISCO board.

 ## Overview

@ -54,5 +53,3 @@ make BOARD=stm32f746g-disco debug
 For using the STM32F746G-DISCO board we recommend the usage of the
 [GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded)
 toolchain.
-
- */
--- a/boards/stm32f7508-dk/doc.txt
+++ b/boards/stm32f7508-dk/doc.txt
@ -1,7 +1,6 @@
-/**
- * @defgroup    boards_stm32f750n8-dk STM32F750N8-DK
- * @ingroup     boards
- * @brief       Support for the STM32F750N8-DK board.
+@defgroup    boards_stm32f750n8-dk STM32F750N8-DK
+@ingroup     boards
+@brief       Support for the STM32F750N8-DK board.

 ## Overview

@ -56,5 +55,3 @@ make BOARD=stm32f750n8-dk debug
 For using the STM32F750N8-DK board we recommend the usage of the
 [GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded)
 toolchain.
-
- */
--- a/boards/stm32f769i-disco/doc.md
+++ b/boards/stm32f769i-disco/doc.md
@ -0,0 +1,8 @@
+@defgroup    boards_stm32f769i-disco STM32F769I-DISCO board
+@ingroup     boards
+@brief       Support for the STM32F769I-DISCO board
+
+## Overview
+
+The STM32F769I-DISCO is a board from ST's Discovery family supporting ARM
+Cortex-M7 STM32F769NI microcontroller with 532KiB of RAM and 2MiB of Flash.
--- a/boards/stm32f769i-disco/doc.txt
+++ b/boards/stm32f769i-disco/doc.txt
@ -1,5 +0,0 @@
-/**
-@defgroup    boards_stm32f769i-disco STM32F769I-DISCO board
-@ingroup     boards
-@brief       Support for the STM32F769I-DISCO board
- */
--- a/boards/stm32g0316-disco/doc.md
+++ b/boards/stm32g0316-disco/doc.md
@ -0,0 +1,32 @@
+@defgroup    boards_stm32g0316-disco STM32G0316-DISCO
+@ingroup     boards
+@brief       Support for the STM32G0316-DISCO board.
+
+### General information
+
+The ST [STM32G0316-DISCO](https://www.st.com/en/evaluation-tools/stm32g0316-disco.html)
+is an evaluation board supporting a ARM Cortex-M0 STM32G031J6 microcontroller
+with 8KB of RAM and 32KB of ROM Flash.
+
+### Pinout
+
+In an SO8 package, this MCU uses multi-bonding to run multiple ports to the same pins.
+See [this application note as reference](https://www.st.com/resource/en/application_note/dm00443870-getting-started-with-stm32g0-series-hardware-development-stmicroelectronics.pdf).
+This means the responsibility is on the firmware configurer to take special care when configured IO, ensuring that
+ports are not conflicting on each pin.
+
+### Flash the board
+
+The STM32G0316-DISCO board includes an on-board ST-LINK programmer and can be
+flashed using OpenOCD.
+
+To flash this board, just use the following command:
+```
+ make BOARD=stm32g0316-disco flash -C examples/basic/hello-world
+ ```
+### UART Terminal Interaction
+
+Due to the limited number of pins, to get stdio UART traffic, use a USB->UART adapter
+like the CP2104 from Adafruit (http://adafru.it/954). Connect the adapter's TX line
+to the MCU RX pin (PB6, Pin 8) and the adapter's RX line to the MCU's TX pin -
+(PB7, pin 1).
--- a/boards/stm32g0316-disco/doc.txt
+++ b/boards/stm32g0316-disco/doc.txt
@ -1,36 +0,0 @@
-/**
- * @defgroup    boards_stm32g0316-disco STM32G0316-DISCO
- * @ingroup     boards
- * @brief       Support for the STM32G0316-DISCO board.
- *
- * ### General information
- *
- * The ST [STM32G0316-DISCO](https://www.st.com/en/evaluation-tools/stm32g0316-disco.html)
- * is an evaluation board supporting a ARM Cortex-M0 STM32G031J6 microcontroller
- * with 8KB of RAM and 32KB of ROM Flash.
- *
- * ### Pinout
- *
- * In an SO8 package, this MCU uses multi-bonding to run multiple ports to the same pins.
- * See [this application note as reference](https://www.st.com/resource/en/application_note/dm00443870-getting-started-with-stm32g0-series-hardware-development-stmicroelectronics.pdf).
- * This means the responsibility is on the firmware configurer to take special care when configured IO, ensuring that
- * ports are not conflicting on each pin.
- *
- * ### Flash the board
- *
- * The STM32G0316-DISCO board includes an on-board ST-LINK programmer and can be
- * flashed using OpenOCD.
- *
- * To flash this board, just use the following command:
- *
- * ```
- * make BOARD=stm32g0316-disco flash -C examples/basic/hello-world
- * ```
- *
- * ### UART Terminal Interaction
- *
- * Due to the limited number of pins, to get stdio UART traffic, use a USB->UART adapter
- * like the CP2104 from Adafruit (http://adafru.it/954).  Connect the adapter's TX line
- * to the MCU RX pin (PB6, Pin 8) and the adapter's RX line to the MCU's TX pin -
- * (PB7, pin 1)
- */
--- a/boards/stm32l0538-disco/doc.txt
+++ b/boards/stm32l0538-disco/doc.txt
@ -1,7 +1,6 @@
-/**
- * @defgroup    boards_stm32l0538-disco STM32L0538-DISCO
- * @ingroup     boards
- * @brief       Support for the STM32L0538-DISCO board
+@defgroup    boards_stm32l0538-disco STM32L0538-DISCO
+@ingroup     boards
+@brief       Support for the STM32L0538-DISCO board

 ### Introduction

@ -76,5 +75,3 @@ required. Use the `term` target to open a terminal:

 If an external ST-Link adapter is used, RX and TX pins can be directly connected
 to it. In this case, STDIO is available on /dev/ttyACMx (Linux case).
-
- */
--- a/boards/stm32l476g-disco/doc.txt
+++ b/boards/stm32l476g-disco/doc.txt
@ -1,7 +1,6 @@
-/**
- * @defgroup    boards_stm32l476g-disco STM32L476G-DISCO
- * @ingroup     boards
- * @brief       Support for the STM32L476G-DISCO board.
+@defgroup    boards_stm32l476g-disco STM32L476G-DISCO
+@ingroup     boards
+@brief       Support for the STM32L476G-DISCO board.

 ## Overview

@ -60,5 +59,3 @@ provided by integrated ST-LINK programmer. ST-LINK is connected to the
 microcontroller USART2.

 The default baud rate is 115200.
-
- */
--- a/boards/stm32mp157c-dk2/doc.txt
+++ b/boards/stm32mp157c-dk2/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_stm32mp157c-dk2 STM32MP157C-DK2 board
@ingroup     boards
@brief       Support for the STM32MP157C-DK2 board
@ -101,4 +100,3 @@ echo stop > /sys/class/remoteproc/remoteproc0/state
 For using the STM32MP157C-DK2 board we strongly recommend the usage of the
 [GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded)
 toolchain.
- */