Attachment 59114 Details for Bug 47767 – CallContentMediaDescription: Add missing documentation (updated)

[patch] CallContentMediaDescription: Add missing documentation (updated)

0001-CallContentMediaDescription-Add-missing-documentatio.patch (text/plain), 2.40 KB, created by Olivier Crête on 2012-03-27 09:08:12 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Olivier Crête

Created: 2012-03-27 09:08:12 UTC

Size: 2.40 KB

patch

obsolete

>From 9519b59d845bf23b11c0ba5fc4212dd777e4dd93 Mon Sep 17 00:00:00 2001
>From: =?UTF-8?q?Olivier=20Cr=C3=AAte?= <olivier.crete@collabora.com>
>Date: Fri, 23 Mar 2012 18:51:02 -0400
>Subject: [PATCH] CallContentMediaDescription: Add missing documentation
>
>https://bugs.freedesktop.org/show_bug.cgi?id=47767
>---
> telepathy-glib/call-content-media-description.c |   21 ++++++++++++---------
> 1 files changed, 12 insertions(+), 9 deletions(-)
>
>diff --git a/telepathy-glib/call-content-media-description.c b/telepathy-glib/call-content-media-description.c
>index 9af8066..153d578 100644
>--- a/telepathy-glib/call-content-media-description.c
>+++ b/telepathy-glib/call-content-media-description.c
>@@ -724,10 +724,12 @@ tp_call_content_media_description_get_remote_contact (
> /**
>  * tp_call_content_media_description_add_ssrc:
>  * @self: a #TpCallContentMediaDescription
>- * @contact: if you use this API, you know what it is about
>- * @ssrc: if you use this API, you know what it is about
>+ * @contact: The #TpHandle of a contact that is part of the call
>+ * @ssrc: A SSRC that this contact may send from
>  *
>- * if you use this API, you know what it is about
>+ * Add an SSRC to the list of SSRCs that a contact will send from. A SSRC
>+ * is a synchronization source in RTP, it is the identifier for a continuous
>+ * stream of packets following the same timeline.
>  *
>  * Since: 0.17.5
>  */
>@@ -763,12 +765,13 @@ tp_call_content_media_description_add_ssrc (TpCallContentMediaDescription *self,
> /**
>  * tp_call_content_media_description_append_codec:
>  * @self: a #TpCallContentMediaDescription
>- * @identifier: if you use this API, you know what it is about
>- * @name: if you use this API, you know what it is about
>- * @clock_rate: if you use this API, you know what it is about
>- * @channels: if you use this API, you know what it is about
>- * @updated: if you use this API, you know what it is about
>- * @parameters: if you use this API, you know what it is about
>+ * @identifier: Numeric identifier for the codec. This will be used as the PT
>+ *    in the SDP or content description.
>+ * @name: The name of the codec.
>+ * @clock_rate: The clock rate of the codec.
>+ * @channels: Number of channels of the codec if applicable, otherwise 0.
>+ * @updated: %TRUE if this codec was updated since the last Media Description
>+ * @parameters: a #GHashTable of string->string containing optional parameters
>  *
>  * Add description for a supported codec.
>  *
>-- 
>1.7.7.6
>

Actions: View | Splinter Review

Attachments on bug 47767: 58951 | 59114

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.