Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.

[pub/lufa.git] / Demos / MouseHostViaInt / MouseHostViaInt.txt

diff --git a/Demos/MouseHostViaInt/MouseHostViaInt.txt b/Demos/MouseHostViaInt/MouseHostViaInt.txt
index 72ee1db..7498655 100644 (file)
--- a/Demos/MouseHostViaInt/MouseHostViaInt.txt
+++ b/Demos/MouseHostViaInt/MouseHostViaInt.txt
@@ -4,24 +4,9 @@
  *  documentation pages. It is not a project source file.\r
  */\r
  \r
-/** \mainpage Mouse Host Demo\r
- *  \r
- *  Mouse host demonstration application, using pipe interrupts. This\r
- *  gives a simple reference application for implementing a USB Mouse\r
- *  host utilizing the LUFA pipe interrupt system, for USB mice using\r
- *  the standard mouse HID profile.\r
- *  \r
- *  Mouse movement and button presses are displayed on the board LEDs,\r
- *  as well as printed out the serial terminal as formatted dY, dY and\r
- *  button status information.\r
- *  \r
- *  This uses a naive method where the mouse is set to Boot Protocol mode, so\r
- *  that the report structure is fixed and known. A better implementation\r
- *  uses the HID report parser for correct report data processing across\r
- *  all compatable mice with advanced characteristics, as shown in the\r
- *  MouseHostWithParser demo application.\r
- *  \r
- *  Currently only single interface mice are supported.        \r
+/** \mainpage Mouse Host Demo (via interrupts)\r
+ *\r
+ *  \section SSec_Info USB Information:\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -45,4 +30,37 @@
  *    <td>Low Speed Mode, Full Speed Mode</td>\r
  *   </tr>\r
  *  </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
+ *\r
+ *  Mouse host demonstration application, using pipe interrupts. This\r
+ *  gives a simple reference application for implementing a USB Mouse\r
+ *  host utilizing the LUFA pipe interrupt system, for USB mice using\r
+ *  the standard mouse HID profile.\r
+ *  \r
+ *  Mouse movement and button presses are displayed on the board LEDs,\r
+ *  as well as printed out the serial terminal as formatted dY, dY and\r
+ *  button status information.\r
+ *  \r
+ *  This uses a naive method where the mouse is set to Boot Protocol mode, so\r
+ *  that the report structure is fixed and known. A better implementation\r
+ *  uses the HID report parser for correct report data processing across\r
+ *  all compatable mice with advanced characteristics, as shown in the\r
+ *  MouseHostWithParser demo application.\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