summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier CrĂȘte <olivier.crete@collabora.com>2011-06-24 17:38:01 -0400
committerOlivier CrĂȘte <olivier.crete@collabora.com>2011-06-24 17:39:22 -0400
commitea21f6ab0511786a99418967516df732ae6134e9 (patch)
treec26c4418ea275ef0785689b354b5ab8f06530253
parent4b4ca908468975f1c6ff7a47b56b0cd64d443f01 (diff)
Fixup docs
-rw-r--r--doc/lib/telepathy-farstream-sections.txt7
-rw-r--r--telepathy-farstream/content.c8
-rw-r--r--telepathy-farstream/content.h4
-rw-r--r--telepathy-farstream/utils.h8
4 files changed, 19 insertions, 8 deletions
diff --git a/doc/lib/telepathy-farstream-sections.txt b/doc/lib/telepathy-farstream-sections.txt
index bec8dda..4a1382d 100644
--- a/doc/lib/telepathy-farstream-sections.txt
+++ b/doc/lib/telepathy-farstream-sections.txt
@@ -1,6 +1,7 @@
<SECTION>
-<TITLE>Initializers</TITLE>
+<TITLE>Core</TITLE>
tf_init
+tp_media_type_to_fs
</SECTION>
<SECTION>
@@ -8,8 +9,9 @@ tf_init
<TITLE>TfContent</TITLE>
TfContent
TfContentClass
-tf_content_error
tf_content_iterate_src_pads
+tf_content_error
+tf_content_error_literal
<SUBSECTION Private>
TfContentPrivate
<SUBSECTION Standard>
@@ -27,7 +29,6 @@ TF_IS_CONTENT_CLASS
<TITLE>TfChannel</TITLE>
TfChannel
tf_channel_new_async
-tf_channel_error
tf_channel_bus_message
<SUBSECTION Private>
TfChannelPrivate
diff --git a/telepathy-farstream/content.c b/telepathy-farstream/content.c
index cfcde54..e32a4c8 100644
--- a/telepathy-farstream/content.c
+++ b/telepathy-farstream/content.c
@@ -284,7 +284,7 @@ _tf_content_emit_src_pad_added (TfContent *self, guint handle,
}
/**
- * tf_content_error:
+ * tf_content_error_literal:
* @content: a #TfContent
* @reason: the reason (a #TfContentRemovalReason)
* @detailed_reason: The detailled error (as a DBus name)
@@ -313,7 +313,8 @@ tf_content_error_literal (TfContent *content,
* @content: a #TfContent
* @reason: the reason (a #TfContentRemovalReason)
* @detailed_reason: The detailled error (as a DBus name)
- * @message: error Message
+ * @message_format: error Message with printf style formatting
+ * @...: Parameters to insert into the @message_format string
*
* Send an error to the Content to the CM, the effect is most likely that the
* content will be removed.
@@ -323,7 +324,8 @@ void
tf_content_error (TfContent *content,
guint reason, /* TfFutureContentRemovalReason */
const gchar *detailed_reason,
- const gchar *message_format, ...)
+ const gchar *message_format,
+ ...)
{
gchar *message;
va_list valist;
diff --git a/telepathy-farstream/content.h b/telepathy-farstream/content.h
index e6b6d3b..d5bf409 100644
--- a/telepathy-farstream/content.h
+++ b/telepathy-farstream/content.h
@@ -54,10 +54,10 @@ void tf_content_error_literal (TfContent *content,
void tf_content_error (TfContent *content,
guint reason, /* TfFutureContentRemovalReason */
const gchar *detailed_reason,
- const gchar *message, ...) G_GNUC_PRINTF (4, 5);
+ const gchar *message_format, ...) G_GNUC_PRINTF (4, 5);
GstIterator *tf_content_iterate_src_pads (TfContent *content,
- guint *handle, guint handle_count);
+ guint *handles, guint handle_count);
G_END_DECLS
diff --git a/telepathy-farstream/utils.h b/telepathy-farstream/utils.h
index 94b8b8a..a3a922d 100644
--- a/telepathy-farstream/utils.h
+++ b/telepathy-farstream/utils.h
@@ -1,6 +1,14 @@
#ifndef __UTILS_H__
#define __UTILS_H__
+/**
+ * tp_media_type_to_fs:
+ * @type: A Telepathy Media Stream Type
+ *
+ * Converts a Telepathy Media Stream Type to the Farsight2 equivalent
+ *
+ * Return: A Farsight2 Stream Type
+ */
static inline FsMediaType
tp_media_type_to_fs (TpMediaStreamType type)