X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gio%2Fgdbusproxy.c;h=33492b718ca2f3145eeb3bc3dd86d83e40b9bc7c;hb=fd643b87ab7bc232274c5cd6f9c175d5f6f9ecb9;hp=878561f7ddc9a4c9072c974c075c5a052de0f8d9;hpb=cb588d45320c5a6b767d299ebd85306d45e1773c;p=platform%2Fupstream%2Fglib.git
diff --git a/gio/gdbusproxy.c b/gio/gdbusproxy.c
index 878561f..33492b7 100644
--- a/gio/gdbusproxy.c
+++ b/gio/gdbusproxy.c
@@ -72,20 +72,20 @@
* %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is set).
*
* The generic #GDBusProxy::g-properties-changed and
- * #GDBusProxy::g-signal signals are not very convenient to work
- * with. Therefore, the recommended way of working with proxies is to
- * subclass #GDBusProxy, and have more natural properties and signals
- * in your derived class. See
- * for how this can easily be done using the
- * gdbus-codegen tool.
+ * #GDBusProxy::g-signal signals are not very convenient to work with.
+ * Therefore, the recommended way of working with proxies is to subclass
+ * #GDBusProxy, and have more natural properties and signals in your derived
+ * class. This [example][gdbus-example-gdbus-codegen] shows how this can
+ * easily be done using the [gdbus-codegen][gdbus-codegen] tool.
*
* A #GDBusProxy instance can be used from multiple threads but note
* that all signals (e.g. #GDBusProxy::g-signal, #GDBusProxy::g-properties-changed
* and #GObject::notify) are emitted in the
- * thread-default main loop
+ * [thread-default main context][g-main-context-push-thread-default]
* of the thread where the instance was constructed.
*
- * GDBusProxy for a well-known-nameFIXME: MISSING XINCLUDE CONTENT
+ * An example using a proxy for a well-known name can be found in
+ * [gdbus-example-watch-proxy.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-watch-proxy.c)
*/
/* lock protecting the mutable properties: name_owner, timeout_msec,
@@ -370,8 +370,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* - Received signals that have a type signature mismatch are dropped and
* a warning is logged via g_warning().
*
- * - Properties received via the initial GetAll() call
- * or via the ::PropertiesChanged signal (on the
+ * - Properties received via the initial `GetAll()` call or via the
+ * `::PropertiesChanged` signal (on the
* [org.freedesktop.DBus.Properties](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties)
* interface) or set using g_dbus_proxy_set_cached_property()
* with a type signature mismatch are ignored and a warning is
@@ -585,8 +585,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* @invalidated_properties will always be empty.
*
* This signal corresponds to the
- * PropertiesChanged D-Bus signal on the
- * org.freedesktop.DBus.Properties interface.
+ * `PropertiesChanged` D-Bus signal on the
+ * `org.freedesktop.DBus.Properties` interface.
*
* Since: 2.26
*/
@@ -794,20 +794,19 @@ g_dbus_proxy_get_cached_property (GDBusProxy *proxy,
* 42));
* ]|
*
- * Normally you will not need to use this method since @proxy is
- * tracking changes using the
- * org.freedesktop.DBus.Properties.PropertiesChanged
- * D-Bus signal. However, for performance reasons an object may decide
- * to not use this signal for some properties and instead use a
- * proprietary out-of-band mechanism to transmit changes.
+ * Normally you will not need to use this method since @proxy
+ * is tracking changes using the
+ * `org.freedesktop.DBus.Properties.PropertiesChanged`
+ * D-Bus signal. However, for performance reasons an object may
+ * decide to not use this signal for some properties and instead
+ * use a proprietary out-of-band mechanism to transmit changes.
*
* As a concrete example, consider an object with a property
- * ChatroomParticipants which is an array of
- * strings. Instead of transmitting the same (long) array every time
- * the property changes, it is more efficient to only transmit the
- * delta using e.g. signals ChatroomParticipantJoined(String
- * name) and ChatroomParticipantParted(String
- * name).
+ * `ChatroomParticipants` which is an array of strings. Instead of
+ * transmitting the same (long) array every time the property changes,
+ * it is more efficient to only transmit the delta using e.g. signals
+ * `ChatroomParticipantJoined(String name)` and
+ * `ChatroomParticipantParted(String name)`.
*
* Since: 2.26
*/
@@ -2043,7 +2042,7 @@ initable_iface_init (GInitableIface *initable_iface)
*
* See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
*
- * See for an example of how #GDBusProxy can be used.
+ * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* Since: 2.26
*/
@@ -2137,7 +2136,7 @@ g_dbus_proxy_new_finish (GAsyncResult *res,
* This is a synchronous failable constructor. See g_dbus_proxy_new()
* and g_dbus_proxy_new_finish() for the asynchronous version.
*
- * See for an example of how #GDBusProxy can be used.
+ * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
*
@@ -2193,7 +2192,7 @@ g_dbus_proxy_new_sync (GDBusConnection *connection,
*
* Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection.
*
- * See for an example of how #GDBusProxy can be used.
+ * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* Since: 2.26
*/
@@ -2258,7 +2257,7 @@ g_dbus_proxy_new_for_bus_finish (GAsyncResult *res,
*
* Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.
*
- * See for an example of how #GDBusProxy can be used.
+ * #GDBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
*
@@ -2985,7 +2984,7 @@ g_dbus_proxy_call_sync_internal (GDBusProxy *proxy,
*
* This is an asynchronous method. When the operation is finished,
* @callback will be invoked in the
- * thread-default main loop
+ * [thread-default main context][g-main-context-push-thread-default]
* of the thread you are calling this method from.
* You can then call g_dbus_proxy_call_finish() to get the result of
* the operation. See g_dbus_proxy_call_sync() for the synchronous