X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/34f6e0dd33230441b8a91130467b3164e343853e..0323e13b39a8a00ede4a3242bddfc6d8343acdaa:/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
index 000000000..3c83341a2
--- /dev/null
+++ b/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.txt
@@ -0,0 +1,62 @@
+/** \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 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>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, USBIF HID Usage Tables</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Low Speed Mode, Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_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 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 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>
+ */
\ No newline at end of file