From 49ab2f0ef2f8af4ff304b25850234beedf2a9f11 Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Tue, 5 Oct 2021 16:06:58 +0200 Subject: [PATCH] boards/*esp32*: Fix documentation format Fix broken references and missing open/closing group commands. --- boards/common/esp32/include/board_common.h | 4 ++-- boards/common/esp32/include/periph_conf_common.h | 5 +++-- boards/esp32-ethernet-kit-v1_0/doc_common.txt | 2 +- boards/esp32-ethernet-kit-v1_0/include/periph_conf.h | 3 ++- boards/esp32-heltec-lora32-v2/doc.txt | 8 ++++---- boards/esp32-heltec-lora32-v2/include/arduino_pinmap.h | 2 +- boards/esp32-heltec-lora32-v2/include/board.h | 4 ++-- boards/esp32-heltec-lora32-v2/include/periph_conf.h | 4 ++-- boards/esp32-mh-et-live-minikit/doc.txt | 8 ++++---- boards/esp32-mh-et-live-minikit/include/arduino_pinmap.h | 2 +- boards/esp32-mh-et-live-minikit/include/board.h | 4 ++-- boards/esp32-mh-et-live-minikit/include/board_modules.h | 4 ++-- boards/esp32-mh-et-live-minikit/include/periph_conf.h | 4 ++-- boards/esp32-olimex-evb/doc.txt | 8 ++++---- boards/esp32-olimex-evb/include/arduino_pinmap.h | 2 +- boards/esp32-olimex-evb/include/board.h | 4 ++-- boards/esp32-olimex-evb/include/periph_conf.h | 4 ++-- boards/esp32-ttgo-t-beam/doc.txt | 6 +++--- boards/esp32-ttgo-t-beam/include/arduino_pinmap.h | 2 +- boards/esp32-ttgo-t-beam/include/board.h | 4 ++-- boards/esp32-ttgo-t-beam/include/periph_conf.h | 4 ++-- boards/esp32-wemos-lolin-d32-pro/doc.txt | 8 ++++---- boards/esp32-wemos-lolin-d32-pro/include/arduino_pinmap.h | 2 +- boards/esp32-wemos-lolin-d32-pro/include/board.h | 4 ++-- boards/esp32-wemos-lolin-d32-pro/include/periph_conf.h | 4 ++-- boards/esp32-wroom-32/doc.txt | 8 ++++---- boards/esp32-wroom-32/include/arduino_pinmap.h | 2 +- boards/esp32-wroom-32/include/board.h | 4 ++-- boards/esp32-wroom-32/include/periph_conf.h | 4 ++-- boards/esp32-wrover-kit/include/arduino_pinmap.h | 2 +- boards/esp32-wrover-kit/include/board.h | 6 ++++-- boards/esp32-wrover-kit/include/periph_conf.h | 4 ++-- 32 files changed, 70 insertions(+), 66 deletions(-) diff --git a/boards/common/esp32/include/board_common.h b/boards/common/esp32/include/board_common.h index 5d20a889f0..38f0ff7fe3 100644 --- a/boards/common/esp32/include/board_common.h +++ b/boards/common/esp32/include/board_common.h @@ -13,7 +13,7 @@ * This file contains board configurations that are valid for all ESP32. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @author Gunar Schorcht * @file @@ -112,7 +112,7 @@ extern "C" { * @brief MTD drive start address in SPI flash memory * * Defines the start address of the MTD system device in the SPI - * flash memory. It can be overridden by \ref esp32_app_spec_conf + * flash memory. It can be overridden by \ref esp32_application_specific_configurations * "application-specific board configuration" * * If the MTD start address is not defined or is 0, the first possible diff --git a/boards/common/esp32/include/periph_conf_common.h b/boards/common/esp32/include/periph_conf_common.h index dbfb390c4c..437ba58f49 100644 --- a/boards/common/esp32/include/periph_conf_common.h +++ b/boards/common/esp32/include/periph_conf_common.h @@ -13,7 +13,7 @@ * This file contains peripheral configurations that are valid for all ESP32. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @author Gunar Schorcht * @file @@ -170,6 +170,7 @@ static const gpio_t pwm1_channels[] = PWM1_GPIOS; /** * @name SPI configuration + * @{ */ /** @@ -205,11 +206,11 @@ static const spi_conf_t spi_config[] = { * @note SPI_NUMOF definition must not be changed. */ #define SPI_NUMOF ARRAY_SIZE(spi_config) - /** @} */ /** * @name UART configuration + * @{ */ #ifndef UART0_TXD diff --git a/boards/esp32-ethernet-kit-v1_0/doc_common.txt b/boards/esp32-ethernet-kit-v1_0/doc_common.txt index 2c8dc5bae8..cf22c2d72e 100644 --- a/boards/esp32-ethernet-kit-v1_0/doc_common.txt +++ b/boards/esp32-ethernet-kit-v1_0/doc_common.txt @@ -47,7 +47,7 @@ This section describes ### MCU    [[TOC](#toc)] Most features of the board are provided by the ESP32 SoC. For detailed -information about the ESP32, see section \ref esp32_mcu "MCU ESP32". +information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32". ### Board Configuration    [[TOC](#toc)] diff --git a/boards/esp32-ethernet-kit-v1_0/include/periph_conf.h b/boards/esp32-ethernet-kit-v1_0/include/periph_conf.h index ad86adaddb..d8f7682a9a 100644 --- a/boards/esp32-ethernet-kit-v1_0/include/periph_conf.h +++ b/boards/esp32-ethernet-kit-v1_0/include/periph_conf.h @@ -41,9 +41,10 @@ #endif /** - * @brief Declaration of GPIOs that can be used as DAC channels + * @name Declaration of GPIOs that can be used as DAC channels * * ESP32-Ethernet-Kit has no GPIOs left that might be used as DAC channels. + * @{ */ #ifndef DAC_GPIOS #define DAC_GPIOS { } diff --git a/boards/esp32-heltec-lora32-v2/doc.txt b/boards/esp32-heltec-lora32-v2/doc.txt index 4cb41d085e..9021294305 100644 --- a/boards/esp32-heltec-lora32-v2/doc.txt +++ b/boards/esp32-heltec-lora32-v2/doc.txt @@ -50,7 +50,7 @@ This section describes ### MCU    [[TOC](#toc)] Most features of the board are provided by the ESP32 SoC. For detailed -information about the ESP32, see section \ref esp32_mcu "MCU ESP32". +information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32". ### Board Configuration    [[TOC](#toc)] @@ -88,7 +88,7 @@ unless you exactly know what you are doing. The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be -overridden by \ref esp32_app_spec_conf "application-specific configurations". +overridden by \ref esp32_application_specific_configurations "application-specific configurations".
\anchor esp32_heltec_lora_32_v2_table_board_configuration @@ -120,7 +120,7 @@ OLED RESET | GPIO16 | | | \ref esp32_flash_modes "flash modes". For detailed information about the configuration of ESP32 boards, see -section \ref esp32_comm_periph "Common Peripherals". +section \ref esp32_peripherals "Common Peripherals". ### Using the OLED Display    [[TOC](#toc)] @@ -167,7 +167,7 @@ BOARD=esp32-heltec-lora32-v2 make -C tests/pkg_u8g2/ flash MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your -\ref esp32_app_spec_conf "application-specific configuration" +\ref esp32_application_specific_configurations "application-specific configuration" to use such modules: ``` diff --git a/boards/esp32-heltec-lora32-v2/include/arduino_pinmap.h b/boards/esp32-heltec-lora32-v2/include/arduino_pinmap.h index cc9d3566a0..90a16db74a 100644 --- a/boards/esp32-heltec-lora32-v2/include/arduino_pinmap.h +++ b/boards/esp32-heltec-lora32-v2/include/arduino_pinmap.h @@ -54,7 +54,7 @@ extern "C" { #define ARDUINO_PIN_A4 GPIO4 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A5 GPIO15 /**< Arduino Uno pin A5 (SCL) */ -/** @ */ +/** @} */ #ifdef __cplusplus } diff --git a/boards/esp32-heltec-lora32-v2/include/board.h b/boards/esp32-heltec-lora32-v2/include/board.h index 5c80a56cc6..246dc58b94 100644 --- a/boards/esp32-heltec-lora32-v2/include/board.h +++ b/boards/esp32-heltec-lora32-v2/include/board.h @@ -17,10 +17,10 @@ * Additionally, it has an OLED display connected via I2C on board. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-heltec-lora32-v2/include/periph_conf.h b/boards/esp32-heltec-lora32-v2/include/periph_conf.h index c53d701729..3655b5eb84 100644 --- a/boards/esp32-heltec-lora32-v2/include/periph_conf.h +++ b/boards/esp32-heltec-lora32-v2/include/periph_conf.h @@ -17,10 +17,10 @@ * Additionally, it has an OLED display connected via I2C on board. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-mh-et-live-minikit/doc.txt b/boards/esp32-mh-et-live-minikit/doc.txt index 1e278104cf..8eadccfee1 100644 --- a/boards/esp32-mh-et-live-minikit/doc.txt +++ b/boards/esp32-mh-et-live-minikit/doc.txt @@ -65,11 +65,11 @@ This section describes ### MCU    [[TOC](#toc)] Most features of the board are provided by the ESP32 SoC. For detailed -information about the ESP32, see section \ref esp32_mcu "MCU ESP32". +information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32". ### Board Configuration    [[TOC](#toc)] -The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by an \ref esp32_app_spec_conf "application-specific configuration". +The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by an \ref esp32_application_specific_configurations "application-specific configuration".
\anchor esp32_mh-et-live-minikit_table_board_configuration @@ -111,11 +111,11 @@ GPIO33 | - | | | | - GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes". - The **RESET** signal of MRF24J40 shield can be connected to the RST **pin** of the board (see \ref esp32_mh-et-live-minikit "pinout") to keep the configured GPIO free for other purposes. -For detailed information about the configuration of ESP32 boards, see section \ref esp32_comm_periph "Common Peripherals". +For detailed information about the configuration of ESP32 boards, see section \ref esp32_peripherals "Common Peripherals". ### Optional Hardware Configurations    [[TOC](#toc)] -ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_app_spec_conf "application-specific configuration" to use such a module: +ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such a module: ``` #if MODULE_ENC28J80 && BOARD_ESP32_MH_ET_LIVE_MINIKIT diff --git a/boards/esp32-mh-et-live-minikit/include/arduino_pinmap.h b/boards/esp32-mh-et-live-minikit/include/arduino_pinmap.h index 42e7c77a01..0473a2d846 100644 --- a/boards/esp32-mh-et-live-minikit/include/arduino_pinmap.h +++ b/boards/esp32-mh-et-live-minikit/include/arduino_pinmap.h @@ -54,7 +54,7 @@ extern "C" { #define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */ -/** @ */ +/** @} */ #ifdef __cplusplus } diff --git a/boards/esp32-mh-et-live-minikit/include/board.h b/boards/esp32-mh-et-live-minikit/include/board.h index 44541ff67e..005b6d79ad 100644 --- a/boards/esp32-mh-et-live-minikit/include/board.h +++ b/boards/esp32-mh-et-live-minikit/include/board.h @@ -18,10 +18,10 @@ * it can be configured very flexibly. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-mh-et-live-minikit/include/board_modules.h b/boards/esp32-mh-et-live-minikit/include/board_modules.h index 51cbf008cf..da05cc914b 100644 --- a/boards/esp32-mh-et-live-minikit/include/board_modules.h +++ b/boards/esp32-mh-et-live-minikit/include/board_modules.h @@ -16,7 +16,7 @@ * The board can be used with lots of optional stackable hardware modules. * This file contains the default configurations for those hardware modules * that have been tested. Most of these configurations can be overridden by an - * \ref esp32_app_spec_conf "application-specific configuration". + * \ref esp32_application_specific_configurations "application-specific configuration". * * The configurations of the respective hardware modules only take place if * the corresponding driver modules are used. @@ -71,7 +71,7 @@ extern "C" { * CS signal. * * @note Please override the definition of CS pin by an by \ref - * esp32_app_spec_conf "application-specific configurations" according to your + * esp32_application_specific_configurations "application-specific configurations" according to your * solder bride configuration. * @{ */ diff --git a/boards/esp32-mh-et-live-minikit/include/periph_conf.h b/boards/esp32-mh-et-live-minikit/include/periph_conf.h index 26b7f945e1..719eb04904 100644 --- a/boards/esp32-mh-et-live-minikit/include/periph_conf.h +++ b/boards/esp32-mh-et-live-minikit/include/periph_conf.h @@ -18,10 +18,10 @@ * it can be configured very flexibly. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-olimex-evb/doc.txt b/boards/esp32-olimex-evb/doc.txt index 5a33267071..1c385a7ab2 100644 --- a/boards/esp32-olimex-evb/doc.txt +++ b/boards/esp32-olimex-evb/doc.txt @@ -54,7 +54,7 @@ This section describes ### MCU    [[TOC](#toc)] Most features of the board are provided by the ESP32 SoC. For detailed -information about the ESP32, see section \ref esp32_mcu "MCU ESP32". +information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32". ### Board Configuration    [[TOC](#toc)] @@ -67,7 +67,7 @@ Olimex ESP32-EVB and Olimex ESP32-GATEWAY have the following on-board components - two Relais (Olimex ESP32-EVB only) - [UEXT](https://www.olimex.com/Products/Modules/UEXT/) connector with I2C, SPI and UART interfaces (Olimex ESP32-EVB only) -The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_app_spec_conf "application-specific configurations". +The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_application_specific_configurations "application-specific configurations".
\anchor esp32_olimex-esp32-evb_table_board_configuration @@ -111,11 +111,11 @@ USEMODULE += olimex_esp32_gateway - GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes". - It might be necessary to remove the SD card or the peripheral hardware attached to the SPI_DEV(0) interface for flashing RIOT. Reason is that the **SPI_DEV(0)** interface uses the HSPI interface with the GPIO2 pin as the MISO signal, which has bootstrapping functionality. -For detailed information about the configuration of ESP32 boards, see section \ref esp32_comm_periph "Common Peripherals". +For detailed information about the configuration of ESP32 boards, see section \ref esp32_peripherals "Common Peripherals". ### Optional Hardware Configurations    [[TOC](#toc)] -MRF24J40-based IEEE 802.15.4 radio modules have been tested with the board. You could use the following code in your \ref esp32_app_spec_conf "application-specific configuration" to use such modules: +MRF24J40-based IEEE 802.15.4 radio modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such modules: ``` #ifdef BOARD_ESP32_OLIMEX_EVB && !MODULE_ESP32_OLIMEX_GATEWAY diff --git a/boards/esp32-olimex-evb/include/arduino_pinmap.h b/boards/esp32-olimex-evb/include/arduino_pinmap.h index 439bee9ad6..1a041304a9 100644 --- a/boards/esp32-olimex-evb/include/arduino_pinmap.h +++ b/boards/esp32-olimex-evb/include/arduino_pinmap.h @@ -54,7 +54,7 @@ extern "C" { #define ARDUINO_PIN_A4 GPIO13 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A5 GPIO16 /**< Arduino Uno pin A5 (SCL) */ -/** @ */ +/** @} */ #ifdef __cplusplus } diff --git a/boards/esp32-olimex-evb/include/board.h b/boards/esp32-olimex-evb/include/board.h index e1f89f97bf..8ac64b4014 100644 --- a/boards/esp32-olimex-evb/include/board.h +++ b/boards/esp32-olimex-evb/include/board.h @@ -20,10 +20,10 @@ * configuration. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @author Gunar Schorcht diff --git a/boards/esp32-olimex-evb/include/periph_conf.h b/boards/esp32-olimex-evb/include/periph_conf.h index a95d66934a..6ab9fd4e6e 100644 --- a/boards/esp32-olimex-evb/include/periph_conf.h +++ b/boards/esp32-olimex-evb/include/periph_conf.h @@ -21,10 +21,10 @@ * configuration. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @author Gunar Schorcht diff --git a/boards/esp32-ttgo-t-beam/doc.txt b/boards/esp32-ttgo-t-beam/doc.txt index a81a6a318b..3a1e82f5ad 100644 --- a/boards/esp32-ttgo-t-beam/doc.txt +++ b/boards/esp32-ttgo-t-beam/doc.txt @@ -51,7 +51,7 @@ This section describes ### MCU    [[TOC](#toc)] Most features of the board are provided by the ESP32 SoC. For detailed -information about the ESP32, see section \ref esp32_mcu "MCU ESP32". +information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32". ### Board Configuration    [[TOC](#toc)] @@ -88,7 +88,7 @@ unless you exactly know what you are doing. The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be -overridden by \ref esp32_app_spec_conf "application-specific configurations". +overridden by \ref esp32_application_specific_configurations "application-specific configurations". TTGO- T-Beam rev1 @@ -141,7 +141,7 @@ UART_DEV(1):RxD | GPIO12 | GPS (configuration is fixed) | \ref esp32_uart_interf as ADC channels. For detailed information about the configuration of ESP32 boards, see -section \ref esp32_comm_periph "Common Peripherals". +section \ref esp32_peripherals "Common Peripherals". ### Board Pinout    [[TOC](#toc)] diff --git a/boards/esp32-ttgo-t-beam/include/arduino_pinmap.h b/boards/esp32-ttgo-t-beam/include/arduino_pinmap.h index b9917e3649..53e5a1c0d3 100644 --- a/boards/esp32-ttgo-t-beam/include/arduino_pinmap.h +++ b/boards/esp32-ttgo-t-beam/include/arduino_pinmap.h @@ -50,7 +50,7 @@ extern "C" { #define ARDUINO_PIN_A3 GPIO35 /**< Arduino Uno pin A3 */ #define ARDUINO_PIN_A4 GPIO36 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A5 GPIO39 /**< Arduino Uno pin A5 (SCL) */ -/** @ */ +/** @} */ #ifdef __cplusplus } diff --git a/boards/esp32-ttgo-t-beam/include/board.h b/boards/esp32-ttgo-t-beam/include/board.h index d21be43f06..210d22cebf 100644 --- a/boards/esp32-ttgo-t-beam/include/board.h +++ b/boards/esp32-ttgo-t-beam/include/board.h @@ -17,10 +17,10 @@ * Additionally, it has an OLED display connected via I2C on board. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-ttgo-t-beam/include/periph_conf.h b/boards/esp32-ttgo-t-beam/include/periph_conf.h index 59ae164888..76a8173eba 100644 --- a/boards/esp32-ttgo-t-beam/include/periph_conf.h +++ b/boards/esp32-ttgo-t-beam/include/periph_conf.h @@ -17,10 +17,10 @@ * Additionally, it has an GPS receiver connected via UART on board. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-wemos-lolin-d32-pro/doc.txt b/boards/esp32-wemos-lolin-d32-pro/doc.txt index 3d05f25276..3a4e63c228 100644 --- a/boards/esp32-wemos-lolin-d32-pro/doc.txt +++ b/boards/esp32-wemos-lolin-d32-pro/doc.txt @@ -50,7 +50,7 @@ This section describes ### MCU    [[TOC](#toc)] Most features of the board are provided by the ESP32 SoC. For detailed -information about the ESP32, see section \ref esp32_mcu "MCU ESP32". +information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32". ### Board Configuration    [[TOC](#toc)] @@ -60,7 +60,7 @@ The board for the Wemos LOLIN D32 Pro has the following on-board components: - 1 x Micro SD card interface - 1 x TFT display connector -The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by an \ref esp32_app_spec_conf "application-specific configuration". +The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by an \ref esp32_application_specific_configurations "application-specific configuration".
\anchor esp32_wemos-lolin-d32-pro_table_board_configuration @@ -99,11 +99,11 @@ GPIO27 | - | TFT_DC | when TFT is connected | | USEMODULE += esp_lolin_tft ``` -For detailed information about the configuration of ESP32 boards, see section \ref esp32_comm_periph "Common Peripherals". +For detailed information about the configuration of ESP32 boards, see section \ref esp32_peripherals "Common Peripherals". ### Optional Hardware Configurations    [[TOC](#toc)] -MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_app_spec_conf "application-specific configuration" to use such modules: +MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such modules: ``` #ifdef BOARD_ESP32_WEMOS_LOLIN_D32_PRO diff --git a/boards/esp32-wemos-lolin-d32-pro/include/arduino_pinmap.h b/boards/esp32-wemos-lolin-d32-pro/include/arduino_pinmap.h index 77f141530c..1ad2e7d6d7 100644 --- a/boards/esp32-wemos-lolin-d32-pro/include/arduino_pinmap.h +++ b/boards/esp32-wemos-lolin-d32-pro/include/arduino_pinmap.h @@ -54,7 +54,7 @@ extern "C" { #define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */ -/** @ */ +/** @} */ #ifdef __cplusplus } diff --git a/boards/esp32-wemos-lolin-d32-pro/include/board.h b/boards/esp32-wemos-lolin-d32-pro/include/board.h index 6860255e6b..597e35ecd0 100644 --- a/boards/esp32-wemos-lolin-d32-pro/include/board.h +++ b/boards/esp32-wemos-lolin-d32-pro/include/board.h @@ -29,10 +29,10 @@ * configuration. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-wemos-lolin-d32-pro/include/periph_conf.h b/boards/esp32-wemos-lolin-d32-pro/include/periph_conf.h index b3fbc91843..5c79d3ba13 100644 --- a/boards/esp32-wemos-lolin-d32-pro/include/periph_conf.h +++ b/boards/esp32-wemos-lolin-d32-pro/include/periph_conf.h @@ -30,10 +30,10 @@ * configuration. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @author Gunar Schorcht diff --git a/boards/esp32-wroom-32/doc.txt b/boards/esp32-wroom-32/doc.txt index ce5c6dfb66..f3f172af09 100644 --- a/boards/esp32-wroom-32/doc.txt +++ b/boards/esp32-wroom-32/doc.txt @@ -41,7 +41,7 @@ This section describes ### MCU    [[TOC](#toc)] Most features of the board are provided by the ESP32 SoC. For detailed -information about the ESP32, see section \ref esp32_mcu "MCU ESP32". +information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32". ### Board Configuration    [[TOC](#toc)] @@ -65,7 +65,7 @@ That is, the purpose for which a GPIO is used depends on which module or functio For example, if module periph_i2c is not used, the GPIOs listed in I2C configuration can be used for the other purposes. -The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_app_spec_conf "application-specific configurations". +The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_application_specific_configurations "application-specific configurations".
\anchor esp32_wroom_32_table_board_configuration @@ -97,11 +97,11 @@ UART_DEV(1):RxD | GPIO9 | not available in **qout** and **qio** flash mode | \r - The configuration of DAC channels contains all ESP32 GPIOs that can be used as DAC channels. - GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes". -For detailed information about the configuration of ESP32 boards, see section \ref esp32_comm_periph "Common Peripherals". +For detailed information about the configuration of ESP32 boards, see section \ref esp32_peripherals "Common Peripherals". ### Optional Hardware Configurations    [[TOC](#toc)] -MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_app_spec_conf "application-specific configuration" to use such modules: +MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such modules: ``` #ifdef BOARD_ESP32_WROOM-32 diff --git a/boards/esp32-wroom-32/include/arduino_pinmap.h b/boards/esp32-wroom-32/include/arduino_pinmap.h index ed3098522d..88f04e40df 100644 --- a/boards/esp32-wroom-32/include/arduino_pinmap.h +++ b/boards/esp32-wroom-32/include/arduino_pinmap.h @@ -54,7 +54,7 @@ extern "C" { #define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */ -/** @ */ +/** @} */ #ifdef __cplusplus } diff --git a/boards/esp32-wroom-32/include/board.h b/boards/esp32-wroom-32/include/board.h index 0d7edf9b6e..e6580c5c3d 100644 --- a/boards/esp32-wroom-32/include/board.h +++ b/boards/esp32-wroom-32/include/board.h @@ -18,10 +18,10 @@ * number of clones. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-wroom-32/include/periph_conf.h b/boards/esp32-wroom-32/include/periph_conf.h index 50ebeb2b54..98b3ab80e3 100644 --- a/boards/esp32-wroom-32/include/periph_conf.h +++ b/boards/esp32-wroom-32/include/periph_conf.h @@ -18,10 +18,10 @@ * number of clones. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file diff --git a/boards/esp32-wrover-kit/include/arduino_pinmap.h b/boards/esp32-wrover-kit/include/arduino_pinmap.h index 1ddba2b351..5d00d007f2 100644 --- a/boards/esp32-wrover-kit/include/arduino_pinmap.h +++ b/boards/esp32-wrover-kit/include/arduino_pinmap.h @@ -54,7 +54,7 @@ extern "C" { #define ARDUINO_PIN_A4 GPIO26 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A5 GPIO27 /**< Arduino Uno pin A5 (SCL) */ -/** @ */ +/** @} */ #ifdef __cplusplus } diff --git a/boards/esp32-wrover-kit/include/board.h b/boards/esp32-wrover-kit/include/board.h index b35daae4bd..8effa57fdb 100644 --- a/boards/esp32-wrover-kit/include/board.h +++ b/boards/esp32-wrover-kit/include/board.h @@ -32,10 +32,10 @@ * configuration. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file @@ -77,6 +77,8 @@ #define LED_BLUE_PIN LED2_PIN /**< LED2 is a blue LED */ #endif +/** @} */ + /** * @name SD-Card interface configuration * diff --git a/boards/esp32-wrover-kit/include/periph_conf.h b/boards/esp32-wrover-kit/include/periph_conf.h index d5fe114271..acccc5a673 100644 --- a/boards/esp32-wrover-kit/include/periph_conf.h +++ b/boards/esp32-wrover-kit/include/periph_conf.h @@ -32,10 +32,10 @@ * configuration. * * For detailed information about the configuration of ESP32 boards, see - * section \ref esp32_comm_periph "Common Peripherals". + * section \ref esp32_peripherals "Common Peripherals". * * @note - * Most definitions can be overridden by an \ref esp32_app_spec_conf + * Most definitions can be overridden by an \ref esp32_application_specific_configurations * "application-specific board configuration". * * @file