Add symbolic names for USB Device String Descriptors within the demos, applications...
[pub/USBasp.git] / Demos / Device / LowLevel / Keyboard / Keyboard.txt
index 0401222..f7e2829 100644 (file)
@@ -3,19 +3,19 @@
  *  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:
+ *  \section Sec_Compat Demo Compatibility:
  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *
- *  - Series 7 USB AVRs
- *  - Series 6 USB AVRs
- *  - Series 4 USB AVRs
- *  - Series 2 USB AVRs
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series 4 USB AVRs (ATMEGAxxU4)
+ *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  *
- *  \section SSec_Info USB Information:
+ *  \section Sec_Info USB Information:
  *
  *  The following table gives a rundown of the USB utilization of this demo.
  *
@@ -28,7 +28,7 @@
  *    <td><b>USB Class:</b></td>
  *    <td>Human Interface Device (HID)</td>
  *   </tr>
- *   <tr> 
+ *   <tr>
  *    <td><b>USB Subclass:</b></td>
  *    <td>N/A</td>
  *   </tr>
  *        USBIF HID Usage Tables</td>
  *   </tr>
  *   <tr>
- *    <td><b>Usable Speeds:</b></td>
+ *    <td><b>Supported USB Speeds:</b></td>
  *    <td>Low Speed Mode \n
  *        Full Speed Mode</td>
  *   </tr>
  *  </table>
  *
- *  \section SSec_Description Project Description:
+ *  \section Sec_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 
+ *
+ *  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 keypresses
+ *  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
- *  
+ *  \section Sec_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>
@@ -70,3 +70,4 @@
  *   </tr>
  *  </table>
  */
+