Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.

[pub/lufa.git] / Demos / KeyboardHostViaInt / KeyboardHostViaInt.txt

diff --git a/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt b/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt
index 07c1108..de61d32 100644 (file)
--- a/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt
+++ b/Demos/KeyboardHostViaInt/KeyboardHostViaInt.txt
@@ -4,23 +4,11 @@
  *  documentation pages. It is not a project source file.\r
  */\r
  \r
-/** \mainpage Keyboard Host Demo\r
- *  \r
- *  Keyboard host demonstration application, using pipe interrupts. This gives\r
- *  a simple reference application for implementing a USB Keyboard host utilizing\r
- *  the LUFA pipe interrupt system, for USB keyboards using the standard Keyboard\r
- *  HID profile.\r
- *  \r
- *  Pressed alpha-numeric, enter or space key is transmitted through the serial\r
- *  USART at serial settings 9600, 8, N, 1.\r
- *  \r
- *  This uses a naive method where the keyboard is set to Boot Protocol mode, so\r
- *  that the report structure is fixed and known. A better implementation\r
- *  uses the HID report parser for correct report data processing across\r
- *  all compatable mice with advanced characteristics, as shown in the\r
- *  KeyboardHostWithParser demo application.\r
- *  \r
- *  Currently only single interface keyboards are supported.   \r
+/** \mainpage Keyboard Host Demo (via interrupts)\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
@@ -44,4 +32,34 @@
  *    <td>Low Speed Mode, Full Speed Mode</td>\r
  *   </tr>\r
  *  </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
+ *  Keyboard host demonstration application, using pipe interrupts. This gives\r
+ *  a simple reference application for implementing a USB Keyboard host utilizing\r
+ *  the LUFA pipe interrupt system, for USB keyboards using the standard Keyboard\r
+ *  HID profile.\r
+ *  \r
+ *  Pressed alpha-numeric, enter or space key is transmitted through the serial\r
+ *  USART at serial settings 9600, 8, N, 1.\r
+ *  \r
+ *  This uses a naive method where the keyboard is set to Boot Protocol mode, so\r
+ *  that the report structure is fixed and known. A better implementation\r
+ *  uses the HID report parser for correct report data processing across\r
+ *  all compatable mice with advanced characteristics, as shown in the\r
+ *  KeyboardHostWithParser demo application.\r
+ *  \r
+ *  Currently only single interface keyboards are supported.\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
  */
\ No newline at end of file