From 46236ce3de8385f27e3f13a9921abee7e1e0fa57 Mon Sep 17 00:00:00 2001 From: Ryan Date: Fri, 15 Nov 2024 05:00:02 +1100 Subject: [docs] Improve halconf/mcuconf code examples (#24597) --- docs/drivers/ws2812.md | 44 ++++++++++++++++++++++++++++++-------------- 1 file changed, 30 insertions(+), 14 deletions(-) (limited to 'docs/drivers/ws2812.md') diff --git a/docs/drivers/ws2812.md b/docs/drivers/ws2812.md index 61addf1917..88c096794f 100644 --- a/docs/drivers/ws2812.md +++ b/docs/drivers/ws2812.md @@ -160,15 +160,23 @@ To configure the DI pin for open drain configuration, add the following to your Depending on the ChibiOS board configuration, you may need to enable SPI at the keyboard level. For STM32, this would look like: -`halconf.h`: -```c -#define HAL_USE_SPI TRUE +::: code-group +```c [halconf.h] +#pragma once + +#define HAL_USE_SPI TRUE // [!code focus] + +#include_next ``` -`mcuconf.h`: -```c -#undef STM32_SPI_USE_SPI1 -#define STM32_SPI_USE_SPI1 TRUE +```c [mcuconf.h] +#pragma once + +#include_next + +#undef STM32_SPI_USE_SPI1 // [!code focus] +#define STM32_SPI_USE_SPI1 TRUE // [!code focus] ``` +::: The following `define`s apply only to the `spi` driver: @@ -213,15 +221,23 @@ The following `#define`s apply only to the PIO driver: Depending on the ChibiOS board configuration, you may need to enable PWM at the keyboard level. For STM32, this would look like: -`halconf.h`: -```c -#define HAL_USE_PWM TRUE +::: code-group +```c [halconf.h] +#pragma once + +#define HAL_USE_PWM TRUE // [!code focus] + +#include_next ``` -`mcuconf.h`: -```c -#undef STM32_PWM_USE_TIM2 -#define STM32_PWM_USE_TIM2 TRUE +```c [mcuconf.h] +#pragma once + +#include_next + +#undef STM32_PWM_USE_TIM2 // [!code focus] +#define STM32_PWM_USE_TIM2 TRUE // [!code focus] ``` +::: The following `#define`s apply only to the `pwm` driver: -- cgit v1.2.3