Upgrade to latest Doxygen.
[pub/USBasp.git] / Demos / Device / ClassDriver / KeyboardMouseMultiReport / KeyboardMouseMultiReport.txt
index 3e0d369..6ff910e 100644 (file)
@@ -1,75 +1,78 @@
-/** \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 Multiple Report HID Keyboard and Mouse Device Demo\r
- *\r
- *  \section Sec_Compat Demo Compatibility:\r
- *\r
- *  The following list indicates what microcontrollers are compatible with this demo.\r
- *\r
- *  - Series 7 USB AVRs (AT90USBxxx7)\r
- *  - Series 6 USB AVRs (AT90USBxxx6)\r
- *  - Series 4 USB AVRs (ATMEGAxxU4)\r
- *  - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)\r
- *\r
- *  \section Sec_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>N/A</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Relevant Standards:</b></td>\r
- *    <td>USBIF HID Specification \n\r
- *        USBIF HID Usage Tables</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Usable Speeds:</b></td>\r
- *    <td>Low Speed Mode \n\r
- *        Full Speed Mode</td>\r
- *   </tr>\r
- *  </table>\r
- *\r
- *  \section Sec_Description Project Description:\r
- *\r
- *  Keyboard/Mouse demonstration application, using a single HID interface. This gives\r
- *  a simple reference application for implementing a multiple HID report device\r
- *  containing both USB Keyboard and USB Mouse functionality using the basic USB HID\r
- *  drivers in all modern OSes (i.e. no special drivers required). This example uses a\r
- *  single HID interface that is shared between the two functions.\r
- *\r
- *  On start-up the system will automatically enumerate and function as a keyboard when\r
- *  the USB connection to a host is present and the HWB is not pressed. When enabled,\r
- *  manipulate the joystick to send the letters a, b, c, d and e. See the USB HID\r
- *  documentation for more information on sending keyboard event and key presses.\r
- *\r
- *  When the HWB is pressed, the mouse mode is enabled. When enabled, move the joystick\r
- *  to move the pointer, and push the joystick inwards to simulate a left-button click.\r
- *\r
- *  \section Sec_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
-\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 Multiple Report HID Keyboard and Mouse Device Demo
+ *
+ *  \section Sec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  \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)
+ *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
+ *  \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
+ *  \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
+ *
+ *  \section Sec_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>N/A</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF HID Specification \n
+ *        USBIF HID Usage Tables</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Supported USB Speeds:</b></td>
+ *    <td>Low Speed Mode \n
+ *        Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section Sec_Description Project Description:
+ *
+ *  Keyboard/Mouse demonstration application, using a single HID interface. This gives
+ *  a simple reference application for implementing a multiple HID report device
+ *  containing both USB Keyboard and USB Mouse functionality using the basic USB HID
+ *  drivers in all modern OSes (i.e. no special drivers required). This example uses a
+ *  single HID interface that is shared between the two functions.
+ *
+ *  On start-up the system will automatically enumerate and function as a keyboard when
+ *  the USB connection to a host is present and the HWB is not pressed. When enabled,
+ *  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.
+ *
+ *  When the HWB is pressed, the mouse mode is enabled. When enabled, move the joystick
+ *  to move the pointer, and push the joystick inwards to simulate a left-button click.
+ *
+ *  \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>
+ *   <tr>
+ *    <td>
+ *     None
+ *    </td>
+ *   </tr>
+ *  </table>
+ */
+