diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-02-23 07:08:17 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-02-23 07:08:17 +0000 |
| commit | 9991321321d30ca9383d795ea7e796098c92045f (patch) | |
| tree | cd3bd40eef421cc83c9d63e58f5def8a233acab6 /Demos/TestApp/TestApp.txt | |
| parent | c1a1b6eeecb375259968ef6d989833312047f2d8 (diff) | |
| download | lufa-9991321321d30ca9383d795ea7e796098c92045f.tar.gz lufa-9991321321d30ca9383d795ea7e796098c92045f.tar.bz2 lufa-9991321321d30ca9383d795ea7e796098c92045f.zip | |
Moved all source to the trunk directory.
Diffstat (limited to 'Demos/TestApp/TestApp.txt')
| -rw-r--r-- | Demos/TestApp/TestApp.txt | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/Demos/TestApp/TestApp.txt b/Demos/TestApp/TestApp.txt new file mode 100644 index 000000000..e5b268aa5 --- /dev/null +++ b/Demos/TestApp/TestApp.txt @@ -0,0 +1,51 @@ +/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \mainpage Test Application for the LUFA library
+ *
+ * Test application. Demonstrates several aspects of the LUFA
+ * Library. On startup the current temperature will be printed
+ * through the USART every 10 seconds, and the current joystick
+ * position will be indicated via the LEDs on the selected board.
+ * Pressing the HWB will initiate the USB subsystem, enumerating
+ * the device (which has <b>no actual functionality beyond
+ * enumeration as a device or as a host in this demo</b>, and serves
+ * only to demonstrate the USB portion of the library). It will
+ * also suspend the joystick and temperature monitoring tasks.
+ *
+ * Pressing the HWB a second time will turn off the USB system
+ * and resume the temperature printing task (but not the joystick
+ * monitoring task).
+ *
+ * When activated, the USB events will be printed through the
+ * serial USART.
+ *
+ * When the USB subsystem is activated, the board LEDs will show
+ * the current USB status.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Host/Device (Dual Role)</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ */
\ No newline at end of file |