aboutsummaryrefslogtreecommitdiffstats
path: root/Demos/MouseHostWithParser/MouseHostWithParser.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Demos/MouseHostWithParser/MouseHostWithParser.txt')
-rw-r--r--Demos/MouseHostWithParser/MouseHostWithParser.txt44
1 files changed, 31 insertions, 13 deletions
diff --git a/Demos/MouseHostWithParser/MouseHostWithParser.txt b/Demos/MouseHostWithParser/MouseHostWithParser.txt
index 97ee8bfb8..3c83341a2 100644
--- a/Demos/MouseHostWithParser/MouseHostWithParser.txt
+++ b/Demos/MouseHostWithParser/MouseHostWithParser.txt
@@ -5,19 +5,10 @@
*/
/** \mainpage Mouse Host With HID Descriptor Parser Demo
- *
- * 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_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -41,4 +32,31 @@
* <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