diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-19 14:16:12 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-19 14:16:12 +0000 |
| commit | 88051e78a281f5776538558aec113ff2b66e056c (patch) | |
| tree | cfdd65c067c9c660b7e3d3f6edcefe25596f5f6f /Demos/KeyboardMouse | |
| parent | 48400df13c7f9f4f0fd8e7f841d49f9502557cb1 (diff) | |
| download | lufa-88051e78a281f5776538558aec113ff2b66e056c.tar.gz lufa-88051e78a281f5776538558aec113ff2b66e056c.tar.bz2 lufa-88051e78a281f5776538558aec113ff2b66e056c.zip | |
Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.
Corrections to Keyboard demo.
Removed AVRISP_Programmer project due to code quality concerns.
Diffstat (limited to 'Demos/KeyboardMouse')
| -rw-r--r-- | Demos/KeyboardMouse/KeyboardMouse.txt | 50 |
1 files changed, 34 insertions, 16 deletions
diff --git a/Demos/KeyboardMouse/KeyboardMouse.txt b/Demos/KeyboardMouse/KeyboardMouse.txt index 969e2871b..6388e9803 100644 --- a/Demos/KeyboardMouse/KeyboardMouse.txt +++ b/Demos/KeyboardMouse/KeyboardMouse.txt @@ -6,22 +6,9 @@ /** \mainpage Dual HID Keyboard and Mouse Device Demo
*
- * 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 seperate 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 startup 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 keypresses.
- *
- * 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_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -45,4 +32,35 @@ * <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 seperate 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 startup 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 keypresses.
+ *
+ * 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>
*/
\ No newline at end of file |