From 972b9e54748410f870cfa561409c4f67132142c3 Mon Sep 17 00:00:00 2001
From: Robert Ayrapetyan <robert.ayrapetyan@gmail.com>
Date: Thu, 1 Feb 2024 19:29:12 +0000
Subject: [PATCH] doc: add docstrings for signaller object

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/1419>
---
 net/webrtc/src/signaller/imp.rs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/net/webrtc/src/signaller/imp.rs b/net/webrtc/src/signaller/imp.rs
index 1b8b5d76..4c982add 100644
--- a/net/webrtc/src/signaller/imp.rs
+++ b/net/webrtc/src/signaller/imp.rs
@@ -493,21 +493,33 @@ impl ObjectImpl for Signaller {
         static PROPS: Lazy<Vec<glib::ParamSpec>> = Lazy::new(|| {
             vec![
                 glib::ParamSpecString::builder("uri")
+                    .nick("Signaller URI")
+                    .blurb("URI for connecting to the signaller server")
                     .flags(glib::ParamFlags::READWRITE)
                     .build(),
                 glib::ParamSpecString::builder("producer-peer-id")
+                    .nick("Producer peer id")
+                    .blurb("The peer id of the producer transmitted to the signaller server")
                     .flags(glib::ParamFlags::READWRITE)
                     .build(),
                 glib::ParamSpecString::builder("cafile")
+                    .nick("Certificate Authority (CA) file")
+                    .blurb("Certificate file used in TLS session")
                     .flags(glib::ParamFlags::READWRITE)
                     .build(),
                 glib::ParamSpecEnum::builder_with_default("role", WebRTCSignallerRole::Consumer)
+                    .nick("Role")
+                    .blurb("Role within the session (Consumer, Producer or Listener)")
                     .flags(glib::ParamFlags::READWRITE)
                     .build(),
                 glib::ParamSpecString::builder("client-id")
+                    .nick("Client id")
+                    .blurb("The client id transmitted to the signaller server")
                     .flags(glib::ParamFlags::READABLE)
                     .build(),
                 glib::ParamSpecBoxed::builder::<gst::Structure>("headers")
+                    .nick("HTTP headers")
+                    .blurb("HTTP headers sent during the connection handshake")
                     .flags(glib::ParamFlags::READWRITE)
                     .build(),
             ]