Add commentary on test methods?

[fw/stlink] / src / stlink-usb.c

diff --git a/src/stlink-usb.c b/src/stlink-usb.c
index 895b368fa512c432d44802e972adeccbcd932f6a..f2ee2bd1d995a0077fa8edde6ce8fefbd1661cba 100644 (file)
--- a/src/stlink-usb.c
+++ b/src/stlink-usb.c
@@ -289,6 +289,10 @@ void _stlink_usb_exit_dfu_mode(stlink_t* sl) {
     }
 }
 
+/**
+ * TODO - not convinced this does anything...
+ * @param sl
+ */
 void _stlink_usb_reset(stlink_t * sl) {
     struct stlink_libusb * const slu = sl->backend_data;
     unsigned char* const buf = sl->q_buf;
@@ -322,6 +326,10 @@ void _stlink_usb_step(stlink_t* sl) {
     }
 }
 
+/**
+ * This seems to do a good job of restarting things from the beginning?
+ * @param sl
+ */
 void _stlink_usb_run(stlink_t* sl) {
     struct stlink_libusb * const slu = sl->backend_data;
     unsigned char* const buf = sl->q_buf;