Document failure modes of xcb_connect*() functions
authorAlan Coopersmith <alan.coopersmith@oracle.com>
Sat, 14 Jun 2014 04:26:21 +0000 (21:26 -0700)
committerAlan Coopersmith <alan.coopersmith@oracle.com>
Sat, 14 Jun 2014 15:24:30 +0000 (08:24 -0700)
commitbc5a1047548b578624cfbc44ca192cde7664ed78
tree4a1a4882e7e09124cbca976e583a2d8643332ee9
parent72e45969ff71204cee2dde3502841736cfd41c8a
Document failure modes of xcb_connect*() functions

Documentation was previously unclear that these always return a non-NULL
pointer, and that callers need to check it for error values, instead of
checking for a NULL return value.

Triggered by having to dig through code to answer a user's question on
the #xcb irc channel, since neither of us found it covered in the docs.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Uli Schlachter <psychon@znc.in>
src/xcb.h