Generate plugins documentation using hotdoc

Which will automatically be integrated in gstreamer documentation

27 files changed, 85 insertions, 0 deletions

diff --git a/video/cdg/Cargo.toml b/video/cdg/Cargo.toml
index 042a217d..bba8decc 100644
--- a/video/cdg/Cargo.toml
+++ b/video/cdg/Cargo.toml
@@ -32,6 +32,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/cdg/src/lib.rs b/video/cdg/src/lib.rs
index bbf9bcfd..03dd3629 100644
--- a/video/cdg/src/lib.rs
+++ b/video/cdg/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-cdg:
+ *
+ * Since: plugins-rs-0.5.0
+ */
 use gst::glib;
 
 mod cdgdec;
diff --git a/video/closedcaption/Cargo.toml b/video/closedcaption/Cargo.toml
index ea1b7304..ee83bfa9 100644
--- a/video/closedcaption/Cargo.toml
+++ b/video/closedcaption/Cargo.toml
@@ -59,6 +59,7 @@ cc = "1.0"
 # We already use 1.16 which is new enough for static build
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/closedcaption/src/lib.rs b/video/closedcaption/src/lib.rs
index 8bae593d..570c3143 100644
--- a/video/closedcaption/src/lib.rs
+++ b/video/closedcaption/src/lib.rs
@@ -8,7 +8,13 @@
 #![allow(clippy::non_send_fields_in_send_ty)]
 #![recursion_limit = "128"]
 
+/**
+ * plugin-rsclosedcaption:
+ *
+ * Since: plugins-rs-0.4.0
+ */
 use gst::glib;
+use gst::prelude::*;
 
 #[allow(non_camel_case_types, non_upper_case_globals, unused)]
 #[allow(clippy::redundant_static_lifetimes, clippy::unreadable_literal)]
