From f3c28dd2f1a27ee8039a86942ccd2277fbb4102e Mon Sep 17 00:00:00 2001
From: Clyne Sullivan <clyne@bitgloo.com>
Date: Sun, 8 Oct 2023 16:32:23 -0400
Subject: add to firmware documentation
---
firmware/source/conversion.hpp | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
(limited to 'firmware/source/conversion.hpp')
diff --git a/firmware/source/conversion.hpp b/firmware/source/conversion.hpp
index ca0054a..75d644e 100644
--- a/firmware/source/conversion.hpp
+++ b/firmware/source/conversion.hpp
@@ -2,7 +2,7 @@
* @file conversion.hpp
* @brief Manages algorithm application (converts input samples to output).
*
- * Copyright (C) 2021 Clyne Sullivan
+ * Copyright (C) 2023 Clyne Sullivan
*
* Distributed under the GNU GPL v3 or later. You should have received a copy of
* the GNU General Public License along with this program.
@@ -27,6 +27,10 @@ constexpr unsigned int CONVERSION_THREAD_STACK_SIZE =
class ConversionManager
{
public:
+ /**
+ * Starts two threads: the privileged monitor thread and the unprivileged
+ * algorithm execution thread.
+ */
static void begin();
// Begins sample conversion.
--
cgit v1.2.3