aboutsummaryrefslogtreecommitdiffstats
path: root/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt')
-rw-r--r--Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt44
1 files changed, 31 insertions, 13 deletions
diff --git a/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt b/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
index 09a83ca57..cd3670673 100644
--- a/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
+++ b/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
@@ -5,19 +5,10 @@
*/
/** \mainpage Keyboard Host With HID Descriptor Parser Demo
- *
- * Keyboard host demonstration application. This gives a simple reference
- * application for implementing a USB Keyboard host, for USB keyboards using
- * the standard Keyboard HID profile. It uses a HID parser for the HID reports,
- * allowing for correct operation across all USB keyboards. This demo supports
- * keyboards with a single HID report.
- *
- * Pressed alpha-numeric, enter or space key is transmitted through the serial
- * USART at serial settings 9600, 8, N, 1. On connection to a USB keyboard, the
- * report items will be processed and printed as a formatted list through the
- * USART before the keyboard is fully enumerated.
- *
- * Currently only single interface keyboards 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:
+ *
+ * Keyboard host demonstration application. This gives a simple reference
+ * application for implementing a USB Keyboard host, for USB keyboards using
+ * the standard Keyboard HID profile. It uses a HID parser for the HID reports,
+ * allowing for correct operation across all USB keyboards. This demo supports
+ * keyboards with a single HID report.
+ *
+ * Pressed alpha-numeric, enter or space key is transmitted through the serial
+ * USART at serial settings 9600, 8, N, 1. On connection to a USB keyboard, the
+ * report items will be processed and printed as a formatted list through the
+ * USART before the keyboard is fully enumerated.
+ *
+ * Currently only single interface keyboards 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