Skip to content
This repository was archived by the owner on Mar 27, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ pub struct AEffect {
impl AEffect {
/// Return handle to Plugin object. Only works for plugins created using this library.
/// Caller is responsible for not calling this function concurrently.
// Supresses warning about returning a reference to a box
// Suppresses warning about returning a reference to a box
#[allow(clippy::borrowed_box)]
pub unsafe fn get_plugin(&self) -> &mut Box<dyn Plugin> {
//FIXME: find a way to do this without resorting to transmuting via a box
Expand Down Expand Up @@ -480,7 +480,7 @@ impl Events {
}
}

/// The type of event that has occured. See `api::Event.event_type`.
/// The type of event that has occurred. See `api::Event.event_type`.
#[repr(i32)]
#[derive(Copy, Clone, Debug)]
pub enum EventType {
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
//!
//! ## `Plugin` Trait
//! All methods in this trait have a default implementation except for the `get_info` method which
//! must be implemented by the plugin. Any of the default implementations may be overriden for
//! must be implemented by the plugin. Any of the default implementations may be overridden for
//! custom functionality; the defaults do nothing on their own.
//!
//! ## `PluginParameters` Trait
Expand Down
8 changes: 4 additions & 4 deletions src/plugin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ pub enum OpCode {
/// [index]: parameter
/// [ptr]: char buffer, limited to `consts::MAX_PARAM_STR_LEN` (e.g. "db", "ms", etc)
GetParameterLabel,
/// [index]: paramter
/// [index]: parameter
/// [ptr]: char buffer, limited to `consts::MAX_PARAM_STR_LEN` (e.g. "0.5", "ROOM", etc).
GetParameterDisplay,
/// [index]: parameter
Expand Down Expand Up @@ -200,7 +200,7 @@ pub enum OpCode {
/// [ptr]: "Can do" string.
/// [return]: 1 = yes, 0 = maybe, -1 = no.
CanDo,
/// [return]: tail size (e.g. reverb time). 0 is defualt, 1 means no tail.
/// [return]: tail size (e.g. reverb time). 0 is default, 1 means no tail.
GetTailSize,

/// Deprecated.
Expand Down Expand Up @@ -476,7 +476,7 @@ pub trait Plugin: Send {

/// Called during initialization to pass a `HostCallback` to the plugin.
///
/// This method can be overriden to set `host` as a field in the plugin struct.
/// This method can be overridden to set `host` as a field in the plugin struct.
///
/// # Example
///
Expand Down Expand Up @@ -738,7 +738,7 @@ pub trait PluginParameters: Sync {
format!("Param {}", index)
}

/// Get the value of paramater at `index`. Should be value between 0.0 and 1.0.
/// Get the value of parameter at `index`. Should be value between 0.0 and 1.0.
fn get_parameter(&self, index: i32) -> f32 {
0.0
}
Expand Down