kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-25 14:33:52 +01:00
Code Releases Activity

Merge pull request #21618 from krzysztof-cabaj/boards_rename_doc_txt_part2

Browse Source 
boards: rename doc.txt -> doc.md for boards which name's starts from a to d.
This commit is contained in:
crasbe 2025-07-24 11:21:31 +00:00 committed by GitHub
commit 6fb3b2918d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
69 changed files with 243 additions and 379 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
boards/acd52832/doc.txt → boards/acd52832/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_acd52832 ACD52832
@ingroup boards
@brief Support for the aconno™ ACD52832
@ -6,5 +5,3 @@
## Flash the board
See the `Flashing` section in @ref boards_common_nrf52.
*/

3
boards/adafruit-grand-central-m4-express/doc.txt → boards/adafruit-grand-central-m4-express/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_adafruit-grand-central-m4-express Adafruit Grand Central M4 Express
@ingroup boards
@brief Support for the Adafruit Grand Central M4 Express
@ -48,5 +47,3 @@ Readiness of the bootloader is indicated by LED pulsing in red.
The usual way to obtain a console on this board is using an emulated USB serial
port.
*/

3
boards/adafruit-itsybitsy-m4/doc.txt → boards/adafruit-itsybitsy-m4/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_adafruit-itsybitsy-m4 Adafruit-Itsybitsy-M4
@ingroup boards
@brief Support for the Adafruit-Itsybitsy-M4
@ -33,5 +32,3 @@ Readiness of the bootloader is indicated by LD1 pulsing in red.
### Accessing STDIO
The usual way to obtain a console on this board is using an emulated USB serial port.
*/

3
boards/adafruit-metro-m4-express/doc.txt → boards/adafruit-metro-m4-express/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_adafruit-metro-m4-express Adafruit Metro M4 Express
@ingroup boards
@brief Support for the Adafruit Metro M4 Express
@ -67,5 +66,3 @@ Accessing STDIO
The usual way to obtain a console on this board is using an emulated USB serial
port.
*/

3
boards/adafruit-pybadge/doc.txt → boards/adafruit-pybadge/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_adafruit-pybadge Adafruit PyBadge
@ingroup boards
@brief Support for the Adafruit PyBadge board.
@ -36,5 +35,3 @@ button before running the flash command provided above.
### Accessing STDIO via UART
STDIO of RIOT is directly available over the USB port.
*/

2
boards/airfy-beacon/doc.txt → boards/airfy-beacon/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_airfy-beacon Airfy Beacon
@ingroup boards
@brief Support for the Airfy Beacon board
@ -245,4 +244,3 @@ The UART pins are configured in `boards/airfy-beacon/include/periph_conf.h`.
The default values are PIN 17 and 18.
The default Baud rate is `115 200`.
*/

3
boards/alientek-pandora/doc.txt → boards/alientek-pandora/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_alientek-pandora Alientek Pandora
@ingroup boards
@brief Support for the Alientek Pandora board
@ -36,5 +35,3 @@ Use the `term` target to open a terminal:
make BOARD=alientek-pandora -C examples/basic/hello-world term
An on-board ST-Link compatible debugger is used to transport serial STDIO message.
*/

3
boards/arduino-due/doc.txt → boards/arduino-due/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-due Arduino Due
@ingroup boards
@brief Support for the Arduino Due board
@ -57,5 +56,3 @@ the preinstalled arduino bootloader. Connect your board using the programming
port to your host computer and type:
`make BOARD=arduino-due flash`
*/

2
boards/arduino-duemilanove/doc.txt → boards/arduino-duemilanove/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-duemilanove Arduino Duemilanove
@ingroup boards
@brief Support for the Arduino Duemilanove board
@ -24,4 +23,3 @@ type:
`make BOARD=arduino-duemilanove flash`
This should take care of everything!
*/

3
boards/arduino-leonardo/doc.txt → boards/arduino-leonardo/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-leonardo Arduino Leonardo
@ingroup boards
@brief Support for the Arduino Leonardo board
@ -58,5 +57,3 @@ the user program, flashing will fail. See below to work around
Mac Users have export the environment variable both `PORT` and `PROG_DEV`
to point to the device file of the TTL adapter (`PORT`) and the device file of
the Arduino Leonardo (`PROG_DEV`).
*/

