From 24305ff6638cf25ea3f85e64d3de4b2083feff2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikolai=20G=C3=BCtschow?= Date: Wed, 26 Feb 2025 15:49:09 +0100 Subject: [PATCH] boards/doc.md: migrate to markdown --- boards/{doc.txt => doc.md} | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) rename boards/{doc.txt => doc.md} (94%) diff --git a/boards/doc.txt b/boards/doc.md similarity index 94% rename from boards/doc.txt rename to boards/doc.md index 465e8e3efb..b389d3e37e 100644 --- a/boards/doc.txt +++ b/boards/doc.md @@ -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 - */