Commit 9924fc3a authored by Marc-André Lureau's avatar Marc-André Lureau
Browse files

zm: update dbus_proxy macro documentation


Signed-off-by: default avatarMarc-André Lureau <marcandre.lureau@redhat.com>
parent 660b7bb4
......@@ -16,9 +16,9 @@ mod utils;
///
/// The macro must be applied on a `trait T`. Two matching `impl T` will provide a synchronous Proxy
/// implementation, named `TraitNameProxy` and an asynchronous one, named `AsyncTraitNameProxy`. The
/// proxy instances can be created with the associated `new()` or `new_for()` methods. The former
/// proxy instances can be created with the associated `new()` or `builder()` methods. The former
/// doesn't take any argument and uses the default service name and path. The later allows you to
/// specify both.
/// specify non-default proxy arguments.
///
/// Each trait method will be expanded to call to the associated D-Bus remote interface.
///
......@@ -38,8 +38,6 @@ mod utils;
///
/// NB: Any doc comments provided shall be appended to the ones added by the macro.
///
/// (the expanded `impl` also provides an `introspect()` method, for convenience)
///
/// # Example
///
/// ```
......@@ -80,7 +78,10 @@ mod utils;
/// trait SomeOtherIface {}
///
/// let connection = Connection::new_session()?;
/// let proxy = SomeIfaceProxy::new(&connection);
/// // Use `builder` to override the default arguments, `new` otherwise.
/// let proxy = SomeIfaceProxy::builder(&connection)
/// .destination("org.another.Service")
/// .build();
/// let _ = proxy.do_this("foo", 32, &Value::new(true));
/// let _ = proxy.set_a_property("val");
///
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment