diff options
Diffstat (limited to 'Demos/USBtoSerial/USBtoSerial.txt')
-rw-r--r-- | Demos/USBtoSerial/USBtoSerial.txt | 49 |
1 files changed, 36 insertions, 13 deletions
diff --git a/Demos/USBtoSerial/USBtoSerial.txt b/Demos/USBtoSerial/USBtoSerial.txt index 992f00f47..e33467217 100644 --- a/Demos/USBtoSerial/USBtoSerial.txt +++ b/Demos/USBtoSerial/USBtoSerial.txt @@ -6,19 +6,9 @@ /** \mainpage USB to Serial Converter Demo (via CDC-ACM class)
*
- * Communications Device Class demonstration application.
- * This gives a simple reference application for implementing
- * a USB to Serial converter using the CDC class. Sent and
- * received data on the serial port is communicated to the USB
- * host.
- *
- * After running this demo for the first time on a new computer,
- * you will need to supply the .INF file located in this demo
- * project's directory as the device's driver when running under
- * Windows. This will enable Windows to use its inbuilt CDC drivers,
- * negating the need for custom drivers for the device. Other
- * Operating Systems should automatically use their own inbuilt
- * CDC-ACM drivers.
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -42,4 +32,37 @@ * <td>Full Speed Mode</td>
* </tr>
* </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Communications Device Class demonstration application.
+ * This gives a simple reference application for implementing
+ * a USB to Serial converter using the CDC class. Sent and
+ * received data on the serial port is communicated to the USB
+ * host.
+ *
+ * After running this demo for the first time on a new computer,
+ * you will need to supply the .INF file located in this demo
+ * project's directory as the device's driver when running under
+ * Windows. This will enable Windows to use its inbuilt CDC drivers,
+ * negating the need for custom drivers for the device. Other
+ * Operating Systems should automatically use their own inbuilt
+ * CDC-ACM drivers.
+ *
+ * \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.
+ *
+ * <table>
+ * <tr>
+ * <td><b>Define Name:</b></td>
+ * <td><b>Location:</b></td>
+ * <td><b>Description:</b></td>
+ * </tr>
+ * <tr>
+ * <td>BUFF_STATICSIZE</td>
+ * <td>RingBuff.h</td>
+ * <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer.</td>
+ * </tr>
+ * </table>
*/
\ No newline at end of file |