[farsight2/master] Add some documentation

Olivier Crête olivier.crete at collabora.co.uk
Tue Dec 23 15:19:11 PST 2008


---
 gst-libs/gst/farsight/fs-codec.h            |    3 +++
 gst-libs/gst/farsight/fs-conference-iface.c |    1 +
 2 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/gst-libs/gst/farsight/fs-codec.h b/gst-libs/gst/farsight/fs-codec.h
index 83bf3ab..17b4162 100644
--- a/gst-libs/gst/farsight/fs-codec.h
+++ b/gst-libs/gst/farsight/fs-codec.h
@@ -50,6 +50,7 @@ typedef struct _FsCodecPreference FsCodecPreference;
  * @FS_MEDIA_TYPE_AUDIO: A media type that encodes audio.
  * @FS_MEDIA_TYPE_VIDEO: A media type that encodes video.
  * @FS_MEDIA_TYPE_APPLICATION: A media type that ???
+ * @FS_MEDIA_TYPE_LAST: Largest valid #FsMediaType
  *
  * Enum used to signify the media type of a codec or stream.
  */
@@ -69,6 +70,8 @@ typedef enum
  * @clock_rate: clock rate of this stream
  * @channels: Number of channels codec should decode
  * @optional_params:  key pairs of param name to param data
+ *
+ * This structure reprensents one codec that can be offered or received
  */
 struct _FsCodec
 {
diff --git a/gst-libs/gst/farsight/fs-conference-iface.c b/gst-libs/gst/farsight/fs-conference-iface.c
index c3094b5..62d0ef7 100644
--- a/gst-libs/gst/farsight/fs-conference-iface.c
+++ b/gst-libs/gst/farsight/fs-conference-iface.c
@@ -83,6 +83,7 @@ fs_conference_iface_init (FsConferenceInterface * iface)
  * fs_conference_new_session
  * @conference: #FsConference interface of a #GstElement
  * @media_type: #FsMediaType of the new session
+ * @error: location of a #GError, or NULL if no error occured
  *
  * Create a new Farsight session for the given conference.
  *
-- 
1.5.6.5




More information about the farsight-commits mailing list