diff options
| author | Stefan Sperling <stsp@cvs.openbsd.org> | 2012-02-19 15:48:49 +0000 |
|---|---|---|
| committer | Stefan Sperling <stsp@cvs.openbsd.org> | 2012-02-19 15:48:49 +0000 |
| commit | 6cef1001a869a3c8d77256a5c22664452fd481bd (patch) | |
| tree | f5171322f922a4cd77883833a3066aacff52e236 /lib | |
| parent | 76c5f28a8d7206a43f7aaafb4a20db4f54a8d3ea (diff) | |
Fix return value documentation errors in usbhid(3).
hid_dispose_report_desc() returns void, it can't return NULL on failure.
hid_get_report_desc() and hid_use_report_desc() return NULL on failure but
this was not documented.
ok jmc
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/libusbhid/usbhid.3 | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/lib/libusbhid/usbhid.3 b/lib/libusbhid/usbhid.3 index c95960cd3df..ed883720e73 100644 --- a/lib/libusbhid/usbhid.3 +++ b/lib/libusbhid/usbhid.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: usbhid.3,v 1.10 2007/05/31 19:19:38 jmc Exp $ +.\" $OpenBSD: usbhid.3,v 1.11 2012/02/19 15:48:48 stsp Exp $ .\" $NetBSD: usbhid.3,v 1.5 2002/02/07 07:00:52 ross Exp $ .\" .\" Copyright (c) 1999, 2001 Lennart Augustsson <augustss@netbsd.org> @@ -25,7 +25,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd $Mdocdate: May 31 2007 $ +.Dd $Mdocdate: February 19 2012 $ .Dt USBHID 3 .Os .Sh NAME @@ -110,10 +110,12 @@ When the report descriptor is no longer needed it should be freed by calling The type .Fa report_desc_t is opaque and should be used when calling the parsing functions. -If -.Fn hid_dispose_report_desc -fails it will return -.Fa NULL . +.Fn hid_get_report_desc +and +.Fn hid_use_report_desc +return +.Fa NULL +on failure. .Ss DESCRIPTOR PARSING FUNCTIONS To parse the report descriptor the .Fn hid_start_parse |