aboutsummaryrefslogtreecommitdiffstats
path: root/Demos/CDC/CDC.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Demos/CDC/CDC.txt')
-rw-r--r--Demos/CDC/CDC.txt44
1 files changed, 31 insertions, 13 deletions
diff --git a/Demos/CDC/CDC.txt b/Demos/CDC/CDC.txt
index 34e1c82a1..8e13b55b4 100644
--- a/Demos/CDC/CDC.txt
+++ b/Demos/CDC/CDC.txt
@@ -6,19 +6,9 @@
/** \mainpage Communications Device Class Device (Virtual Serial Port)
*
- * Communications Device Class demonstration application.
- * This gives a simple reference application for implementing
- * a CDC device acting as a virtual serial port. Joystick
- * actions are transmitted to the host as strings. The device
- * does not respond to serial data sent from the 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,32 @@
* <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 CDC device acting as a virtual serial port. Joystick
+ * actions are transmitted to the host as strings. The device
+ * does not respond to serial data sent from the 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>
+ * None
+ * </td>
+ * </tr>
+ * </table>
*/ \ No newline at end of file