From 721fe66cf4f6a258ee5db4926085cecc196e0cbc Mon Sep 17 00:00:00 2001 From: jake Date: Thu, 13 Feb 2025 12:22:43 -0800 Subject: [PATCH] Added doxygen comments to the function protopyes in header. --- inc/main.h | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/inc/main.h b/inc/main.h index 0ca1ad4..4be8126 100644 --- a/inc/main.h +++ b/inc/main.h @@ -98,34 +98,25 @@ void InitProg(void); /** * @brief Reads the ADC pin - * @param */ uint16_t ReadADC(void); /** - * @brief - * @param + * @brief Moves the motor to target location based off the PB3. + * @param[in] 8bit value representing fader location. */ void MotorMoveTo(uint8_t target); /** - * @brief - * @param + * @brief Turns off motor allowing free movement. */ void MotorCoast(void); /** - * @brief - * @param + * @brief Activates the motor driver in forward or reverse. + * @param[in] moves foward when true and in reverse when false. */ void MotorMove(uint8_t fwd); -/** - * @brief - * @param - */ -uint8_t ReadButton(void); - - #endif