From 06bb259aea28bbc21dd8fcf1644ef107211b4820 Mon Sep 17 00:00:00 2001 From: liebman Date: Thu, 24 Oct 2024 09:51:05 -0700 Subject: [PATCH] update doc & fmt --- esp-hal/src/i2s_parallel.rs | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/esp-hal/src/i2s_parallel.rs b/esp-hal/src/i2s_parallel.rs index 95dd7a2d9f7..5dd4c25a801 100644 --- a/esp-hal/src/i2s_parallel.rs +++ b/esp-hal/src/i2s_parallel.rs @@ -14,11 +14,17 @@ //! words) //! - 16bit: [A, B, C, D] is output as [B, A, D, C] (i.e., 16bit words are //! swapped) -//! -//! I2S0 does not support true 8bit parallel output, so if you want to do 8bit -//! you should use I2S1. If you have to use I2S0, it will only output the even -//! bytes! so [A, B, C, D] will be output as [A, C]!!!! -//! +#![cfg_attr(esp32, doc = "")] +#![cfg_attr( + esp32, + doc = "I2S0 does not support true 8bit parallel output, so if you want to do 8bit" +)] +#![cfg_attr( + esp32, + doc = "you should use I2S1. If you have to use I2S0, it will only output the even" +)] +#![cfg_attr(esp32, doc = "bytes! so [A, B, C, D] will be output as [A, C]!!!!")] +#![cfg_attr(esp32, doc = "")] //! ## Configuration //! //! The driver uses DMA (Direct Memory Access) for efficient data transfer and