2
boards/arduino-mkr1000/doc.txt → boards/arduino-mkr1000/doc.md
View File

@ -1,5 +1,3 @@
/**
@defgroup boards_arduino-mkr1000 Arduino MKR1000
@ingroup boards
@brief Support for the Arduino MKR1000 board.
*/

2
boards/arduino-mkrfox1200/doc.txt → boards/arduino-mkrfox1200/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-mkrfox1200 Arduino MKRFOX1200
@ingroup boards
@brief Support for the Arduino MKRFOX1200 board.
@ -34,4 +33,3 @@ STDIO of RIOT is directly available over the USB port.
The `TERM_DELAY` environment variable can be used to add a delay (in second)
before opening the serial terminal. The default value is 2s which should be
enough in most of the situation.
*/

2
boards/arduino-mkrwan1300/doc.txt → boards/arduino-mkrwan1300/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-mkrwan1300 Arduino MKR WAN 1300
@ingroup boards
@brief Support for the Arduino MKR WAN 1300 board.
@ -34,4 +33,3 @@ STDIO of RIOT is directly available over the USB port.
The `TERM_DELAY` environment variable can be used to add a delay (in second)
before opening the serial terminal. The default value is 2s which should be
enough in most of the situation.
*/

2
boards/arduino-mkrzero/doc.txt → boards/arduino-mkrzero/doc.md
View File

@ -1,5 +1,3 @@
/**
@defgroup boards_arduino-mkrzero Arduino MKRZERO
@ingroup boards
@brief Support for the Arduino MKRZERO board.
*/

2
boards/arduino-nano-33-ble-sense/doc.txt → boards/arduino-nano-33-ble-sense/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-nano-33-ble-sense Arduino Nano 33 BLE sense
@ingroup boards
@brief Support for the Arduino Nano 33 BLE Sense
@ -31,7 +30,6 @@ Use the `term` target to connect to the board serial port<br/>
```
make BOARD=arduino-nano-33-ble-sense -C examples/basic/hello-world term
```
*/
### Internal devices

2
boards/arduino-nano-33-ble/doc.txt → boards/arduino-nano-33-ble/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-nano-33-ble Arduino Nano 33 BLE
@ingroup boards
@brief Support for the Arduino Nano 33 BLE
@ -31,4 +30,3 @@ Use the `term` target to connect to the board serial port<br/>
```
make BOARD=arduino-nano-33-ble -C examples/basic/hello-world term
```
*/

2
boards/arduino-nano-33-iot/doc.txt → boards/arduino-nano-33-iot/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-nano-33-iot Arduino Nano 33 IoT
@ingroup boards
@brief Support for the Arduino Nano 33 IoT board.
@ -24,4 +23,3 @@ STDIO of RIOT is directly available over the USB port.
The `TERM_DELAY` environment variable can be used to add a delay (in second)
before opening the serial terminal. The default value is 2s which should be
enough in most of the situation.
*/

2
boards/arduino-zero/doc.txt → boards/arduino-zero/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_arduino-zero Arduino Zero
@ingroup boards
@brief Support for the Arduino Zero board.
@ -88,4 +87,3 @@ The default stack sizes have not been tuned properly yet. If in doubt why
your application crashes try increasing the default stack sizes and use `ps` to
find out how much stack is being used.
Tracked in https://github.com/RIOT-OS/RIOT/issues/2228
*/

3
boards/atmega256rfr2-xpro/doc.txt → boards/atmega256rfr2-xpro/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_atmega256rfr2-xpro Atmega256RFR2 Xplained Pro
@ingroup boards
@brief Support for the Atmega256RFR2 Xplained Pro board
@ -38,5 +37,3 @@ It will be used automatically with `make term`:
```
make BOARD=atmega256rfr2-xpro -C examples/basic/hello-world term
```
*/

3
boards/atmega8/doc.txt → boards/atmega8/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_atmega8 Standalone ATmega8
@ingroup boards
@brief Support for using the ATmega8 as standalone board
@ -95,5 +94,3 @@ Connect a TTL adapter with pins 2/RXD and 3/TXD an run
Please note that the supply voltage should be compatible with the logic level of
the TTL adapter. Usually everything between 3.3 V and 5 V should work.
*/

