Skip to content

Commit 978736a

Browse files
krzysztof-cabajkrzysztof-cabaj
committed
cpu: rename doc.txt -> doc.md for ESP
1 parent 4568420 commit 978736a

File tree

7 files changed

+72
-85
lines changed

7 files changed

+72
-85
lines changed

‎cpu/esp32/esp-ble-nimble/doc.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!--
2+
Copyright (C) 2022 Gunar Schorcht
3+
4+
This file is subject to the terms and conditions of the GNU Lesser
5+
General Public License v2.1. See the file LICENSE in the top level
6+
directory for more details.
7+
-->
8+
9+
@defgroup cpu_esp32_esp_ble_nimble ESP32 Bluetooth LE HCI for NimBLE host
10+
@ingroup cpu_esp32
11+
@brief ESP32 Bluetooth LE HCI implementation for NimBLE host
12+
13+
This module realizes the HCI for NimBLE host using the ESP32 Bluetooth controller
14+
15+
@author Gunar Schorcht <[email protected]>

‎cpu/esp32/esp-ble-nimble/doc.txt‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎cpu/esp32/esp-eth/doc.txt‎ renamed to ‎cpu/esp32/esp-eth/doc.md‎

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
1-
/*
2-
* Copyright (C) 2018 Gunar Schorcht
3-
*
4-
* This file is subject to the terms and conditions of the GNU Lesser
5-
* General Public License v2.1. See the file LICENSE in the top level
6-
* directory for more details.
7-
*/
8-
9-
/**
10-
* @defgroup cpu_esp32_esp_eth ESP32 Ethernet netdev interface
11-
* @ingroup cpu_esp32
12-
* @brief ESP32 ethernet network device driver
13-
*
14-
* This module realizes a netdev interface using the ESP32 Ethernet MAC
15-
* module.
16-
*
17-
* @author Gunar Schorcht <[email protected]>
1+
<!--
2+
Copyright (C) 2018 Gunar Schorcht
3+
4+
This file is subject to the terms and conditions of the GNU Lesser
5+
General Public License v2.1. See the file LICENSE in the top level
6+
directory for more details.
7+
-->
8+
9+
@defgroup cpu_esp32_esp_eth ESP32 Ethernet netdev interface
10+
@ingroup cpu_esp32
11+
@brief ESP32 ethernet network device driver
12+
13+
This module realizes a netdev interface using the ESP32 Ethernet MAC
14+
module.
15+
16+
@author Gunar Schorcht <[email protected]>
1817

1918
ESP32 provides an <b>Ethernet MAC layer module (EMAC)</b> according to the IEEE 802.3 standard which can be used together with an external physical layer chip (PHY) to realize a 100/10 Mbps Ethernet interface. Supported PHY chips are the Microchip LAN8710/LAN8720, the IC Plus 101G, and the Texas Instruments TLK110.
2019

@@ -30,4 +29,3 @@ Otherwise, the application has to add the ```esp_eth``` module in its makefile w
3029

3130
@note
3231
The board has to have one of the supported PHY modules to be able to use the Ethernet MAC module.
33-
*/

‎cpu/esp8266/sdk/doc.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!--
2+
Copyright (C) 2018 Gunar Schorcht
3+
4+
This file is subject to the terms and conditions of the GNU Lesser
5+
General Public License v2.1. See the file LICENSE in the top level
6+
directory for more details.
7+
-->
8+
9+
@defgroup cpu_esp8266_sdk ESP8266 SDK interface
10+
@ingroup cpu_esp8266
11+
@brief Function declarations and mappings for compatibility with ESP8266 SDK

‎cpu/esp8266/sdk/doc.txt‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎cpu/esp_common/esp-now/doc.txt‎ renamed to ‎cpu/esp_common/esp-now/doc.md‎

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
/*
2-
* Copyright (C) 2018 Gunar Schorcht
3-
*
4-
* This file is subject to the terms and conditions of the GNU Lesser
5-
* General Public License v2.1. See the file LICENSE in the top level
6-
* directory for more details.
7-
*/
8-
9-
/**
10-
* @defgroup cpu_esp_common_esp_now ESP-NOW netdev interface
11-
* @ingroup cpu_esp_common
12-
* @ingroup cpu_esp32
13-
* @ingroup cpu_esp8266
14-
* @brief WiFi based ESP-NOW network device driver
15-
*
16-
* @author Gunar Schorcht <[email protected]>
1+
<!--
2+
Copyright (C) 2018 Gunar Schorcht
3+
4+
This file is subject to the terms and conditions of the GNU Lesser
5+
General Public License v2.1. See the file LICENSE in the top level
6+
directory for more details.
7+
-->
8+
9+
@defgroup cpu_esp_common_esp_now ESP-NOW netdev interface
10+
@ingroup cpu_esp_common
11+
@ingroup cpu_esp32
12+
@ingroup cpu_esp8266
13+
@brief WiFi based ESP-NOW network device driver
14+
15+
@author Gunar Schorcht <[email protected]>
1716

1817
This module realizes a netdev interface using Espressif's ESP-NOW technology which uses the built-in WiFi module.
1918

@@ -48,5 +47,3 @@ a mesh network which uses ESP-NOW.
4847
In this case the ESP-NOW interface must use the same channel as the AP of the
4948
infrastructure WiFi network. All ESP-NOW nodes must therefore be compiled with
5049
the channel of the AP asvalue for the parameter 'ESP_NOW_CHANNEL'.
51-
52-
*/

‎cpu/esp_common/esp-wifi/doc.txt‎ renamed to ‎cpu/esp_common/esp-wifi/doc.md‎

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
/*
2-
* Copyright (C) 2019 Gunar Schorcht
3-
*
4-
* This file is subject to the terms and conditions of the GNU Lesser
5-
* General Public License v2.1. See the file LICENSE in the top level
6-
* directory for more details.
7-
*/
8-
9-
/**
10-
* @defgroup cpu_esp_common_esp_wifi ESP-WiFi netdev interface
11-
* @ingroup cpu_esp_common
12-
* @ingroup cpu_esp32
13-
* @ingroup cpu_esp8266
14-
* @brief Network device driver for the ESP SoC WiFi interface
15-
*
16-
* @author Gunar Schorcht <[email protected]>
17-
*/
1+
<!--
2+
Copyright (C) 2019 Gunar Schorcht
3+
4+
This file is subject to the terms and conditions of the GNU Lesser
5+
General Public License v2.1. See the file LICENSE in the top level
6+
directory for more details.
7+
-->
8+
9+
@defgroup cpu_esp_common_esp_wifi ESP-WiFi netdev interface
10+
@ingroup cpu_esp_common
11+
@ingroup cpu_esp32
12+
@ingroup cpu_esp8266
13+
@brief Network device driver for the ESP SoC WiFi interface
14+
15+
@author Gunar Schorcht <[email protected]>
1816

1917
This module realizes a `netdev` interface for the built-in WiFi interface of
2018
ESP SoCs.
@@ -117,5 +115,3 @@ a mesh network which uses ESP-NOW.
117115
In this case the ESP-NOW interface must use the same channel as the AP of the
118116
infrastructure WiFi network. All ESP-NOW nodes must therefore be compiled with
119117
the channel of the AP asvalue for the parameter 'ESP_NOW_CHANNEL'.
120-
121-
*/

0 commit comments

Comments
 (0)