alex/nih-plug
1
0
Fork 0
Code Activity

Add a basic docstring to the Params module

Browse source
This commit is contained in:
Robbert van der Helm 2022-04-11 17:38:20 +02:00
parent fc4386a585
commit 4e5afc152a
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/param.rs
View file

@ -1,4 +1,8 @@
//! TODO: Document how to use the [`Param`] trait. For now, just look at the gain example. //! NIH-plug can handle floating point, integer, boolean, and enum parameters. Parameters are
//! managed by creating a struct deriving the [`Params`][internals::Params] trait containing fields
//! for those parmaeter types, and then returning a reference to that object from your
//! [`Plugin::params()`][crate::prelude::Plugin::params()] method. See the `Params` trait for more
//! information.
use std::fmt::Display; use std::fmt::Display;