aboutsummaryrefslogtreecommitdiff
path: root/Demos/MouseHostViaInt/MouseHostViaInt.txt
diff options
context:
space:
mode:
authorDean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28>2009-03-19 14:16:12 +0000
committerDean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28>2009-03-19 14:16:12 +0000
commitdf836c084ec37df55fa106b2bcb16ea02e49dc36 (patch)
treecfdd65c067c9c660b7e3d3f6edcefe25596f5f6f /Demos/MouseHostViaInt/MouseHostViaInt.txt
parentc86cc74e54b4f849e86e2ed5493e015c9783b32b (diff)
Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.
Corrections to Keyboard demo. Removed AVRISP_Programmer project due to code quality concerns. git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@470 d5102386-fcda-11dd-9fdb-3debd5008f28
Diffstat (limited to 'Demos/MouseHostViaInt/MouseHostViaInt.txt')
-rw-r--r--Demos/MouseHostViaInt/MouseHostViaInt.txt54
1 files changed, 36 insertions, 18 deletions
diff --git a/Demos/MouseHostViaInt/MouseHostViaInt.txt b/Demos/MouseHostViaInt/MouseHostViaInt.txt
index 72ee1dbe..74986554 100644
--- a/Demos/MouseHostViaInt/MouseHostViaInt.txt
+++ b/Demos/MouseHostViaInt/MouseHostViaInt.txt
@@ -4,24 +4,9 @@
* documentation pages. It is not a project source file.
*/
-/** \mainpage Mouse Host Demo
- *
- * Mouse host demonstration application, using pipe interrupts. This
- * gives a simple reference application for implementing a USB Mouse
- * host utilizing the LUFA pipe interrupt system, for USB mice using
- * the standard mouse HID profile.
- *
- * Mouse movement and button presses are displayed on the board LEDs,
- * as well as printed out the serial terminal as formatted dY, dY and
- * button status information.
- *
- * This uses a naive method where the mouse is set to Boot Protocol mode, so
- * that the report structure is fixed and known. A better implementation
- * uses the HID report parser for correct report data processing across
- * all compatable mice with advanced characteristics, as shown in the
- * MouseHostWithParser demo application.
- *
- * Currently only single interface mice are supported.
+/** \mainpage Mouse Host Demo (via interrupts)
+ *
+ * \section SSec_Info USB Information:
*
* <table>
* <tr>
@@ -45,4 +30,37 @@
* <td>Low Speed Mode, Full Speed Mode</td>
* </tr>
* </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
+ *
+ * Mouse host demonstration application, using pipe interrupts. This
+ * gives a simple reference application for implementing a USB Mouse
+ * host utilizing the LUFA pipe interrupt system, for USB mice using
+ * the standard mouse HID profile.
+ *
+ * Mouse movement and button presses are displayed on the board LEDs,
+ * as well as printed out the serial terminal as formatted dY, dY and
+ * button status information.
+ *
+ * This uses a naive method where the mouse is set to Boot Protocol mode, so
+ * that the report structure is fixed and known. A better implementation
+ * uses the HID report parser for correct report data processing across
+ * all compatable mice with advanced characteristics, as shown in the
+ * MouseHostWithParser demo application.
+ *
+ * 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