From 287576d064b7f1a42a10fd218560d501a742628e Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Mon, 14 Feb 2022 14:22:50 +0100
Subject: [PATCH] Fix rustdoc hyperlinks
---
src/context.rs | 4 ++--
src/param.rs | 4 ++--
src/plugin.rs | 12 ++++++------
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/context.rs b/src/context.rs
index c57ef0f3..deb42694 100644
--- a/src/context.rs
+++ b/src/context.rs
@@ -48,8 +48,8 @@ pub trait ProcessContext {
}
/// Callbacks the plugin can make when the user interacts with its GUI such as updating parameter
-/// values. This is passed to the plugin during [crate::plugin::Plugin::create_editor()]. All of
-/// these functions assume they're being called from the main GUI thread.
+/// values. This is passed to the plugin during [crate::Editor::spawn()]. All of these functions
+/// assume they're being called from the main GUI thread.
//
// # Safety
//
diff --git a/src/param.rs b/src/param.rs
index 27cbcfb2..8a143fe3 100644
--- a/src/param.rs
+++ b/src/param.rs
@@ -106,8 +106,8 @@ pub struct EnumParam<T: EnumIter + EnumMessage + Eq + Copy + Display> {
/// The integer parameter backing this enum parameter.
pub inner: IntParam,
/// An associative list of the variants converted to an i32 and their names. We need this
- /// because we're doing some nasty type erasure things with [internals::ParamPtr::Enum], so we
- /// can't directly query the associated functions on `T` after the parameter when handling
+ /// because we're doing some nasty type erasure things with [internals::ParamPtr::EnumParam], so
+ /// we can't directly query the associated functions on `T` after the parameter when handling
/// function calls from the wrapper.
variants: Vec<(T, String)>,
}
diff --git a/src/plugin.rs b/src/plugin.rs
index 86fef3cb..92cb12c9 100644
--- a/src/plugin.rs
+++ b/src/plugin.rs
@@ -54,8 +54,8 @@ pub trait Plugin: Default + Send + Sync + 'static {
/// The plugin's editor, if it has one. The actual editor instance is created in
/// [Editor::spawn]. A plugin editor likely wants to interact with the plugin's parameters and
/// other shared data, so you'll need to move [Arc] pointing to any data you want to access into
- /// the editor. You can later modify the parameters through the [GuiContext] and [ParamSetter]
- /// after the editor GUI has been created.
+ /// the editor. You can later modify the parameters through the [crate::GuiContext] and
+ /// [crate::ParamSetter] after the editor GUI has been created.
fn editor(&self) -> Option<Box<dyn Editor>> {
None
}
@@ -144,10 +144,10 @@ const fn swap_vst3_uid_byte_order(mut uid: [u8; 16]) -> [u8; 16] {
/// An editor for a [Plugin].
pub trait Editor: Send + Sync {
/// Create an instance of the plugin's editor and embed it in the parent window. As explained in
- /// [Plugin::editor], you can then read the parameter values directly from your [Params] object,
- /// and modifying the values can be done using the functions on the [ParamSetter]. When you
- /// change a parameter value that way it will be broadcasted to the host and also updated in
- /// your [Params] struct.
+ /// [Plugin::editor], you can then read the parameter values directly from your [crate::Params]
+ /// object, and modifying the values can be done using the functions on the
+ /// [crate::ParamSetter]. When you change a parameter value that way it will be broadcasted to
+ /// the host and also updated in your [Params] struct.
///
/// This function should return a handle to the editor, which will be dropped when the editor
/// gets closed. Implement the [Drop] trait on the returned handle if you need to explicitly