3
boards/atxmega-a1-xplained/doc.txt → boards/atxmega-a1-xplained/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_atxmega-a1-xplained ATxmega-A1 Xplained board
@ingroup boards
@brief Support for the ATxmega-A1 Xplained board
@ -48,5 +47,3 @@ The CDC-ACM will enumerate a /dev/ttyACM device. The STDIO at CDC-ACM shares
with J4 pins 2/3.
make BOARD=atxmega-a1-xplained term
*/

3
boards/atxmega-a1u-xpro/doc.txt → boards/atxmega-a1u-xpro/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_atxmega-a1u-xpro ATxmega-A1U Xplained Pro board
@ingroup boards
@brief Support for the ATxmega-A1U Xplained Pro board
@ -62,5 +61,3 @@ The CDC-ACM will enumerate a /dev/ttyACM device.
## On-Chip Debugging (OCD)
make debug
*/

3
boards/atxmega-a3bu-xplained/doc.txt → boards/atxmega-a3bu-xplained/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_atxmega-a3bu-xplained ATxmega-A3BU Xplained board
@ingroup boards
@brief Support for the ATxmega-A3BU Xplained board
@ -45,5 +44,3 @@ In order to flash the ATxmega256A3BU, simple run:
This board needs a serial converter. The default STDIO is at J1 pins 2/3.
make BOARD=atxmega-a3bu-xplained term
*/

