aboutsummaryrefslogtreecommitdiffstats
path: root/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt')
-rw-r--r--Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt52
1 files changed, 35 insertions, 17 deletions
diff --git a/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt b/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt
index 07c110848..de61d32fe 100644
--- a/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt
+++ b/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt
@@ -4,23 +4,11 @@
* documentation pages. It is not a project source file.
*/
-/** \mainpage Keyboard Host Demo
- *
- * Keyboard host demonstration application, using pipe interrupts. This gives
- * a simple reference application for implementing a USB Keyboard host utilizing
- * the LUFA pipe interrupt system, 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.
+/** \mainpage Keyboard Host Demo (via interrupts)
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -44,4 +32,34 @@
* <td>Low Speed Mode, Full Speed Mode</td>
* </tr>
* </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Keyboard host demonstration application, using pipe interrupts. This gives
+ * a simple reference application for implementing a USB Keyboard host utilizing
+ * the LUFA pipe interrupt system, 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