jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases Activity

usb: correctly document return type.

Browse Source 
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
This commit is contained in:
Karl Palsson 2015-07-29 12:36:08 +00:00
parent 9edde424f8
commit bc212bba45
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/usb/usb.c
View File

@ -59,7 +59,7 @@ LGPL License Terms @ref lgpl_license
* received during control requests with DATA * received during control requests with DATA
* stage * stage
* @param control_buffer_size Size of control_buffer * @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, usbd_device *usbd_init(const usbd_driver *driver,
const struct usb_device_descriptor *dev, const struct usb_device_descriptor *dev,