Bug 29666 - dbus_bus_get documentation doesn't describe return value on error
Summary: dbus_bus_get documentation doesn't describe return value on error
Status: RESOLVED FIXED
Alias: None
Product: dbus
Classification: Unclassified
Component: core (show other bugs)
Version: 1.3.x (devel)
Hardware: All All
: medium trivial
Assignee: Ralf Habacker
QA Contact:
URL:
Whiteboard:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2010-08-19 02:01 UTC by John Wimer
Modified: 2014-09-25 14:19 UTC (History)
2 users (show)

See Also:
i915 platform:
i915 features:

Attachments
Documentation fix (756 bytes, patch)
2013-08-12 15:48 UTC, Ralf Habacker 		Details | Splinter Review
Show Obsolete (1) View All

Description John Wimer 2010-08-19 02:01:49 UTC 
The documentation for dbus_bus_get states it returns a DBusConnection pointer.

On error, it returns NULL. The documentation should reflect this.

It can be as simple as changing HEAD dbus/dbus-bus.c:561 from:
* @returns a #DBusConnection with new ref
to
* @returns a #DBusConnection with new ref or #NULL on error
Comment 1 Ralf Habacker 2013-08-12 15:48:16 UTC 
Created attachment 83977 [details] [review]
Documentation fix
Comment 2 Chengwei Yang 2013-08-15 08:37:48 UTC 
Comment on attachment 83977 [details] [review]
Documentation fix

Review of attachment 83977 [details] [review]:
-----------------------------------------------------------------

Looks good.
Comment 3 Ralf Habacker 2013-08-15 08:44:33 UTC 
committed to master

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.