Generate plugins documentation using hotdoc

Which will automatically be integrated in gstreamer documentation

12 files changed, 34 insertions, 1 deletions

diff --git a/audio/audiofx/Cargo.toml b/audio/audiofx/Cargo.toml
index 9c4a067a7..e90a6774f 100644
--- a/audio/audiofx/Cargo.toml
+++ b/audio/audiofx/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/audio/audiofx/src/ebur128level/imp.rs b/audio/audiofx/src/ebur128level/imp.rs
index 71c3811da..7c889c546 100644
--- a/audio/audiofx/src/ebur128level/imp.rs
+++ b/audio/audiofx/src/ebur128level/imp.rs
@@ -33,7 +33,7 @@ static CAT: Lazy<gst::DebugCategory> = Lazy::new(|| {
 });
 
 #[glib::flags(name = "EbuR128LevelMode")]
-enum Mode {
+pub(crate) enum Mode {
     #[flags_value(name = "Calculate momentary loudness (400ms)", nick = "momentary")]
     MOMENTARY = 0b00000001,
     #[flags_value(name = "Calculate short-term loudness (3s)", nick = "short-term")]
diff --git a/audio/audiofx/src/ebur128level/mod.rs b/audio/audiofx/src/ebur128level/mod.rs
index 722789ba6..3908d21ce 100644
--- a/audio/audiofx/src/ebur128level/mod.rs
+++ b/audio/audiofx/src/ebur128level/mod.rs
@@ -16,6 +16,9 @@ glib::wrapper! {
 }
 
 pub fn register(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    #[cfg(feature = "doc")]
+    imp::Mode::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
+
     gst::Element::register(
         Some(plugin),
         "ebur128level",
diff --git a/audio/audiofx/src/lib.rs b/audio/audiofx/src/lib.rs
index ecf90b51a..345317b12 100644
--- a/audio/audiofx/src/lib.rs
+++ b/audio/audiofx/src/lib.rs
@@ -7,6 +7,11 @@
 // SPDX-License-Identifier: MPL-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-rsaudiofx:
+ *
+ * Since: plugins-rs-0.1
+ */
 use gst::glib;
 
 mod audioecho;
diff --git a/audio/claxon/Cargo.toml b/audio/claxon/Cargo.toml
index 9748cceb1..1163f7a78 100644
--- a/audio/claxon/Cargo.toml
+++ b/audio/claxon/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/audio/claxon/src/lib.rs b/audio/claxon/src/lib.rs
index dff703877..6483a8719 100644
--- a/audio/claxon/src/lib.rs
+++ b/audio/claxon/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-claxon:
+ *
+ * Since: plugins-rs-0.6.0
+ */
 use gst::glib;
 
 mod claxondec;
diff --git a/audio/csound/Cargo.toml b/audio/csound/Cargo.toml
index 10c9d8fe9..7269f332a 100644
--- a/audio/csound/Cargo.toml
+++ b/audio/csound/Cargo.toml
@@ -34,6 +34,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/audio/csound/src/lib.rs b/audio/csound/src/lib.rs
index c156b88c8..f38b09a55 100644
--- a/audio/csound/src/lib.rs
+++ b/audio/csound/src/lib.rs
@@ -7,6 +7,11 @@
 // SPDX-License-Identifier: MPL-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-csound:
+ *
+ * Since: plugins-rs-0.6.0
+ */
 use gst::glib;
 
 mod filter;
diff --git a/audio/lewton/Cargo.toml b/audio/lewton/Cargo.toml
index 6c988fd52..6d31e3b47 100644
--- a/audio/lewton/Cargo.toml
+++ b/audio/lewton/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/audio/lewton/src/lib.rs b/audio/lewton/src/lib.rs
index 6e49a70bd..7338be3ce 100644
--- a/audio/lewton/src/lib.rs
+++ b/audio/lewton/src/lib.rs
@@ -11,6 +11,11 @@
 
 use gst::glib;
 
+/**
+ * plugin-lewton:
+ *
+ * Since: plugins-rs-0.6.0
+ */
 mod lewtondec;
 
 fn plugin_init(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
diff --git a/audio/spotify/Cargo.toml b/audio/spotify/Cargo.toml
index 5e6b9c4b7..0f796c873 100644
--- a/audio/spotify/Cargo.toml
+++ b/audio/spotify/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/audio/spotify/src/lib.rs b/audio/spotify/src/lib.rs
index 72771b28e..6bd716277 100644
--- a/audio/spotify/src/lib.rs
+++ b/audio/spotify/src/lib.rs
@@ -7,6 +7,11 @@
 // SPDX-License-Identifier: MPL-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-spotify:
+ *
+ * Since: plugins-rs-0.8.0
+ */
 use gst::glib;
 
 mod spotifyaudiosrc;