@@ -34,6 +40,8 @@ mod tttojson;
 mod ttutils;
 
 fn plugin_init(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    #[cfg(feature = "doc")]
+    ttutils::Cea608Mode::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
     mcc_parse::register(plugin)?;
     mcc_enc::register(plugin)?;
     scc_parse::register(plugin)?;
diff --git a/video/closedcaption/src/transcriberbin/mod.rs b/video/closedcaption/src/transcriberbin/mod.rs
index 90f7a4c7..f1c40ff8 100644
--- a/video/closedcaption/src/transcriberbin/mod.rs
+++ b/video/closedcaption/src/transcriberbin/mod.rs
@@ -25,6 +25,9 @@ glib::wrapper! {
 }
 
 pub fn register(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    #[cfg(feature = "doc")]
+    CaptionSource::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
+
     gst::Element::register(
         Some(plugin),
         "transcriberbin",
diff --git a/video/dav1d/Cargo.toml b/video/dav1d/Cargo.toml
index 9c489c16..584a2b04 100644
--- a/video/dav1d/Cargo.toml
+++ b/video/dav1d/Cargo.toml
@@ -27,6 +27,7 @@ gst-plugin-version-helper = { path = "../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/dav1d/src/lib.rs b/video/dav1d/src/lib.rs
index a63ee025..f74aee42 100644
--- a/video/dav1d/src/lib.rs
+++ b/video/dav1d/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-rsdav1d:
+ *
+ * Since: plugins-rs-0.6.0
+ */
 use gst::glib;
 
 mod dav1ddec;
diff --git a/video/ffv1/Cargo.toml b/video/ffv1/Cargo.toml
index da4daff1..fb138f42 100644
--- a/video/ffv1/Cargo.toml
+++ b/video/ffv1/Cargo.toml
@@ -28,6 +28,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/ffv1/src/lib.rs b/video/ffv1/src/lib.rs
index 2fb0e972..d76b895f 100644
--- a/video/ffv1/src/lib.rs
+++ b/video/ffv1/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-ffv1:
+ *
+ * Since: plugins-rs-0.8.0
+ */
 mod ffv1dec;
 
 fn plugin_init(plugin: &gst::Plugin) -> Result<(), gst::glib::BoolError> {
diff --git a/video/flavors/Cargo.toml b/video/flavors/Cargo.toml
index 092b898c..2d677976 100644
--- a/video/flavors/Cargo.toml
+++ b/video/flavors/Cargo.toml
@@ -31,6 +31,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/flavors/src/lib.rs b/video/flavors/src/lib.rs
index 95bf6501..dd9c0fcc 100644
--- a/video/flavors/src/lib.rs
+++ b/video/flavors/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-rsflv:
+ *
+ * Since: plugins-rs-0.4.0
+ */
 use gst::glib;
 
 mod bytes;
diff --git a/video/gif/Cargo.toml b/video/gif/Cargo.toml
index 109ea231..104c4333 100644
--- a/video/gif/Cargo.toml
+++ b/video/gif/Cargo.toml
@@ -33,6 +33,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/gif/src/lib.rs b/video/gif/src/lib.rs
index 0ae16abf..3d3b33eb 100644
--- a/video/gif/src/lib.rs
+++ b/video/gif/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-gif:
+ *
+ * Since: plugins-rs-0.6.0
+ */
 use gst::glib;
 
 mod gifenc;
diff --git a/video/gtk4/Cargo.toml b/video/gtk4/Cargo.toml
index 639a5ca9..1d1ca754 100644
--- a/video/gtk4/Cargo.toml
+++ b/video/gtk4/Cargo.toml
@@ -29,6 +29,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.7.0"
diff --git a/video/gtk4/src/lib.rs b/video/gtk4/src/lib.rs
index 1f838403..21df1ba4 100644
--- a/video/gtk4/src/lib.rs
+++ b/video/gtk4/src/lib.rs
@@ -10,6 +10,11 @@
 // SPDX-License-Identifier: MPL-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-gtk4:
+ *
+ * Since: plugins-rs-0.8.0
+ */
 use gst::glib;
 
 mod sink;
diff --git a/video/hsv/Cargo.toml b/video/hsv/Cargo.toml
index 59cd343b..4956f7b9 100644
--- a/video/hsv/Cargo.toml
+++ b/video/hsv/Cargo.toml
@@ -31,6 +31,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/hsv/src/lib.rs b/video/hsv/src/lib.rs
index f2ea26b3..40e20e27 100644
--- a/video/hsv/src/lib.rs
+++ b/video/hsv/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-hsv:
+ *
+ * Since: plugins-rs-0.7.0
+ */
 use gst::glib;
 
 mod hsvdetector;
diff --git a/video/rav1e/Cargo.toml b/video/rav1e/Cargo.toml
index a152b897..6541f905 100644
--- a/video/rav1e/Cargo.toml
+++ b/video/rav1e/Cargo.toml
@@ -30,6 +30,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 default = ["hdr"]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 asm = ["rav1e/asm"]
 hdr = ["gst-video/v1_18"]
 
diff --git a/video/rav1e/src/lib.rs b/video/rav1e/src/lib.rs
index bfc8bf9d..3395fc22 100644
--- a/video/rav1e/src/lib.rs
+++ b/video/rav1e/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-rav1e:
+ *
+ * Since: plugins-rs-0.5.0
+ */
 use gst::glib;
 
 mod rav1enc;
diff --git a/video/rav1e/src/rav1enc/mod.rs b/video/rav1e/src/rav1enc/mod.rs
index 9349c1dd..a6f5e90d 100644
--- a/video/rav1e/src/rav1enc/mod.rs
+++ b/video/rav1e/src/rav1enc/mod.rs
@@ -18,6 +18,9 @@ glib::wrapper! {
 }
 
 pub fn register(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    #[cfg(feature = "doc")]
+    imp::Tune::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
+
     gst::Element::register(
         Some(plugin),
         "rav1enc",
diff --git a/video/rspng/Cargo.toml b/video/rspng/Cargo.toml
index 1e630390..a129899a 100644
--- a/video/rspng/Cargo.toml
+++ b/video/rspng/Cargo.toml
@@ -30,6 +30,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/rspng/src/lib.rs b/video/rspng/src/lib.rs
index d05a4d73..ce78256b 100644
--- a/video/rspng/src/lib.rs
+++ b/video/rspng/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-rspng:
+ *
+ * Since: plugins-rs-0.6.0
+ */
 use gst::glib;
 
 mod pngenc;
diff --git a/video/rspng/src/pngenc/mod.rs b/video/rspng/src/pngenc/mod.rs
index debedaa2..1d83ffb6 100644
--- a/video/rspng/src/pngenc/mod.rs
+++ b/video/rspng/src/pngenc/mod.rs
@@ -86,6 +86,10 @@ glib::wrapper! {
 }
 
 pub fn register(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    #[cfg(feature = "doc")]
+    CompressionLevel::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
+    FilterType::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
+
     gst::Element::register(
         Some(plugin),
         "rspngenc",
diff --git a/video/videofx/Cargo.toml b/video/videofx/Cargo.toml
index b56c9e0f..02f00e67 100644
--- a/video/videofx/Cargo.toml
+++ b/video/videofx/Cargo.toml
@@ -44,6 +44,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/videofx/src/lib.rs b/video/videofx/src/lib.rs
index 2b8d4c5b..5dbb4bb2 100644
--- a/video/videofx/src/lib.rs
+++ b/video/videofx/src/lib.rs
@@ -8,6 +8,11 @@
 // SPDX-License-Identifier: MPL-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-videofx:
+ *
+ * Since: plugins-rs-0.8.0
+ */
 mod border;
 mod colordetect;
 
diff --git a/video/webp/Cargo.toml b/video/webp/Cargo.toml
index c8ac9d3d..871fa2fe 100644
--- a/video/webp/Cargo.toml
+++ b/video/webp/Cargo.toml
@@ -38,6 +38,7 @@ gst-plugin-version-helper = { path="../../version-helper" }
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/video/webp/src/lib.rs b/video/webp/src/lib.rs
index 079f14d3..5b6061e7 100644
--- a/video/webp/src/lib.rs
+++ b/video/webp/src/lib.rs
@@ -7,6 +7,11 @@
 // SPDX-License-Identifier: MPL-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-rswebp:
+ *
+ * Since: plugins-rs-0.7.0
+ */
 use gst::glib;
 
 mod dec;