summaryrefslogtreecommitdiff
path: root/stmhal/usb.c
diff options
context:
space:
mode:
Diffstat (limited to 'stmhal/usb.c')
-rw-r--r--stmhal/usb.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/stmhal/usb.c b/stmhal/usb.c
index a7c3add53..13f8f8330 100644
--- a/stmhal/usb.c
+++ b/stmhal/usb.c
@@ -137,6 +137,13 @@ void usb_hid_send_report(uint8_t *buf) {
/******************************************************************************/
// Micro Python bindings for USB VCP
+/// \moduleref pyb
+/// \class USB_VCP - USB virtual comm port
+///
+/// The USB_VCP class allows creation of an object representing the USB
+/// virtual comm port. It can be used to read and write data over USB to
+/// the connected host.
+
typedef struct _pyb_usb_vcp_obj_t {
mp_obj_base_t base;
} pyb_usb_vcp_obj_t;