summaryrefslogtreecommitdiff
path: root/farstream
diff options
context:
space:
mode:
authorOlivier CrĂȘte <olivier.crete@collabora.com>2014-05-02 16:01:20 -0400
committerOlivier CrĂȘte <olivier.crete@collabora.com>2014-05-02 16:01:20 -0400
commit4bf22a838a8641c997ef50e38b1d0b784a63e444 (patch)
tree5082176bca6f24a3f3dfe10e026958caceff73c0 /farstream
parent70267acdd6cde281d9be936701d4e3d1c92cd885 (diff)
downloadfarstream-4bf22a838a8641c997ef50e38b1d0b784a63e444.tar.gz
Fix documentation
Diffstat (limited to 'farstream')
-rw-r--r--farstream/fs-candidate.c2
-rw-r--r--farstream/fs-codec.c33
-rw-r--r--farstream/fs-stream.c2
3 files changed, 34 insertions, 3 deletions
diff --git a/farstream/fs-candidate.c b/farstream/fs-candidate.c
index d50bcfce..165704ed 100644
--- a/farstream/fs-candidate.c
+++ b/farstream/fs-candidate.c
@@ -215,7 +215,7 @@ fs_candidate_new (
* @proto: The protocol this component is for
* @priority: Value between 0 and (2^31 - 1) representing the priority
* @type: The type of candidate
- * @username (allow-none):: Username to use to connect to client if necessary,
+ * @username: (allow-none): Username to use to connect to client if necessary,
* NULL otherwise
* @password: (allow-none): Username to use to connect to client if necessary,
* NULL otherwise
diff --git a/farstream/fs-codec.c b/farstream/fs-codec.c
index 43704ce0..e97b515b 100644
--- a/farstream/fs-codec.c
+++ b/farstream/fs-codec.c
@@ -114,6 +114,13 @@ fs_codec_new (int id, const char *encoding_name,
return codec;
}
+/**
+ * fs_codec_parameter_free:
+ * @param: a #FsCodecParameter to free
+ *
+ * Frees a #FsCodecParameter
+ *
+ */
void
fs_codec_parameter_free (FsCodecParameter *param)
@@ -123,7 +130,13 @@ fs_codec_parameter_free (FsCodecParameter *param)
g_slice_free (FsCodecParameter, param);
}
-
+/**
+ * fs_feedback_parameter_free:
+ * @param: a #FsFeedbackParameter to free
+ *
+ * Frees a #FsFeedbackParameter
+ *
+ */
void
fs_feedback_parameter_free (FsFeedbackParameter *param)
{
@@ -865,6 +878,15 @@ fs_codec_remove_feedback_parameter (FsCodec *codec, GList *item)
g_list_delete_link (codec->feedback_params, item);
}
+/**
+ * fs_codec_parameter_copy:
+ * @param: a #FsCodecParameter
+ *
+ * Makes a copy of a #FsCodecParameter
+ *
+ * Returns: a newly allocated #FsCodecParameter
+ */
+
FsCodecParameter *
fs_codec_parameter_copy (const FsCodecParameter *param)
{
@@ -877,6 +899,15 @@ fs_codec_parameter_copy (const FsCodecParameter *param)
}
+/**
+ * fs_feedback_parameter_copy:
+ * @param: a #FsFeedbackParameter
+ *
+ * Makes a copy of a #FsFeedbackParameter
+ *
+ * Returns: a newly allocated #FsFeedbackParameter
+ */
+
FsFeedbackParameter *
fs_feedback_parameter_copy (const FsFeedbackParameter *param)
{
diff --git a/farstream/fs-stream.c b/farstream/fs-stream.c
index c81e8788..de7126aa 100644
--- a/farstream/fs-stream.c
+++ b/farstream/fs-stream.c
@@ -652,7 +652,7 @@ fs_stream_set_transmitter (FsStream *stream,
* @stream: a #FsStream
* @transmitter: Name of the type of transmitter to use for this stream
* @stream_transmitter_parameters: (element-type utf8 GValue) (allow-none):
- * A #GHashTable of <String->GValue) containing the parameters.
+ * A #GHashTable of string->GValue containing the parameters.
* @error: location of a #GError, or %NULL if no error occured
*
* Set the transmitter to use for this stream. This function will only succeed