From 3e0316e17cc1cf314cbf54f120ef735482536c4b Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Thu, 3 Mar 2022 23:34:06 +0100 Subject: [PATCH] Add missing docstrings --- src/buffer.rs | 2 ++ src/lib.rs | 4 ++-- src/plugin.rs | 2 ++ src/util.rs | 2 ++ 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/buffer.rs b/src/buffer.rs index 57b55c54..e57519ec 100644 --- a/src/buffer.rs +++ b/src/buffer.rs @@ -1,3 +1,5 @@ +//! Adapters and utilities for working with audio buffers. + use std::marker::PhantomData; #[cfg(feature = "simd")] diff --git a/src/lib.rs b/src/lib.rs index 4edc2ad8..35db5892 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -4,7 +4,7 @@ #![cfg_attr(feature = "simd", feature(portable_simd))] #[macro_use] -pub mod debug; +mod debug; /// Everything you'll need to use NIH-plug. Import this with `use nih_plug::prelude::*;`. pub mod prelude; @@ -15,7 +15,7 @@ pub mod util; pub mod buffer; pub mod context; -pub mod event_loop; +mod event_loop; pub mod param; pub mod plugin; pub mod wrapper; diff --git a/src/plugin.rs b/src/plugin.rs index 32d496e1..64f840d1 100644 --- a/src/plugin.rs +++ b/src/plugin.rs @@ -1,3 +1,5 @@ +//! Traits and structs describing plugins and editors. + use raw_window_handle::{HasRawWindowHandle, RawWindowHandle}; use std::any::Any; use std::pin::Pin; diff --git a/src/util.rs b/src/util.rs index 7f53a170..e2a9deaa 100644 --- a/src/util.rs +++ b/src/util.rs @@ -1,3 +1,5 @@ +//! General conversion functions and utilities. + pub const MINUS_INFINITY_DB: f32 = -100.0; /// Convert decibels to a voltage gain ratio, treating anything below -100 dB as minus infinity.