pidgin.vv: 9ed2c540: Add documentation for a few media functi...

[maiku at soc.pidgin.im]

-----------------------------------------------------------------
Revision: 9ed2c540f1244c1cc0881a165c76d2886f073fab
Ancestor: 1f56f20787fc3fe82c8632b0ba45efbee555a3c2
Author: maiku at soc.pidgin.im
Date: 2009-03-21T07:53:22
Branch: im.pidgin.pidgin.vv
URL: http://d.pidgin.im/viewmtn/revision/info/9ed2c540f1244c1cc0881a165c76d2886f073fab

Modified files:
        libpurple/media.h

ChangeLog: 

Add documentation for a few media functions.

-------------- next part --------------
============================================================
--- libpurple/media.h	10430027eca249ad42f084eaddf8cd60f6d92821
+++ libpurple/media.h	de47b4760e9be5b51da9765078828d2ff66d1c63
@@ -677,12 +677,36 @@ void purple_media_set_output_volume(Purp
 void purple_media_set_output_volume(PurpleMedia *media, const gchar *session_id,
 		const gchar *participant, double level);
 
+/**
+ * Sets a video output window for the given session/stream.
+ *
+ * @param media The media instance to set the output window on.
+ * @param session_id The session to set the output window on.
+ * @param participant Optionally, the participant to set the output window on.
+ * @param window_id The window id use for embedding the video in.
+ *
+ * @return An id to reference the output window.
+ */
 gulong purple_media_set_output_window(PurpleMedia *media,
 		const gchar *session_id, const gchar *participant,
 		gulong window_id);
 
+/**
+ * Removes all output windows from a given media session.
+ *
+ * @param media The instance to remove all output windows from.
+ */
 void purple_media_remove_output_windows(PurpleMedia *media);
 
+/**
+ * Gets the tee from a given session/stream.
+ *
+ * @param media The instance to get the tee from.
+ * @param session_id The id of the session to get the tee from.
+ * @param participant Optionally, the participant of the stream to get the tee from.
+ *
+ * @return The GstTee element from the chosen session/stream.
+ */
 GstElement *purple_media_get_tee(PurpleMedia *media,
 		const gchar *session_id, const gchar *participant);