alex/nih-plug
1
0
Fork 0
Code Activity

Fix rustdoc links

Browse source
This commit is contained in:
Robbert van der Helm 2022-02-05 23:34:38 +01:00
parent b1afe0b224
commit 4021b28155
2 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/context.rs
View file

@ -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,

5
src/lib.rs
View file

@ -14,7 +14,8 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
// 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};