Additional file renames and modifications to change CDC demos to VirtualSerial.

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

diff --git a/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt b/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt
new file mode 100644 (file)
index 0000000..4983735
--- /dev/null
+++ b/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt
@@ -0,0 +1,72 @@
+/** \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 Communications Device Class (Virtual Serial Port) Demo\r
+ *\r
+ *  \section SSec_Compat Demo Compatibility:\r
+ *\r
+ *  The following list indicates what microcontrollers are compatible with this demo.\r
+ *\r
+ *  - Series 7 USB AVRs\r
+ *  - Series 6 USB AVRs\r
+ *  - Series 4 USB AVRs\r
+ *  - Series 2 USB AVRs\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>Communications Device Class (CDC)</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>Abstract Control Model (ACM)</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF CDC Class Standard</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
+ *  Communications Device Class demonstration application.\r
+ *  This gives a simple reference application for implementing\r
+ *  a CDC device acting as a virtual serial port. Joystick\r
+ *  actions are transmitted to the host as strings. The device\r
+ *  does not respond to serial data sent from the host.\r
+ *  \r
+ *  After running this demo for the first time on a new computer,\r
+ *  you will need to supply the .INF file located in this demo\r
+ *  project's directory as the device's driver when running under\r
+ *  Windows. This will enable Windows to use its inbuilt CDC drivers,\r
+ *  negating the need for custom drivers for the device. Other\r
+ *  Operating Systems should automatically use their own inbuilt\r
+ *  CDC-ACM drivers.\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>\r
+ *     None\r
+ *    </td>\r
+ *   </tr>\r
+ *  </table>\r
+ */
\ No newline at end of file