CalvinBackup/Embedded-Hacking
1
0
Fork 0
mirror of https://github.com/mytechnotalent/Embedded-Hacking.git synced 2026-08-10 13:10:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix: remove duplicate docstrings from public functions in .c files

Browse Source 
Public function docstrings belong exclusively in .h headers per
coding convention. Only static helper functions and static variables
retain docstrings in .c files. Removed 413 duplicate docstrings
across 185 files (15 CBM + 15 C SDK projects). All 30 projects
rebuild with zero errors.
This commit is contained in:
Kevin Thomas
2026-04-06 08:49:37 -04:00
parent 3604b3c921
commit 066c69f24b
185 changed files with 0 additions and 2041 deletions
Download Patch File Download Diff File Expand all files Collapse all files
drivers/0x03_button/button.c
-23
View File
@@ -49,12 +49,6 @@ 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);
@@ -62,12 +56,6 @@ 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);
@@ -75,23 +63,12 @@ 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);
}