summaryrefslogtreecommitdiff
path: root/gio/gdbusconnection.h
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2014-03-02 18:20:37 -0500
committerMatthias Clasen <mclasen@redhat.com>2014-03-02 18:23:43 -0500
commit49cc207e35ef6b6ce7f4954a4c067ab43145f6bf (patch)
treeb44611e63ea4bcd0cda0f81f3854f51403a0fe2e /gio/gdbusconnection.h
parentad4d81418ecdaf53950de117710be127d53169da (diff)
downloadglib-49cc207e35ef6b6ce7f4954a4c067ab43145f6bf.tar.gz
docs: Ditch more markup
Some markup was hiding in docs in headers. Drop it there, too.
Diffstat (limited to 'gio/gdbusconnection.h')
-rw-r--r--gio/gdbusconnection.h56
1 files changed, 26 insertions, 30 deletions
diff --git a/gio/gdbusconnection.h b/gio/gdbusconnection.h
index 8f200babe..ffded9e96 100644
--- a/gio/gdbusconnection.h
+++ b/gio/gdbusconnection.h
@@ -340,36 +340,32 @@ typedef gboolean (*GDBusInterfaceSetPropertyFunc) (GDBusConnection *conne
*
* Since 2.38, if you want to handle getting/setting D-Bus properties
* asynchronously, give %NULL as your get_property() or set_property()
- * function. The D-Bus call will be directed to your @method_call
- * function, with the provided @interface_name set to
- * <literal>"org.freedesktop.DBus.Properties"</literal>.
- *
- * The usual checks on the validity of the calls is performed. For
- * <literal>'Get'</literal> calls, an error is automatically returned if
- * the property does not exist or the permissions do not allow access.
- * The same checks are performed for <literal>'Set'</literal> calls, and
- * the provided value is also checked for being the correct type.
- *
- * For both <literal>'Get'</literal> and <literal>'Set'</literal> calls,
- * the #GDBusMethodInvocation passed to the method_call handler can be
- * queried with g_dbus_method_invocation_get_property_info() to get a
- * pointer to the #GDBusPropertyInfo of the property.
- *
- * If you have readable properties specified in your interface info, you
- * must ensure that you either provide a non-%NULL @get_property()
- * function or provide implementations of both the
- * <literal>'Get'</literal> and <literal>'GetAll'</literal> methods on
- * the <literal>'org.freedesktop.DBus.Properties'</literal> interface in
- * your @method_call function. Note that the required return type of
- * the <literal>'Get'</literal> call is <literal>(v)</literal>, not the
- * type of the property. <literal>'GetAll'</literal> expects a return
- * value of type <literal>a{sv}</literal>.
- *
- * If you have writable properties specified in your interface info, you
- * must ensure that you either provide a non-%NULL @set_property()
- * function or provide an implementation of the <literal>'Set'</literal>
- * call. If implementing the call, you must return the value of type
- * %G_VARIANT_TYPE_UNIT.
+ * function. The D-Bus call will be directed to your @method_call function,
+ * with the provided @interface_name set to "org.freedesktop.DBus.Properties".
+ *
+ * The usual checks on the validity of the calls is performed. For
+ * `Get` calls, an error is automatically returned if the property does
+ * not exist or the permissions do not allow access. The same checks are
+ * performed for `Set` calls, and the provided value is also checked for
+ * being the correct type.
+ *
+ * For both `Get` and `Set` calls, the #GDBusMethodInvocation
+ * passed to the @method_call handler can be queried with
+ * g_dbus_method_invocation_get_property_info() to get a pointer
+ * to the #GDBusPropertyInfo of the property.
+ *
+ * If you have readable properties specified in your interface info,
+ * you must ensure that you either provide a non-%NULL @get_property()
+ * function or provide implementations of both the `Get` and `GetAll`
+ * methods on org.freedesktop.DBus.Properties interface in your @method_call
+ * function. Note that the required return type of the `Get` call is
+ * `(v)`, not the type of the property. `GetAll` expects a return value
+ * of type `a{sv}`.
+ *
+ * If you have writable properties specified in your interface info,
+ * you must ensure that you either provide a non-%NULL @set_property()
+ * function or provide an implementation of the `Set` call. If implementing
+ * the call, you must return the value of type %G_VARIANT_TYPE_UNIT.
*
* Since: 2.26
*/