X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lib%2Flufa%2FDemos%2FDevice%2FClassDriver%2FMouse%2FMouse.txt;fp=lib%2Flufa%2FDemos%2FDevice%2FClassDriver%2FMouse%2FMouse.txt;h=dc65b8879336b70c4736863fbaf4904c66a24716;hb=8655d4f4948b2deef7844503c8d690f23ac1a062;hp=0000000000000000000000000000000000000000;hpb=1896c76a2928c96f9ab7947bec2ef8dd37623cff;p=qmk_firmware.git
diff --git a/lib/lufa/Demos/Device/ClassDriver/Mouse/Mouse.txt b/lib/lufa/Demos/Device/ClassDriver/Mouse/Mouse.txt
new file mode 100644
index 000000000..dc65b8879
--- /dev/null
+++ b/lib/lufa/Demos/Device/ClassDriver/Mouse/Mouse.txt
@@ -0,0 +1,76 @@
+/** \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 Mouse Device Demo
+ *
+ * \section Sec_Compat Demo Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this demo.
+ *
+ * \li Series 7 USB AVRs (AT90USBxxx7)
+ * \li Series 6 USB AVRs (AT90USBxxx6)
+ * \li Series 4 USB AVRs (ATMEGAxxU4)
+ * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
+ * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
+ * \li Series B XMEGA AVRs (ATXMEGAxxxBx)
+ * \li Series C XMEGA AVRs (ATXMEGAxxxCx)
+ *
+ * \section Sec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
+ *
+ *
+ *
+ * USB Mode: |
+ * Device |
+ *
+ *
+ * USB Class: |
+ * Human Interface Device (HID) |
+ *
+ *
+ * USB Subclass: |
+ * Mouse Subclass |
+ *
+ *
+ * Relevant Standards: |
+ * USBIF HID Specification \n
+ * USBIF HID Usage Tables |
+ *
+ *
+ * Supported USB Speeds: |
+ * Low Speed Mode \n
+ * Full Speed Mode |
+ *
+ *
+ *
+ * \section Sec_Description Project Description:
+ *
+ * Mouse demonstration application. This gives a simple reference
+ * application for implementing a USB Mouse using the basic USB HID
+ * drivers in all modern OSes (i.e. no special drivers required). It is
+ * boot protocol compatible, and thus works under compatible BIOS as if
+ * it was a native mouse (e.g. PS/2).
+ *
+ * On start-up the system will automatically enumerate and function
+ * as a mouse when the USB connection to a host is present. To use
+ * the mouse, move the joystick to move the pointer, and push the
+ * joystick inwards to simulate a left-button click. The HWB serves as
+ * the right mouse button.
+ *
+ * \section Sec_Options Project Options
+ *
+ * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *
+ *
+ *
+ * None
+ * |
+ *
+ *
+ */
+