commit ae281b6cfd6d49e11710e74c3693bd4d043b66b6
author Tim Shepard <tjshep@google.com> Thu Oct 17 10:33:33 2019 -0400
committer tjshep <51791992+tjshep@users.noreply.github.com> Fri Oct 25 17:10:15 2019 -0400
tree d232a4cd1712b182138848663bc37e9fa5ee44be
parent a6a9a01c2dd77c0e5484cac1a2fab55b051e4d02

[sw/lib] Modify existing documentation comments to use doxygen format.

Also moved documentation of some interfaces from .c to .h files.

sw/lib/usb_simpleserial.h

diff --git a/sw/lib/usb_simpleserial.h b/sw/lib/usb_simpleserial.h
index 8f37641..c1cc51a 100644
--- a/sw/lib/usb_simpleserial.h
+++ b/sw/lib/usb_simpleserial.h
@@ -23,18 +23,19 @@
 
 /**
  * Send a byte on a simpleserial endpoint
- * ssctx - instance context
- * c - byte to send
+ *
+ * @param ssctx instance context
+ * @param c byte to send
  */
 void usb_simpleserial_send_byte(usb_ss_ctx_t *ssctx, uint8_t c);
 
 /**
  * Initialize a simpleserial endpoint
  *
- * ctx - initialized usbdev context
- * ep - endpoint number for this instance
- * ssctx - unintialized simpleserial instance context
- * got_byte - callback function for when a byte is received
+ * @param ssctx unintialized simpleserial instance context
+ * @param ctx initialized usbdev context
+ * @param ep endpoint number for this instance
+ * @param got_byte callback function for when a byte is received
  */
 void usb_simpleserial_init(usb_ss_ctx_t *ssctx, usbdev_ctx_t *ctx, int ep,
                            void (*got_byte)(uint8_t));