[farsight2/master] Improve fsrtpconference documentation

[Olivier Crête]

---
 gst/fsrtpconference/fs-rtp-conference.h  |    2 ++
 gst/fsrtpconference/fs-rtp-participant.c |    2 +-
 gst/fsrtpconference/fs-rtp-session.c     |    5 ++++-
 gst/fsrtpconference/fs-rtp-session.h     |    5 +++--
 gst/fsrtpconference/fs-rtp-stream.c      |   18 +++++++++++++++---
 gst/fsrtpconference/fs-rtp-stream.h      |    2 ++
 6 files changed, 27 insertions(+), 7 deletions(-)

diff --git a/gst/fsrtpconference/fs-rtp-conference.h b/gst/fsrtpconference/fs-rtp-conference.h
index 79288de..b39b958 100644
--- a/gst/fsrtpconference/fs-rtp-conference.h
+++ b/gst/fsrtpconference/fs-rtp-conference.h
@@ -53,6 +53,8 @@ typedef struct _FsRtpConferencePrivate FsRtpConferencePrivate;
 struct _FsRtpConference
 {
   FsBaseConference parent;
+
+  /*< private >*/
   FsRtpConferencePrivate *priv;
 
   /* Do not modify the pointer */
diff --git a/gst/fsrtpconference/fs-rtp-participant.c b/gst/fsrtpconference/fs-rtp-participant.c
index b94eede..c6bde15 100644
--- a/gst/fsrtpconference/fs-rtp-participant.c
+++ b/gst/fsrtpconference/fs-rtp-participant.c
@@ -26,7 +26,7 @@
  * SECTION:fs-rtp-participant
  * @short_description: A RTP participant in a #FsRtpConference
  *
- * This object represents one participant or person in a conference
+ * This object represents one participant or person in a RTP conference
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/gst/fsrtpconference/fs-rtp-session.c b/gst/fsrtpconference/fs-rtp-session.c
index 466e2b4..83de722 100644
--- a/gst/fsrtpconference/fs-rtp-session.c
+++ b/gst/fsrtpconference/fs-rtp-session.c
@@ -26,7 +26,10 @@
  * SECTION:fs-rtp-session
  * @short_description: A  RTP session in a #FsRtpConference
  *
- *
+ * This object represents one session, it is created by called
+ * fs_conference_new_session() on a #FsRtpConference. It can be either
+ * Audio or Video. It also represents data send with one and only one
+ * SSRC (although if there is a SSRC collision, that SSRC may change).
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/gst/fsrtpconference/fs-rtp-session.h b/gst/fsrtpconference/fs-rtp-session.h
index 1142800..c919be7 100644
--- a/gst/fsrtpconference/fs-rtp-session.h
+++ b/gst/fsrtpconference/fs-rtp-session.h
@@ -65,10 +65,11 @@ struct _FsRtpSession
 {
   FsSession parent;
 
-  guint id;
-
   /*< private >*/
 
+  /* This ID can be accessed by the stream/substreams for this session */
+  guint id;
+
   GStaticRecMutex mutex; /* Should only be accessed using the macros */
 
   FsRtpSessionPrivate *priv;
diff --git a/gst/fsrtpconference/fs-rtp-stream.c b/gst/fsrtpconference/fs-rtp-stream.c
index 93cfa2c..f7b32dd 100644
--- a/gst/fsrtpconference/fs-rtp-stream.c
+++ b/gst/fsrtpconference/fs-rtp-stream.c
@@ -26,7 +26,9 @@
  * SECTION:fs-rtp-stream
  * @short_description: A RTP stream in a #FsRtpSession in a #FsRtpConference
  *
-
+ * This is the conjunction of a #FsRtpParticipant and a #FsRtpSession,
+ * it is created by calling fs_session_new_stream() on a
+ * #FsRtpSession.
  */
 
 #ifdef HAVE_CONFIG_H
@@ -193,7 +195,7 @@ fs_rtp_stream_class_init (FsRtpStreamClass *klass)
                                     PROP_STREAM_TRANSMITTER,
                                    "stream-transmitter");
 
-   /**
+  /*
    * FsRtpStream::new-remote-codecs
    * @self: #FsRtpStream that emitted the signal
    * @codecs: #GList of new remote #FsCodec
@@ -203,6 +205,11 @@ fs_rtp_stream_class_init (FsRtpStreamClass *klass)
    *
    * Returns: %NULL on success, or a #GError if an error occured
    */
+  /**
+   * FsRtpStream::new-remote-codecs:
+   *
+   * ENTIRELY INTERNAL
+   */
   signals[NEW_REMOTE_CODECS] = g_signal_new ("new-remote-codecs",
       G_TYPE_FROM_CLASS (klass),
       G_SIGNAL_RUN_LAST,
@@ -212,7 +219,7 @@ fs_rtp_stream_class_init (FsRtpStreamClass *klass)
       _fs_rtp_marshal_POINTER__BOXED,
       G_TYPE_POINTER, 1, FS_TYPE_CODEC_LIST);
 
- /**
+  /*
    * FsRtpStream::known-source-packet-received:
    * @self: #FsRtpStream that emitted the signal
    * @component: The Component on which this buffer was received
@@ -222,6 +229,11 @@ fs_rtp_stream_class_init (FsRtpStreamClass *klass)
    * is received. It is a proxy of the
    * #FsStreamTransmitter::known-source-packet-received signal.
    */
+  /**
+   * FsRtpStream::known-source-packet-received:
+   *
+   * ENTIRELY INTERNAL
+   */
   signals[KNOWN_SOURCE_PACKET_RECEIVED] = g_signal_new
     ("known-source-packet-received",
       G_TYPE_FROM_CLASS (klass),
diff --git a/gst/fsrtpconference/fs-rtp-stream.h b/gst/fsrtpconference/fs-rtp-stream.h
index 4821709..f0a6f41 100644
--- a/gst/fsrtpconference/fs-rtp-stream.h
+++ b/gst/fsrtpconference/fs-rtp-stream.h
@@ -69,6 +69,8 @@ struct _FsRtpStream
 {
   FsStream parent;
 
+  /*< private >*/
+
   /* Can only be accessed while holding the FsRtpSession lock */
   /* Dont modify, call set_remote_codecs() */
   GList *remote_codecs;
-- 
1.5.6.5