ECE4180 / SparkfunAnalogJoystick

Sparkfun Analog Joystick

Dependents:   Lab4 4180final_receiver 4180final_sender DuelingTanks ... more

Fork of SparkfunAnalogJoystick by ECE4180

Diff: SparkfunAnalogJoystick.h

Revision:
3:2b40241a7675
Parent:
1:ed0057aa2e31
--- a/SparkfunAnalogJoystick.h	Mon Mar 09 21:01:23 2015 +0000
+++ b/SparkfunAnalogJoystick.h	Mon Mar 09 21:11:22 2015 +0000
@@ -1,13 +1,22 @@
+/** Analog Joystick APIs
+ *  Used as a user interface for Sparkfun Analog Joystick Module
+ *  @file SparkfunAnalogJoystick.h
+ *  @author Yuan,ZHANG; Jiajie,YANG
+ */
+
 #ifndef SPARKFUN_ANALOG_JOYSTICK
 #define SPARKFUN_ANALOG_JOYSTICK
 
 #include "mbed.h"
 
+/** Joystick class.
+ *  User Interface to use Sparkfun Joystick Module
+ */
 class SparkfunAnalogJoystick
 {
 	
 public:
-	// Constructor
+	// Constructor of Joystick object
 	SparkfunAnalogJoystick(PinName, PinName, PinName);
 	// Get the button status, 1 for on and 0 for off
 	int button();