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

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

diff --git a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt
new file mode 100644 (file)
index 0000000..3e31057
--- /dev/null
+++ b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt
@@ -0,0 +1,66 @@
+/** \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 Dual HID Keyboard and Mouse 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/Mouse demonstration application. This gives a simple reference\r
+ *  application for implementing a composite device containing both USB Keyboard\r
+ *  and USB Mouse functionality using the basic USB HID drivers in all modern OSes\r
+ *  (i.e. no special drivers required). This example uses two separate HID\r
+ *  interfaces for each function. It is boot protocol compatible, and thus works under\r
+ *  compatible BIOS as if it was a native keyboard and mouse (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 and the HWB is not\r
+ *  pressed. When enabled, 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
+ *  When the HWB is pressed, the mouse mode is enabled. When enabled, move the\r
+ *  joystick to move the pointer, and push the joystick inwards to simulate a\r
+ *  left-button click.\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