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

boards/doc.md: migrate to markdown

Browse Source
This commit is contained in:
Mikolai Gütschow 2025-02-26 15:49:09 +01:00
parent 4b52679fd7
commit 24305ff663
No known key found for this signature in database
GPG Key ID: 943E2F37AA659AD5
1 changed files with 8 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
boards/doc.txt → boards/doc.md
View File

@ -1,21 +1,12 @@
/*
* Copyright (C) 2013 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 Boards
@brief Board specific definitions and implementations
The boards module contains all definitions and implementations that are
specific to a certain board. Generally, boards consist of a fixed
configuration of a controller and some external devices such as sensors or
radios. All aspects concerning configuration of GPIO pins, MCU clock and
device drivers should go into this module.
/**
* @defgroup boards Boards
* @brief Board specific definitions and implementations
*
* The boards module contains all definitions and implementations that are
* specific to a certain board. Generally, boards consist of a fixed
* configuration of a controller and some external devices such as sensors or
* radios. All aspects concerning configuration of GPIO pins, MCU clock and
* device drivers should go into this module.
*
Board Selection Guide {#board-selection-guide}
=====================
@ -133,4 +124,3 @@ physically located it is recommended to search
using either `PA_10` or `UART1_RX` and the tx_pin can be found on CN5-1
using either `PA_9` or `UART1_TX`, it is recommended to use the GPIO pin as
sometimes the peripheral may be using an alternate pin
*/