diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-20 06:34:41 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-20 06:34:41 +0000 |
| commit | ed031c1df2f5b053b9cd9f48c63e66a42b7c049e (patch) | |
| tree | 8e49d639484d53a6e00700b20e2b804e9775242f /Demos/Device/Joystick/Joystick.txt | |
| parent | ecf7538430c01b95104682f0f7493e57b9168125 (diff) | |
| download | lufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.tar.gz lufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.tar.bz2 lufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.zip | |
Seperated out OTG, Device and Host mode demos into seperate folders for clarity. Adjusted makefiles so that the path to the LUFA library can be set in one place.
Diffstat (limited to 'Demos/Device/Joystick/Joystick.txt')
| -rw-r--r-- | Demos/Device/Joystick/Joystick.txt | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/Demos/Device/Joystick/Joystick.txt b/Demos/Device/Joystick/Joystick.txt new file mode 100644 index 000000000..7d47ae92f --- /dev/null +++ b/Demos/Device/Joystick/Joystick.txt @@ -0,0 +1,62 @@ +/** \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 Joystick Device Demo
+ *
+ * \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>Device</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:
+ *
+ * Joystick demonstration application. This gives a simple reference
+ * application for implementing a USB Keyboard device, for USB Joysticks
+ * using the standard Keyboard HID profile.
+ *
+ * This device will show up as a generic joystick device, with two buttons.
+ * Pressing the joystick inwards is the first button, and the HWB button
+ * is the second.
+ *
+ * Moving the joystick on the selected board moves the joystick location on
+ * the host computer.
+ *
+ * Currently only single interface joysticks 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 |