Combined Keyboard, KeyboardViaInt and KeyboardFullInt demos into a single unified...

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

diff --git a/Demos/Keyboard/Keyboard.txt b/Demos/Keyboard/Keyboard.txt
index c227725..7939035 100644 (file)
--- a/Demos/Keyboard/Keyboard.txt
+++ b/Demos/Keyboard/Keyboard.txt
@@ -5,18 +5,10 @@
  */\r
  \r
 /** \mainpage Keyboard Device Demo\r
- *  \r
- *  Keyboard demonstration application. This gives a simple reference\r
- *  application for implementing a USB Keyboard using the basic USB HID\r
- *  drivers in all modern OSes (i.e. no special drivers required). It is\r
- *  boot protocol compatible, and thus works under compatible BIOS as if\r
- *  it was a native keyboard (e.g. PS/2).\r
- *  \r
- *  On startup the system will automatically enumerate and function\r
- *  as a keyboard when the USB connection to a host is present. To use\r
- *  the keyboard example, manipulate the joystick to send the letters\r
- *  a, b, c, d and e. See the USB HID documentation for more information\r
- *  on sending keyboard event and keypresses.\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
@@ -40,4 +32,42 @@
  *    <td>Low Speed Mode, Full Speed Mode</td>\r
  *   </tr>\r
  *  </table>\r
+ *\r
+ *  \section SSec_Description Project Description:\r
+ *  Keyboard demonstration application. This gives a simple reference application\r
+ *  for implementing a USB Keyboard using the basic USB HID drivers in all modern\r
+ *  OSes (i.e. no special drivers required). It is boot protocol compatible, and thus\r
+ *  works under compatible BIOS as if it was a native keyboard (e.g. PS/2).\r
+ *  \r
+ *  On startup the system will automatically enumerate and function\r
+ *  as a keyboard when the USB connection to a host is present. To use\r
+ *  the keyboard example, manipulate the joystick to send the letters\r
+ *  a, b, c, d and e. See the USB HID documentation for more information\r
+ *  on sending keyboard event and keypresses.\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><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>INTERRUPT_CONTROL_ENDPOINT</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this causes the demo to enable interrupts for the control endpoint,\r
+ *        which services control requests from the host. If not defined, the control endpoint\r
+ *        is serviced via polling using the task scheduler.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>INTERRUPT_DATA_ENDPOINT</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this causes the demo to enable interrupts for the data endpoints,\r
+ *        which services incomming LED reports and outgoing key status reports to and from the host.\r
+ *        If not defined, the data endpoints are serviced via polling using the task scheduler.</td>\r
+ *   </tr>\r
+ *  </table>\r
  */
\ No newline at end of file