Testing documentation

Dependencies:   mbed

Committer:
sgrove
Date:
Mon Apr 18 04:14:57 2011 +0000
Revision:
3:987ee333d593
Child:
4:3f1a2b5dc176
r3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sgrove 3:987ee333d593 1 /** Servo control class, based on a PwmOut
sgrove 3:987ee333d593 2 *
sgrove 3:987ee333d593 3 * Example:
sgrove 3:987ee333d593 4 * @code
sgrove 3:987ee333d593 5 * // Continuously sweep the servo through it's full range
sgrove 3:987ee333d593 6 * #include "mbed.h"
sgrove 3:987ee333d593 7 * #include "Servo.h"
sgrove 3:987ee333d593 8 *
sgrove 3:987ee333d593 9 * Servo myservo(p21);
sgrove 3:987ee333d593 10 *
sgrove 3:987ee333d593 11 * int main() {
sgrove 3:987ee333d593 12 * while(1) {
sgrove 3:987ee333d593 13 * for(int i=0; i<100; i++) {
sgrove 3:987ee333d593 14 * myservo = i/100.0;
sgrove 3:987ee333d593 15 * wait(0.01);
sgrove 3:987ee333d593 16 * }
sgrove 3:987ee333d593 17 * for(int i=100; i>0; i--) {
sgrove 3:987ee333d593 18 * myservo = i/100.0;
sgrove 3:987ee333d593 19 * wait(0.01);
sgrove 3:987ee333d593 20 * }
sgrove 3:987ee333d593 21 * }
sgrove 3:987ee333d593 22 * }
sgrove 3:987ee333d593 23 * @endcode
sgrove 3:987ee333d593 24 */
sgrove 3:987ee333d593 25 /** Create a servo object connected to the specified PwmOut pin
sgrove 3:987ee333d593 26 *
sgrove 3:987ee333d593 27 * @param pin PwmOut pin to connect to
sgrove 3:987ee333d593 28 */
sgrove 3:987ee333d593 29
sgrove 3:987ee333d593 30 /** A brief description of the function foo
sgrove 3:987ee333d593 31 *
sgrove 3:987ee333d593 32 * More details about the function goes here
sgrove 3:987ee333d593 33 * and here
sgrove 3:987ee333d593 34 *
sgrove 3:987ee333d593 35 * @param x a variable used by foo
sgrove 3:987ee333d593 36 * @returns something magical done with x
sgrove 3:987ee333d593 37 */
sgrove 3:987ee333d593 38 int foo(int x) {...}