alex/nih-plug
1
0
Fork 0
Code Activity

Add missing docstrings

Browse source
This commit is contained in:
Robbert van der Helm 2022-03-03 23:34:06 +01:00
parent 80457ac0f9
commit 3e0316e17c
4 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/buffer.rs
View file

@ -1,3 +1,5 @@
//! Adapters and utilities for working with audio buffers.
use std::marker::PhantomData; use std::marker::PhantomData;
#[cfg(feature = "simd")] #[cfg(feature = "simd")]

4
src/lib.rs
View file

@ -4,7 +4,7 @@
#![cfg_attr(feature = "simd", feature(portable_simd))] #![cfg_attr(feature = "simd", feature(portable_simd))]
#[macro_use] #[macro_use]
pub mod debug; mod debug;
/// Everything you'll need to use NIH-plug. Import this with `use nih_plug::prelude::*;`. /// Everything you'll need to use NIH-plug. Import this with `use nih_plug::prelude::*;`.
pub mod prelude; pub mod prelude;
@ -15,7 +15,7 @@ pub mod util;
pub mod buffer; pub mod buffer;
pub mod context; pub mod context;
pub mod event_loop; mod event_loop;
pub mod param; pub mod param;
pub mod plugin; pub mod plugin;
pub mod wrapper; pub mod wrapper;

2
src/plugin.rs
View file

@ -1,3 +1,5 @@
//! Traits and structs describing plugins and editors.
use raw_window_handle::{HasRawWindowHandle, RawWindowHandle}; use raw_window_handle::{HasRawWindowHandle, RawWindowHandle};
use std::any::Any; use std::any::Any;
use std::pin::Pin; use std::pin::Pin;

2
src/util.rs
View file

@ -1,3 +1,5 @@
//! General conversion functions and utilities.
pub const MINUS_INFINITY_DB: f32 = -100.0; pub const MINUS_INFINITY_DB: f32 = -100.0;
/// Convert decibels to a voltage gain ratio, treating anything below -100 dB as minus infinity. /// Convert decibels to a voltage gain ratio, treating anything below -100 dB as minus infinity.