From 8362bffb2eed310d319b0b96c1b3305eff9c4417 Mon Sep 17 00:00:00 2001
From: Damien George <damien.p.george@gmail.com>
Date: Sun, 3 Aug 2014 17:30:26 +0100
Subject: [PATCH] stmhal: Document behaviour of usb_vcp_recv_byte.

---
 stmhal/usb.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/stmhal/usb.h b/stmhal/usb.h
index 5153cb5fab..6d2d469fe9 100644
--- a/stmhal/usb.h
+++ b/stmhal/usb.h
@@ -48,7 +48,7 @@ void pyb_usb_dev_stop(void);
 bool usb_vcp_is_enabled(void);
 bool usb_vcp_is_connected(void);
 void usb_vcp_set_interrupt_char(int c);
-int usb_vcp_recv_byte(uint8_t *c);
+int usb_vcp_recv_byte(uint8_t *c); // if a byte is available, return 1 and put the byte in *c, else return 0
 void usb_vcp_send_strn(const char* str, int len);
 void usb_vcp_send_strn_cooked(const char *str, int len);
 void usb_hid_send_report(uint8_t *buf); // 4 bytes for mouse: ?, x, y, ?