[farsight2/master] Document the relay-info property completely

[Olivier Crête]

---
 transmitters/nice/fs-nice-stream-transmitter.c |   50 +++++++++++++++++++++++-
 1 files changed, 48 insertions(+), 2 deletions(-)

diff --git a/transmitters/nice/fs-nice-stream-transmitter.c b/transmitters/nice/fs-nice-stream-transmitter.c
index ca6c038..23a2d0b 100644
--- a/transmitters/nice/fs-nice-stream-transmitter.c
+++ b/transmitters/nice/fs-nice-stream-transmitter.c
@@ -278,12 +278,58 @@ fs_nice_stream_transmitter_class_init (FsNiceStreamTransmitterClass *klass)
           NICE_COMPATIBILITY_DRAFT19,
           G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
 
+  /**
+   * FsNiceStreamTransmitter:relay-info:
+   *
+   * This is a #GValueArray containing one or more #GstStructure.
+   *
+   * The fields in the structure are:
+   *  <informaltable>
+   *   <tr><th colspan="2">Required</th></tr>
+   *   <tr>
+   *     <td nowrap="nowrap">(gchar*)</td>
+   *     <td nowrap="nowrap">ip</td>
+   *     <td>The IP address of the TURN server</td>
+   *   </tr>
+   *   <tr>
+   *     <td nowrap="nowrap">(guint)</td>
+   *     <td nowrap="nowrap">port</td>
+   *     <td>The port of the TURN server</td>
+   *   </tr>
+   *   <tr>
+   *     <td nowrap="nowrap">(gchar*)</td>
+   *     <td nowrap="nowrap">username</td>
+   *   </tr>
+   *   <tr>
+   *     <td nowrap="nowrap">(gchar*)</td>
+   *     <td nowrap="nowrap">password</td>
+   *   </tr>
+   *   <tr><th colspan="2">Optional</th></tr>
+   *   <tr>
+   *    <td nowrap="nowrap">(gchar *)</td>
+   *    <td nowrap="nowrap">relay-type</td>
+   *    <td>The type of STUN server, can use "udp", "tcp" or "tls".
+   *        Defaults to "udp" if not specified.</td>
+   *   </tr>
+   *   <tr>
+   *    <td nowrap="nowrap">(guint)</td>
+   *    <td nowrap="nowrap">component</td>
+   *    <td>The component this TURN server and creditials will be used for.
+   *    If no component is specified, it will be used for all components where
+   *    no per-component details were specified.
+   *    This is useful if you want to specify different short term creditial
+   *    username/password combinations for Google and MSN compatibility modes.
+   *    </td>
+   *   </tr>
+   *  </informaltable>
+   */
+
   g_object_class_install_property (gobject_class, PROP_RELAY_INFO,
       g_param_spec_value_array (
           "relay-info",
           "Information for the TURN server",
-          "ip/port/username/password/component of the TURN servers in a"
-          " GValueArray of GstStructures ",
+          "ip/port/username/password/relay-type/component of the TURN servers"
+          " in a GValueArray of GstStructures",
           NULL,
           G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
 
-- 
1.5.6.5