Bug 47767 - tp_call_content_media_description_append_codec() should be properly documented
Summary: tp_call_content_media_description_append_codec() should be properly documented
Status: RESOLVED MOVED
Alias: None
Product: Telepathy
Classification: Unclassified
Component: tp-glib (show other bugs)
Version: unspecified
Hardware: Other All
: medium normal
Assignee: Telepathy bugs list
QA Contact: Telepathy bugs list
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-03-23 05:54 UTC by Guillaume Desmottes
Modified: 2019-12-03 20:39 UTC (History)
1 user (show)

See Also:
i915 platform:
i915 features:


Attachments
CallContentMediaDescription: Add missing documentation (2.26 KB, patch)
2012-03-23 15:52 UTC, Olivier Crête
Details | Splinter Review
CallContentMediaDescription: Add missing documentation (updated) (2.40 KB, patch)
2012-03-27 09:08 UTC, Olivier Crête
Details | Splinter Review

Description Guillaume Desmottes 2012-03-23 05:54:41 UTC
Documentation of tp_call_content_media_description_append_codec() is pretty lame, all its arguments have "if you use this API, you know what it is about" as doc. We should re-use the doc from the spec at the very least.

This is true for tp_call_content_media_description_add_ssrc() as well.
Comment 1 Olivier Crête 2012-03-23 15:52:52 UTC
Created attachment 58951 [details] [review]
CallContentMediaDescription: Add missing documentation
Comment 2 Guillaume Desmottes 2012-03-26 00:31:51 UTC
Comment on attachment 58951 [details] [review]
CallContentMediaDescription: Add missing documentation

Review of attachment 58951 [details] [review]:
-----------------------------------------------------------------

::: telepathy-glib/call-content-media-description.c
@@ +729,2 @@
>   *
> + * Add an SSRC to the list of SSRCs that a contact will send from

Trailing '.' missing. A small explanation of what a SSRC is and how it would be used may be useful for newbies like me.

@@ +768,5 @@
> + * @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

This arg should be annotated to make gi happy.
Comment 3 Olivier Crête 2012-03-27 09:08:12 UTC
Created attachment 59114 [details] [review]
CallContentMediaDescription: Add missing documentation (updated)

I've added a . and a little explanation of what a SSRC is.

I haven't added any GI as this is CM-side.
Comment 4 Guillaume Desmottes 2012-03-28 01:44:17 UTC
Comment on attachment 59114 [details] [review]
CallContentMediaDescription: Add missing documentation (updated)

Review of attachment 59114 [details] [review]:
-----------------------------------------------------------------

++
Comment 5 GitLab Migration User 2019-12-03 20:39:38 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/telepathy/telepathy-glib/issues/85.


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.