Revision 1:8408853a700c, committed 2013-08-22

Comitter:

ccoleman

Date:

Thu Aug 22 21:11:14 2013 +0000

Parent:

0:2010bcffbae0

Child:

2:0a64af7ab7c6

Commit message:

Generated CarAPI documentation.

Changed in this revision

--- a/CarAPI.h	Thu Aug 22 20:50:08 2013 +0000
+++ b/CarAPI.h	Thu Aug 22 21:11:14 2013 +0000
@@ -1,3 +1,17 @@
+/**
+ * @defgroup FRDM-UTCS-CAR_API FRDM-UTCS-CAR_API
+ *
+ * @{
+ */
+
+
+/**
+
+@addtogroup FRDM-UTCS-CAR_API
+
+@{
+*/
+
 #ifndef CAR_API_0yx22l34755
 #define CAR_API_0yx22l34755
 
@@ -8,7 +22,7 @@
 
 /******************************** Wheels and Motor ********************************/
 
-/* turn the car.  turnAngle should be between [-1,1] */
+/** turn the car.  turnAngle should be between [-1,1] */
 void turn(float turnAngle);
 
 /** move forward with the given power, turn angle, for a specified time */
@@ -17,7 +31,7 @@
 /** move forward with the given powers for each wheel, turn angle, for a specified time */
 void move(float leftWheelPower, float rightWheelPower,  float seconds);
 
-/** lock the wheels*/
+/** lock the wheels */
 void parkingBrake();
 
 /******************************** INPUTS AND OUTPUTS ********************************/
@@ -25,10 +39,10 @@
 bool checkIsCrashing();
 
 /** Return the line direction
-    line to the left of center. return [-1,0
-    line to the right of center. return (0,1]
-    line in center. return 0
-*/
+ *  line to the left of center. return [-1,0
+ *  line to the right of center. return (0,1]
+ *  line in center. return 0
+ */
 float lineDirection();
 
 /* toggle led 0 */