Fixed ISR definition conflict in the XPLAIN bridge between the software UART and...
[pub/USBasp.git] / Demos / Device / ClassDriver / Keyboard / Keyboard.txt
index b1f5c2b..d4b4144 100644 (file)
@@ -1,69 +1,72 @@
-/** \file\r
- *\r
- *  This file contains special DoxyGen information for the generation of the main page and other special\r
- *  documentation pages. It is not a project source file.\r
- */\r
\r
-/** \mainpage Keyboard Device Demo\r
- *\r
- *  \section SSec_Compat Demo Compatibility:\r
- *\r
- *  The following list indicates what microcontrollers are compatible with this demo.\r
- *\r
- *  - Series 7 USB AVRs\r
- *  - Series 6 USB AVRs\r
- *  - Series 4 USB AVRs\r
- *  - Series 2 USB AVRs\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
- *    <td><b>USB Mode:</b></td>\r
- *    <td>Device</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>USB Class:</b></td>\r
- *    <td>Human Interface Device (HID)</td>\r
- *   </tr>\r
- *   <tr> \r
- *    <td><b>USB Subclass:</b></td>\r
- *    <td>Keyboard Subclass</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Relevant Standards:</b></td>\r
- *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Usable Speeds:</b></td>\r
- *    <td>Low Speed Mode, Full Speed Mode</td>\r
- *   </tr>\r
- *  </table>\r
- *\r
- *  \section SSec_Description Project Description:\r
- *\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 start-up 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 key presses.\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
- */\r
+/** \file
+ *
+ *  This file contains special DoxyGen information for the generation of the main page and other special
+ *  documentation pages. It is not a project source file.
+ */
+/** \mainpage Keyboard Device Demo
+ *
+ *  \section SSec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  - Series 7 USB AVRs (AT90USBxxx7)
+ *  - Series 6 USB AVRs (AT90USBxxx6)
+ *  - Series 4 USB AVRs (ATMEGAxxU4)
+ *  - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
+ *
+ *  \section SSec_Info USB Information:
+ *
+ *  The following table gives a rundown of the USB utilization of this demo.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>USB Mode:</b></td>
+ *    <td>Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Class:</b></td>
+ *    <td>Human Interface Device (HID)</td>
+ *   </tr>
+ *   <tr> 
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>Keyboard Subclass</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF HID Specification \n
+ *        USBIF HID Usage Tables</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Low Speed Mode \n
+ *        Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_Description Project Description:
+ *
+ *  Keyboard demonstration application. This gives a simple reference application
+ *  for implementing a USB Keyboard using the basic USB HID drivers in all modern
+ *  OSes (i.e. no special drivers required). It is boot protocol compatible, and thus
+ *  works under compatible BIOS as if it was a native keyboard (e.g. PS/2).
+ *  
+ *  On start-up the system will automatically enumerate and function as a keyboard 
+ *  when the USB connection to a host is present. To use the keyboard example,
+ *  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 key presses. Unlike
+ *  other LUFA Keyboard demos, this example shows explicitly how to send multiple key presses
+ *  inside the same report to the host.
+ *
+ *  \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>
+ */