aboutsummaryrefslogtreecommitdiffstats
path: root/Projects/MissleLauncher/MissileLauncher.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Projects/MissleLauncher/MissileLauncher.txt')
-rw-r--r--Projects/MissleLauncher/MissileLauncher.txt53
1 files changed, 53 insertions, 0 deletions
diff --git a/Projects/MissleLauncher/MissileLauncher.txt b/Projects/MissleLauncher/MissileLauncher.txt
new file mode 100644
index 000000000..d30d5ea7d
--- /dev/null
+++ b/Projects/MissleLauncher/MissileLauncher.txt
@@ -0,0 +1,53 @@
+/** \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 Missle Launcher
+ *
+ * \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>
+ * <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>Usable Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Missle Launcher host. This is a host driver for the popular USB-controller table top toy missle launchers,
+ * which can typically aim and fire small foam "missles" from a spring-loaded turret. This project controls the
+ * launcher via a joystick and button to aim and fire missles at targets without a PC.
+ *
+ * \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>
+ */