From 4021b281556295b225e771ce8af8d98d01e8fbc8 Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Sat, 5 Feb 2022 23:34:38 +0100 Subject: [PATCH] Fix rustdoc links --- src/context.rs | 6 +++--- src/lib.rs | 5 +++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/context.rs b/src/context.rs index ec5a910e..b4c351bb 100644 --- a/src/context.rs +++ b/src/context.rs @@ -67,8 +67,8 @@ pub trait ProcessContext { // NIH-plug doesn't own the GUI event loop, this invariant cannot be part of the interface. pub trait GuiContext: Send + Sync { /// Retrieve a safe setter for updating the plugin's parameters. Modifying parameters here will - /// broadcast the changes both to the host and to your plugin's [crate::param::internal::Params] - /// object. + /// broadcast the changes both to the host and to your plugin's + /// [crate::param::internals::Params] object. fn setter(&self) -> ParamSetter where Self: Sized, @@ -105,7 +105,7 @@ pub trait GuiContext: Send + Sync { } /// A convenience helper for setting parameter values. Any changes made here will be broadcasted to -/// the host and reflected in the plugin's [crate::param::internal::Params] object. These functions +/// the host and reflected in the plugin's [crate::param::internals::Params] object. These functions /// should only be called from the main thread. pub struct ParamSetter<'a> { context: &'a dyn GuiContext, diff --git a/src/lib.rs b/src/lib.rs index 71ec93b7..3f6fd650 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -14,7 +14,8 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -// TODO: Once everything is more fleshed out, document the basic usage of this library +// TODO: Once everything is more fleshed out, document the basic usage of this library and +// restructure these re-exports into a more useful prelude #[macro_use] pub mod debug; @@ -27,7 +28,7 @@ pub use nih_plug_derive::Params; // And also re-export anything you'd need to build a plugin pub use buffer::Buffer; -pub use context::{GuiContext, ProcessContext}; +pub use context::{GuiContext, ParamSetter, ProcessContext}; pub use param::internals::Params; pub use param::range::Range; pub use param::smoothing::{Smoother, SmoothingStyle};