diff --git a/nih_plug_egui/src/lib.rs b/nih_plug_egui/src/lib.rs index 842085bf..5ab69e24 100644 --- a/nih_plug_egui/src/lib.rs +++ b/nih_plug_egui/src/lib.rs @@ -65,7 +65,7 @@ impl EguiState { }) } - /// Return a `(width, height)` pair for the current size of the GUI in logical pixels. + /// Returns a `(width, height)` pair for the current size of the GUI in logical pixels. pub fn size(&self) -> (u32, u32) { self.size.load() } diff --git a/nih_plug_iced/src/lib.rs b/nih_plug_iced/src/lib.rs index 0e41f831..d8f8e53d 100644 --- a/nih_plug_iced/src/lib.rs +++ b/nih_plug_iced/src/lib.rs @@ -158,7 +158,7 @@ pub trait IcedEditor: 'static + Send + Sync + Sized { context: Arc, ) -> (Self, Command); - /// Return a reference to the GUI context. + /// Returns a reference to the GUI context. /// [`handle_param_message()`][Self::handle_param_message()] uses this to interact with the /// parameters. fn context(&self) -> &dyn GuiContext; @@ -240,7 +240,7 @@ impl IcedState { }) } - /// Return a `(width, height)` pair for the current size of the GUI in logical pixels. + /// Returns a `(width, height)` pair for the current size of the GUI in logical pixels. pub fn size(&self) -> (u32, u32) { self.size.load() } diff --git a/nih_plug_vizia/src/lib.rs b/nih_plug_vizia/src/lib.rs index 901bea41..39b6bf4d 100644 --- a/nih_plug_vizia/src/lib.rs +++ b/nih_plug_vizia/src/lib.rs @@ -95,7 +95,7 @@ impl ViziaState { }) } - /// Return a `(width, height)` pair for the current size of the GUI in logical pixels, after + /// Returns a `(width, height)` pair for the current size of the GUI in logical pixels, after /// applying the user scale factor. pub fn scaled_logical_size(&self) -> (u32, u32) { let (logical_width, logical_height) = self.size.load(); @@ -107,7 +107,7 @@ impl ViziaState { ) } - /// Return a `(width, height)` pair for the current size of the GUI in logical pixels before + /// Returns a `(width, height)` pair for the current size of the GUI in logical pixels before /// applying the user scale factor. pub fn inner_logical_size(&self) -> (u32, u32) { self.size.load() diff --git a/src/buffer.rs b/src/buffer.rs index 52919244..a7e49831 100644 --- a/src/buffer.rs +++ b/src/buffer.rs @@ -28,7 +28,7 @@ pub struct Buffer<'a> { } impl<'a> Buffer<'a> { - /// Return the numer of samples in this buffer. + /// Returns the numer of samples in this buffer. #[inline] pub fn len(&self) -> usize { if self.output_slices.is_empty() { @@ -38,7 +38,7 @@ impl<'a> Buffer<'a> { } } - /// Return the numer of channels in this buffer. + /// Returns the numer of channels in this buffer. #[inline] pub fn channels(&self) -> usize { self.output_slices.len() diff --git a/src/buffer/blocks.rs b/src/buffer/blocks.rs index 51ed60ba..0cb6461d 100644 --- a/src/buffer/blocks.rs +++ b/src/buffer/blocks.rs @@ -131,7 +131,7 @@ impl<'slice, 'sample> Block<'slice, 'sample> { self.current_block_end - self.current_block_start } - /// Return the numer of channels in this buffer. + /// Returns the numer of channels in this buffer. #[inline] pub fn channels(&self) -> usize { unsafe { (*self.buffers).len() } diff --git a/src/context.rs b/src/context.rs index bfd01812..51cbfad2 100644 --- a/src/context.rs +++ b/src/context.rs @@ -24,7 +24,7 @@ pub trait ProcessContext { /// Get information about the current transport position and status. fn transport(&self) -> &Transport; - /// Return the next note event, if there is one. Use [`NoteEvent::timing()`] to get the event's + /// Returns the next note event, if there is one. Use [`NoteEvent::timing()`] to get the event's /// timing within the buffer. Only available when /// [`Plugin::MIDI_INPUT`][crate::prelude::Plugin::MIDI_INPUT] is set. /// diff --git a/src/midi.rs b/src/midi.rs index 95a52169..f2e02260 100644 --- a/src/midi.rs +++ b/src/midi.rs @@ -166,7 +166,7 @@ pub enum NoteEvent { } impl NoteEvent { - /// Return the sample within the current buffer this event belongs to. + /// Returns the sample within the current buffer this event belongs to. pub fn timing(&self) -> u32 { match &self { NoteEvent::NoteOn { timing, .. } => *timing, diff --git a/src/param.rs b/src/param.rs index 439c35ba..231c2eb8 100644 --- a/src/param.rs +++ b/src/param.rs @@ -72,13 +72,13 @@ pub trait Param: Display { /// UI. fn step_count(&self) -> Option; - /// Return the previous step from a specific value for this parameter. This can be the same as + /// Returns the previous step from a specific value for this parameter. This can be the same as /// `from` if the value is at the start of its range. This is mainly used for scroll wheel /// interaction in plugin GUIs. When the parameter is not discrete then a step should cover one /// hundredth of the normalized range instead. fn previous_step(&self, from: Self::Plain) -> Self::Plain; - /// Return the next step from a specific value for this parameter. This can be the same as + /// Returns the next step from a specific value for this parameter. This can be the same as /// `from` if the value is at the end of its range. This is mainly used for scroll wheel /// interaction in plugin GUIs. When the parameter is not discrete then a step should cover one /// hundredth of the normalized range instead. diff --git a/src/plugin.rs b/src/plugin.rs index a7338fd6..6fd2c52c 100644 --- a/src/plugin.rs +++ b/src/plugin.rs @@ -234,7 +234,7 @@ pub trait Editor: Send + Sync { context: Arc, ) -> Box; - /// Return the (currnent) size of the editor in pixels as a `(width, height)` pair. This size + /// Returns the (currnent) size of the editor in pixels as a `(width, height)` pair. This size /// must be reported in _logical pixels_, i.e. the size before being multiplied by the DPI /// scaling factor to get the actual physical screen pixels. fn size(&self) -> (u32, u32);