Add missing project files for the new HIDReportViewer project to upgrade its status...

[pub/lufa.git] / Projects / HIDReportViewer / HIDReportViewer.txt

diff --git a/Projects/HIDReportViewer/HIDReportViewer.txt b/Projects/HIDReportViewer/HIDReportViewer.txt
new file mode 100644 (file)
index 0000000..40a2f98
--- /dev/null
+++ b/Projects/HIDReportViewer/HIDReportViewer.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 HID Device Report Viewer Programmer Project\r
+ *\r
+ *  \section Sec_Compat Project Compatibility:\r
+ *\r
+ *  The following list indicates what microcontrollers are compatible with this project.\r
+ *\r
+ *  - Series 7 USB AVRs (AT90USBxxx7)\r
+ *\r
+ *  \section Sec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this project.\r
+ *\r
+ * <table>\r
+ *  <tr>\r
+ *   <td><b>USB Mode:</b></td>\r
+ *   <td>Host</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 \n\r
+ *        USBIF HID Usage Tables</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Low Speed Mode \n\r
+ *        Full Speed Mode</td>\r
+ *   </tr>\r
+ * </table>\r
+ *\r
+ *  \section Sec_Description Project Description:\r
+ *\r
+ *  Firmware for a HID Report viewer. This project is designed to aid in the debugging of USB HID Hosts, where the contents of an\r
+ *  unknown HID device's HID Report need to be examined. Once a HID device has been plugged into this application, the HID report\r
+ *  descriptor will be parsed using the internal LUFA HID report parser, and the results dumped to the serial port in a human\r
+ *  readable format. This output will contain information on the sizes of the reports within the device's HID interface, as well as\r
+ *  information on each report element (size, usage, minimum/maximum values, etc.).\r
+ *\r
+ *  \section Sec_Options Project Options\r
+ *\r
+ *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td>\r
+ *     None\r
+ *    </td>\r
+ *   </tr>\r
+ *  </table>\r
+ */\r
+\r