From 6285f3f2220eae0cfa3176ac337f86df1792df18 Mon Sep 17 00:00:00 2001
From: Andrew Belt <andrewpbelt@gmail.com>
Date: Sun, 19 Jul 2020 11:08:13 -0400
Subject: [PATCH] Add documentation to `engine::Module::ProcessArgs`

---
 include/engine/Module.hpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/engine/Module.hpp b/include/engine/Module.hpp
index 91fb22c7..e1eff9ae 100644
--- a/include/engine/Module.hpp
+++ b/include/engine/Module.hpp
@@ -193,7 +193,11 @@ struct Module {
 	}
 
 	struct ProcessArgs {
+		/** The current sample rate in Hz. */
 		float sampleRate;
+		/** The timestep of process() in seconds.
+		Defined by `1 / sampleRate`.
+		*/
 		float sampleTime;
 	};
 	/** Advances the module by one audio sample.