[tuxdroid-svn] r522 - firmware/tuxcore/trunk

[jaguarondi <c2m...@c2...>]

Author: jaguarondi
Date: 2007-09-13 11:30:32 +0200 (Thu, 13 Sep 2007)
New Revision: 522

Modified:
   firmware/tuxcore/trunk/motors.c
Log:
* Slight changes on the comments.


Modified: firmware/tuxcore/trunk/motors.c
===================================================================
--- firmware/tuxcore/trunk/motors.c	2007-09-13 07:30:10 UTC (rev 521)
+++ firmware/tuxcore/trunk/motors.c	2007-09-13 09:30:32 UTC (rev 522)
@@ -201,8 +201,8 @@
    \brief Blink the eyes
    \ingroup eyes
 
-   \param cnt number of movements before the flippers will stop
-   \note Any mouth command is cancelled
+   \param cnt number of movements before the flippers will stop.
+   \note Any mouth command is cancelled.
 
    The eyes will start blinking until 'cnt' movements are executed. A movement
    is raising or lowering the eyelids. 'cnt' can be up to 256. If 'cnt' is
@@ -356,10 +356,10 @@
 }
 
 /**
-   \brief Move the mouth
+   \brief Move the mouth.
    \ingroup mouth
-   \note Any eye command is cancelled
-   \param cnt number of movements before the mouth will stop
+   \note Any eye command is cancelled.
+   \param cnt number of movements before the mouth will stop.
 
    The mouth will start blinking until 'cnt' movements are executed. A movement
    is raising or lowering the eyelids. 'cnt' can be up to 256. If 'cnt' is
@@ -373,7 +373,7 @@
 }
 
 /**
-   \brief Open the mouth
+   \brief Open the mouth.
    \ingroup mouth
 
    Open the mouth if they are closed.
@@ -385,7 +385,7 @@
 }
 
 /**
-   \brief Close the mouth
+   \brief Close the mouth.
    \ingroup mouth
 
    Close the mouth if they are opened.
@@ -397,7 +397,7 @@
 }
 
 /**
-   \brief Mouth position interrupt
+   \brief Mouth position interrupt.
 
    This interrupt stops the mouth when the desired number of movements have
    been executed. In order to stop the mouth quickly and block the motor, we
@@ -473,10 +473,10 @@
 }
 
 /**
-   \brief Start waving the flippers up and down
+   \brief Start waving the flippers up and down.
    \ingroup flippers
-   \param cnt number of movements before the flippers will stop
-   \param pwm pwm value between 1 (slow) and 5 (fast)
+   \param cnt number of movements before the flippers will stop.
+   \param pwm pwm value between 1 (slow) and 5 (fast).
 
    The flippers will start waving until 'cnt' movements have been executed. A
    movement is raising or lowering the flippers. 'cnt' can be up to 256. If
@@ -495,7 +495,7 @@
 }
 
 /**
-   \brief Reset flippers
+   \brief Reset flippers.
    \ingroup flippers
 
    This function resets the flippers position. flippers_timer is used to
@@ -513,7 +513,7 @@
 }
 
 /**
-   \brief Raise flippers
+   \brief Raise flippers.
    \ingroup flippers
 
    The condition to raise the flippers is that they aren't already in the upper
@@ -539,7 +539,7 @@
 }
 
 /**
-   \brief Lower flippers
+   \brief Lower flippers.
    \ingroup flippers
 
    The condition to lower the flippers is that they aren't already in the lower
@@ -555,7 +555,7 @@
 }
 
 /**
-   \brief Flippers position interrupt
+   \brief Flippers position interrupt.
 
    This interrupt stops the flippers when the desired number of movements have
    been executed. In order to stop the flippers quickly and block the motor, we
@@ -593,10 +593,10 @@
                     flippers_timer = 0;
                     flippers_revious_timer = 0;
                 }
-                else /* continue */
+                else
                 {
                     /* Unknow position, execute another movement to determine
-                     * it */
+                     * it. */
                     flippers_revious_timer = flippers_timer;
                     flippers_timer = FLIP_TIMER_INIT;
                     return;
@@ -640,8 +640,9 @@
 }
 
 /**
-   \brief Spin left for the \c angle amount
-   \param angle Angle to turn, in 90° unit
+   \brief Spin left for the \c angle amount.
+   \param angle Angle to turn, in 90° unit.
+   \param pwm PWM value assigned to the spinning.
    \ingroup spin
  */
 void spin_left(uint8_t angle, uint8_t pwm)
@@ -660,8 +661,9 @@
 }
 
 /**
-   \brief Spin right for the \c angle amount
-   \param angle Angle to turn, in 90° unit
+   \brief Spin right for the \c angle amount.
+   \param angle Angle to turn, in 90° unit.
+   \param pwm PWM value assigned to the spinning.
    \ingroup spin
  */
 void spin_right(uint8_t angle, uint8_t pwm)
@@ -679,7 +681,7 @@
     spin_PWM_mask |= MOT_SPIN_R_MK;
 }
 /**
-   \brief Spin position interrupt
+   \brief Spin position interrupt.
 
    This interrupt stops the spinning motor when the desired number of movements
    have been executed.