From bc212bba456fd62760a898044487e8dd5fee31a6 Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Wed, 29 Jul 2015 12:36:08 +0000 Subject: [PATCH] usb: correctly document return type. The three existing usb drivers have no possible path that doesn't return the object here, so I've left that comment, but it is plausible that future drivers might have some reason that allows failing to init. We should strive to avoid that though. Fixes github issue: #494 --- lib/usb/usb.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/usb/usb.c b/lib/usb/usb.c index bb7b5a3b..fc16d421 100644 --- a/lib/usb/usb.c +++ b/lib/usb/usb.c @@ -59,7 +59,7 @@ LGPL License Terms @ref lgpl_license * received during control requests with DATA * stage * @param control_buffer_size Size of control_buffer - * @return Zero on success (currently cannot fail). + * @return the usb device initialized for use. (currently cannot fail). */ usbd_device *usbd_init(const usbd_driver *driver, const struct usb_device_descriptor *dev,