Revision 1:3ece560dd2da, committed 2010-11-19

Comitter:

littlexc

Date:

Fri Nov 19 12:18:21 2010 +0000

Parent:

0:774d7a3e63ae

Commit message:

documentation change, no code diffrence.

Changed in this revision

diff -r 774d7a3e63ae -r 3ece560dd2da motordrivercs.h
--- a/motordrivercs.h	Fri Nov 19 12:15:33 2010 +0000
+++ b/motordrivercs.h	Fri Nov 19 12:18:21 2010 +0000
@@ -59,7 +59,8 @@
         
 /** Set the the motor to coast
 * 
-* @param void motor coasts until another instruction is recived
+* @param void 
+* @returns motor coasts until another instruction is recived
 */        
   
         void coastcs(void);
@@ -67,14 +68,15 @@
 /** Set the motor to dynamicaly brake (addition)
 * 
 * @param float duty 0 - 1.0 provides some control over how hard the motor brakes.
-* @return returns duty applied due to current limiting.
+* @return duty applied due to current limiting.
 */
 
         float stopcs(float duty);
 
 /** read the current
 *
-* @param void returns (analog in * 0.303)/ohms.
+* @param void 
+* @return (analog in * 0.303)/ohms.
 */
         float current(void);