diff options
| author | Thibault Saunier <tsaunier@igalia.com> | 2022-08-26 01:30:08 +0300 |
|---|---|---|
| committer | Thibault Saunier <tsaunier@igalia.com> | 2022-08-30 01:33:22 +0300 |
| commit | 31a53bba8ae22d4be44861c868fb663fd46a69a3 (patch) | |
| tree | 480e63405d0f1fc51ad147eb795879cc7bac644b /audio/audiofx | |
| parent | 25465fd9f3c65ecc3ce089d56a0c746fcd6a839c (diff) | |
Generate plugins documentation using hotdoc
Which will automatically be integrated in gstreamer documentation
Diffstat (limited to 'audio/audiofx')
| -rw-r--r-- | audio/audiofx/Cargo.toml | 1 | ||||
| -rw-r--r-- | audio/audiofx/src/ebur128level/imp.rs | 2 | ||||
| -rw-r--r-- | audio/audiofx/src/ebur128level/mod.rs | 3 | ||||
| -rw-r--r-- | audio/audiofx/src/lib.rs | 5 |
4 files changed, 10 insertions, 1 deletions
diff --git a/audio/audiofx/Cargo.toml b/audio/audiofx/Cargo.toml index 9c4a067a..e90a6774 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 71c3811d..7c889c54 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 722789ba..3908d21c 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 ecf90b51..345317b1 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; |