refactor: enforce max 8 code lines, add docstrings, fix warnings across all Rust and C SDK projects

Rust (all 15 projects):
- Refactored overlength functions: format_counter, format_u8, format_f32_1,
  format_u32_minimal, gpio_drive, read_sensor, poll_sensor, format_round_trip,
  format_u32, prepare_write_buf, write_min_digits, write_temp, UartDriver::init,
  init_spi, angle_to_pulse_us, compute_servo_level
- Added 200+ docstrings to test functions, mock structs, impl blocks
- Fixed pub static comments (//) to doc comments (///) in all main.rs files
- Fixed helper function ordering (helpers above callers)
- Fixed Fn(u32) -> FnMut(u32) bound in button poll_button
- Moved OneShot trait import from main.rs to board.rs in adc project
- Added unsafe {} blocks in flash unsafe fn bodies (Rust 2024 edition)
- Removed unused hal::Clock imports from pwm/servo main.rs
- All 15 projects build with zero errors and zero warnings

C Pico SDK (all 15 projects):
- Added docstrings to all public functions, macros, and static variables
- All 15 projects rebuilt with zero errors

Cleanup:
- Removed build/ and target/ directories from git tracking
- Added target/ to .gitignore
- Deleted temporary fix_rust_docs.py script
This commit is contained in:
Kevin Thomas
2026-04-06 08:32:55 -04:00
parent d9fe6c314e
commit 3604b3c921
9896 changed files with 3106 additions and 312146 deletions
+24
View File
@@ -31,6 +31,7 @@
#include "pico/stdlib.h"
#include "hardware/gpio.h"
/** @brief Debounce settling time stored from button_init() */
static uint32_t debounce_delay_ms = 20;
/**
@@ -48,6 +49,12 @@ static bool _debounce_confirm(uint32_t pin) {
return !gpio_get(pin);
}
/**
* @brief Initialize a GPIO pin as an active-low button input with pull-up
*
* @param pin GPIO pin number to configure as a button input
* @param debounce_ms Debounce settling time in milliseconds
*/
void button_init(uint32_t pin, uint32_t debounce_ms) {
debounce_delay_ms = debounce_ms;
gpio_init(pin);
@@ -55,6 +62,12 @@ void button_init(uint32_t pin, uint32_t debounce_ms) {
gpio_pull_up(pin);
}
/**
* @brief Read the debounced state of the button
*
* @param pin GPIO pin number previously initialized with button_init()
* @return bool true if the button is firmly pressed, false if released
*/
bool button_is_pressed(uint32_t pin) {
if (!gpio_get(pin)) {
return _debounce_confirm(pin);
@@ -62,12 +75,23 @@ bool button_is_pressed(uint32_t pin) {
return false;
}
/**
* @brief Initialize a GPIO pin as a push-pull digital output for an indicator LED
*
* @param pin GPIO pin number to configure as an LED output
*/
void button_led_init(uint32_t pin) {
gpio_init(pin);
gpio_set_dir(pin, GPIO_OUT);
gpio_put(pin, false);
}
/**
* @brief Set the indicator LED state
*
* @param pin GPIO pin number
* @param on true to turn the LED on, false to turn it off
*/
void button_led_set(uint32_t pin, bool on) {
gpio_put(pin, on);
}