Fix doxygen comment in USBDevice

c1728p9 · c1728p9 · commit 2986b3af7c62 · 2019-04-08T17:30:22.000-05:00
Update the doxygen to correctly describe the return value of
endpoint_read_result.
diff --git a/usb/device/USBPhy/USBPhy.h b/usb/device/USBPhy/USBPhy.h
@@ -283,7 +283,7 @@ class USBPhy {
      * Finish a read on the given endpoint
      *
      * @param endpoint Endpoint to check
-     * @return true if data was read false otherwise
+     * @return The number of bytes received
      */
     virtual uint32_t endpoint_read_result(usb_ep_t endpoint) = 0;
 

Original file line number	Diff line number	Diff line change
`@@ -283,7 +283,7 @@ class USBPhy {`
`283`	`283`	`* Finish a read on the given endpoint`
`284`	`284`	`*`
`285`	`285`	`* @param endpoint Endpoint to check`
`286`		`- * @return true if data was read false otherwise`
	`286`	`+ * @return The number of bytes received`
`287`	`287`	`*/`
`288`	`288`	`virtual uint32_t endpoint_read_result(usb_ep_t endpoint) = 0;`
`289`	`289`