boards:rename doc.txt->doc.md for boards which name's starts from e-h

2025-12-15 17:43:51 +01:00 · 2025-07-31 10:56:49 +02:00 · 2025-07-31 10:56:49 +02:00 · edcd20fc0d
commit edcd20fc0d
parent 01929dbcc3
15 changed files with 10 additions and 45 deletions
--- a/boards/e104-bt5010a-tb/doc.txt
+++ b/boards/e104-bt5010a-tb/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_e104-bt5010a-tb E104-BT5010A Test Board
@ingroup     boards
@brief       Support for the Ebyte E104-BT5010A Test Board (nRF52810)
@ -27,5 +26,3 @@ Use the `term` target to connect to the board serial port<br/>
 ```
    make BOARD=e104-bt5010a-tb -C examples/basic/hello-world term
 ```
-
- */
--- a/boards/e104-bt5011a-tb/doc.txt
+++ b/boards/e104-bt5011a-tb/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_e104-bt5011a-tb E104-BT5011A Test Board
@ingroup     boards
@brief       Support for the Ebyte E104-BT5011A Test Board (nRF52811)
@ -27,5 +26,3 @@ Use the `term` target to connect to the board serial port<br/>
 ```
    make BOARD=e104-bt5011a-tb -C examples/basic/hello-world term
 ```
-
- */
--- a/boards/e180-zg120b-tb/doc.txt
+++ b/boards/e180-zg120b-tb/doc.txt
@ -1,7 +1,6 @@
-/**
- * @defgroup    boards_e180-zg120b-tb Ebyte E180-ZG120B-TB Test Board
- * @ingroup     boards
- * @brief       Support for Ebyte E180-ZG120B-TB Test Board
+@defgroup   boards_e180-zg120b-tb Ebyte E180-ZG120B-TB Test Board
+@ingroup    boards
+@brief      Support for Ebyte E180-ZG120B-TB Test Board

 ## Overview
 ![Image of the E180-ZG120B test board](https://www.ebyte.com/Uploadfiles/Picture/2019-12-20/201912201352132348.jpg)
@ -261,5 +260,4 @@ the usage of the [GNU Tools for ARM Embedded Processors](https://developer.arm.c
 toolchain.

 ## License information
-* Ebyte' EMLIB: zlib-style license (permits distribution of source).
- */
+Ebyte' EMLIB: zlib-style license (permits distribution of source).
--- a/boards/ek-lm4f120xl/doc.txt
+++ b/boards/ek-lm4f120xl/doc.txt
@ -1,5 +1,3 @@
-/**
@defgroup    boards_ek-lm4f120xl EK-LM4F120XL
@ingroup     boards
@brief       Support for the Stellaris Launchpad LM4F120 board
- */
--- a/boards/f4vi1/doc.txt
+++ b/boards/f4vi1/doc.txt
@ -1,5 +1,3 @@
-/**
@defgroup    boards_f4vi1  F4VI1
@ingroup     boards
@brief       Support for the F4VI1 board
- */
--- a/boards/firefly/doc.txt
+++ b/boards/firefly/doc.txt
@ -1,7 +1,6 @@
-/**
- * @defgroup    boards_firefly Firefly Board
- * @ingroup     boards
- * @brief       Support for the Firefly board
+@defgroup   boards_firefly Firefly Board
+@ingroup    boards
+@brief      Support for the Firefly board

 Zolertia Firefly platform
 ============================================
@ -128,5 +127,3 @@ More Reading
 [zolertia-wiki]: https://github.com/Zolertia/Resources/wiki
 [cc1200]: http://www.ti.com/product/cc1200     "CC1200"
 [cc2538]: http://www.ti.com/product/cc2538     "CC2538"
-
-*/
--- a/boards/frdm-k22f/doc.txt
+++ b/boards/frdm-k22f/doc.txt
@ -1,5 +1,3 @@
-/**
@defgroup    boards_frdm-k22f NXP FRDM-K22F Board
@ingroup     boards
@brief       Support for the NXP FRDM-K22F
- */
--- a/boards/frdm-k64f/doc.txt
+++ b/boards/frdm-k64f/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_frdm-k64f NXP FRDM-K64F Board
@ingroup     boards
@brief       Support for the NXP FRDM-K64F
@ -98,4 +97,3 @@ in `boards/frdm-k64f/dist/openocd.cfg`

 Solution 3:
 + Ask Deep Thought
- */
--- a/boards/frdm-kw41z/doc.md
+++ b/boards/frdm-kw41z/doc.md
@ -0,0 +1,3 @@
+@defgroup   boards_frdm-kw41z Freescale FRDM-KW41Z Board
+@ingroup    boards
+@brief      Support for the FRDM-KW41Z
--- a/boards/frdm-kw41z/doc.txt
+++ b/boards/frdm-kw41z/doc.txt
@ -1,5 +0,0 @@
-/**
- * @defgroup    boards_frdm-kw41z Freescale FRDM-KW41Z Board
- * @ingroup     boards
- * @brief       Support for the FRDM-KW41Z
- */
--- a/boards/gba_cartridge/doc.txt
+++ b/boards/gba_cartridge/doc.txt
@ -1,5 +1,3 @@
-/**
@defgroup    boards_gba_cartridge GBA
@ingroup     boards
@brief       Support for the GBA
- */
--- a/boards/gd32vf103c-start/doc.txt
+++ b/boards/gd32vf103c-start/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup   boards_gd32vf103c_start GD32VF103C-START
@ingroup    boards
@brief      Support for the GD32VF103C-START board
@ -99,5 +98,3 @@ needs to be connected to the USB connector labeled OTG.
@note   It is safe to keep the jumper at JP2 in "Usart" position or even
        remove the jumper with RIOT. PA9 is still used as UART/TXD and VBUS
        sensing is disabled anyway.
-
- */
--- a/boards/generic-cc2538-cc2592-dk/doc.txt
+++ b/boards/generic-cc2538-cc2592-dk/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_generic_cc2538_cc2592_dk Generic CC2538-CC2592-DK Board
@ingroup     boards
@brief       Support for the 3rd party CC2538-CC2592-DK board
@ -80,5 +79,3 @@ make BOARD=generic-cc2538-cc2592-dk debug

@note   By default OpenOCD is used for debugging. While debugging works fine
        with OpenOCD, flashing is only supported via the bootloader or `jlink`.
-
- */
--- a/boards/hamilton/doc.txt
+++ b/boards/hamilton/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_hamilton HamiltonIoT Hamilton
@ingroup     boards
@brief       Support for the HamiltonIoT Hamilton board.
@ -6,5 +5,3 @@
@image html "https://github.com/immesys/baseliner/raw/fa1f224b0a6eaf101dfeb2abe3127ecc5acd0986/misc/hamilton-sm.jpg" "Image of the Hamilton IoT board next to coin" width=80%

 See https://github.com/hamilton-mote/hw for more details on the hardware.
-
- */
--- a/boards/hip-badge/doc.txt
+++ b/boards/hip-badge/doc.txt
@ -1,4 +1,3 @@
-/**
@defgroup    boards_hip_badge HiP Badge
@ingroup     boards_esp32c3
@brief       Support for the Hacking in Parallel Badge
@ -51,5 +50,3 @@ The event (and badge) were organized on short notice (6 Weeks), so there are som

 - [Badge Clinic](https://wiki.hip-berlin.de/index.php?title=Badge_Clinic)
 - [Design files](https://gitlab.com/tidklaas/hip-badge/)
-
- */