update doc & fmt

liebman · Oct 24, 2024 · 06bb259 · 06bb259
1 parent 8327b2e
commit 06bb259
Showing 1 changed file with 11 additions and 5 deletions.
diff --git 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