diff --git a/drivers/0x01_uart_rust/src/board.rs b/drivers/0x01_uart_rust/src/board.rs index c9fe6d3..10926bb 100644 --- a/drivers/0x01_uart_rust/src/board.rs +++ b/drivers/0x01_uart_rust/src/board.rs @@ -1,5 +1,5 @@ //! @file board.rs -//! @brief Board-level initialisation helpers for the UART demo +//! @brief Board-level HAL helpers for the UART driver //! @author Kevin Thomas //! @date 2025 //! @@ -25,11 +25,6 @@ //! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //! SOFTWARE. -//! @file board.rs -//! @brief Board-level HAL helpers for the UART driver -//! @author Kevin Thomas -//! @date 2025 - // Alias our HAL crate #[cfg(rp2350)] use rp235x_hal as hal; diff --git a/drivers/0x02_blink_rust/src/board.rs b/drivers/0x02_blink_rust/src/board.rs index 8d596e8..ddb5bb9 100644 --- a/drivers/0x02_blink_rust/src/board.rs +++ b/drivers/0x02_blink_rust/src/board.rs @@ -1,5 +1,5 @@ //! @file board.rs -//! @brief Board-level initialisation helpers for the blink demo +//! @brief Board-level HAL helpers for the blink driver //! @author Kevin Thomas //! @date 2025 //! @@ -25,11 +25,6 @@ //! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //! SOFTWARE. -//! @file board.rs -//! @brief Board-level HAL helpers for the blink driver -//! @author Kevin Thomas -//! @date 2025 - // Rate extension trait for .Hz() baud rate construction use fugit::RateExtU32; // Clock trait for accessing system clock frequency diff --git a/drivers/0x02_blink_rust/src/lib.rs b/drivers/0x02_blink_rust/src/lib.rs index 4f3672c..d0cd50d 100644 --- a/drivers/0x02_blink_rust/src/lib.rs +++ b/drivers/0x02_blink_rust/src/lib.rs @@ -5,4 +5,5 @@ #![no_std] +// Blink driver module pub mod blink; diff --git a/drivers/0x03_button_rust/src/board.rs b/drivers/0x03_button_rust/src/board.rs index c716164..73261a6 100644 --- a/drivers/0x03_button_rust/src/board.rs +++ b/drivers/0x03_button_rust/src/board.rs @@ -1,5 +1,5 @@ //! @file board.rs -//! @brief Board-level initialisation helpers for the button demo +//! @brief Board-level HAL helpers for the button driver //! @author Kevin Thomas //! @date 2025 //! @@ -25,11 +25,6 @@ //! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //! SOFTWARE. -//! @file board.rs -//! @brief Board-level HAL helpers for the button driver -//! @author Kevin Thomas -//! @date 2025 - // Rate extension trait for .Hz() baud rate construction use fugit::RateExtU32; // Clock trait for accessing system clock frequency diff --git a/drivers/0x03_button_rust/src/lib.rs b/drivers/0x03_button_rust/src/lib.rs index 45b5692..08a6cda 100644 --- a/drivers/0x03_button_rust/src/lib.rs +++ b/drivers/0x03_button_rust/src/lib.rs @@ -5,4 +5,5 @@ #![no_std] +// Button driver module pub mod button; diff --git a/drivers/0x04_pwm_rust/src/board.rs b/drivers/0x04_pwm_rust/src/board.rs index 4868ac8..157e221 100644 --- a/drivers/0x04_pwm_rust/src/board.rs +++ b/drivers/0x04_pwm_rust/src/board.rs @@ -1,5 +1,5 @@ //! @file board.rs -//! @brief Board-level initialisation helpers for the PWM demo +//! @brief Board-level HAL helpers for the PWM driver //! @author Kevin Thomas //! @date 2025 //! @@ -25,11 +25,6 @@ //! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //! SOFTWARE. -//! @file board.rs -//! @brief Board-level HAL helpers for the PWM driver -//! @author Kevin Thomas -//! @date 2025 - // PWM duty-cycle trait for .set_duty_cycle() use embedded_hal::pwm::SetDutyCycle; // Rate extension trait for .Hz() baud rate construction diff --git a/drivers/0x04_pwm_rust/src/lib.rs b/drivers/0x04_pwm_rust/src/lib.rs index 96fac99..1abd659 100644 --- a/drivers/0x04_pwm_rust/src/lib.rs +++ b/drivers/0x04_pwm_rust/src/lib.rs @@ -5,4 +5,5 @@ #![no_std] +// PWM driver module pub mod pwm; diff --git a/drivers/0x05_servo_rust/src/board.rs b/drivers/0x05_servo_rust/src/board.rs index 76d0bc4..b4b833e 100644 --- a/drivers/0x05_servo_rust/src/board.rs +++ b/drivers/0x05_servo_rust/src/board.rs @@ -1,5 +1,5 @@ //! @file board.rs -//! @brief Board-level initialisation helpers for the servo demo +//! @brief Board-level HAL helpers for the servo driver //! @author Kevin Thomas //! @date 2025 //! @@ -25,11 +25,6 @@ //! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //! SOFTWARE. -//! @file board.rs -//! @brief Board-level HAL helpers for the servo driver -//! @author Kevin Thomas -//! @date 2025 - // PWM duty-cycle trait for .set_duty_cycle() use embedded_hal::pwm::SetDutyCycle; // Rate extension trait for .Hz() baud rate construction diff --git a/drivers/0x05_servo_rust/src/lib.rs b/drivers/0x05_servo_rust/src/lib.rs index 70d0b5f..a1d9a0f 100644 --- a/drivers/0x05_servo_rust/src/lib.rs +++ b/drivers/0x05_servo_rust/src/lib.rs @@ -5,4 +5,5 @@ #![no_std] +// Servo driver module pub mod servo; diff --git a/drivers/0x06_adc_rust/src/board.rs b/drivers/0x06_adc_rust/src/board.rs index 7e65d6c..678bc95 100644 --- a/drivers/0x06_adc_rust/src/board.rs +++ b/drivers/0x06_adc_rust/src/board.rs @@ -1,5 +1,5 @@ //! @file board.rs -//! @brief Board-level initialisation helpers for the ADC demo +//! @brief Board-level HAL helpers for the ADC driver //! @author Kevin Thomas //! @date 2025 //! @@ -25,11 +25,6 @@ //! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //! SOFTWARE. -//! @file board.rs -//! @brief Board-level HAL helpers for the ADC driver -//! @author Kevin Thomas -//! @date 2025 - // Rate extension trait for .Hz() baud rate construction use fugit::RateExtU32; // Clock trait for accessing system clock frequency diff --git a/drivers/0x06_adc_rust/src/lib.rs b/drivers/0x06_adc_rust/src/lib.rs index d26b690..d73a3ea 100644 --- a/drivers/0x06_adc_rust/src/lib.rs +++ b/drivers/0x06_adc_rust/src/lib.rs @@ -5,4 +5,5 @@ #![no_std] +// ADC driver module pub mod adc; diff --git a/drivers/0x07_i2c_rust/src/board.rs b/drivers/0x07_i2c_rust/src/board.rs index 74b2bf5..551bb63 100644 --- a/drivers/0x07_i2c_rust/src/board.rs +++ b/drivers/0x07_i2c_rust/src/board.rs @@ -1,5 +1,5 @@ //! @file board.rs -//! @brief Board-level initialisation helpers for the I2C scanner demo +//! @brief Board-level HAL helpers for the I2C driver //! @author Kevin Thomas //! @date 2025 //! @@ -25,11 +25,6 @@ //! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //! SOFTWARE. -//! @file board.rs -//! @brief Board-level HAL helpers for the I2C driver -//! @author Kevin Thomas -//! @date 2025 - // I2C bus trait for device probing use embedded_hal::i2c::I2c; // Rate extension trait for .Hz() baud rate construction diff --git a/drivers/0x07_i2c_rust/src/lib.rs b/drivers/0x07_i2c_rust/src/lib.rs index 56f0ade..ff9bede 100644 --- a/drivers/0x07_i2c_rust/src/lib.rs +++ b/drivers/0x07_i2c_rust/src/lib.rs @@ -5,4 +5,5 @@ #![no_std] +// I2C driver module pub mod i2c; diff --git a/drivers/0x08_lcd1602_rust/src/board.rs b/drivers/0x08_lcd1602_rust/src/board.rs index f110994..64cd246 100644 --- a/drivers/0x08_lcd1602_rust/src/board.rs +++ b/drivers/0x08_lcd1602_rust/src/board.rs @@ -1,5 +1,5 @@ //! @file board.rs -//! @brief Board-level initialisation and LCD hardware helpers +//! @brief Board-level HAL helpers for the LCD 1602 driver //! @author Kevin Thomas //! @date 2025 //! @@ -25,11 +25,6 @@ //! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //! SOFTWARE. -//! @file board.rs -//! @brief Board-level HAL helpers for the LCD 1602 driver -//! @author Kevin Thomas -//! @date 2025 - // I2C bus trait for LCD communication use embedded_hal::i2c::I2c; // Rate extension trait for .Hz() baud rate construction diff --git a/drivers/0x08_lcd1602_rust/src/lib.rs b/drivers/0x08_lcd1602_rust/src/lib.rs index 4672ce8..a935c82 100644 --- a/drivers/0x08_lcd1602_rust/src/lib.rs +++ b/drivers/0x08_lcd1602_rust/src/lib.rs @@ -5,4 +5,5 @@ #![no_std] +// LCD 1602 driver module pub mod lcd1602;