Generate plugins documentation using hotdoc

Which will automatically be integrated in gstreamer documentation

9 files changed, 32 insertions, 0 deletions

diff --git a/generic/file/Cargo.toml b/generic/file/Cargo.toml
index 4952d0c7e..5b38a588c 100644
--- a/generic/file/Cargo.toml
+++ b/generic/file/Cargo.toml
@@ -25,6 +25,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/generic/file/src/lib.rs b/generic/file/src/lib.rs
index cdcf505b1..bc11afd23 100644
--- a/generic/file/src/lib.rs
+++ b/generic/file/src/lib.rs
@@ -9,6 +9,11 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-rsfile:
+ *
+ * Since: plugins-rs-0.1.0
+ */
 use gst::glib;
 
 mod file_location;
diff --git a/generic/fmp4/src/fmp4mux/mod.rs b/generic/fmp4/src/fmp4mux/mod.rs
index 1424d9a3c..76c2da9c2 100644
--- a/generic/fmp4/src/fmp4mux/mod.rs
+++ b/generic/fmp4/src/fmp4mux/mod.rs
@@ -33,6 +33,8 @@ glib::wrapper! {
 }
 
 pub fn register(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    FMP4Mux::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
+    HeaderUpdateMode::static_type().mark_as_plugin_api(gst::PluginAPIFlags::empty());
     gst::Element::register(
         Some(plugin),
         "isofmp4mux",
diff --git a/generic/fmp4/src/lib.rs b/generic/fmp4/src/lib.rs
index 7832bf999..d44dbc2ce 100644
--- a/generic/fmp4/src/lib.rs
+++ b/generic/fmp4/src/lib.rs
@@ -7,6 +7,11 @@
 // SPDX-License-Identifier: MPL-2.0
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-fmp4:
+ *
+ * Since: plugins-rs-0.8.0
+ */
 use gst::glib;
 
 mod fmp4mux;
diff --git a/generic/sodium/Cargo.toml b/generic/sodium/Cargo.toml
index d707fe896..8f73a2471 100644
--- a/generic/sodium/Cargo.toml
+++ b/generic/sodium/Cargo.toml
@@ -59,6 +59,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/generic/sodium/src/lib.rs b/generic/sodium/src/lib.rs
index 69b5b7032..7d88ee96a 100644
--- a/generic/sodium/src/lib.rs
+++ b/generic/sodium/src/lib.rs
@@ -21,6 +21,11 @@
 // SPDX-License-Identifier: MIT
 #![allow(clippy::non_send_fields_in_send_ty)]
 
+/**
+ * plugin-sodium:
+ *
+ * Since: plugins-rs-0.5.0
+ */
 use gst::glib;
 
 const TYPEFIND_HEADER: &[u8; 12] = b"gst-sodium10";
diff --git a/generic/threadshare/Cargo.toml b/generic/threadshare/Cargo.toml
index bf23f862a..b4d08e7ba 100644
--- a/generic/threadshare/Cargo.toml
+++ b/generic/threadshare/Cargo.toml
@@ -66,6 +66,7 @@ pkg-config = "0.3.15"
 [features]
 static = []
 capi = []
+doc = ["gst/v1_18"]
 
 [package.metadata.capi]
 min_version = "0.8.0"
diff --git a/generic/threadshare/src/appsrc/imp.rs b/generic/threadshare/src/appsrc/imp.rs
index 10c696fb4..ec4ca6202 100644
--- a/generic/threadshare/src/appsrc/imp.rs
+++ b/generic/threadshare/src/appsrc/imp.rs
@@ -506,6 +506,12 @@ impl ObjectImpl for AppSrc {
                         Some(appsrc.push_buffer(&element, buffer).to_value())
                     })
                     .build(),
+                /**
+                 * ts-appsrc::end-of-stream:
+                 * @self: A ts-appsrc
+                 *
+                 * Returns: %TRUE if the EOS could be queued, %FALSE otherwise
+                 */
                 glib::subclass::Signal::builder("end-of-stream")
                     .return_type::<bool>()
                     .action()
diff --git a/generic/threadshare/src/lib.rs b/generic/threadshare/src/lib.rs
index e9b5a9dc2..6067a2b0c 100644
--- a/generic/threadshare/src/lib.rs
+++ b/generic/threadshare/src/lib.rs
@@ -7,6 +7,12 @@
 //!
 //! [`runtime`]: runtime/index.html
 
+/**
+ * plugin-threadshare:
+ *
+ * Since: plugins-rs-0.4.0
+ */
+
 #[macro_use]
 pub mod runtime;