Undo doc comments cleanup

esp-rs · Nov 7, 2024 · 5dc062f · 5dc062f
1 parent 5868c10
commit 5dc062f
Show file tree

Hide file tree

Showing 15 changed files with 47 additions and 0 deletions.
diff --git a/esp-hal/src/soc/esp32/mod.rs b/esp-hal/src/soc/esp32/mod.rs
@@ -1,3 +1,5 @@
+//! # SOC (System-on-Chip) module (ESP32)
+//!
 //! ## Overview
 //!
 //! The `SOC` module provides access, functions and structures that are useful

diff --git a/esp-hal/src/soc/esp32c2/gpio.rs b/esp-hal/src/soc/esp32c2/gpio.rs
@@ -1,3 +1,5 @@
+//! # GPIO configuration module (ESP32-C2)
+//!
 //! ## Overview
 //!
 //! The `GPIO` module provides functions and configurations for controlling the

diff --git a/esp-hal/src/soc/esp32c2/mod.rs b/esp-hal/src/soc/esp32c2/mod.rs
@@ -1,3 +1,5 @@
+//! # SOC (System-on-Chip) module (ESP32-C2)
+//!
 //! ## Overview
 //!
 //! The `SOC` module provides access, functions and structures that are useful

diff --git a/esp-hal/src/soc/esp32c3/gpio.rs b/esp-hal/src/soc/esp32c3/gpio.rs
@@ -1,3 +1,5 @@
+//! # GPIO configuration module (ESP32-C3)
+//!
 //! ## Overview
 //!
 //! The `GPIO` module provides functions and configurations for controlling the

diff --git a/esp-hal/src/soc/esp32c3/mod.rs b/esp-hal/src/soc/esp32c3/mod.rs
@@ -1,7 +1,13 @@
+//! # SOC (System-on-Chip) module (ESP32-C3)
+//!
 //! ## Overview
 //!
 //! The `SOC` module provides access, functions and structures that are useful
 //! for interacting with various system-related peripherals on `ESP32-C3` chip.
+//!
+//! Also few constants are defined in this module for `ESP32-C3` chip:
+//!    * I2S_SCLK: 160_000_000 - I2S clock frequency
+//!    * I2S_DEFAULT_CLK_SRC: 2 - I2S clock source
 
 pub mod efuse;
 pub mod gpio;

diff --git a/esp-hal/src/soc/esp32c6/gpio.rs b/esp-hal/src/soc/esp32c6/gpio.rs
@@ -1,3 +1,5 @@
+//! # GPIO configuration module (ESP32-C6)
+//!
 //! ## Overview
 //!
 //! The `GPIO` module provides functions and configurations for controlling the

diff --git a/esp-hal/src/soc/esp32c6/mod.rs b/esp-hal/src/soc/esp32c6/mod.rs
@@ -1,7 +1,14 @@
+//! # SOC (System-on-Chip) module (ESP32-C6)
+//!
 //! ## Overview
 //!
 //! The `SOC` module provides access, functions and structures that are useful
 //! for interacting with various system-related peripherals on `ESP32-C6` chip.
+//!
+//! Also few constants are defined in this module for `ESP32-C6` chip:
+//!    * TIMG_DEFAULT_CLK_SRC: 1 - Timer clock source
+//!    * I2S_DEFAULT_CLK_SRC: 2 - I2S clock source
+//!    * I2S_SCLK: 160_000_000 - I2S clock frequency
 
 pub mod efuse;
 pub mod gpio;

diff --git a/esp-hal/src/soc/esp32h2/gpio.rs b/esp-hal/src/soc/esp32h2/gpio.rs
@@ -1,3 +1,5 @@
+//! # GPIO configuration module (ESP32-H2)
+//!
 //! ## Overview
 //!
 //! The `GPIO` module provides functions and configurations for controlling the

diff --git a/esp-hal/src/soc/esp32h2/mod.rs b/esp-hal/src/soc/esp32h2/mod.rs
@@ -1,3 +1,5 @@
+//! # SOC (System-on-Chip) module (ESP32-H2)
+//!
 //! ## Overview
 //!
 //! The `SOC` module provides access, functions and structures that are useful

diff --git a/esp-hal/src/soc/esp32p4/gpio.rs b/esp-hal/src/soc/esp32p4/gpio.rs
@@ -1,3 +1,5 @@
+//! # GPIO configuration module (ESP32-P4)
+//!
 //! ## Overview
 //!
 //! The `GPIO` module provides functions and configurations for controlling the

diff --git a/esp-hal/src/soc/esp32p4/mod.rs b/esp-hal/src/soc/esp32p4/mod.rs
@@ -1,3 +1,5 @@
+//! # SOC (System-on-Chip) module (ESP32-P4)
+//!
 //! ## Overview
 //!
 //! The `SOC` module provides access, functions and structures that are useful

diff --git a/esp-hal/src/soc/esp32s2/gpio.rs b/esp-hal/src/soc/esp32s2/gpio.rs
@@ -1,3 +1,5 @@
+//! # GPIO configuration module (ESP32-S2)
+//!
 //! ## Overview
 //!
 //! The `GPIO` module provides functions and configurations for controlling the

diff --git a/esp-hal/src/soc/esp32s2/mod.rs b/esp-hal/src/soc/esp32s2/mod.rs
@@ -1,7 +1,13 @@
+//! # SOC (System-on-Chip) module (ESP32-S2)
+//!
 //! ## Overview
 //!
 //! The `SOC` module provides access, functions and structures that are useful
 //! for interacting with various system-related peripherals on `ESP32-S2` chip.
+//!
+//! Also few constants are defined in this module for `ESP32-S2` chip:
+//!    * I2S_SCLK: 160_000_000 - I2S clock frequency
+//!    * I2S_DEFAULT_CLK_SRC: 2 - I2S clock source
 
 use core::ptr::addr_of_mut;
 

diff --git a/esp-hal/src/soc/esp32s3/gpio.rs b/esp-hal/src/soc/esp32s3/gpio.rs
@@ -1,3 +1,5 @@
+//! # GPIO configuration module (ESP32-S3)
+//!
 //! ## Overview
 //!
 //! The `GPIO` module provides functions and configurations for controlling the

diff --git a/esp-hal/src/soc/esp32s3/mod.rs b/esp-hal/src/soc/esp32s3/mod.rs
@@ -1,7 +1,13 @@
+//! # SOC (System-on-Chip) module (ESP32-S3)
+//!
 //! ## Overview
 //!
 //! The `SOC` module provides access, functions and structures that are useful
 //! for interacting with various system-related peripherals on `ESP32-S3` chip.
+//!
+//! Also few constants are defined in this module for `ESP32-S3` chip:
+//!    * I2S_SCLK: 160_000_000 - I2S clock frequency
+//!    * I2S_DEFAULT_CLK_SRC: 2 - I2S clock source
 
 use core::ptr::addr_of_mut;