* dbus/bus.c (dbus_bus_release_name): Add documentation

diff --git a/ChangeLog b/ChangeLog
index 59a3f82..34c2d4d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2005-12-19  John (J5) Palmieri  <johnp@redhat.com>
+
+       * dbus/bus.c (dbus_bus_release_name): Add documentation
+
 2005-12-06  Robert McQueen  <robot101@debian.org>
 
        * python/service.py: s/sucessful/successful/ so we're allocating to

diff --git a/dbus/dbus-bus.c b/dbus/dbus-bus.c
index 7578efb..8ba7d94 100644 (file)
--- a/dbus/dbus-bus.c
+++ b/dbus/dbus-bus.c
@@ -778,6 +778,17 @@ dbus_bus_request_name (DBusConnection *connection,
   return result;
 }
 
+
+/**
+ * Asks the bus to unassign the given name to this connection by invoking
+ * the ReleaseName method on the bus. This method is fully documented
+ * in the D-BUS specification.
+ *
+ * @param connection the connection
+ * @param name the name to remove 
+ * @param error location to store the error
+ * @returns a result code, -1 if error is set
+ */ 
 int
 dbus_bus_release_name (DBusConnection *connection,
                        const char     *name,