Testing documentation

Dependencies:   mbed

main.h

Committer:
sgrove
Date:
2011-04-18
Revision:
3:987ee333d593
Child:
4:3f1a2b5dc176

File content as of revision 3:987ee333d593:

/** Servo control class, based on a PwmOut
 *
 * Example:
 * @code
 * // Continuously sweep the servo through it's full range
 * #include "mbed.h"
 * #include "Servo.h"
 * 
 * Servo myservo(p21);
 * 
 * int main() {
 *     while(1) {
 *         for(int i=0; i<100; i++) {
 *             myservo = i/100.0;
 *             wait(0.01);
 *         }
 *         for(int i=100; i>0; i--) {
 *             myservo = i/100.0;
 *             wait(0.01);
 *         }
 *     }
 * }
 * @endcode
 */
/** Create a servo object connected to the specified PwmOut pin
 *
 * @param pin PwmOut pin to connect to 
 */
 
 /** A brief description of the function foo
 * 
 * More details about the function goes here
 * and here
 *
 * @param x a variable used by foo
 * @returns something magical done with x   
 */
int foo(int x) {...}