Merge pull request #21596 from krzysztof-cabaj/boards_rename_doc_txt

crasbe · web-flow · commit 41e2da191451 · 2025-07-12T20:58:15.000Z
boards: rename doc.txt -&gt; doc.md for particle, Microchip, nrf ... boards
diff --git a/boards/blackpill-stm32f103c8/doc.md b/boards/blackpill-stm32f103c8/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_blackpill_stm32f103c8 Blackpill STM32F103C8 board
 @ingroup     boards
 @brief       Support for the stm32f103c8 based blackpill board.
@@ -12,5 +11,3 @@ in @ref boards_common_blxxxpill instead.
 
 The [STM32-base](https://stm32-base.org/boards/STM32F103C8T6-Black-Pill.html)
 page on the blackpill contains additional info on the hardware.
-
- */
diff --git a/boards/blackpill-stm32f103cb/doc.md b/boards/blackpill-stm32f103cb/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_blackpill_stm32f103cb Blackpill STM32F103CB board (128KiB flash)
 @ingroup     boards
 @brief       Support for the stm32f103c8 based blackpill board.
@@ -12,5 +11,3 @@ in @ref boards_common_blxxxpill instead.
 
 The [STM32-base](https://stm32-base.org/boards/STM32F103C8T6-Black-Pill.html)
 page on the blackpill contains additional info on the hardware.
-
- */
diff --git a/boards/bluepill-stm32f030c8/doc.md b/boards/bluepill-stm32f030c8/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_bluepill-stm32f030c8 STM32F030C8 based Bluepill
 @ingroup     boards
 @brief       Support for the STM32F030C8 based Bluepill
@@ -61,5 +60,3 @@ reset button.
 You can work around this by pressing the reset button when OpenOCD wants to connect
 to the Blue Pill, or keep it pressed until OpenOCD tries to connect.
 Hit the reset button again after flashing in order to boot the newly flashed image.
-
- */
diff --git a/boards/bluepill-stm32f103c8/doc.md b/boards/bluepill-stm32f103c8/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_bluepill_stm32f103c8 Bluepill STM32F103C8 board
 @ingroup     boards
 @brief       Support for the stm32f103c8 based bluepill board.
@@ -12,5 +11,3 @@ in @ref boards_common_blxxxpill instead.
 
 The [STM32-base](https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill.html)
 page on the bluepill contains additional info on the hardware.
-
- */
diff --git a/boards/bluepill-stm32f103cb/doc.md b/boards/bluepill-stm32f103cb/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_bluepill_stm32f103cb Bluepill STM32F103CB board (128KiB flash)
 @ingroup     boards
 @brief       Support for the stm32f103cb based bluepill board.
@@ -12,5 +11,3 @@ in @ref boards_common_blxxxpill instead.
 
 The [STM32-base](https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill.html)
 page on the bluepill contains additional info on the hardware.
-
- */
diff --git a/boards/cc1312-launchpad/doc.md b/boards/cc1312-launchpad/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup        boards_cc1312_launchpad TI CC1312 LaunchPad
 @ingroup         boards
 @brief           Texas Instruments SimpleLink(TM) CC1312 Wireless MCU LaunchPad(TM) Kit
@@ -59,5 +58,3 @@ Now we can just do `make flash` and `make debug`, this all using OpenOCD.
 For detailed information about CC1312 MCUs as well as configuring, compiling
 RIOT and installation of flashing tools for CC1312 boards,
 see \ref cc26xx_cc13xx_riot.
-
-*/
diff --git a/boards/cc1350-launchpad/doc.md b/boards/cc1350-launchpad/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup        boards_cc1350_launchpad TI CC1350 LaunchPad XL
 @ingroup         boards
 @brief           Texas Instruments SimpleLink(TM) CC1350 Wireless MCU LaunchPad(TM) Kit
@@ -76,5 +75,3 @@ level shifter when connecting to 5V UART.
 For detailed information about CC1350 MCUs as well as configuring, compiling
 RIOT and installation of flashing tools for CC1350 boards,
 see \ref cc26xx_cc13xx_riot.
-
-*/
diff --git a/boards/cc1352-launchpad/doc.md b/boards/cc1352-launchpad/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup        boards_cc1352_launchpad TI CC1352 LaunchPad
 @ingroup         boards
 @brief           Texas Instruments SimpleLink(TM) CC1352 Wireless MCU LaunchPad(TM) Kit
@@ -75,5 +74,3 @@ level shifter when connecting to 5V UART.
 For detailed information about CC1352R1 MCUs as well as configuring, compiling
 RIOT and installation of flashing tools for CC1352R1 boards,
 see \ref cc26xx_cc13xx_riot.
-
-*/
diff --git a/boards/cc1352p-launchpad/doc.md b/boards/cc1352p-launchpad/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup        boards_cc1352p_launchpad TI CC1352P LaunchPad
 @ingroup         boards
 @brief           Texas Instruments SimpleLink(TM) CC1352P Wireless MCU LaunchPad(TM) Kit
@@ -64,6 +63,3 @@ Now we can just do `make flash` and `make debug`, this all using OpenOCD.
 For detailed information about CC1352P MCUs as well as configuring, compiling
 RIOT and installation of flashing tools for CC1352P boards,
 see \ref cc26xx_cc13xx_riot.
-
-
-*/
diff --git a/boards/cc2538dk/doc.md b/boards/cc2538dk/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_cc2538dk CC2538DK
 @ingroup     boards
 @brief       Support for the Texas Instruments CC2538DK board.
@@ -147,4 +146,3 @@ $ sudo kextload /System/Library/Extensions/FTDIUSBSerialDriver.kext
 
 If everything worked, the XDS will be enumerated as
 `/dev/tty.usbserial-<serial-number>`
- */
diff --git a/boards/cc2650-launchpad/doc.md b/boards/cc2650-launchpad/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup        boards_cc2650_launchpad TI CC2650 LaunchPad XL
 @ingroup         boards
 @brief           Texas Instruments SimpleLink(TM) CC2650 Wireless MCU LaunchPad(TM) Kit
@@ -59,5 +58,3 @@ Now we can just do `make flash` and `make debug`, this all using OpenOCD.
 For detailed information about CC2650 MCUs as well as configuring, compiling
 RIOT and installation of flashing tools for CC2650 boards,
 see \ref cc26xx_cc13xx_riot.
-
-*/
diff --git a/boards/cc2650stk/doc.md b/boards/cc2650stk/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_cc2650stk CC2650STK
 @ingroup     boards
 @brief       Support for the SimpleLink™ CC2650 sensor tag
@@ -215,4 +214,3 @@ on all three channels you can create three ble_rop_cmd_t commands and chain them
 via `cmd.pNextOp`.
 3. Send the command to be executed to the RF core via the `rfc_send_cmd()`
 function
- */
diff --git a/boards/nrf51dk/doc.md b/boards/nrf51dk/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_nrf51dk nRF51DK Development Kit
 @ingroup     boards
 @brief       Support for the Nordic nRF51DK Development Kit
@@ -31,4 +30,3 @@ To flash the board, use the following command:
 $ make BOARD=nrf51dk flash
 ```
 from any application directory.
- */
diff --git a/boards/nrf51dongle/doc.md b/boards/nrf51dongle/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_nrf51dongle nRF51 Dongle
 @ingroup     boards
 @brief       Support for the Nordic nRF51 Dongle
@@ -51,4 +50,3 @@ To interact with the board just start the tool using the following command:
 For RIOT itself there is a Flash-Script available. When using any of the
 Examples type in the following command:
 `# Make -B clean flash`
- */
diff --git a/boards/nrf52832-mdk/doc.md b/boards/nrf52832-mdk/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_nrf52832-mdk nRF52832-MDK
 @ingroup     boards
 @brief       Support for the nRF52832-MDK
@@ -44,4 +43,3 @@ Use the `term` target to connect to the board serial port<br/>
 ```
     make BOARD=nrf52832-mdk -C examples/basic/hello-world term
 ```
- */
diff --git a/boards/nrf52840-mdk-dongle/doc.md b/boards/nrf52840-mdk-dongle/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_nrf52840-mdk-dongle nRF52840 MDK USB Dongle
 @ingroup     boards
 @brief       Support for the nRF52840 MDK USB Dongle
@@ -58,5 +57,3 @@ To ease debugging,
 pins 0.6 and 0.7 are configured as RX and TX, respectively.
 They provide stdio if no CDC-ACM is disabled,
 and can be used as a custom UART otherwise.
-
- */
diff --git a/boards/nrf52840-mdk/doc.md b/boards/nrf52840-mdk/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_nrf52840-mdk nRF52840-MDK
 @ingroup     boards
 @brief       Support for the nRF52840-MDK
@@ -34,4 +33,3 @@ Use the `term` target to connect to the board serial port<br/>
 ```
     make BOARD=nrf52840-mdk -C examples/basic/hello-world term
 ```
- */
diff --git a/boards/nrf52dk/doc.md b/boards/nrf52dk/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_nrf52dk nRF52 DK
 @ingroup     boards
 @brief       Support for the nRF52 DK
@@ -64,4 +63,3 @@ Use the `term` target to connect to the board serial port<br/>
 ```
     make BOARD=nrf52dk -C examples/basic/hello-world term
 ```
- */
diff --git a/boards/nrf5340dk-app/doc.md b/boards/nrf5340dk-app/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_nrf5340dk-app nRF5340DK
 @ingroup     boards
 @brief       Support for the nRF5340DK-app board
@@ -34,5 +33,3 @@ Use the `term` target to connect to the board serial port<br/>
 ```
     make BOARD=nrf5340dk-app -C examples/basic/hello-world term
 ```
-
- */
diff --git a/boards/nrf9160dk/doc.md b/boards/nrf9160dk/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_nrf9160dk nRF9160DK
 @ingroup     boards
 @brief       Support for the nRF9160DK board
@@ -31,5 +30,3 @@ Use the `term` target to connect to the board serial port<br/>
 ```
     make BOARD=nrf9160dk -C examples/basic/hello-world term
 ```
-
- */
diff --git a/boards/particle-argon/doc.md b/boards/particle-argon/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_particle-argon Particle Argon
 @ingroup     boards
 @brief       Support for the Particle Argon
@@ -27,5 +26,3 @@ voltage for the Particle Argon, please report this!
 ### Flash the board
 
 See the `Flashing` section in @ref boards_common_particle-mesh.
-
- */
diff --git a/boards/particle-boron/doc.md b/boards/particle-boron/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_particle-boron Particle Boron
 @ingroup     boards
 @brief       Support for the Particle Boron
@@ -27,5 +26,3 @@ voltage for the Particle Boron, please report this!
 ### Flash the board
 
 See the `Flashing` section in @ref boards_common_particle-mesh.
-
- */
diff --git a/boards/particle-xenon/doc.md b/boards/particle-xenon/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_particle-xenon Particle Xenon
 @ingroup     boards
 @brief       Support for the Particle Xenon
@@ -21,5 +20,3 @@ The board datasheet is available [here](https://docs.particle.io/assets/pdfs/dat
 ### Flash the board
 
 See the `Flashing` section in @ref boards_common_particle-mesh.
-
- */
diff --git a/boards/sam4s-xpro/doc.md b/boards/sam4s-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_sam4s-xpro ATSAM4S Xplained Pro board
 @ingroup     boards
 @brief       Support for the ATSAM4S Xplained Pro board
@@ -44,5 +43,3 @@ featuring a SAM4SD32 (Cortex-M4) SoC running up to 120 MHz. This MCU comes with
 By default, openOCD is used for both flashing and debugging.
 EDBG programmer is also available with:
 `PROGRAMMER=edbg BOARD=sam4s-xpro make -C tests/leds flash`
-
- */
diff --git a/boards/samd10-xmini/doc.md b/boards/samd10-xmini/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_samd10-xmini Atmel SAM D10 Xplained Mini
 @ingroup     boards
 @brief       Support for the Atmel SAM D10 Xplained Mini board.
@@ -72,5 +71,3 @@ sudo service udev restart
 The I2C pins on the board do not have any pull-ups connected to them.
 That means that running e.g. `i2c_scan` without any I2C slaves connected
 will run into timeouts.
-
- */
diff --git a/boards/samd20-xpro/doc.md b/boards/samd20-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_samd20-xpro Atmel SAM D20 Xplained Pro
 @ingroup     boards
 @brief       Support for the Atmel SAM D20 Xplained Pro board.
@@ -78,5 +77,3 @@ helpful to understanding how to set up a solid RIOT development environment for
 the SAMD20: http://watr.li/samr21-dev-setup-ubuntu.html
 
 ## Known Issues / Problems
-
- */
diff --git a/boards/samd21-xpro/doc.md b/boards/samd21-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_samd21-xpro Atmel SAM D21 Xplained Pro
 @ingroup     boards
 @brief       Support for the Atmel SAM D21 Xplained Pro board.
@@ -98,5 +97,3 @@ helpful to understanding how to set up a solid RIOT development environment for
 the SAMD21: http://watr.li/samr21-dev-setup-ubuntu.html
 
 ## Known Issues / Problems
-
- */
diff --git a/boards/same51-curiosity-nano/doc.md b/boards/same51-curiosity-nano/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_same51-curiosity-nano Microchip SAM E51 Curiosity Nano
 @ingroup     boards
 @brief       Support for the Microchip SAM E51 Curiosity Nano board.
@@ -82,5 +81,3 @@ sudo service udev restart
 ```
 
 ## Known Issues / Problems
-
- */
diff --git a/boards/same54-xpro/doc.md b/boards/same54-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_same54-xpro Microchip SAM E54 Xplained Pro
 @ingroup     boards
 @brief       Support for the Microchip SAM E54 Xplained Pro board.
@@ -91,5 +90,3 @@ sudo service udev restart
 ```
 
 ## Known Issues / Problems
-
- */
diff --git a/boards/saml10-xpro/doc.md b/boards/saml10-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_saml10-xpro Microchip SAML10 Xplained Pro
 @ingroup     boards
 @brief       Support for the Microchip SAML10 Xplained Pro board.
@@ -65,5 +64,3 @@ memory.
 Connect the device to your Micro-USB cable.
 
 The standard method for flashing RIOT to the saml10-xpro is using EDBG.
-
- */
diff --git a/boards/saml11-xpro/doc.md b/boards/saml11-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_saml11-xpro Microchip SAML11 Xplained Pro
 @ingroup     boards
 @brief       Support for the Microchip SAML11 Xplained Pro board.
@@ -78,5 +77,3 @@ flash memory. Such action can be done with the following EDBG command:
 'edbg -t saml11 -F w0,194,1'
 or pass it as argument when calling make:
 EDBG_ARGS="-F w0,194,1" BOARD=saml11-xpro make flash term -C tests/periph/uart
-
-*/
diff --git a/boards/saml21-xpro/doc.md b/boards/saml21-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_saml21-xpro Atmel SAM L21 Xplained Pro
 @ingroup     boards
 @brief       Support for the Atmel SAM L21 Xplained Pro board.
@@ -106,5 +105,3 @@ helpful to understanding how to set up a solid RIOT development environment for
 the SAML21: http://watr.li/samr21-dev-setup-ubuntu.html
 
 ## Known Issues / Problems
-
- */
diff --git a/boards/samr21-xpro/doc.md b/boards/samr21-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_samr21-xpro Atmel SAM R21 Xplained Pro
 @ingroup     boards
 @brief       Support for the Atmel SAM R21 Xplained Pro board.
@@ -203,4 +202,3 @@ But when you try to flash again, you could get a CMSIS-DAP related error. It
 seems to only happen with USB 3.0 ports. You can take a look at
 [Vagrant](http://en.wikipedia.org/wiki/Vagrant_%28software%29) and use a virtual
 Linux to run the virtual RIOT, and flash from macOS.
- */
diff --git a/boards/samr34-xpro/doc.md b/boards/samr34-xpro/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup    boards_samr34-xpro Microchip SAM R34 Xplained Pro
 @ingroup     boards
 @brief       Support for the Microchip SAM R34 Xplained Pro and WLR089 Xplained Pro
@@ -36,5 +35,3 @@ An evaluation board for the radio certified WLR089 module exists as the WLR089 X
 | Vcc        | 1.8V - 3.6V           |
 | Datasheet  | [Datasheet](https://ww1.microchip.com/downloads/en/DeviceDoc/SAMR34-R35-Low-Power-LoRa-Sub-GHz-SiP-Data-Sheet-DS70005356B.pdf) |
 | Board Manual | [SAM R34 XPro](https://www.microchip.com/en-us/development-tool/DM320111)<br>[WLR089 XPro](https://www.microchip.com/en-us/development-tool/EV23M25A)|
-
- */
diff --git a/boards/sensebox_samd21/doc.md b/boards/sensebox_samd21/doc.md
@@ -1,7 +1,6 @@
-/**
- * @defgroup    boards_sensebox_samd21 SenseBox MCU with SAMD21
- * @ingroup     boards
- * @brief       Support for the SenseBox MCU with SAMD21 board.
+@defgroup    boards_sensebox_samd21 SenseBox MCU with SAMD21
+@ingroup     boards
+@brief       Support for the SenseBox MCU with SAMD21 board.
 
 ### General information
 
@@ -66,4 +65,3 @@ This has the following limitations:
 - FSK mode is not possible
 - The interrupt pins can have different configurations, so caution is required
 when making changes.
- */
diff --git a/boards/waveshare-nrf52840-eval-kit/doc.md b/boards/waveshare-nrf52840-eval-kit/doc.md
@@ -1,4 +1,3 @@
-/**
 @defgroup   boards_waveshare_nrf52840_eval_kit Waveshare nRF52840 Eval Kit
 @ingroup    boards
 @brief      Support for the Waveshare nRF52840 Eval Kit
@@ -156,5 +155,3 @@ RESET_PIN='GPIO_PIN\(0,18\)' make BOARD=waveshare-nrf52840-eval-kit -C dist/tool
 ```
 Simply compile, flash, and run that tool on your board, and the reset pin should
 work for the time being.
-
- */
diff --git a/boards/yunjia-nrf51822/doc.md b/boards/yunjia-nrf51822/doc.md
