[Bug 55024] Provide tp_dbus_tube_channel_dup_parameters_vardict () variant to accessing dbus-tube parameters

[bugzilla-daemon at freedesktop.org]

https://bugs.freedesktop.org/show_bug.cgi?id=55024

--- Comment #3 from Simon McVittie <simon.mcvittie at collabora.co.uk> 2012-09-17 15:56:33 UTC ---
Comment on attachment 67287
  --> https://bugs.freedesktop.org/attachment.cgi?id=67287
TpDBusTube:  obtain parameters as vardict

Review of attachment 67287:
 --> (https://bugs.freedesktop.org/page.cgi?id=splinter.html&bug=55024&attachment=67287)
-----------------------------------------------------------------

This looks great. Want to add the stream-tube equivalent while you're here? :-)

A few minor documentation things, which I'll just fix myself while I'm
committing it:

::: telepathy-glib/dbus-tube-channel.c
@@ +517,5 @@
> + * @self: a #TpDBusTubeChannel
> + *
> + * Return the parameters of the dbus-tube channel in a variant of
> + * type %G_VARIANT_TYPE_VARDICT whose keys are strings representing 
> + * parameter names and values are GValues representing corresponding 

... and values are variants representing ...

@@ +525,5 @@
> + * yet been offered or the parameters property has not been set.
> + *
> + * Use g_variant_lookup() or g_variant_lookup_value() for convenient
> + * access to the values, the expected types of which should match the ones
> + * defined upon the creation of the parameters #GHashTable.

The second clause "the expected types..." looks like copy/paste damage, it's
not really particularly relevant here. I'd replace this sentence with something
like:

    Use g_variant_lookup(), g_variant_lookup_value() or functions like
tp_vardict_get_uint32() for convenient access to the values.

(tp_vardict_get_uint32 is new in master.)

@@ +527,5 @@
> + * Use g_variant_lookup() or g_variant_lookup_value() for convenient
> + * access to the values, the expected types of which should match the ones
> + * defined upon the creation of the parameters #GHashTable.
> + *
> + * Since: 0.20.0

We say "Since: 0.UNRELEASED" in patches, and whoever does the release greps for
UNRELEASED and fixes the reference. Otherwise, if your patch didn't get applied
until 0.21.5 or something, it'd be inaccurate.

-- 
Configure bugmail: https://bugs.freedesktop.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA Contact for the bug.
You are the assignee for the bug.