[farsight2/master] Document undocumented symbols
Olivier Crête
olivier.crete at collabora.co.uk
Sat Jul 25 15:38:48 PDT 2009
---
gst-libs/gst/farsight/fs-session.h | 1 +
gst-libs/gst/farsight/fs-stream.h | 1 +
gst/fsrtpconference/fs-rtp-codec-cache.c | 2 +-
gst/fsrtpconference/fs-rtp-discover-codecs.c | 2 +-
.../multicast/fs-multicast-stream-transmitter.h | 1 +
transmitters/multicast/fs-multicast-transmitter.h | 1 +
transmitters/nice/fs-nice-stream-transmitter.h | 1 +
transmitters/nice/fs-nice-transmitter.h | 1 +
transmitters/rawudp/fs-rawudp-stream-transmitter.h | 1 +
9 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/gst-libs/gst/farsight/fs-session.h b/gst-libs/gst/farsight/fs-session.h
index d994fa8..07a3955 100644
--- a/gst-libs/gst/farsight/fs-session.h
+++ b/gst-libs/gst/farsight/fs-session.h
@@ -108,6 +108,7 @@ typedef enum
* @set_send_codec: Forces sending with a specific codec
* @set_codec_preferences: Specifies the codec preferences
* @list_transmitters: Returns a list of the available transmitters
+ * @get_stream_transmitter_type: Returns the GType of the stream transmitter
*
* You must override at least new_stream in a subclass.
*/
diff --git a/gst-libs/gst/farsight/fs-stream.h b/gst-libs/gst/farsight/fs-stream.h
index 1e32e15..5691cc5 100644
--- a/gst-libs/gst/farsight/fs-stream.h
+++ b/gst-libs/gst/farsight/fs-stream.h
@@ -102,6 +102,7 @@ typedef struct _FsStreamPrivate FsStreamPrivate;
* @set_remote_candidates: Set sthe remote candidates
* @force_remote_candidates: Forces certain remote candidates
* @set_remote_codecs: Sets the list of remote codecs
+ * @add_id: Add a known id to be associated with this stream
*
* You must override add_remote_candidate in a subclass.
* If you have to negotiate codecs, then you must override set_remote_codecs too
diff --git a/gst/fsrtpconference/fs-rtp-codec-cache.c b/gst/fsrtpconference/fs-rtp-codec-cache.c
index 9cec6d2..3382525 100644
--- a/gst/fsrtpconference/fs-rtp-codec-cache.c
+++ b/gst/fsrtpconference/fs-rtp-codec-cache.c
@@ -256,7 +256,7 @@ load_codec_blueprint (FsMediaType media_type, gchar **in, gsize *size) {
*
* Will load the codecs blueprints from the cache.
*
- * Returns : TRUE if successful, FALSE if error, or cache outdated
+ * Returns: TRUE if successful, FALSE if error, or cache outdated
*
*/
GList *
diff --git a/gst/fsrtpconference/fs-rtp-discover-codecs.c b/gst/fsrtpconference/fs-rtp-discover-codecs.c
index c872931..86e2ada 100644
--- a/gst/fsrtpconference/fs-rtp-discover-codecs.c
+++ b/gst/fsrtpconference/fs-rtp-discover-codecs.c
@@ -204,7 +204,7 @@ codec_cap_list_free (GList *list)
* network -> rtp depayloader -> N* -> output (soundcard)
* media_type defines if we want audio or video codecs
*
- * Returns : a #GList of #CodecBlueprint or NULL on error
+ * Returns: a #GList of #CodecBlueprint or NULL on error
*/
GList *
fs_rtp_blueprints_get (FsMediaType media_type, GError **error)
diff --git a/transmitters/multicast/fs-multicast-stream-transmitter.h b/transmitters/multicast/fs-multicast-stream-transmitter.h
index e391ac7..094999c 100644
--- a/transmitters/multicast/fs-multicast-stream-transmitter.h
+++ b/transmitters/multicast/fs-multicast-stream-transmitter.h
@@ -73,6 +73,7 @@ struct _FsMulticastStreamTransmitterClass
/**
* FsMulticastStreamTransmitter:
+ * @parent: Parent object
*
* All members are private, access them using methods and properties
*/
diff --git a/transmitters/multicast/fs-multicast-transmitter.h b/transmitters/multicast/fs-multicast-transmitter.h
index 609a455..37c0b6b 100644
--- a/transmitters/multicast/fs-multicast-transmitter.h
+++ b/transmitters/multicast/fs-multicast-transmitter.h
@@ -67,6 +67,7 @@ struct _FsMulticastTransmitterClass
/**
* FsMulticastTransmitter:
+ * @parent: Parent object
*
* All members are private, access them using methods and properties
*/
diff --git a/transmitters/nice/fs-nice-stream-transmitter.h b/transmitters/nice/fs-nice-stream-transmitter.h
index 1cc8ff8..8a65b54 100644
--- a/transmitters/nice/fs-nice-stream-transmitter.h
+++ b/transmitters/nice/fs-nice-stream-transmitter.h
@@ -73,6 +73,7 @@ struct _FsNiceStreamTransmitterClass
/**
* FsNiceStreamTransmitter:
+ * @parent: Parent object
*
* All members are private, access them using methods and properties
*/
diff --git a/transmitters/nice/fs-nice-transmitter.h b/transmitters/nice/fs-nice-transmitter.h
index 4a46391..86fdb34 100644
--- a/transmitters/nice/fs-nice-transmitter.h
+++ b/transmitters/nice/fs-nice-transmitter.h
@@ -68,6 +68,7 @@ struct _FsNiceTransmitterClass
/**
* FsNiceTransmitter:
+ * @parent: Parent object
*
* All members are private, access them using methods and properties
*/
diff --git a/transmitters/rawudp/fs-rawudp-stream-transmitter.h b/transmitters/rawudp/fs-rawudp-stream-transmitter.h
index 8482cba..0fbfe4c 100644
--- a/transmitters/rawudp/fs-rawudp-stream-transmitter.h
+++ b/transmitters/rawudp/fs-rawudp-stream-transmitter.h
@@ -74,6 +74,7 @@ struct _FsRawUdpStreamTransmitterClass
/**
* FsRawUdpStreamTransmitter:
+ * @parent: Parent object
*
* All members are private, access them using methods and properties
*/
--
1.5.6.5
More information about the farsight-commits
mailing list