Finish initial draft of the Host Mode HID Class driver.

[pub/lufa.git] / Demos / Host / ClassDriver / MouseHostWithParser / MouseHostWithParser.txt

diff --git a/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt b/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt
new file mode 100644 (file)
index 0000000..c0ff4bf
--- /dev/null
+++ b/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt
@@ -0,0 +1,69 @@
+/** \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 table indicates what microcontrollers are compatible with this demo.\r
+ *\r
+ *  - AT90USB1287\r
+ *  - AT90USB647\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