Moved all source to the trunk directory.
[pub/lufa.git] / Demos / KeyboardFullInt / KeyboardFullInt.txt
diff --git a/Demos/KeyboardFullInt/KeyboardFullInt.txt b/Demos/KeyboardFullInt/KeyboardFullInt.txt
new file mode 100644 (file)
index 0000000..8907118
--- /dev/null
@@ -0,0 +1,44 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
\r
+/** \mainpage Fully Interrupt Driven Keyboard Device Demo\r
+ *  \r
+ *  Keyboard demonstration application, using endpoint interrupts for the\r
+ *  exchange of data to the USB host, and control requests on the control\r
+ *  endpoint. This gives a simple reference application for implementing a\r
+ *  USB Keyboard using the basic USB HID drivers in all modern OSes (i.e.\r
+ *  no special drivers required). It is boot protocol compatible, and thus\r
+ *  works under compatible BIOS as if it was a native keyboard (e.g. PS/2).\r
+ *  \r
+ *  On startup the system will automatically enumerate and function\r
+ *  as a keyboard when the USB connection to a host is present. To use\r
+ *  the keyboard example, manipulate the joystick to send the letters\r
+ *  a, b, c, d and e. See the USB HID documentation for more information\r
+ *  on sending keyboard event and keypresses.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>USB Mode:</b></td>\r
+ *    <td>Device</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Class:</b></td>\r
+ *    <td>Human Interface Device (HID)</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>N/A</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Low Speed Mode, Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ */
\ No newline at end of file