Add script reading bootloader flags
[pub/lufa.git] / Demos / Host / LowLevel / MouseHostWithParser / MouseHostWithParser.txt
index 79bc5c4..9b1b7d0 100644 (file)
@@ -1,68 +1,71 @@
-/** \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 Mouse Host With HID Descriptor Parser 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
- *\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>Host</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, 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
- *  Mouse host demonstration application. This gives a simple reference\r
- *  application for implementing a USB Mouse host, for USB mice using\r
- *  the standard mouse HID profile. It uses a HID parser for the HID\r
- *  reports, allowing for correct operation across all USB mice. This\r
- *  demo supports mice with a single HID report.\r
- *  \r
- *  Mouse movement and button presses are displayed on the board LEDs.\r
- *  On connection to a USB mouse, the report items will be processed and\r
- *  printed as a formatted list through the USART before the mouse is\r
- *  fully enumerated.\r
- *  \r
- *  Currently only single interface mice 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
+/** \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 Mouse Host With HID Descriptor Parser Demo
+ *
+ *  \section Sec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *
+ *  \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>Host</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:
+ *
+ *  Mouse host demonstration application. This gives a simple reference
+ *  application for implementing a USB Mouse host, for USB mice using
+ *  the standard mouse HID profile. It uses a HID parser for the HID
+ *  reports, allowing for correct operation across all USB mice. This
+ *  demo supports mice with a single HID report.
+ *
+ *  Mouse and scroll wheel movement and button presses are displayed
+ *  on the board LEDs. On connection to a USB mouse, the report items
+ *  will be processed and printed as a formatted list through the USART
+ *  before the mouse is fully enumerated.
+ *
+ *  Currently only single interface mice are supported.
+ *
+ *  \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>
+ */
+