[farsight2/master] msn: Add a bit of documentation

[Olivier Crête]

---
 gst/fsmsnconference/fs-msn-conference.c |    7 +++++--
 gst/fsmsnconference/fs-msn-session.c    |   13 +++++++++++++
 gst/fsmsnconference/fs-msn-stream.c     |   13 +++++++++++++
 3 files changed, 31 insertions(+), 2 deletions(-)

diff --git a/gst/fsmsnconference/fs-msn-conference.c b/gst/fsmsnconference/fs-msn-conference.c
index 6204b5d..3a62361 100644
--- a/gst/fsmsnconference/fs-msn-conference.c
+++ b/gst/fsmsnconference/fs-msn-conference.c
@@ -26,11 +26,14 @@
  */
 
 /**
- * SECTION:fs-msn-conference
- * @short_description: FarsightMSN Conference Gstreamer Elements
+ * SECTION:element-fsmsnconference
+ * @short_description: Farsight MSN Conference Gstreamer Elements
  *
+ * This element implements the unidirection webcam feature found in various
+ * version of MSN Messenger (tm) and Windows Live Messenger (tm).
  */
 
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/gst/fsmsnconference/fs-msn-session.c b/gst/fsmsnconference/fs-msn-session.c
index 0ab632b..190fc4c 100644
--- a/gst/fsmsnconference/fs-msn-session.c
+++ b/gst/fsmsnconference/fs-msn-session.c
@@ -27,7 +27,20 @@
  * SECTION:fs-msn-session
  * @short_description: A  MSN session in a #FsMsnConference
  *
+ * There can be only one stream per session.
  *
+ * The direction is chosen when creating the stream using the direction
+ * parameter in the fs_session_new_stream() function.
+ * It can afterwards be modified to pause sending (or receiving) by modifying
+ * the #FsMsnStream::direction property.
+ *
+ * The transmitter parameters to the fs_session_new_stream() function are
+ * used to set the initial value of the construct properties of the stream
+ * object. This plugin does not use transmitter plugins, so the transmitter
+ * parameter itself is ignored.
+ *
+ * The codecs preferences can not be modified and the codec is a fixed value.
+ * It is always "MIMIC".
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/gst/fsmsnconference/fs-msn-stream.c b/gst/fsmsnconference/fs-msn-stream.c
index c959ebc..1581d4b 100644
--- a/gst/fsmsnconference/fs-msn-stream.c
+++ b/gst/fsmsnconference/fs-msn-stream.c
@@ -27,6 +27,19 @@
  * SECTION:fs-msn-stream
  * @short_description: A MSN stream in a #FsMsnSession in a #FsMsnConference
  *
+ * The #FsMsnStream::direction property can be used to pause the stream, but not
+ * to change the direction between sending and receiving since this protocol
+ * is unidirectional.
+ *
+ * The "foundation" field of the local #FsCandidate contains the "recipient-id"
+ * that must be transmitted to the peer.
+ *
+ * The session id can either be retrieved as a property, but it is also
+ * put into every #FsCandidate in the "username" field.
+ *
+ * If the peer started the webcam session, it picks the session-id, it can then
+ * be set either in the transmitter parameters field of fs_session_new_stream()
+ * or by putting it in the "username" field of the remote #FsCandidate.
  */
 
 #ifdef HAVE_CONFIG_H
-- 
1.5.6.5