paulM_projects
/
motorized_fader
generated from TDD-Templates/cmake_cpputest_template_avr
2
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases 2 Wiki Activity

Added doxygen comments to the function protopyes in header.

This commit is contained in:
Jake Goodwin 2025-02-13 12:22:43 -08:00
parent 9b9b8a07e4
commit 721fe66cf4
1 changed files with 5 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
inc/main.h
View File

@ -98,34 +98,25 @@ void InitProg(void);
/** /**
* @brief Reads the ADC pin * @brief Reads the ADC pin
* @param
*/ */
uint16_t ReadADC(void); uint16_t ReadADC(void);
/** /**
* @brief * @brief Moves the motor to target location based off the PB3.
* @param * @param[in] 8bit value representing fader location.
*/ */
void MotorMoveTo(uint8_t target); void MotorMoveTo(uint8_t target);
/** /**
* @brief * @brief Turns off motor allowing free movement.
* @param
*/ */
void MotorCoast(void); void MotorCoast(void);
/** /**
* @brief * @brief Activates the motor driver in forward or reverse.
* @param * @param[in] moves foward when true and in reverse when false.
*/ */
void MotorMove(uint8_t fwd); void MotorMove(uint8_t fwd);
/**
* @brief
* @param
*/
uint8_t ReadButton(void);
#endif #endif