aboutsummaryrefslogtreecommitdiffstats
path: root/firmware/source/communication.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'firmware/source/communication.hpp')
-rw-r--r--firmware/source/communication.hpp10
1 files changed, 9 insertions, 1 deletions
diff --git a/firmware/source/communication.hpp b/firmware/source/communication.hpp
index 03220b8..a4f818a 100644
--- a/firmware/source/communication.hpp
+++ b/firmware/source/communication.hpp
@@ -2,7 +2,7 @@
* @file communication.hpp
* @brief Manages communication with the host computer.
*
- * 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.
@@ -17,9 +17,17 @@
class CommunicationManager
{
public:
+ /**
+ * Starts the communication manager thread (threadComm).
+ */
static void begin();
private:
+ /**
+ * Continuously polls the USB serial connection, handling received commands
+ * as necessary.
+ * Does not return.
+ */
static void threadComm(void *);
static std::array<char, 4096> m_thread_stack;