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/KeyboardHost/KeyboardHost.txt | |
| 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/KeyboardHost/KeyboardHost.txt')
| -rw-r--r-- | Demos/KeyboardHost/KeyboardHost.txt | 48 |
1 files changed, 33 insertions, 15 deletions
diff --git a/Demos/KeyboardHost/KeyboardHost.txt b/Demos/KeyboardHost/KeyboardHost.txt index 92e380789..db0e14ad6 100644 --- a/Demos/KeyboardHost/KeyboardHost.txt +++ b/Demos/KeyboardHost/KeyboardHost.txt @@ -5,21 +5,10 @@ */
/** \mainpage Keyboard Host Demo
- *
- * Keyboard host demonstration application. This gives a simple reference
- * application for implementing a USB Mouse keyboard, for USB keyboards using
- * the standard keyboard HID profile.
- *
- * Pressed alpha-numeric, enter or space key is transmitted through the serial
- * USART at serial settings 9600, 8, N, 1.
- *
- * This uses a naive method where the keyboard is set to Boot Protocol mode, so
- * that the report structure is fixed and known. A better implementation
- * uses the HID report parser for correct report data processing across
- * all compatable mice with advanced characteristics, as shown in the
- * KeyboardHostWithParser demo application.
- *
- * Currently only single interface keyboards are supported.
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -43,4 +32,33 @@ * <td>Low Speed Mode, Full Speed Mode</td>
* </tr>
* </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Keyboard host demonstration application. This gives a simple reference
+ * application for implementing a USB Mouse keyboard, for USB keyboards using
+ * the standard keyboard HID profile.
+ *
+ * Pressed alpha-numeric, enter or space key is transmitted through the serial
+ * USART at serial settings 9600, 8, N, 1.
+ *
+ * This uses a naive method where the keyboard is set to Boot Protocol mode, so
+ * that the report structure is fixed and known. A better implementation
+ * uses the HID report parser for correct report data processing across
+ * all compatable mice with advanced characteristics, as shown in the
+ * KeyboardHostWithParser demo application.
+ *
+ * Currently only single interface keyboards are supported.
+ *
+ * \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 |