[glib/glib-2-28] GDBusServer: Documentation: Improvements.



commit 38220cd31d7732c52923ec1fa864b2e5d2855ccf
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Apr 4 10:01:51 2011 +0200

    GDBusServer: Documentation: Improvements.
    
    Provide a fuller description and lead people away if they arrived
    here just looking for a way to provide a regular D-Bus service.

 gio/gdbusserver.c |    8 +++++++-
 1 files changed, 7 insertions(+), 1 deletions(-)
---
diff --git a/gio/gdbusserver.c b/gio/gdbusserver.c
index 7f79c68..b0c5773 100644
--- a/gio/gdbusserver.c
+++ b/gio/gdbusserver.c
@@ -63,7 +63,13 @@
  * @include: gio/gio.h
  *
  * #GDBusServer is a helper for listening to and accepting D-Bus
- * connections.
+ * connections. This can be used to create a new D-Bus server, allowing two
+ * peers to use the D-Bus protocol for their own specialized communication.
+ * A server instance provided in this way will not perform message routing or
+ * implement the org.freedesktop.DBus interface.
+ *
+ * To just export an object on a well-known name on a message bus, such as the
+ * session or system bus, you should instead use g_bus_own_name().
  *
  * <example id="gdbus-peer-to-peer"><title>D-Bus peer-to-peer example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; parse="text" href="../../../../gio/tests/gdbus-example-peer.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
  */



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]