aboutsummaryrefslogtreecommitdiffstats
path: root/Bootloaders/TeensyHID/TeensyHID.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Bootloaders/TeensyHID/TeensyHID.txt')
-rw-r--r--Bootloaders/TeensyHID/TeensyHID.txt36
1 files changed, 27 insertions, 9 deletions
diff --git a/Bootloaders/TeensyHID/TeensyHID.txt b/Bootloaders/TeensyHID/TeensyHID.txt
index 973819cf8..1d83510d8 100644
--- a/Bootloaders/TeensyHID/TeensyHID.txt
+++ b/Bootloaders/TeensyHID/TeensyHID.txt
@@ -5,15 +5,11 @@
*/
/** \mainpage Teensy HID Class USB AVR Bootloader
- *
- * This bootloader enumerates to the host as a HID Class device, allowing for Teensy compatible programming
- * software to load firmware onto the AVR, such as the official software at http://www.pjrc.com/teensy/.
- *
- * Out of the box this bootloader builds for the USB162, and will fit into 2KB of bootloader space.
*
- * This spoofs (with permission) the offical Teensy bootloader's VID and PID, so that the software remains
- * compatible with no changes.
- *
+ * \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>
@@ -38,4 +34,26 @@
* <td>Full Speed Mode</td>
* </tr>
* </table>
- */
+ *
+ * \section SSec_Description Project Description:
+ *
+ * This bootloader enumerates to the host as a HID Class device, allowing for Teensy compatible programming
+ * software to load firmware onto the AVR, such as the official software at http://www.pjrc.com/teensy/.
+ *
+ * Out of the box this bootloader builds for the USB162, and will fit into 2KB of bootloader space.
+ *
+ * This spoofs (with permission) the offical Teensy bootloader's VID and PID, so that the software remains
+ * compatible with no changes.
+ *
+ * \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