summaryrefslogtreecommitdiffstats
path: root/tmk_core/protocol/lufa/LUFA-git/Projects/MissileLauncher/MissileLauncher.txt
diff options
context:
space:
mode:
authortmk <hasu@tmk-kbd.com>2015-05-13 04:13:10 +0200
committertmk <hasu@tmk-kbd.com>2015-05-13 04:13:10 +0200
commitf1f2066657f4a0998adc016c95d7e541b436e09f (patch)
treed056cb656b538c4f3a3c205363e0070976655e2e /tmk_core/protocol/lufa/LUFA-git/Projects/MissileLauncher/MissileLauncher.txt
parent1c73e574f109a17566db99e399bdf86007488d2a (diff)
parentf6d56675f9f981c5464f0ca7a1fbb0162154e8c5 (diff)
downloadqmk_firmware-f1f2066657f4a0998adc016c95d7e541b436e09f.tar.gz
qmk_firmware-f1f2066657f4a0998adc016c95d7e541b436e09f.tar.xz
Diffstat (limited to 'tmk_core/protocol/lufa/LUFA-git/Projects/MissileLauncher/MissileLauncher.txt')
-rw-r--r--tmk_core/protocol/lufa/LUFA-git/Projects/MissileLauncher/MissileLauncher.txt60
1 files changed, 60 insertions, 0 deletions
diff --git a/tmk_core/protocol/lufa/LUFA-git/Projects/MissileLauncher/MissileLauncher.txt b/tmk_core/protocol/lufa/LUFA-git/Projects/MissileLauncher/MissileLauncher.txt
new file mode 100644
index 000000000..a0ddd15cd
--- /dev/null
+++ b/tmk_core/protocol/lufa/LUFA-git/Projects/MissileLauncher/MissileLauncher.txt
@@ -0,0 +1,60 @@
+/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \mainpage David Fletcher's Missile Launcher
+ *
+ * \section Sec_Compat Project Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this project.
+ *
+ * \li Series 7 USB AVRs (AT90USBxxx7)
+ *
+ * \section Sec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this project.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Host</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>Human Interface Device (HID)</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF HID Specification, USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Supported USB Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section Sec_Description Project Description:
+ *
+ * Missile Launcher host. This is a host driver for the popular USB-controller table top toy missile launchers,
+ * which can typically aim and fire small foam "missiles" from a spring-loaded turret. This project controls the
+ * launcher via a joystick and button to aim and fire missiles at targets without a PC.
+ *
+ * \section Sec_Options Project Options
+ *
+ * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
+ *
+ * <table>
+ * <tr>
+ * <td>
+ * None
+ * </td>
+ * </tr>
+ * </table>
+ */
+