ndi: Add NDI plugin to the docs

3 files changed, 26 insertions, 10 deletions

diff --git a/net/ndi/src/lib.rs b/net/ndi/src/lib.rs
index ba82e9b3..97a0fc6a 100644
--- a/net/ndi/src/lib.rs
+++ b/net/ndi/src/lib.rs
@@ -1,4 +1,11 @@
 // SPDX-License-Identifier: MPL-2.0
+#![allow(unused_doc_comments)]
+
+/**
+ * plugin-ndi:
+ *
+ * Since: plugins-rs-0.9
+ */
 
 #[allow(dead_code)]
 mod ndi;
@@ -18,6 +25,9 @@ mod ndisrc;
 mod ndisrcdemux;
 mod ndisrcmeta;
 
+#[cfg(feature = "doc")]
+use gst::prelude::*;
+
 use once_cell::sync::Lazy;
 
 #[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Clone, Copy, glib::Enum)]
@@ -118,6 +128,11 @@ impl From<RecvColorFormat> for crate::ndisys::NDIlib_recv_color_format_e {
 }
 
 fn plugin_init(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    #[cfg(feature = "doc")]
+    TimestampMode::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
+    #[cfg(feature = "doc")]
+    RecvColorFormat::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
+
     device_provider::register(plugin)?;
 
     ndisrc::register(plugin)?;
@@ -128,17 +143,10 @@ fn plugin_init(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
         ndisinkcombiner::register(plugin)?;
         ndisink::register(plugin)?;
     }
+
     Ok(())
 }
 
-static DEFAULT_RECEIVER_NDI_NAME: Lazy<String> = Lazy::new(|| {
-    format!(
-        "GStreamer NDI Source {}-{}",
-        env!("CARGO_PKG_VERSION"),
-        env!("COMMIT_ID")
-    )
-});
-
 static TIMECODE_CAPS: Lazy<gst::Caps> =
     Lazy::new(|| gst::Caps::new_simple("timestamp/x-ndi-timecode", &[]));
 static TIMESTAMP_CAPS: Lazy<gst::Caps> =
diff --git a/net/ndi/src/ndisink/imp.rs b/net/ndi/src/ndisink/imp.rs
index cbf9a3e6..5dd95800 100644
--- a/net/ndi/src/ndisink/imp.rs
+++ b/net/ndi/src/ndisink/imp.rs
@@ -69,7 +69,7 @@ impl ObjectImpl for NdiSink {
             vec![glib::ParamSpecString::builder("ndi-name")
                 .nick("NDI Name")
                 .blurb("NDI Name to use")
-                .default_value(Some(DEFAULT_SENDER_NDI_NAME.as_ref()))
+                .doc_show_default()
                 .build()]
         });
 
diff --git a/net/ndi/src/ndisrc/imp.rs b/net/ndi/src/ndisrc/imp.rs
index d971e89a..ef7f2fd2 100644
--- a/net/ndi/src/ndisrc/imp.rs
+++ b/net/ndi/src/ndisrc/imp.rs
@@ -18,7 +18,6 @@ use crate::TimestampMode;
 
 use super::receiver::{self, Buffer, Receiver, ReceiverControlHandle, ReceiverItem};
 use crate::ndisrcmeta;
-use crate::DEFAULT_RECEIVER_NDI_NAME;
 
 static CAT: Lazy<gst::DebugCategory> = Lazy::new(|| {
     gst::DebugCategory::new(
@@ -28,6 +27,14 @@ static CAT: Lazy<gst::DebugCategory> = Lazy::new(|| {
     )
 });
 
+static DEFAULT_RECEIVER_NDI_NAME: Lazy<String> = Lazy::new(|| {
+    format!(
+        "GStreamer NewTek NDI Source {}-{}",
+        env!("CARGO_PKG_VERSION"),
+        env!("COMMIT_ID")
+    )
+});
+
 #[derive(Debug, Clone)]
 struct Settings {
     ndi_name: Option<String>,
@@ -115,6 +122,7 @@ impl ObjectImpl for NdiSrc {
                 glib::ParamSpecString::builder("receiver-ndi-name")
                     .nick("Receiver NDI Name")
                     .blurb("NDI stream name of this receiver")
+                    .doc_show_default()
                     .build(),
                 glib::ParamSpecUInt::builder("connect-timeout")
                     .nick("Connect Timeout")