Move new Class Driver powered demos to a new ClassDriver subdirectory, re-add old...

[pub/lufa.git] / Demos / Device / ClassDriver / GenericHID / GenericHID.txt

diff --git a/Demos/Device/ClassDriver/GenericHID/GenericHID.txt b/Demos/Device/ClassDriver/GenericHID/GenericHID.txt
new file mode 100644 (file)
index 0000000..a40b78b
--- /dev/null
+++ b/Demos/Device/ClassDriver/GenericHID/GenericHID.txt
@@ -0,0 +1,64 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
+ \r
+/** \mainpage Generic HID Device\r
+ *\r
+ *  \section SSec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>USB Mode:</b></td>\r
+ *    <td>Device</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Class:</b></td>\r
+ *    <td>Human Interface Device (HID)</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>N/A</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Low Speed Mode, Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
+ *  Generic HID device demonstration application. This gives a simple reference application\r
+ *  for implementing a generic HID device, using the basic USB HID drivers in all modern\r
+ *  OSes (i.e. no special drivers required). It accepts and sends up to 255 byte reports to\r
+ *  and from a USB Host, and by default transmits the last sent report back to the host.\r
+ *  \r
+ *  On start-up the system will automatically enumerate and function as a vendor HID device.\r
+ *  When controlled by a custom HID class application, reports can be sent and received by\r
+ *  both the standard data endpoint and control request methods defined in the HID specification.\r
+ *\r
+ *  \section SSec_Options Project Options\r
+ *  \r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>GENERIC_REPORT_SIZE</td>\r
+ *    <td>Descriptors.h</td>\r
+ *    <td>This token defines the size of the device reports, both sent and received. The value must be an\r
+ *        integer ranging from 1 to 255.</td>\r
+ *   </tr>\r
+ *  </table>\r
+ */\r