Move new Class Driver powered demos to a new ClassDriver subdirectory, re-add old...

[pub/lufa.git] / Demos / Device / ClassDriver / Keyboard / Keyboard.txt

diff --git a/Demos/Device/ClassDriver/Keyboard/Keyboard.txt b/Demos/Device/ClassDriver/Keyboard/Keyboard.txt
new file mode 100644 (file)
index 0000000..3fc9bee
--- /dev/null
+++ b/Demos/Device/ClassDriver/Keyboard/Keyboard.txt
@@ -0,0 +1,60 @@
+/** \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 Keyboard Device Demo\r
+ *\r
+ *  \section SSec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\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
+ *\r
+ *  \section SSec_Description Project Description:\r
+ *\r
+ *  Keyboard demonstration application. This gives a simple reference application\r
+ *  for implementing a USB Keyboard using the basic USB HID drivers in all modern\r
+ *  OSes (i.e. 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 start-up 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 key presses.\r
+ *\r
+ *  \section SSec_Options Project Options\r
+ *  \r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td>\r
+ *     None\r
+ *    </td>\r
+ *   </tr>\r
+ *  </table>\r
+ */\r