X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/6a7c298c0f7119e44e18de15d714cd8b938e3bef..b9b03aadb219d06fbad9d110e508db93e45461af:/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt?ds=sidebyside

diff --git a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt
new file mode 100644
index 000000000..3e31057ca
--- /dev/null
+++ b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt
@@ -0,0 +1,66 @@
+/** \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 Dual HID Keyboard and Mouse Device Demo
+ *
+ *  \section SSec_Info USB Information:
+ *
+ *  The following table gives a rundown of the USB utilization of this demo.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>USB Mode:</b></td>
+ *    <td>Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Class:</b></td>
+ *    <td>Human Interface Device (HID)</td>
+ *   </tr>
+ *   <tr> 
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>N/A</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Low Speed Mode, Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_Description Project Description: 
+ *
+ *  Keyboard/Mouse demonstration application. This gives a simple reference
+ *  application for implementing a composite device containing both USB Keyboard
+ *  and USB Mouse functionality using the basic USB HID drivers in all modern OSes
+ *  (i.e. no special drivers required). This example uses two separate HID
+ *  interfaces for each function. It is boot protocol compatible, and thus works under
+ *  compatible BIOS as if it was a native keyboard and mouse (e.g. PS/2).
+ *  
+ *  On start-up the system will automatically enumerate and function
+ *  as a keyboard when the USB connection to a host is present and the HWB is not
+ *  pressed. When enabled, manipulate the joystick to send the letters
+ *  a, b, c, d and e. See the USB HID documentation for more information
+ *  on sending keyboard event and key presses.
+ *  
+ *  When the HWB is pressed, the mouse mode is enabled. When enabled, move the
+ *  joystick to move the pointer, and push the joystick inwards to simulate a
+ *  left-button click.
+ *
+ *  \section SSec_Options Project Options
+ *
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td>
+ *     None
+ *    </td>
+ *   </tr>
+ *  </table>
+ */