From 4e5afc152acabc7dbd0595aaa16bbfea84cce2f8 Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Mon, 11 Apr 2022 17:38:20 +0200 Subject: [PATCH] Add a basic docstring to the Params module --- src/param.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/param.rs b/src/param.rs index 9bdec7da..a919efe0 100644 --- a/src/param.rs +++ b/src/param.rs @@ -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;