6
boards/avr-rss2/doc.txt → boards/avr-rss2/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_avr-rss2 Atmega256RFR2 rss2
@ingroup boards
@brief Support for the Radio Sensors Atmega256RFR2 rss2 board
@ -7,7 +6,7 @@
Document version V1.4 2019-11-10<br>
Board is based AtMega256RFR2 with additional HW, EUI64 chip, HW comparator, RTC XTAL, BME280
- Directory `$(RIOTBASE)/boards/avr-rss2'
- Directory `$(RIOTBASE)/boards/avr-rss2`
### Board Features
@ -99,5 +98,4 @@ Contact vendor. For research legislation is more relaxed in most countries.
### Board (Rev2.4) anatomy with connectors
- http://radio-sensors.com/pictures/s2-2.4-front-edited.jpg
- http://radio-sensors.com/pictures/s2-2.4-back-port-edited.jpg
*/
- http://radio-sensors.com/pictures/s2-2.4-back-port-edited.jpg

2
boards/avsextrem/doc.txt → boards/avsextrem/doc.md
View File

@ -1,5 +1,3 @@
/**
@defgroup boards_avsextrem Avsextrem
@ingroup boards
@brief Support for the Avsextrem board
*/

2
boards/b-l072z-lrwan1/doc.txt → boards/b-l072z-lrwan1/doc.md
View File

@ -1,5 +1,3 @@
/**
@defgroup boards_b-l072z-lrwan1 ST B-L072Z-LRWAN1 LoRa discovery
@ingroup boards
@brief Support for the ST B-L072Z-LRWAN1 board
*/

2
boards/b-l475e-iot01a/doc.txt → boards/b-l475e-iot01a/doc.md
View File

@ -1,5 +1,3 @@
/**
@defgroup boards_b-l475e-iot01a ST B-L475E-IOT01A
@ingroup boards
@brief Support for the ST B-L475E-IOT01A board
*/

3
boards/b-u585i-iot02a/doc.txt → boards/b-u585i-iot02a/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_b-u585i-iot02a STM32 B-U585I-IOT02A
@ingroup boards
@brief Support for the STM32 B-U585I-IOT02A
@ -39,5 +38,3 @@ toolchain.
**Important notice:** With GCC 10, the `tests/sys/malloc` application doesn't work.
To use malloc, prefer GCC 9 which seems to work better.
*/

2
boards/calliope-mini/doc.txt → boards/calliope-mini/doc.md
View File

@ -1,5 +1,3 @@
/**
@defgroup boards_calliope-mini Calliope mini
@ingroup boards
@brief Support for the Calliope mini
*/

3
boards/common/atmega/doc.md Normal file
View File

@ -0,0 +1,3 @@
@defgroup boards_common_atmega ATmega common
@ingroup boards
@brief Shared files and configuration for ATmega-based boards

5
boards/common/atmega/doc.txt
View File

@ -1,5 +0,0 @@
/**
* @defgroup boards_common_atmega ATmega common
* @ingroup boards
* @brief Shared files and configuration for ATmega-based boards
*/

2
boards/common/atxmega/doc.txt → boards/common/atxmega/doc.md
View File

@ -1,5 +1,3 @@
/**
@defgroup boards_common_atxmega ATxmega common
@ingroup boards
@brief Shared files and configuration for ATxmega-based boards
*/

2
boards/common/blxxxpill/doc.txt → boards/common/blxxxpill/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_common_blxxxpill Blackpill and Bluepill common code
@ingroup boards_common
@brief Support for cheap stm32f103c8 based boards such as bluepill and blackpill.
@ -152,4 +151,3 @@ https://web.archive.org/web/20190428082446/http://wiki.stm32duino.com/index.php?
https://web.archive.org/web/20190428082446/http://wiki.stm32duino.com/index.php?title=Blue_Pill#Hardware_installation
[imgTop]:
https://web.archive.org/web/20190428082446/http://wiki.stm32duino.com/images/thumb/1/19/STM32_Blue_Pill_top.jpg/800px-STM32_Blue_Pill_top.jpg
*/

15
boards/common/cc2538/doc.md Normal file
View File

@ -0,0 +1,15 @@
<!--
Copyright (C) 2020 Inria
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_cc2538 cc2538 Configuration Snippets
@ingroup boards_common
@brief Board configuration snippets for cc2538-based boards
All boards using a cc2538 share certain parts of their configuration. This
module provides a collection of fine grained configuration snippets that can
be reused for different boards.

17
boards/common/cc2538/doc.txt
View File

@ -1,17 +0,0 @@
/*
* Copyright (C) 2020 Inria
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_cc2538 cc2538 Configuration Snippets
* @ingroup boards_common
* @brief Board configuration snippets for cc2538-based boards
*
* All boards using a cc2538 share certain parts of their configuration. This
* module provides a collection of fine grained configuration snippets that can
* be reused for different boards.
*/

2
boards/common/doc.txt → boards/common/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_common Common Board Groups
@ingroup boards
@brief Common definitions and implementations for board groups
@ -30,4 +29,3 @@ The following steps are tested with the STM32 bluepill board:
4. Flash RIOT binary by running `PROGRAMMER=dfu-util BOARD=bluepill make flash`
5. Reset Boot1 pin to 0 and reset device via button, this should boot the RIOT
binary.
*/

3
boards/common/e104-bt50xxa-tb/doc.md Normal file
View File

@ -0,0 +1,3 @@
@defgroup boards_common_e104-bt50xxa-tb E104-BT50xxA-TB common code
@ingroup boards_common
@brief Support for EBYTE nRF52 module breakout boards

6
boards/common/e104-bt50xxa-tb/doc.txt
View File

@ -1,6 +0,0 @@
/**
@defgroup boards_common_e104-bt50xxa-tb E104-BT50xxA-TB common code
@ingroup boards_common
@brief Support for EBYTE nRF52 module breakout boards
*/

24
boards/common/esp32/doc.md Normal file
View File

@ -0,0 +1,24 @@
<!--
Copyright (C) 2018 Gunar Schorcht
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_esp32 ESP32 Common
@ingroup boards_common
@ingroup boards_esp32
@brief Definitions and configurations that are common for all ESP32 boards.
For detailed information about the ESP32, configuring and compiling RIOT
for ESP32 boards, please refer \ref esp32_riot.
@defgroup boards_esp32 ESP32 Boards
@ingroup boards
@brief This group of boards contains the documentation of ESP32 boards.
@note For detailed information about the ESP32 SoC, the tool chain
as well as configuring and compiling RIOT for ESP32 boards,
see \ref esp32_riot.

28
boards/common/esp32/doc.txt
View File

@ -1,28 +0,0 @@
/*
* Copyright (C) 2018 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_esp32 ESP32 Common
* @ingroup boards_common
* @ingroup boards_esp32
* @brief Definitions and configurations that are common for
* all ESP32 boards.
*
* For detailed information about the ESP32, configuring and compiling RIOT
* for ESP32 boards, please refer \ref esp32_riot.
*/
/**
* @defgroup boards_esp32 ESP32 Boards
* @ingroup boards
* @brief This group of boards contains the documentation of ESP32 boards.
*
* @note For detailed information about the ESP32 SoC, the tool chain
* as well as configuring and compiling RIOT for ESP32 boards,
* see \ref esp32_riot.
*/

25
boards/common/esp32c3/doc.md Normal file
View File

@ -0,0 +1,25 @@
<!--
Copyright (C) 2018 Gunar Schorcht
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_esp32c3 ESP32-C3 Common
@ingroup boards_common
@ingroup boards_esp32c3
@brief Definitions and configurations that are common for
all ESP32-C3 boards.
For detailed information about the ESP32-C3, configuring and compiling RIOT
for ESP32-C3 boards, please refer \ref esp32_riot.
@defgroup boards_esp32c3 ESP32-C3 Boards
@ingroup boards
@brief This group of boards contains the documentation of ESP32-C3 boards.
@note For detailed information about the ESP32-C3 SoC, the tool chain
as well as configuring and compiling RIOT for ESP32-C3 boards,
see \ref esp32_riot.

28
boards/common/esp32c3/doc.txt
View File

@ -1,28 +0,0 @@
/*
* Copyright (C) 2018 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_esp32c3 ESP32-C3 Common
* @ingroup boards_common
* @ingroup boards_esp32c3
* @brief Definitions and configurations that are common for
* all ESP32-C3 boards.
*
* For detailed information about the ESP32-C3, configuring and compiling RIOT
* for ESP32-C3 boards, please refer \ref esp32_riot.
*/
/**
* @defgroup boards_esp32c3 ESP32-C3 Boards
* @ingroup boards
* @brief This group of boards contains the documentation of ESP32-C3 boards.
*
* @note For detailed information about the ESP32-C3 SoC, the tool chain
* as well as configuring and compiling RIOT for ESP32-C3 boards,
* see \ref esp32_riot.
*/

24
boards/common/esp32s2/doc.md Normal file
View File

@ -0,0 +1,24 @@
<!--
Copyright (C) 2018 Gunar Schorcht
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_esp32s2 ESP32-S2 Common
@ingroup boards_common
@ingroup boards_esp32s2
@brief Definitions and configurations that are common for
all ESP32-S2 boards.
For detailed information about the ESP32-S2, configuring and compiling RIOT
for ESP32-S2 boards, please refer \ref esp32_riot.
@defgroup boards_esp32s2 ESP32-S2 Boards
@ingroup boards
@brief This group of boards contains the documentation of ESP32-S2 boards.
@note For detailed information about the ESP32-S2 SoC, the tool chain
as well as configuring and compiling RIOT for ESP32-S2 boards,
see \ref esp32_riot.

28
boards/common/esp32s2/doc.txt
View File

@ -1,28 +0,0 @@
/*
* Copyright (C) 2018 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_esp32s2 ESP32-S2 Common
* @ingroup boards_common
* @ingroup boards_esp32s2
* @brief Definitions and configurations that are common for
* all ESP32-S2 boards.
*
* For detailed information about the ESP32-S2, configuring and compiling RIOT
* for ESP32-S2 boards, please refer \ref esp32_riot.
*/
/**
* @defgroup boards_esp32s2 ESP32-S2 Boards
* @ingroup boards
* @brief This group of boards contains the documentation of ESP32-S2 boards.
*
* @note For detailed information about the ESP32-S2 SoC, the tool chain
* as well as configuring and compiling RIOT for ESP32-S2 boards,
* see \ref esp32_riot.
*/

24
boards/common/esp32s3/doc.md Normal file
View File

@ -0,0 +1,24 @@
<!--
Copyright (C) 2018 Gunar Schorcht
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_esp32s3 ESP32-S3 Common
@ingroup boards_common
@ingroup boards_esp32s3
@brief Definitions and configurations that are common for
all ESP32-S3 boards.
For detailed information about the ESP32-S3, configuring and compiling RIOT
for ESP32-S3 boards, please refer \ref esp32_riot.
@defgroup boards_esp32s3 ESP32-S3 Boards
@ingroup boards
@brief This group of boards contains the documentation of ESP32-S3 boards.
@note For detailed information about the ESP32-S3 SoC, the tool chain
as well as configuring and compiling RIOT for ESP32-S3 boards,
see \ref esp32_riot.

28
boards/common/esp32s3/doc.txt
View File

@ -1,28 +0,0 @@
/*
* Copyright (C) 2018 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_esp32s3 ESP32-S3 Common
* @ingroup boards_common
* @ingroup boards_esp32s3
* @brief Definitions and configurations that are common for
* all ESP32-S3 boards.
*
* For detailed information about the ESP32-S3, configuring and compiling RIOT
* for ESP32-S3 boards, please refer \ref esp32_riot.
*/
/**
* @defgroup boards_esp32s3 ESP32-S3 Boards
* @ingroup boards
* @brief This group of boards contains the documentation of ESP32-S3 boards.
*
* @note For detailed information about the ESP32-S3 SoC, the tool chain
* as well as configuring and compiling RIOT for ESP32-S3 boards,
* see \ref esp32_riot.
*/

15
boards/common/esp32x/doc.md Normal file
View File

@ -0,0 +1,15 @@
<!--
Copyright (C) 2018 Gunar Schorcht
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_esp32x ESP32x Common
@ingroup boards_common
@brief Definitions and configurations that are common for
all ESP32x boards.
For detailed information about ESP32x SoCs, configuring and compiling RIOT
for ESP32x boards, please refer \ref esp32_riot.

17
boards/common/esp32x/doc.txt
View File

@ -1,17 +0,0 @@
/*
* Copyright (C) 2018 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_esp32x ESP32x Common
* @ingroup boards_common
* @brief Definitions and configurations that are common for
* all ESP32x boards.
*
* For detailed information about ESP32x SoCs, configuring and compiling RIOT
* for ESP32x boards, please refer \ref esp32_riot.
*/

17
boards/common/esp8266/doc.md Normal file
View File

@ -0,0 +1,17 @@
@defgroup boards_common_esp8266 ESP8266 Common
@ingroup boards_common
@ingroup boards_esp8266
@brief Definitions and configurations that are common for
all ESP8266 boards.
For detailed information about the ESP8266, configuring and compiling RIOT
for ESP8266 boards, please refer \ref esp8266_riot.
@defgroup boards_esp8266 ESP8266 Boards
@ingroup boards
@brief This group of boards contains the documentation
defined ESP8266 boards.
@note For detailed information about the ESP8266 SoC, the tool chain
as well as configuring and compiling RIOT for ESP8266 boards,
see \ref esp8266_riot.

21
boards/common/esp8266/doc.txt
View File

@ -1,21 +0,0 @@
/**
* @defgroup boards_common_esp8266 ESP8266 Common
* @ingroup boards_common
* @ingroup boards_esp8266
* @brief Definitions and configurations that are common for
* all ESP8266 boards.
*
* For detailed information about the ESP8266, configuring and compiling RIOT
* for ESP8266 boards, please refer \ref esp8266_riot.
*/
/**
* @defgroup boards_esp8266 ESP8266 Boards
* @ingroup boards
* @brief This group of boards contains the documentation
* defined ESP8266 boards.
*
* @note For detailed information about the ESP8266 SoC, the tool chain
* as well as configuring and compiling RIOT for ESP8266 boards,
* see \ref esp8266_riot.
*/

11
boards/common/frdm/doc.md Normal file
View File

@ -0,0 +1,11 @@
<!--
Copyright (C) 2017 HAW Hamburg
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_frdm NXP FRDM Common
@ingroup boards_common
@brief Shared files and configuration for the NXP Freedom Boards.

13
boards/common/frdm/doc.txt
View File

@ -1,13 +0,0 @@
/*
* Copyright (C) 2017 HAW Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_frdm NXP FRDM Common
* @ingroup boards_common
* @brief Shared files and configuration for the NXP Freedom Boards.
*/

15
boards/common/gd32v/doc.md Normal file
View File

@ -0,0 +1,15 @@
<!--
Copyright (C) 2023 Gunar Schorcht
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_gd32v GD32V Common Configuration
@ingroup boards_common
@brief Definitions and configurations that are common for
all GD32VF103 boards.
All boards using a MCU from the GD32VF103 family share some parts of their
configuration.

17
boards/common/gd32v/doc.txt
View File

@ -1,17 +0,0 @@
/*
* Copyright (C) 2023 Gunar Schorcht
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_gd32v GD32V Common Configuration
* @ingroup boards_common
* @brief Definitions and configurations that are common for
* all GD32VF103 boards.
*
* All boards using a MCU from the GD32VF103 family share some parts of their
* configuration.
*/

15
boards/common/msp430/doc.md Normal file
View File

@ -0,0 +1,15 @@
<!--
Copyright (C) 2023 Otto-von-Guericke-Universität Magdeburg
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_msp430 Common Configuration Snippets for MSP430 boards
@ingroup boards_common
@brief Board configuration snippets for MSP430-based boards
All boards using a CPU from the MSP430 family share certain parts of their
configuration. This module provides a collection of fine grained
configuration snippets that can be reused for different boards.

17
boards/common/msp430/doc.txt
View File

@ -1,17 +0,0 @@
/*
* Copyright (C) 2023 Otto-von-Guericke-Universität Magdeburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_msp430 Common Configuration Snippets for MSP430 boards
* @ingroup boards_common
* @brief Board configuration snippets for MSP430-based boards
*
* All boards using a CPU from the MSP430 family share certain parts of their
* configuration. This module provides a collection of fine grained
* configuration snippets that can be reused for different boards.
*/

3
boards/common/nrf52/doc.txt → boards/common/nrf52/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_common_nrf52 nRF52 common
@ingroup boards_common
@brief Common files and configuration for nRF52 boards.
@ -30,5 +29,3 @@ debugger/programmer with OpenOCD to flash a nrf52 board:
```
PROGRAMMER=openocd OPENOCD_DEBUG_ADAPTER=stlink make BOARD=<nrf52 board> -C examples/basic/hello-world flash
```
*/

3
boards/common/particle-mesh/doc.txt → boards/common/particle-mesh/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_common_particle-mesh Particle Mesh common
@ingroup boards
@brief Common support for the Particle Mesh boards family (Xenon, Argon, Boron)
@ -97,5 +96,3 @@ board_nrfantenna_select function.
The external antenna connection should only be enabled if a suitable antenna is
connected.
*/

11
boards/common/silabs/doc.md Normal file
View File

@ -0,0 +1,11 @@
<!--
Copyright (C) 2018 Bas Stottelaar <basstottelaar@gmail.com>
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_silabs Silicon Labs Common
@ingroup boards_common
@brief Shared files and configuration for the Silicon Labs boards.

13
boards/common/silabs/doc.txt
View File

@ -1,13 +0,0 @@
/*
* Copyright (C) 2018 Bas Stottelaar <basstottelaar@gmail.com>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_silabs Silicon Labs Common
* @ingroup boards_common
* @brief Shared files and configuration for the Silicon Labs boards.
*/

14
boards/common/silabs/drivers/doc.md Normal file
View File

@ -0,0 +1,14 @@
<!--
Copyright (C) 2018 Bas Stottelaar <basstottelaar@gmail.com>
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_silabs_drivers Silicon Labs Common Drivers
@ingroup boards_common_silabs
@brief Silicon Labs board specific drivers
This module contains drivers specific for the Silicon Labs development
boards.

16
boards/common/silabs/drivers/doc.txt
View File

@ -1,16 +0,0 @@
/*
* Copyright (C) 2018 Bas Stottelaar <basstottelaar@gmail.com>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_silabs_drivers Silicon Labs Common Drivers
* @ingroup boards_common_silabs
* @brief Silicon Labs board specific drivers
*
* This module contains drivers specific for the Silicon Labs development
* boards.
*/

10
boards/common/slwstk6000b/doc.txt → boards/common/slwstk6000b/doc.md
View File

@ -1,7 +1,6 @@
/**
* @defgroup boards_common_slwstk6000b Silicon Labs SLWSTK6000B starter kit
* @ingroup boards
* @brief Support for the Silicon Labs SLWSTK6000B starter kit
@defgroup boards_common_slwstk6000b Silicon Labs SLWSTK6000B starter kit
@ingroup boards
@brief Support for the Silicon Labs SLWSTK6000B starter kit
## Overview
Silicon Labs Mighty Gecko Wireless Starter Kit is equipped with the EFM32
@ -210,5 +209,4 @@ usage of the [GNU Tools for ARM Embedded Processors](https://developer.arm.com/o
toolchain.
## License information
* Silicon Labs' EMLIB: zlib-style license (permits distribution of source).
*/
Silicon Labs' EMLIB: zlib-style license (permits distribution of source).

15
boards/common/stm32/doc.md Normal file
View File

@ -0,0 +1,15 @@
<!--
Copyright (C) 2018 Freie Universität Berlin
This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
@defgroup boards_common_stm32 STM32 Configuration Snippets
@ingroup boards_common
@brief Board configuration snippets for STM32-based boards
All boards using a CPU from the STM32 family share certain parts of their
configuration. This module provides a collection of fine grained
configuration snippets that can be reused for different boards.

17
boards/common/stm32/doc.txt
View File

@ -1,17 +0,0 @@
/*
* Copyright (C) 2018 Freie Universität Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup boards_common_stm32 STM32 Configuration Snippets
* @ingroup boards_common
* @brief Board configuration snippets for STM32-based boards
*
* All boards using a CPU from the STM32 family share certain parts of their
* configuration. This module provides a collection of fine grained
* configuration snippets that can be reused for different boards.
*/

3
boards/common/weact-f4x1cx/doc.txt → boards/common/weact-f4x1cx/doc.md
View File

@ -1,6 +1,3 @@
/**
@defgroup boards_common_weact-f4x1cx WeAct-F4x1Cx common code
@ingroup boards_common
@brief Support for cheap stm32f401/stm32f411 based boards by WeAct.
*/

8
boards/derfmega128/doc.txt → boards/derfmega128/doc.md
View File

@ -1,7 +1,6 @@
/**
* @defgroup boards_deRFmega128 deRFmega128 modules from Dresden Elektronik
* @ingroup boards
* @brief Support for deRFmega128 modules produced by Dresden Elektronik
@defgroup boards_deRFmega128 deRFmega128 modules from Dresden Elektronik
@ingroup boards
@brief Support for deRFmega128 modules produced by Dresden Elektronik
# Overview
deRFmega128 is a family of modules produced by Dresden Elektronik.
@ -28,4 +27,3 @@ For details see the according data sheets:
- [deRFmega128-22M00 and deRFmega128-22M10](https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22M00-22M10-DBT-de.pdf)
- [deRFmega128-22A00 and deRFmega128-22C00](https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22A00-C00-DBT-de.pdf)
- [deRFmega128-22A02 and deRFmega128-22C02](https://www.dresden-elektronik.de/files/dresden-elektronik/content/downloads/datenblaetter/_outdated/deRFmega128-22A02-C02-DBT-de.pdf)
*/

9
boards/derfmega256/doc.txt → boards/derfmega256/doc.md
View File

@ -1,7 +1,6 @@
/**
* @defgroup boards_deRFmega256 deRFmega256 modules from Dresden Elektronik
* @ingroup boards
* @brief Support for deRFmega256 modules produced by Dresden Elektronik
@defgroup boards_deRFmega256 deRFmega256 modules from Dresden Elektronik
@ingroup boards
@brief Support for deRFmega256 modules produced by Dresden Elektronik
# Overview
deRFmega256 is a family of modules produced by Dresden Elektronik.
@ -14,5 +13,3 @@ as separate products or as a main part of other products like [RaspBee](https://
# Hardware
The [datasheet](https://usermanual.wiki/dresden-elektronik-ingenieurtechnik/MEGA23M12.15-MEGA23M12-User-Manual/info) for modules.
*/

2
boards/dwm1001/doc.txt → boards/dwm1001/doc.md
View File

@ -1,4 +1,3 @@
/**
@defgroup boards_dwm1001 Decawave DWM1001
@ingroup boards
@brief Support for the Decawave DWM1001 development board
@ -37,4 +36,3 @@ Use the `term` target to connect to the board serial port<br/>
```
make BOARD=dwm1001 -C examples/basic/hello-world term
```
*/