X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/6a7c298c0f7119e44e18de15d714cd8b938e3bef..b9b03aadb219d06fbad9d110e508db93e45461af:/Demos/Device/ClassDriver/Keyboard/Keyboard.txt
diff --git a/Demos/Device/ClassDriver/Keyboard/Keyboard.txt b/Demos/Device/ClassDriver/Keyboard/Keyboard.txt
new file mode 100644
index 000000000..3fc9bee3a
--- /dev/null
+++ b/Demos/Device/ClassDriver/Keyboard/Keyboard.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 Keyboard Device Demo
+ *
+ * \section SSec_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: |
+ * N/A |
+ *
+ *
+ * | Relevant Standards: |
+ * USBIF HID Specification, USBIF HID Usage Tables |
+ *
+ *
+ * | Usable Speeds: |
+ * Low Speed Mode, Full Speed Mode |
+ *
+ *
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Keyboard demonstration application. This gives a simple reference application
+ * for implementing a USB Keyboard 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 keyboard (e.g. PS/2).
+ *
+ * On start-up the system will automatically enumerate and function
+ * as a keyboard when the USB connection to a host is present. To use
+ * the keyboard example, manipulate the joystick to send the letters
+ * a, b, c, d and e. See the USB HID documentation for more information
+ * on sending keyboard event and key presses.
+ *
+ * \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.
+ *
+ *
+ *
+ * |
+ * None
+ * |
+ *
+ *
+ */